MyBatis Generator使用方法

MyBatis Generator可以自动生成 modal类（例如：User, UserKey, UserExample）、dao层（例如：Interface UserMapper）、以及Mapper xml（例如：UserMapper.xml）. 

下面是使用方法的一些小结：

1. pom.xml中引入依赖

<dependency>
   <groupId>org.mybatis.generator</groupId>
   <artifactId>mybatis-generator-core</artifactId>
   <version>1.3.5</version>
</dependency>

同时引入plugin

<plugin>
   <groupId>org.mybatis.generator</groupId>
   <artifactId>mybatis-generator-maven-plugin</artifactId>
   <version>1.3.2</version>
   <executions>
      <execution>
         <id>Generate MyBatis Files</id>
         <goals>
            <goal>generate</goal>
         </goals>
         <phase>generate-resources</phase>
         <configuration>
            <verbose>true</verbose>
            <overwrite>true</overwrite>
         </configuration>
      </execution>
   </executions>

   <dependencies>
      <dependency>
         <groupId>mysql</groupId>
         <artifactId>mysql-connector-java</artifactId>
         <version>5.1.38</version>
      </dependency>
      <dependency>
         <groupId>org.mybatis.generator</groupId>
         <artifactId>mybatis-generator-core</artifactId>
         <version>1.3.5</version>
      </dependency>

      <dependency>
         <groupId>org.mybatis</groupId>
         <artifactId>mybatis</artifactId>
         <version>3.4.2</version>
      </dependency>
   </dependencies>
</plugin>

如果不希望每次mvn install都重新生成一遍问题，需要设置

 <phase>deploy</phase>

根据需要填加一些其他选项，例如下面配置文件读取位置、生成的文件是否覆盖等

<configuration>
   <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
    <verbose>true</verbose>
   <overwrite>true</overwrite>
</configuration>

默认的配置文件是resources/generatorConfig.xml。

2. 数据库表

数据库中需要建好所需的表如user(id, name, age) 

3. 在resources目录下新建properties文件

我用的数据库是MySQL,所以新建的文件名为mysql.properties. 其内容为数据库的相关信息：

例如：

@db config
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

4. 配置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="mysql.properties"/>
    <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3">
        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
    一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖
        -->
        <property name="autoDelimitKeywords" value="false"/>
        <property name="autoDelimitKeywords" value="false"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <!-- 必须要有的，使用这个配置链接数据库
    @TODO:是否可以扩展
        -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
            <!-- 这里面可以设置property属性，每一个property属性都设置到配置的Driver上 -->
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <javaModelGenerator  targetPackage="com.jumoz.demo08.model"
                             targetProject="src/main/java">
            <property  name="enableSubPackages"  value="true"/>
            <property  name="trimStrings"  value="true"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="com.jumoz.demo08.mapper" targetProject="src/main/java">
        <property  name="enableSubPackages"  value="true"/>
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER" targetPackage="com.jumoz.demo08.dao" targetProject="src/main/java">
            <property  name="enableSubPackages"  value="true"/>
        </javaClientGenerator>

        <table  tableName="user"  domainObjectName="user">
             <!--   enableCountByExample="false"   enableUpdateByExample="false"
                enableDeleteByExample="false"  enableSelectByExample="false"
                selectByExampleQueryId="false"> -->
        </table>
        <table  tableName="student"  domainObjectName="student">
            <!--   enableCountByExample="false"   enableUpdateByExample="false"
               enableDeleteByExample="false"  enableSelectByExample="false"
               selectByExampleQueryId="false"> -->
        </table>

    </context>

</generatorConfiguration>

配置详解可参考： https://blog.youkuaiyun.com/testcs_dn/article/details/77881776

5. 配置完成后，执行 mvn mybatis-generator:generate, 即可生成model/dao/*mapper.xml文件