MyBatis Generator生成文件分析

【原创文章，转载请注明原文章地址，谢谢！】

Paste_Image.png

在进入MyBatis Generator生成器之前，先分析一下MBG生成的代码结构：

示例###

示例使用的DDL为：

CREATE TABLE `userinfo` (
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`userName` varchar(255) DEFAULT NULL,
`password` varchar(255) DEFAULT NULL,
`email` varchar(255) DEFAULT NULL,
`age` int(11) DEFAULT NULL,
`DEPT_ID` bigint(20) DEFAULT NULL,
`admin` tinyint(1) DEFAULT NULL,
PRIMARY KEY (`id`),
KEY `FK_11v5rvnq0cx1ljqf41fud7feg` (`DEPT_ID`)
) 

使用的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" defaultModelType="hierarchical" targetRuntime="MyBatis3">

    <property name="javaFileEncoding" value="UTF-8" />
    <property name="beginningDelimiter" value="`" />
    <property name="endingDelimiter" value="`" />

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

    <javaTypeResolver
        type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
        <property name="forceBigDecimals" value="false" />
    </javaTypeResolver>

    <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
        <property name="enableSubPackages" value="true" />
        <property name="trimStrings" value="true" />
    </javaModelGenerator>

    <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources">
        <property name="enableSubPackages" value="true" />
    </sqlMapGenerator>

    <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="MIXEDMAPPER" targetProject="src/main/java">
        <property name="enableSubPackages" value="true" />
    </javaClientGenerator>

    <table tableName="userinfo">
        <columnOverride column="username">
            <!-- 使用property属性来指定列要生成的属性名称 -->
            <property name="property" value="userName" />
        </columnOverride>
    </table>
</context>
</generatorConfiguration>

使用的是mybatis generator maven plugin生成，使用的是MyBatis3　runtime，生成的对象有：

• UserinfoKey：包装了主键的对象；
• Userinfo：除了主键的其他字段包装在Userinfo类中；
• UserinfoExample：包装了动态查询的查询条件；
• UserinfoMapper：MyBatis3的Mapper接口，其中简单的CRUD直接使用Annotation标记，复杂的SQL放在mapper.xml中；
• UserInfoMapper.xml：生成的mapper.xml文件；

具体的类结构图如下：

Paste_Image.png

在所有生成的内容中，注意动态查询的几个类的关系：

• Criteria，GeneratedCriteria和Criterion都是UserInfoExample的内部类；
• 在GeneratedCriteria类中，我只列出了针对id的N多个条件方法，其实MBG为每一个类型都创建了这么多个方法；目的就是为了能像Hibernate的Criteria的查询方式；
• 查询的使用：MBG生成的这堆内容，最重要的目的我感觉就是为了让动态查询更像Hibernate的Criteria，在使用的时候，按照下面的步骤：
  • 不要把UserInfoExample想象成QueryObject，可以把他想象成Hibernate中的Query对象；
  • 调用UserinfoExample对象的createCriteria方法先创建一个Criteria对象，因为这个对象的查询方法都是返回Criteria对象本身，所以也可以使用方法调用链的方式执行；
  • 调用Criteria对象上提供给各个属性的各种添加查询条件的方法，按照实际查询情况调用对应方法即可；
  • 将设置好条件的UserinfoExample对象，传给UserInfoMapper中对应的方法即可，可接受的方法主要几个XXXByExample方法；

另外需要看一下的就是UserinfoMapper.xml中生成的一些关键代码，最重要的就是按照Criteria创建查询条件的方式，简单说，调用Criteria对象上的每一个查询条件，其实都是创建了一个Criterion对象，保持在Criteria对象中的List<Criterion>集合中，在查询的时候，其实就是遍历其中每一个Criterion，按照传入的列，条件，具体的参数来完成查询的拼装：

<sql id="Example_Where_Clause">
<where>
  <foreach collection="oredCriteria" item="criteria" separator="or">
    <if test="criteria.valid">
      <trim prefix="(" prefixOverrides="and" suffix=")">
        <foreach collection="criteria.criteria" item="criterion">
          <choose>
            <when test="criterion.noValue">
              and ${criterion.condition}
            </when>
            <when test="criterion.singleValue">
              and ${criterion.condition} #{criterion.value}
            </when>
            <when test="criterion.betweenValue">
              and ${criterion.condition} #{criterion.value} and #{criterion.secondValue}
            </when>
            <when test="criterion.listValue">
              and ${criterion.condition}
              <foreach close=")" collection="criterion.value" item="listItem" open="(" separator=",">
                #{listItem}
              </foreach>
            </when>
          </choose>
        </foreach>
      </trim>
    </if>
  </foreach>
</where>
</sql>

到此，MyBatis3生成的比较复杂的runtime已经分析完成，接下来就可以分析MBG的实现方式等了。