mybatis generator 插件自动自成代码

使用 mybatis 的 generator 插件可以根据数据库定义的表、字段快速的生成实体类、mapper 接口和 xml 文件，提高开发的效率。

为什么要自动生成？
首先，节省开发人员的时间；其次，当数据库增加或是减少某些表或字段的时候，只需要生成一次代码即可，不必花时间去修改；第三，当数据库体量越来越大要做拆分时，因为没有 sql 间的强引用，都是操作的当前表，所以可以根据业务模块很快的把数据库拆分出去。

怎么样使用 generator？

在 maven 中引入插件

<plugins>
    <plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.2</version>
        <configuration>
            <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
            <verbose>true</verbose>
            <overwrite>true</overwrite>
        </configuration>
        <dependencies>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.25</version>
            </dependency>
        </dependencies>
    </plugin>
</plugins>

在 generator.properties 文件中添加

jdbc.driverLocation=D:\\mysql-connector-java-5.1.20.jar
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://127.0.0.1:3306/testdb?useUnicode=true&characterEncoding=UTF-8
jdbc.userId=root
jdbc.password=123456

编写配置文件 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"></properties>
    <!--指定特定数据库的jdbc驱动jar包的位置-->
    <classPathEntry location="${jdbc.driverLocation}"/>

    
    <!--defaultModelType="flat" 是一个数据表生成一个实体类-->
    <context id="testTables" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="javaFileEncoding" value="UTF-8"/>
            
        <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!-- 生成一个新的selectByExample方法，这个方法可以接收offset和limit参数，主要用来实现分页 -->
        <plugin type="org.mybatis.generator.plugins.RowBoundsPlugin"></plugin>
    
        
        <!-- 生成的代码去掉注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>
        
        <!-- 数据库连接 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/yourdb"
                        userId="root" password="root"/>
                        
        <!-- 类型处理器，在数据库类型和java类型之间的转换控制-->
        <javaTypeResolver>
         <!--将 JDBC DECIMAL和NUMERIC解析为Integer，而不是BigDecimal-->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- model生成 -->
        <javaModelGenerator targetPackage="com.demo.domain" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
            <!-- 是否对model添加 构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

         <!-- MapperXML生成 -->
        <sqlMapGenerator targetPackage="com.demo.mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- Mapper接口生成 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.demo.mapper" targetProject="src/main/java"
                             implementationPackage="com.demo.mapper">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!-- 需要映射的表 -->
        <table tableName="t_area" domainObjectName="Area">
             <!--生成实体类时是否使用实际的列名作为实体类的属性名,默认值为false,数据库中的字段名转换为Camel Case风格-->
             <property name="useActualColumnNames" value="true" />
        </table>
              <!-- 是否生成和使用xxxExample类在查询中替代模型类 -->
        <table tableName="t_user" domainObjectName="User" enableCountByExample="false" enableDeleteByExample="true"
               enableSelectByExample="false" enableUpdateByExample="false"  >
        </table>

    </context>
</generatorConfiguration>

最后，生成代码

关于生成的操作，以下三种操作都可以生成，任选其一即可：

方式1：通过 maven 命令行调用
mvn mybatis-generator:generate
mvn mybatis-generator:generate -Dmybatis.generator.overwrite=true

方式2：在IDEA中直接点击按钮生成
maven插件----对应的模块下面plugins----mybatis-generator----点击mybatis-generator:generate即可

方式3：通过 java 命令执行，使用mybatis-generator-core-xxxx.jar包
java -jar mybatis-generator-core-1.3.2.jar -configfile generatorConfig.xml -overwrite