码云 IDEA 插件最新版本发布,支持 Pull Request

票牛 / pndaoJavaApache-2.0

指数
0
Watch 143 Star 353 Fork 122
加入码云
与超过 300 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
一个非常简单的MyBatis辅助工具,可以基于DAO的命名约定帮你生成并维护SQL语句 展开 收起

取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README.md

pndao

一个非常简单的MyBatis辅助工具,可以基于DAO的命名约定帮你生成并维护SQL语句

pndao是票牛Java团队实践一年演化出来的工具。在实际生产中减少了80%以上的重复SQL编写工作,从而把关注力转移到模型本身的制定上。结合建表语句生成插件pngen,大部分场景只需编写一个模型类即可完成DAO层工作。

特性

  1. 支持最主流的MyBatis框架,无学习成本
  2. 基于常见DAO功能定制,提供便捷的同时也可约束命名规范
  3. 修改表结构后可同步修改SQL
  4. 编译期生成XML,也可便捷支持其他框架

以下是一个常见的DAO功能:

public class UserDaoTest extends AbstractTest{

	public static final int USER_ID = 1;

	@Autowired
	private UserDao userDao;

	@Test
	public void testInsertUser() throws Exception {
		User user = initUser();
		assertThat(userDao.insert(user)).isEqualTo(1);
	}

	@Test
	public void testFindUserById() throws Exception {
		User user = userDao.findById(USER_ID);
		assertThat(user).isNotNull();
	}

	@Test
	public void testUpdateUserName() throws Exception {
		assertThat(userDao.updateForUserName("用户13700000001",USER_ID)).isEqualTo(1);
	}
}

基于pndao,所有需要开发的DAO只有这些:

@DaoGen
public interface UserDao {

	int updateForUserName(@Param("userName") String userName, @Param("id") int id);

	int insert(User t);

	User findById(int id);

}

使用

1. 引入pndao依赖

    <artifactId>pndao</artifactId>
        <groupId>com.piaoniu</groupId>
        <version>0.2.0</version>

2. 如果你正在使用MyBatis,那么只需在Dao上增加@DaoGen注释即可。

3. pndao会优先使用你自己定义的SQL(包括注解和XML),所以不用担心原有的Dao不能用了。

4. 在新编写方法时,按照pndao的方法命名规范即可享受代码生成。

5. 目前只支持Java 8

使用前建议先阅读pndao-example中的样例代码。

支持的方法:

方法 说明 样例 备注
insert 插入记录 insert(User user) ID会回写入user的主键
batchInsert 批量插入记录 batchInsert(List user) 返回插入记录数
findBy 按某列查询单个元素 findByUserName(String userName) 返回单条记录
queryBy 按某列查询一些元素 queryByUserName(String userName) 返回多条记录
countBy 按某列查询总数 countBy(String userName) 返回总数
update 按照主键其他所有列 update(User user) 返回更新记录数
updateFor 按照主键更新一列 updateForUserName(String userName,int id) 返回更新记录数

定制

  1. 如果你的团队命名规范与pndao不同

    • 可以下载源码,修改DaoGen的prefix的default值并重新编译。

    • 可以通过指定编译期的 processor options : -AtablePrefix=PN_ 的方式修改默认表名前缀, 示例如下:

         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-compiler-plugin</artifactId>
             <configuration>
                 <compilerArgument>-AtablePrefix=PNTS_</compilerArgument>
             </configuration>
         </plugin>
  2. pndao基于jsr269的注解编译生成,与lombok的原理是类似的,所以理论上可以为任意框架的生成配置型的代码。

反馈

项目目前仍在beta阶段,对于不同版本覆盖不全,欢迎建议、使用和提交代码。

票牛技术团队博客地址:https://piaoniu.io/

点评 ( 34 )

你可以在登录后,发表评论

搜索帮助