Mybatis Generator（定制化）代碼生成器

 1、使用Mapper專用的MyBatis Generator插件

　　通用Mapper在1.0.0版本的時候增加了MyBatis Generator(以下簡稱MBG)插件，使用該插件可以很方便的生成實體類、Mapper接口以及對應的XML文件。

　　本篇文檔就是講述如何在MBG中使用該插件。

　　首先對MBG不太了解的可以先閱讀下面的文檔：MybatisGeneator詳解

2、使用通用Mapper插件

　　插件代碼在com.github.abel533.generator包下面，一共有如下兩個類：

• MapperCommentGenerator：該類用於生成數據庫備注字段的注釋，以及實體類字段的注解。
• MapperPlugin：插件的實現類，該類默認使用上面這個注釋生成器，插件屏蔽了一般的CRUD方法（保留了Example），插件可以生成實體的@Table注解。
• Maven中添加依賴：　　

<dependency>
    <groupId>com.github.abel533</groupId>
    <artifactId>mapper</artifactId>
    <!-- 建議使用最新版本 -->
    <version>x.x.x</version>
</dependency>

　　運行MBG有多種方法，這里只介紹兩種比較常見的方法。並且有關的內容會針對這樣的運行方式進行配置。

　2.1.  使用Java編碼方式運行MBG

　　使用這種方式，首先下載MBG的Jar包（本項目[taotao]測試代碼中使用maven引入jar包，使用Java代碼運行）。

　　Java代碼很容易，和文檔中的一樣：

List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(
        Generator.class.getResourceAsStream("/generator/generatorConfig.xml"));
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
myBatisGenerator.generate(null);

　　你只需要在你當前的項目中創建一個類，添加一個main方法，在main中寫上上面的代碼即可。

　　這段代碼容易，最主要的一個內容是"generatorConfig.xml",我們應該如何配置該類。

　　下面是一個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>
  <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
  
    <!-- 通用Mapper的插件com.github.abel533.generator.MapperPlugin，該插件有一個必選的<property>屬性mappers，這里的mappers和通用Mapper中的mappers配置含義一樣，就是我們使用的通用Mapper接口，多個通用Mapper接口可以用逗號隔開 -->
    <!-- 關於本插件，最重要的內容就是上面這個配置。下面要說的其他配置和普通的一致。 -->
    <plugin type="com.github.abel533.generator.MapperPlugin">
      <property name="mappers" value="com.github.abel533.mapper.Mapper"/>
    </plugin>

    <!-- 數據庫配置信息，由於需要連接數據庫，需要保證項目的classpath下面有數據庫的JDBC驅動 -->
    <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                    connectionURL="jdbc:mysql://localhost:3306/test"
                    userId="root"
                    password="">
    </jdbcConnection>

    <!-- 生成實體類的配置，是一個必須配置的內容 -->
    <javaModelGenerator targetPackage="test.model" targetProject="G:\MyProject\src\main\java"/>

    <!-- sqlMapGenerator是一個可選的配置，配置后可以生成Mapper接口對應的XML文件 -->
    <sqlMapGenerator targetPackage="mapper"  targetProject="G:\MyProject\src\main\resources"/>

    <!-- 通用Mapper接口的配置，配置javaClientGenerator后會生成對應的接口文件，該接口會自動繼承前面配置的通用Mapper接口 -->
    <javaClientGenerator targetPackage="test.mapper" targetProject="G:\MyProject\src\main\java" type="XMLMAPPER" />

    <!-- 最后一個配置table,這里使用SQL通配符%來匹配所有表。generatedKey意味着所有的表都有一個id自增的主鍵，在生成實體類的時候會根據該配置生成相應的注解 -->
    <table tableName="%" >
      <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
    </table>
  </context>
</generatorConfiguration>

　　這段配置介紹完了，之后運行前面的JAVA方法，就會生成對應的文件。該文件的樣式最后貼個例子。

　2.2. 使用Maven執行MBG

　　這里有一個完整的例子，Mybatis-Spring，下面講解的內容出自這個例子。

　　使用Maven插件的一個好處是可以將Maven中的屬性使用${property}形式在generatorConfig.xml中引用。

　　先看Maven的pom.xml文件(只顯示有關的部分內容):

<properties>
    <!--  MyBatis Generator  -->
    <!--  Java接口和實體類  -->
    <targetJavaProject>${basedir}/src/main/java</targetJavaProject>
    <targetMapperPackage>com.isea533.mybatis.mapper</targetMapperPackage>
    <targetModelPackage>com.isea533.mybatis.model</targetModelPackage>
    <!--  XML生成路徑  -->
    <targetResourcesProject>${basedir}/src/main/resources</targetResourcesProject>
    <targetXMLPackage>mapper</targetXMLPackage>
    <!--  依賴版本  -->
    <mapper.version>1.0.0</mapper.version>
    <mysql.version>5.1.29</mysql.version>
</properties>

