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的实现方式等了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容

  • 本文包括:1、Hibernate 的查询方式2、HQL (Hibernate Query Language) 查询...
    廖少少阅读 2,649评论 0 15
  • hibernate(20170731) 1.导包:hibernate-distribution-3.5.6-Fin...
    潇湘雨smile阅读 531评论 0 0
  • 这部分主要是开源Java EE框架方面的内容,包括Hibernate、MyBatis、Spring、Spring ...
    杂货铺老板阅读 1,343评论 0 2
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,577评论 18 399
  • 尽管现在手机屏幕的趋势是越做越大,然而实际上真正使得手机如此轻便的地方正在于它的小尺寸。相比于台式电脑,甚至笔记本...
    三达不留点gpj阅读 2,852评论 0 24