使用MyBatis Generator自动生成代码

• 2020 年 2 月 14 日
• 笔记

MyBatis是一个实现了JPA规范的用来连接数据库并对其进行增删改查操作的开源框架 （就和传统的JDBC一样，就是个连接数据库的东西），其实，它底层就是一个JDBC封装的组件。

一般项目会使用MyBatis来完成数据库的操作。本文使用MyBatis Generator代码生成工具来完成代码生成。自动生成的文件有如下几个部分：

• Dao (Mapper)
• Entity 以及 Entity对应的Example
• XML

01

▼

环境准备

• 准备数据库表

创建一个用于测试的用户表，包含user_id、email、name三个属性，创建的SQL语句如下：

CREATE TABLE `t_user` (    `user_id` int(11) NOT NULL,    `email` varchar(64) DEFAULT NULL,    `name` varchar(30) DEFAULT NULL,    PRIMARY KEY (`user_id`)  ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

• 添加依赖包

添加相关的依赖包，主要包含MyBatis包、MyBatis Generator包、MySQL连接包以及log4j包 (主要用于输出日志)：

    <dependency>        <groupId>log4j</groupId>        <artifactId>log4j</artifactId>        <version>1.2.17</version>      </dependency>      <dependency>        <groupId>org.mybatis</groupId>        <artifactId>mybatis</artifactId>        <version>${mybatis.version}</version>      </dependency>      <dependency>        <groupId>org.mybatis.generator</groupId>        <artifactId>mybatis-generator-core</artifactId>        <version>${mybatis.generator.version}</version>      </dependency>      <dependency>        <groupId>mysql</groupId>        <artifactId>mysql-connector-java</artifactId>        <version>${mysql.connector.version}</version>      </dependency>

完整的pom.xml文件内容如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <groupId>my.mybatis.example</groupId>    <artifactId>MBGeneratorExample</artifactId>    <version>0.0.1-SNAPSHOT</version>    <properties>      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>      <mybatis.version>3.2.6</mybatis.version>      <mybatis.generator.version>1.3.2</mybatis.generator.version>      <mysql.connector.version>5.1.6</mysql.connector.version>    </properties>    <dependencies>      <dependency>        <groupId>log4j</groupId>        <artifactId>log4j</artifactId>        <version>1.2.17</version>      </dependency>      <dependency>        <groupId>org.mybatis</groupId>        <artifactId>mybatis</artifactId>        <version>${mybatis.version}</version>      </dependency>      <dependency>        <groupId>org.mybatis.generator</groupId>        <artifactId>mybatis-generator-core</artifactId>        <version>${mybatis.generator.version}</version>      </dependency>      <dependency>        <groupId>mysql</groupId>        <artifactId>mysql-connector-java</artifactId>        <version>${mysql.connector.version}</version>      </dependency>    </dependencies>  </project>

02

▼

MyBatis Generator配置

• 创建数据库属性文件

创建一个数据库属性文件generator.properties，配置数据库连接、数据库用户名、密码等，如：

jdbc.driverClassName=com.mysql.jdbc.Driver  jdbc.url=jdbc:mysql://YOUR_IP:YOUR_PORT/YOUR_DATABASE?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull  jdbc.username=YOUR_USERNAME  jdbc.password=YOUR_PASSWPRD

• 创建Generator配置文件

创建一个自动生成代码的配置文件，属性文件generatorConfig.xml。 配置Model、SQL XML文件以及Dao路径配置等。

• 引入属性配置文件

      <!-- 引入配置文件 -->        <properties resource="generator.properties" />

• 对象配置生成的Model文件

    <!-- 生成Model对象路径配置 -->      <javaModelGenerator targetPackage="my.mybatis.generator.auto.entity"        targetProject="srcmainjava">        <property name="enableSubPackages" value="true" />        <property name="trimStrings" value="true" />      </javaModelGenerator>

• 配置数据库连接信息

    <!-- 数据库连接信息 -->      <jdbcConnection driverClass="${jdbc.driverClassName}"        connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}" />

• 配置生成的sqlMap文件

    <!-- 生成sqlXML文件路径配置 -->      <sqlMapGenerator targetPackage="my.mybatis.generator.auto.entity.xml"        targetProject="srcmainjava">        <property name="enableSubPackages" value="true" />      </sqlMapGenerator>

• 配置生成的Dao（Mapper）

    <!-- 生成DAO的类文件路径配置 -->      <javaClientGenerator targetPackage="my.mybatis.generator.auto.dao"        targetProject="srcmainjava" type="XMLMAPPER">        <property name="enableSubPackages" value="true" />      </javaClientGenerator>

• 配置生成的表信息

    <!--要生成哪些表 -->      <table tableName="t_user" domainObjectName="User" />

generatorConfig.xml具体的配置信息如下：