　　上面是pom.xml中properties配置的部分內容。這里配置了MBG配置文件中常用到的幾個路徑以及包名。還包含了通用Mapper的版本和數據庫JDBC驅動的版本。

　　下面是MBG的Maven插件配置：

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.2</version>
    <configuration>
        <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
        <verbose>true</verbose>
    </configuration>
    <dependencies>
        <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql.version}</version>
        </dependency>
        <dependency>
        <groupId>com.github.abel533</groupId>
        <artifactId>mapper</artifactId>
        <version>${mapper.version}</version>
        </dependency>
    </dependencies>
</plugin>

　　這里配置了MBG插件，並且配置了generatorConfig.xml配置文件的路徑。另外還有兩個依賴，分別是JDBC驅動以及通用Mapper（提供了MBG插件）。

　　下面我們在看看這個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="config.properties"/>

    <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <plugin type="${mapper.plugin}">
          <property name="mappers" value="${mapper.Mapper}"/>
        </plugin>

        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.url}"
                        userId="${jdbc.user}"
                        password="${jdbc.password}">
        </jdbcConnection>

        <javaModelGenerator targetPackage="${targetModelPackage}" targetProject="${targetJavaProject}"/>

        <sqlMapGenerator targetPackage="${targetXMLPackage}"  targetProject="${targetResourcesProject}"/>

        <javaClientGenerator targetPackage="${targetMapperPackage}" targetProject="${targetJavaProject}" type="XMLMAPPER" />

        <table tableName="%" >
          <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

　　可以看到這個配置文件中的大多數屬性都使用${}形式替代了。使用<properties resource="config.properties"/>引入了config.properties屬性配置，該文件內容如下：

# 數據庫配置
jdbc.driverClass = com.mysql.jdbc.Driver
jdbc.url = jdbc:mysql://localhost:3306/test
jdbc.user = root
jdbc.password =

#c3p0
jdbc.maxPoolSize=50
jdbc.minPoolSize=10
jdbc.maxStatements=100
jdbc.testConnection=true

# 通用Mapper配置
mapper.plugin = com.github.abel533.generator.MapperPlugin
mapper.Mapper = com.github.abel533.mapper.Mapper

　　使用配置文件的目的是因為系統多處地方使用了這種配置，因而使用一個屬性文件可以方便的保持一致。

　　除了引用配置文件中的屬性外，部分還使用了pom.xml中的屬性。這種方式使用起來更靈活。

運行

　　配置好之后如何運行呢？

　　在pom.xml這一級目錄的命令行窗口執行mvn mybatis-generator:generate即可（前提是配置了mvn）。

3、生成的代碼

　　下面是自動生成的代碼的例子，這些例子可以在Mybatis-Spring這里找到。

　3.1、實體類UserInfo

package com.isea533.mybatis.model;

import javax.persistence.*;

@Table(name = "user_info")
public class UserInfo {
    @Id
    @Column(name = "Id")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    /**
     * 用戶名
     */
    private String username;

    /**
     * 密碼
     */
    private String password;

    /**
     * @return Id
     */
    public Integer getId() {
        return id;
    }

    /**
     * @param id
     */
    public void setId(Integer id) {
        this.id = id;
    }

    /**
     * 獲取用戶名
     *
     * @return username - 用戶名
     */
    public String getUsername() {
        return username;
    }

    /**
     * 設置用戶名
     *
     * @param username 用戶名
     */
    public void setUsername(String username) {
        this.username = username;
    }
}

　　代碼過長，省略了一部分，完整查看：UserInfo

　　可以看到這里生成的注釋是有意義的內容，注釋來源於數據庫表字段的注釋。

　　這里還自動生成了幾項注解的內容。

　3.2、Mapper接口UserInfoMapper

package com.isea533.mybatis.mapper;

import com.github.abel533.mapper.Mapper;
import com.isea533.mybatis.model.UserInfo;

public interface UserInfoMapper extends Mapper<UserInfo> {
}

　　接口自動繼承配置的通用Mapper接口，自動包含泛型實體。

　3.3、Mapper.xml文件UserInfoMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.isea533.mybatis.mapper.UserInfoMapper" >
    <resultMap id="BaseResultMap" type="com.isea533.mybatis.model.UserInfo" >
        <!--
            WARNING - @mbggenerated
        -->
        <id column="Id" property="id" jdbcType="INTEGER" />
        <result column="username" property="username" jdbcType="VARCHAR" />
        <result column="password" property="password" jdbcType="VARCHAR" />
        <result column="usertype" property="usertype" jdbcType="VARCHAR" />
        <result column="enabled" property="enabled" jdbcType="INTEGER" />
        <result column="realname" property="realname" jdbcType="VARCHAR" />
        <result column="qq" property="qq" jdbcType="VARCHAR" />
        <result column="email" property="email" jdbcType="VARCHAR" />
        <result column="tel" property="tel" jdbcType="VARCHAR" />
    </resultMap>
</mapper>

　　xml文件只包含了實體的resultMap映射配置。