使用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類可以繼承基類等，都還不滿足，限於篇幅，這些會在後續的文章中給出。