Java 8 开发的 Mybatis 注解代码生成工具

MybatisAnnotationTools

MybatisAnnotationTools 是基于 Java8 开发的一款可以用于自动化生成 MyBatis 注解类的工具，支持配置数据源、类路径，表名去前缀、指定类名前后缀等功能。同时支持 Java 8 和 Mybatis 3.5+ 的一些新特性，比如时间类 LocalDateTime/LocalDate 、接口方法返回 Optional 等。

此工具生成的代码是基于注解的 Mybatis 接口方法，所以不会生成 XML 配置文件。

源码地址：Github 地址
代码比较简单，总共 700 多行，有兴趣的朋友可以下载看看互相交流学习。

功能：

1.自动生成 PO 和 DAO 的 Java 类，DAO 支持分页查询、根据 id 查询、单个插入、批量插入、更新、单个删除、批量删除。

UserDao.java 内容如下(可以通过修改模板类来改变样式，后面会讲到模板)：

@Mapper
public interface UserDao extends BaseDao<UserDao> {
    /** 分页查询 */
    @Select("select * from t_user limit #{page.currentPage}, #{page.pageSize}")
    List<UserPO> listByPage(@Param("page") Page page);
    /** 根据id查询 */
    @Select("select * from t_user where id = #{id}")
    Optional<UserPO> getById(Serializable id);
    /** 单个插入 */
    @Insert("insert into t_user(id, name, gender, birthday, address, create_time, update_time)  values(#{id}, #{name}, #{gender}, #{birthday}, #{address}, #{createTime}, #{updateTime})")
    void save(UserPO po);
    /** 批量插入 */
    @Insert("<script>insert into t_user(id, name, gender, birthday, address, create_time, update_time) values "
        + "<foreach collection='list' index='index' item='n' separator=','> "
        + "(#{n.id}, #{n.name}, #{n.gender}, #{n.birthday}, #{n.address}, #{n.createTime}, #{n.updateTime})"
        + "</foreach></script>")
    void saveBatch(@Param("list") List<UserPO> list);
    /** 更新 */
    @Update("update t_user set id = #{id}, name = #{name}, gender = #{gender}, birthday = #{birthday}, address = #{address}, create_time = #{createTime}, update_time = #{updateTime} where id = #{id}")
    void update(UserPO po);
    /** 单个删除 */
    @Delete("delete from t_user where id = #{id}")
    void remove(Serializable id);
    /** 批量删除 */
    @Delete("<script>delete from t_user where id in "
        + "<foreach collection='ids' index='index' item='id' open='(' separator=',' close=')'>"
        + "#{id}"
        + "</foreach></script>")
    void removeByIds(@Param("ids") Set<Serializable> ids);
    /** 统计 */
    @Select("select count(*) from t_user")
    int count();
}

2.可配置application.properties

# MySQL 连接配置
mysql.datasource.driver-class-name=com.mysql.jdbc.Driver
mysql.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&useSSL=false
mysql.datasource.username=root
mysql.datasource.password=
# 表前缀，生成类时会去掉这个前缀
mysql.datasource.table.prefix=t_
# 是否要生成 PO
java.model.enable=true
# PO 包路径
java.model.package=com.xxx.po
# PO 类文件生成路径，"/"结尾
java.model.src.folder=E:/CODE/github/po/
# PO 类文件前缀
java.model.prefix=
# PO 类文件后缀
java.model.suffix=PO
# 是否要生成 DAO
java.dao.enable=true
# DAO 包路径
java.dao.package=com.xxx.dao
# DAO 类文件生成路径，"/"结尾
java.dao.src.folder=E:/CODE/github/dao/
# DAO 类文件前缀
java.dao.prefix=
# DAO 类文件后缀
java.dao.suffix=Dao

如何使用？

可以跳过下载和打包源码直接下载 jar 包

• 源码打包：

1. 在pom.xml文件目录下执行mvn clean package -Dmaven.test.skip=true
2. 在生成的target目录下取出可以直接执行的 jar 包：annotation-Tools-1.0-jar-with-dependencies.jar

• 执行 jar 包：
  在上面这个 jar 包目录下执行java -jar annotation-Tools-1.0-jar-with-dependencies.jar即可执行默认配置；也可以把application.properties配置文件取出来修改，执行命令的时候在后面加上配置文件路径{文件路径}application.properties来执行配置文件的位置。

源码结构

• main 启动类：Bootstrap.java
• 配置文件：resources/application.properties目录
• 模板文件位置：resources目录，这里能修改生成代码的模板

例子

有表t_student和t_user，用默认配置会在E:/CODE/github生成dao和po目录，里面的内容如下：

├─dao
│      BaseDao.java
│      StudentDao.java
│      UserDao.java
│
└─po
        Page.java
        StudentPO.java
        UserPO.java