mybatis-generator插件的使用

做个记录，方便用到时查询

1、在pom文件中引入插件

<!--引入mybatis-generator的插件-->
    <build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.3</version>
                <configuration>
                    <configurationFile>${project.basedir}/src/main/resources/mybatis/generatorConfig.xml</configurationFile>
                </configuration>
            </plugin>
        </plugins>
    </build>

2、编写generatorConfig.xml配置文件
配置文件可以参考下面的代码：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <!--配置数据库连接驱动-->
    <classPathEntry location="E:\workspace\src\main\resources\mybatis\mysql-connector-java-5.1.8.jar"/>
    <!--
    <context>元素用于指定生成一组对象的环境。例如指定要连接的数据库，要生成对象的类型和要处理的数据库中的表。运行G的时候还可以指定要运行的<context>
        id：为必选属性，用来唯一确定一个<context>元素。

        defaultModelType属性：这个属性定义了如何生成实体类，它有如下的可选值：
            1、flat:该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段。这种模型最简单，推荐使用。
            2、hierarchical:如果表有主键,那么该模型会产生一个单独的主键实体类,如果表还有BLOB字段， 则会为表生成一个包含所有BLOB字段的单独的实体类,然后为所有其他的字段生成一个单独的实体类。 MBG会在所有生成的实体类之间维护一个继承关系。
            3、conditional:这是默认值,这个模型和hierarchical类似，如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。

        targetRuntime:此属性用于指定生成的代码的运行时环境。该属性支持以下可选值：
            1、MyBatis3:这是默认值。
            2、MyBatis3Simple:如果你不想生成和Example查询有关的内容，可以使用这个值。
            3、Ibatis2Java2
            4、Ibatis2Java5
    -->
    <context id="MysqlTables" targetRuntime="MyBatis3">
        <!--MBG配置中的其他几个元素，基本上都是<context>的子元素，这些子元素（有严格的配置顺序）包括：

            <property> (0个或多个)
            <plugin> (0个或多个)
            <commentGenerator> (0个或1个)
            <jdbcConnection> (1个)
            <javaTypeResolver> (0个或1个)
            <javaModelGenerator> (1个)
            <sqlMapGenerator> (0个或1个)
            <javaClientGenerator> (0个或1个)
            <table> (1个或多个)-->


        <!--去除注释  -->
        <!--该元素最多可以配置1个-->
        <commentGenerator>
            <!--
               1、suppressAllComments:阻止生成注释，默认为false
               2、suppressDate:阻止生成的注释包含时间戳，默认为false

               推荐配置
               <commentGenerator>
                    <property name="suppressAllComments" value="true"/>
                    <property name="suppressDate" value="true"/>
               </commentGenerator>
            -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        userId="root"
                        password="123456">
        </jdbcConnection>

        <!--这个元素的配置用来指定JDBC类型和Java类型如何转换。-->
        <javaTypeResolver>
            <!--forceBigDecimals：该属性可以控制是否强制DECIMAL和NUMERIC类型的字段转换为Java类型的java.math.BigDecimal,默认值为false-->
            <!--
                默认情况下的转换规则为：
                    如果精度>0或者长度>18，就会使用java.math.BigDecimal
                    如果精度=0并且10<=长度<=18，就会使用java.lang.Long
                    如果精度=0并且5<=长度<=9，就会使用java.lang.Integer
                    如果精度=0并且长度<5，就会使用java.lang.Short
            -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!--
               该元素用来控制生成的实体类，根据<context>中配置的defaultModelType，一个表可能会对应生成多个不同的实体类。
               一个表对应多个类实际上并不方便，所以前面也推荐使用flat，这种情况下一个表对应一个实体类。
               该元素只有两个属性，都是必选的。

                targetPackage:生成实体类存放的包名，一般就是放在该包下。
                targetProject:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject="src/main/java"）。
        -->
        <javaModelGenerator targetPackage="com.test.dal.dao" targetProject="E:\workspace\code\src\main\java">
            <!--
                constructorBased:该属性只对MyBatis3有效，如果true就会使用构造方法入参，如果false就会使用setter方式。默认为false。
                enableSubPackages:如果true，MBG会根据catalog和schema来生成子包。如果false就会直接用targetPackage属性。默认为false。
                immutable:该属性用来配置实体类属性是否可变，如果设置为true，那么constructorBased不管设置成什么，都会使用构造方法入参，并且不会生成setter方法。如果为false，实体类属性就可以改变。默认为false。
                rootClass:设置所有实体类的基类。如果设置，需要使用类的全限定名称。并且如果MBG能够加载rootClass，那么MBG不会覆盖和父类中完全匹配的属性。匹配规则：
                    属性名完全相同
                    属性类型相同
                    属性有getter方法
                    属性有setter方法
                trimStrings:是否对数据库查询结果进行trim操作，如果设置为true就会生成类似这样public void setUsername(String username) {this.username = username == null ? null : username.trim();}的setter方法。默认值为false。
            -->
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!--
            该元素可选，最多配置一个。但是有如下两种必选的特殊情况：

                如果targetRuntime目标是**iBATIS2**，该元素必须配置一个。
                如果targetRuntime目标是**MyBatis3**，只有当<javaClientGenerator>需要XML时，该元素必须配置一个。

                    如果没有配置<javaClientGenerator>，则使用以下的规则：
                        如果指定了一个<sqlMapGenerator>，那么MBG将只生成XML的SQL映射文件和实体类。
                        如果没有指定<sqlMapGenerator>，那么MBG将只生成实体类。
                        该元素只有两个属性，都是必选的。

                targetPackage:生成实体类存放的包名，一般就是放在该包下。
                targetProject:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject="src/main/resources"）。
        -->
        <sqlMapGenerator targetPackage="xml" targetProject="E:\workspace\src\main\resources">
            <!--enableSubPackages:如果true，MBG会根据catalog和schema来生成子包。如果false就会直接用targetPackage属性。默认为false。-->
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!--
            如果不配置该元素，就不会生成Mapper接口。
                type:该属性用于选择一个预定义的客户端代码（可以理解为Mapper接口）生成器（可自定义）
                该属性提供了以下预定的代码生成器，首先根据<context>的targetRuntime分成三类：
                MyBatis3:
                    ANNOTATEDMAPPER:基于注解的Mapper接口，不会有对应的XML映射文件
                    MIXEDMAPPER:XML和注解的混合形式，(上面这种情况中的)SqlProvider注解方法会被XML替代。
                    XMLMAPPER:所有的方法都在XML中，接口调用依赖XML文件。
                MyBatis3Simple:
                    ANNOTATEDMAPPER:基于注解的Mapper接口，不会有对应的XML映射文件
                    XMLMAPPER:所有的方法都在XML中，接口调用依赖XML文件。
                Ibatis2Java2或**Ibatis2Java5**:
                    IBATIS:生成的对象符合iBATIS的DAO框架（不建议使用）。
                    GENERIC-CI:生成的对象将只依赖于SqlMapClient，通过构造方法注入。
                    GENERIC-SI:生成的对象将只依赖于SqlMapClient，通过setter方法注入。
                    SPRING:生成的对象符合Spring的DAO接口

               targetPackage:生成实体类存放的包名，一般就是放在该包下。

               targetProject:指定目标项目路径，可以是绝对路径或相对路径（如 targetProject="src/main/java"）。

        -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.test.dal.dao" targetProject="E:\workspace\code\src\main\java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!--
            table可选的几个属性：
                tableName：指定要生成的表名，可以使用SQL通配符匹配多个表。（必填）
                domainObjectName:生成对象的基本名称。如果没有指定，MBG会自动根据表名来生成名称。
                enableXXX:XXX代表多种SQL方法，该属性用来指定是否生成对应的XXX语句。
                selectByPrimaryKeyQueryId:DBA跟踪工具会用到，具体请看详细文档。
                selectByExampleQueryId:DBA跟踪工具会用到，具体请看详细文档。
                modelType:和<context>的defaultModelType含义一样，这里可以针对表进行配置，这里的配置会覆盖<context>的defaultModelType配置。
                escapeWildcards:这个属性表示当查询列，是否对schema和表名中的SQL通配符 ('_' and '%') 进行转义。 对于某些驱动当schema或表名中包含SQL通配符时（例如，一个表名是MY_TABLE，有一些驱动需要将下划线进行转义）是必须的。默认值是false。
                delimitIdentifiers:是否给标识符增加分隔符。默认false。当catalog,schema或tableName中包含空白时，默认为true。
                delimitAllColumns:是否对所有列添加分隔符。默认false。
        -->
        <table schema="aaa" tableName="test2" domainObjectName="Test2">

            <!--
                该元素包含多个可用的<property>子元素，可选属性为：

                    constructorBased:和<javaModelGenerator>中的属性含义一样。
                    ignoreQualifiersAtRuntime:生成的SQL中的表名将不会包含schema和catalog前缀。
                    immutable:和<javaModelGenerator>中的属性含义一样。
                    modelOnly:此属性用于配置是否为表只生成实体类。如果设置为true就不会有Mapper接口。如果配置了<sqlMapGenerator>，并且modelOnly为true，那么XML映射文件中只有实体对象的映射元素(<resultMap>)。如果为true还会覆盖属性中的enableXXX方法，将不会生成任何CRUD方法。
                    rootClass:和<javaModelGenerator>中的属性含义一样。
                    rootInterface:和<javaClientGenerator>中的属性含义一样。
                    runtimeCatalog:运行时的catalog，当生成表和运行环境的表的catalog不一样的时候可以使用该属性进行配置。
                    runtimeSchema:运行时的schema，当生成表和运行环境的表的schema不一样的时候可以使用该属性进行配置。
                    runtimeTableName:运行时的tableName，当生成表和运行环境的表的tableName不一样的时候可以使用该属性进行配置。
                    selectAllOrderByClause:该属性值会追加到selectAll方法后的SQL中，会直接跟order by拼接后添加到SQL末尾。
                    useActualColumnNames:如果设置为true,那么MBG会使用从数据库元数据获取的列名作为生成的实体对象的属性。 如果为false(默认值)，MGB将会尝试将返回的名称转换为驼峰形式。 在这两种情况下，可以通过 元素显示指定，在这种情况下将会忽略这个（useActualColumnNames）属性。
                    useColumnIndexes:如果是true,MBG生成resultMaps的时候会使用列的索引,而不是结果中列名的顺序。
                    useCompoundPropertyNames:如果是true,那么MBG生成属性名的时候会将列名和列备注接起来. 这对于那些通过第四代语言自动生成列(例如:FLD22237),但是备注包含有用信息(例如:"customer id")的数据库来说很有用. 在这种情况下,MBG会生成属性名FLD2237_CustomerId。






                除了<property>子元素外，<table>还包含以下子元素：

                <generatedKey> (0个或1个)
                <columnRenamingRule> (0个或1个)
                <columnOverride> (0个或多个)
                <ignoreColumn> (0个或多个)

                1、<generatedKey>
                    这个元素用来指定自动生成主键的属性（identity字段或者sequences序列）。如果指定这个元素，MBG在生成insert的SQL映射文件中插入一个<selectKey>元素。 这个元素非常重要，这个元素包含下面两个必选属性：

                    column:生成列的列名。
                    sqlStatement:将返回新值的 SQL 语句。如果这是一个identity列，您可以使用其中一个预定义的的特殊值。预定义值如下：
                        Cloudscape
                        DB2
                        DB2_MF
                        Derby
                        HSQLDB
                        Informix
                        MySql
                        SqlServer
                        SYBASE
                    JDBC:这会配置MBG使用MyBatis3支持的JDBC标准的生成key来生成代码。 这是一个独立于数据库获取标识列中的值的方法。 重要: 只有当目标运行为MyBatis3时才会产生正确的代码。 如果与iBATIS2一起使用目标运行时会产生运行时错误的代码。
                    这个元素还包含两个可选属性：

                    identity:当设置为true时,该列会被标记为identity列， 并且<selectKey>元素会被插入在insert后面。 当设置为false时，<selectKey>会插入到insert之前（通常是序列）。
                    重要: 即使您type属性指定为post，您仍然需要为identity列将该参数设置为true。 这将标志MBG从插入列表中删除该列。默认值是false。
                    type:type=post and identity=true的时候生成的<selectKey>中的order=AFTER,当type=pre的时候，identity只能为false，生成的<selectKey>中的order=BEFORE。
                    可以这么理解，自动增长的列只有插入到数据库后才能得到ID，所以是AFTER,使用序列时，只有先获取序列之后，才能插入数据库，所以是BEFORE。

                    配置示例一：
                        <table tableName="user login info" domainObjectName="UserLoginInfo">
                            <generatedKey column="id" sqlStatement="Mysql"/>
                        </table>

                    对应的生成的结果：
                    <insert id="insert" parameterType="test.model.UserLoginInfo">
                        <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
                            SELECT LAST_INSERT_ID()
                        </selectKey>
                        insert into `user login info` (Id, username, logindate, loginip)
                        values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP}, #{loginip,jdbcType=VARCHAR})
                    </insert>

                    配置示例二：
                    <table tableName="user login info" domainObjectName="UserLoginInfo">
                        <generatedKey column="id" sqlStatement="select SEQ_ID.nextval from dual"/>
                    </table>
                    对应的生成的结果：
                    <insert id="insert" parameterType="test.model.UserLoginInfo">
                        <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.Integer">
                            select SEQ_ID.nextval from dual
                        </selectKey>
                        insert into `user login info` (Id, username, logindate, loginip)
                        values (#{id,jdbcType=INTEGER}, #{username,jdbcType=VARCHAR}, #{logindate,jdbcType=TIMESTAMP},#{loginip,jdbcType=VARCHAR})
                    </insert>
                2、<columnRenamingRule>
                    使用该元素可以在生成列之前，对列进行重命名。这对那些存在同一前缀的字段想在生成属性名时去除前缀的表非常有用。
                    例如假设一个表包含以下的列：

                        CUST_BUSINESS_NAME
                        CUST_STREET_ADDRESS
                        CUST_CITY
                        CUST_STATE
                        生成的所有属性名中如果都包含CUST的前缀可能会让人不爽。这些前缀可以通过如下方式定义重命名规则:

                        <columnRenamingRule searchString="^CUST_" replaceString="" />

                        注意，在内部，MBG使用java.util.regex.Matcher.replaceAll方法实现这个功能。 请参阅有关该方法的文档和在Java中使用正则表达式的例子。

                        当<columnOverride>匹配一列时，这个元素（<columnRenamingRule>）会被忽略。<columnOverride>优先于重命名的规则。

                        该元素有一个必选属性：

                        searchString:定义将被替换的字符串的正则表达式。
                        该元素有一个可选属性：

                        replaceString:这是一个用来替换搜索字符串列每一个匹配项的字符串。如果没有指定，就会使用空字符串。
                        关于<table>的<property>属性useActualColumnNames对此的影响可以查看完整文档。

                3. <columnOverride> 元素

                        该元素可选，可以配置多个。

                        该元素从将某些属性默认计算的值更改为指定的值。

                        该元素有一个必选属性:

                        column:要重写的列名。
                        该元素有多个可选属性：

                        property:要使用的Java属性的名称。如果没有指定，MBG会根据列名生成。 例如，如果一个表的一列名为STRT_DTE，MBG会根据<table>的useActualColumnNames属性生成STRT_DTE或strtDte。
                        javaType:该列属性值为完全限定的Java类型。如果需要，这可以覆盖由JavaTypeResolver计算出的类型。 对某些数据库来说，这是必要的用来处理**“奇怪的”**数据库类型（例如MySql的unsigned bigint类型需要映射为java.lang.Object)。
                        jdbcType:该列的JDBC类型(INTEGER, DECIMAL, NUMERIC, VARCHAR等等)。 如果需要，这可以覆盖由JavaTypeResolver计算出的类型。 对某些数据库来说，这是必要的用来处理怪异的JDBC驱动 (例如DB2的LONGVARCHAR类型需要为iBATIS 映射为VARCHAR)。
                        typeHandler:用户定义的需要用来处理这列的类型处理器。它必须是一个继承iBATIS的TypeHandler类或TypeHandlerCallback接口（该接口很容易继承）的全限定的类名。如果没有指定或者是空白，iBATIS会用默认的类型处理器来处理类型。**重要**:MBG不会校验这个类型处理器是否存在或者可用。 MGB只是简单的将这个值插入到生成的SQL映射的配置文件中。
                        delimitedColumnName:指定是否应在生成的SQL的列名称上增加**分隔符**。 如果列的名称中包含空格，MGB会自动添加**分隔符**， 所以这个重写只有当列名需要强制为一个合适的名字或者列名是数据库中的保留字时是必要的。
                        配置示例：

                        <table schema="DB2ADMIN" tableName="ALLTYPES" >
                            <columnOverride column="LONG_VARCHAR_FIELD" javaType="java.lang.String" jdbcType="VARCHAR" />
                        </table>
                4. <ignoreColumn> 元素

                        该元素可选，可以配置多个。

                        该元素可以用来屏蔽不需要生成的列。

                        该元素有一个必选属性：

                        column:要忽略的列名。
                        该元素还有一个可选属性：

                        delimitedColumnName:匹配列名的时候是否区分大小写。如果为true则区分。默认值为false，不区分大小写。



            -->
            <property name="useActualColumnNames" value="false"/>
            <!--<generatedKey column="ID" sqlStatement="DB2" identity="true"/>-->
            <columnOverride column="DATE_FIELD" property="startDate"/>
            <ignoreColumn column="FRED"/>
            <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR"/>
        </table>
    </context>
</generatorConfiguration>
<!--
综合以上信息，这里给出一个Mysql的简单配置：
        <id="MysqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <commentGenerator>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        userId="root"
                        password="">
        </jdbcConnection>

        <javaModelGenerator targetPackage="test.model" targetProject="src\main\java">
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="test.xml"  targetProject="src\main\resources"/>

        <javaClientGenerator type="XMLMAPPER" targetPackage="test.dao"  targetProject="src\main\java"/>

        <table tableName="%">
            <generatedKey column="id" sqlStatement="Mysql"/>

-->