<?xml version="1.0" encoding="UTF-8" ?>  <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >  <generatorConfiguration>    <!-- 引入配置文件 -->    <properties resource="generator.properties" />      <context id="context1" targetRuntime="MyBatis3">        <!-- 数据库连接信息 -->      <jdbcConnection driverClass="${jdbc.driverClassName}"        connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}" />        <!-- 生成Model对象路径配置 -->      <javaModelGenerator targetPackage="my.mybatis.generator.auto.entity"        targetProject="srcmainjava">        <property name="enableSubPackages" value="true" />        <property name="trimStrings" value="true" />      </javaModelGenerator>        <!-- 生成sqlXML文件路径配置 -->      <sqlMapGenerator targetPackage="my.mybatis.generator.auto.entity.xml"        targetProject="srcmainjava">        <property name="enableSubPackages" value="true" />      </sqlMapGenerator>        <!-- 生成DAO的类文件路径配置 -->      <javaClientGenerator targetPackage="my.mybatis.generator.auto.dao"        targetProject="srcmainjava" type="XMLMAPPER">        <property name="enableSubPackages" value="true" />      </javaClientGenerator>        <!--要生成哪些表 -->      <table tableName="t_user" domainObjectName="User" />    </context>  </generatorConfiguration>

03

▼

代码生成

有了上述的配置之后，我们就可以编写一个简单的类来完成代码的生成。

• ShellRunner运行

使用ShellRunner来完成程序的执行，如:

package my.mabatis.example.runner;    import org.mybatis.generator.api.ShellRunner;    /**   *   * @author wangmengjun   *   */  public class Main {      public static void main(String[] args) {        String config = Main.class.getClassLoader()          .getResource("generatorConfig.xml").getFile();      String[] arg = { "-configfile", config, "-overwrite" };      ShellRunner.main(arg);    }  }

• 运行结果

运行上述程序，我们就能看到自动生成的文件就产生了。

Dao (Mapper)

SQL XML

Entity和Example

04

▼

自定义生成

• 生成实现序列化的接口的实体类

上述产生的Java类自动产生后，没有实现序列化接口java.io.Serializable。

如果要使生成的实体Java类实现java.io.Serializable接口，需要怎么做呢？

答案，很简单，使用org.mybatis.generator.plugins.SerializablePlugin自动化代码即可。只要在配置文件generatorConfig.xml中指定一个plugin即可。

<!-- 配置内置的或者自定义的Plugin -->  <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>

然后，再次运行Main.java，我们来看一下User类已经实现序列化接口了。

• 不产生注释

配置文件中，可以配置commentGenerator来指定是否产生注释。如果不想产生注释，我们可以将某些属性设置成true即可。如，

    <!-- 注释产生配置 -->      <commentGenerator>        <property name="suppressAllComments" value="true" />        <property name="suppressDate" value="true" />      </commentGenerator>

运行Main.java，我们来看一下User类已经不含有注释了。

• 不产生按照Example相关的操作

如果不想产生Example相关操作的方法，可以在table中配置，要过滤掉的方法即可。

一个示例如下：

  <!--要生成哪些表 -->      <table tableName="t_user" domainObjectName="User"        enableCountByExample="false" enableDeleteByExample="false"        enableSelectByExample="false" enableUpdateByExample="false" />

运行Main.java，我们来看一下UserMapper类中已经不包含按照Example进行操作的方法了。不过，留着也是一个不错的学习示例，哈 🙂

package my.mybatis.generator.auto.dao;    import my.mybatis.generator.auto.entity.User;    public interface UserMapper {      int deleteByPrimaryKey(Integer userId);        int insert(User record);        int insertSelective(User record);        User selectByPrimaryKey(Integer userId);        int updateByPrimaryKeySelective(User record);        int updateByPrimaryKey(User record);  }

还有其它很多自定义扩展的东西可以学习，大家可以查询相关的资料学习一下，这里就不再一一给出了。

上述自定义例子，详细的generatorConfig.xml文件如下：

<?xml version="1.0" encoding="UTF-8" ?>  <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >  <generatorConfiguration>    <!-- 引入配置文件 -->    <properties resource="generator.properties" />      <context id="context1" targetRuntime="MyBatis3">      <!-- 配置内置的或者自定义的Plugin -->      <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />        <!-- 注释产生配置 -->      <commentGenerator>        <property name="suppressAllComments" value="true" />        <property name="suppressDate" value="true" />      </commentGenerator>        <!-- 数据库连接信息 -->      <jdbcConnection driverClass="${jdbc.driverClassName}"        connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}" />        <!-- 生成Model对象路径配置 -->      <javaModelGenerator targetPackage="my.mybatis.generator.auto.entity"        targetProject="srcmainjava">        <property name="enableSubPackages" value="true" />        <property name="trimStrings" value="true" />      </javaModelGenerator>        <!-- 生成sqlXML文件路径配置 -->      <sqlMapGenerator targetPackage="my.mybatis.generator.auto.entity.xml"        targetProject="srcmainjava">        <property name="enableSubPackages" value="true" />      </sqlMapGenerator>        <!-- 生成DAO的类文件路径配置 -->      <javaClientGenerator targetPackage="my.mybatis.generator.auto.dao"        targetProject="srcmainjava" type="XMLMAPPER">        <property name="enableSubPackages" value="true" />      </javaClientGenerator>        <!--要生成哪些表 -->      <table tableName="t_user" domainObjectName="User"        enableCountByExample="false" enableDeleteByExample="false"        enableSelectByExample="false" enableUpdateByExample="false" />    </context>  </generatorConfiguration>

小结

本文首先给出了一个使用MyBatis Generator产生代码的示例；然后，对其中可以自定义代码产生的部分给出了几个例子；至此，大家可以掌握自动产生代码的方法。

不过，如何让产生的类支持分页查询；或者，产生的Dao类可以继承基类等，都还不满足，限于篇幅，这些会在后续的文章中给出。