MyBatis Generator 详解（转）

MyBatis Generator中文文档

MyBatis Generator中文文档地址：

http://mbg.cndocs.tk/

该中文文档由于尽可能和原文内容一致，所以有些地方如果不熟悉，看中文版的文档的也会有一定的障碍，所以本章根据该中文文档以及实际应用，使用通俗的语言来讲解详细的配置。

本文中所有节点的链接都是对应的中文文档地址，可以点击查看详细信息。

注:本文后面提到的MBG全部指代MyBatis Generator。

MyBatis Generator 1.3.4 扩展，可以设置 Mapper（Dao）后缀

运行MyBatis Generator

有4种运行MBG的方法，具体请看文档运行 MyBatis Generator

MBG下载地址:http://repo1.maven.org/maven2/org/mybatis/generator/mybatis-generator-core/

XML配置详解

在MBG中，最主要也最重要的就是XML配置文件，因此本篇文章主要的内容就是XML配置。

这里按照配置的顺序对配置逐个讲解，更细的内容可以配合中文文档参照。

1. 配置文件头

<?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">

使用最新版的MBG需要使用上面的xml头，配置文件必须包含上面的<generatorConfiguration>

<generatorConfiguration>
    <!-- 具体配置内容 -->
</generatorConfiguration>

3. `<generatorConfiguration>`子元素

从这段开始，就是配置的主要内容，这些配置都是 包含以下子元素（有严格的顺序）：

<properties> (0个或1个)
<classPathEntry> (0个或多个)
<context> (1个或多个)

3.1 `<properties>` 元素

这个元素用来指定外部的属性元素，不是必须的元素。

元素用于指定一个需要在配置中解析使用的外部属性文件，引入属性文件后，可以在配置中使用 targetProject属性会很有用。

这个属性可以通过url来指定属性文件的位置，这两个属性只能使用其中一个来指定，同时出现会报错。

com/myproject/generatorConfig.properties这样的属性值。
file:///C:/myfolder/generatorConfig.properties

3.2 `<classPathEntry>` 元素

这个元素可以0或多个，不受限制。

最常见的用法是通过这个属性指定驱动的路径，例如：

重点提醒：本文之前在这里有误导，特别强调。

注意，classPathEntry只在下面这两种情况下才有效：

当加载 JDBC 驱动内省数据库时
当加载根类中的 JavaModelGenerator 检查重写的方法时

因此，如果你需要加载其他用途的jar包，classPathEntry起不到作用，不能这么写，解决的办法就是将你用的jar包添加到类路径中，在Eclipse等IDE中运行的时候，添加jar包比较容易。当从命令行执行的时候，需要用java -cp xx.jar,xx2.jar xxxMainClass这种方式在-cp后面指定来使用(注意-jar会导致-cp无效)。

3.3 `<context>` 元素

在MBG的配置中，至少需要有一个<context>元素。

数据库，要生成对象的类型和要处理的数据库中的表。运行MBG的时候还可以指定要运行的<context>。

该元素只有一个**必选属性**<context>元素，该 此外还有几个**可选属性**：

这个属性有以下可选值：
- hierarchical类似，除了如果那个单独的类将只包含一个字段，将不会生成一个单独的类。因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。
org.mybatis.generator.api.IntrospectedColumn该类的实现类。该属性的作用可以查看扩展MyBatis Generator。

一般情况下，我们使用如下的配置即可：

如果你希望不生成和

使用<table>中逐个进行配置（后面会提到）。

MBG配置中的其他几个元素，基本上都是<context>的子元素，这些子元素（有严格的配置顺序）包括：

<table> (1个或多个)

其中<property>属性前，我们先看看**什么是分隔符？**。

这里通过一个例子说明。假设在MySQL数据库中有一个表名为select * from user info这样的语句，肯定是要报错的，在mysql中的时候我们一般会写成如下的样子:

这里的使用的**反单引号(`)**就是**分隔符**，**分隔符**可以用于**表名**或者**列名**。

下面继续看<property>支持的属性：

由于这些属性比较重要，这里一一讲解。

首先是然后这里继续上面的例子来讲endingDelimiter属性。由于endingDelimiter的默认值为双引号(

属性Java文件的编码，默认使用当前平台的编码，只有当生产的编码需要特殊指定时才需要使用，一般用不到。

最后两个xmlFormatter属性**可能会**很有用，如果你想使用模板来定制生成的java文件和xml文件的样式，你可以通过指定这两个属性的值来实现。

接下来分节对其他的子元素逐个进行介绍。

3.3.1 `<plugin>` 元素

该元素可以配置0个或者多个，不受限制。

<plugin>元素用来定义一个插件。插件用于扩展或修改通过MyBatis Generator (MBG)代码生成器生成的代码。

插件将按在配置中配置的顺序执行。

有关插件的详细信息可以参考开发插件和提供的插件了解更多。

3.3.2 `<commentGenerator>` 元素

该元素最多可以配置1个。

这个元素非常有用，相信很多人都有过这样的需求，就是希望MBG生成的代码中可以包含**注释信息**，具体就是生成表或字段的备注信息。

使用这个元素就能很简单的实现我们想要的功能。这里先介绍该元素，介绍完后会举例如何扩展实现该功能。

该元素有一个可选属性org.mybatis.generator.api.CommentGenerator接口。而且必有一个默认的构造方法。这个属性接收默认的特殊值org.mybatis.generator.internal.DefaultCommentGenerator。

默认的实现类中提供了两个可选属性，需要通过<property>属性进行配置。

false
false

一般情况下由于MBG生成的注释信息没有任何价值，而且有时间戳的情况下每次生成的注释都不一样，使用**版本控制**的时候每次都会提交，因而一般情况下我们都会屏蔽注释信息，可以如下配置：

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

接下来我们简单举例实现生成包含表字段注释信息的注释

因为系统提供了一个默认的实现类，所以对我们来说，自己实现一个会很容易，最简单的方法就是复制默认实现类代码到一个新的文件中，修改类名如 我们通过下面一个方法的修改来了解，其他几个方法请自行修改(写本章的时候我也没有完全实现该类，所以不提供完整源码了):

这个方法是给字段添加注释信息的，其中getRemarks方法可以获取字段的注释信息。上面这个方法修改起来还是很容易的。除了字段的注释外还有Setter，以及类的注释。此外还有生成XML的注释，大家可以根据默认的实现进行修改。

完成我们自己的实现类后，我们还需要做如下配置：

3.3.3 `<jdbcConnection>` 元素

<jdbcConnection>用于指定数据库连接信息，该元素必选，并且只能有一个。

配置该元素只需要注意如果JDBC驱动不在**classpath**下，就需要通过<classPathEntry>元素引入jar包，这里**推荐**将jar包放到**classpath**下。

该元素有两个必选属性:

该元素还有两个可选属性:
- 此外该元素还可以接受多个<property>属性都会添加到JDBC驱动的属性中。
  
  这个元素配置起来最容易，这里举个简单例子：
  
  3.3.4 <javaTypeResolver> 元素
  
  该元素最多可以配置一个。
  
  这个元素的配置用来指定JDBC类型和Java类型如何转换。
  
  该元素提供了一个可选的属性<commentGenerator>比较类型，提供了默认的实现 该属性还有一个可以配置的<property>元素。
  
  可以配置的属性为DECIMAL和java.math.BigDecimal,默认值为 默认情况下的转换规则为：
  1. 如果长度>18，就会使用如果10<=长度<=18，就会使用如果5<=长度<=9，就会使用如果长度<5，就会使用如果设置为java.math.BigDecimal，配置示例如下：
    <javaTypeResolver > <property name="forceBigDecimals" value="true" /> </javaTypeResolver>
    3.3.5 <javaModelGenerator> 元素
    
    该元素必须配置一个，并且最多一个。
    
    该元素用来控制生成的实体类，根据defaultModelType，一个表可能会对应生成多个不同的实体类。一个表对应多个类实际上并不方便，所以前面也推荐使用 该元素只有两个属性，都是必选的。
    - <table>中会提到)。
    - 如 targetProject="src/main/java"）。
    该元素支持以下几个<property>子元素属性：
    - MyBatis3有效，如果false就会使用false。
    - true，MBG会根据schema来生成子包。如果targetPackage属性。默认为true，那么setter方法。如果为false。
    - rootClass，那么MBG不会覆盖和父类中完全匹配的属性。匹配规则：
      - 属性名完全相同
      - 属性类型相同
      - 属性有属性有
        trim操作，如果设置为public void setUsername(String username) {this.username = username == null ? null : username.trim();}的false。
      配置示例如下：
      3.3.6 <sqlMapGenerator> 元素
      
      该元素可选，最多配置一个。但是有如下两种必选的特殊情况：
      - 如果
      - 如果<javaClientGenerator>需要XML时，该元素必须配置一个。如果没有配置
        
        如果指定了一个如果没有指定
      该元素只有两个属性（和前面提过的<javaModelGenerator>的属性含义一样），都是必选的。
      - <table>中会提到)。
      - ，可以是绝对路径或相对路径（该元素支持<property>子元素，只有一个可以配置的属性：
        
        true，MBG会根据schema来生成子包。如果targetPackage属性。默认为 配置示例：
        
        3.3.7 <javaClientGenerator> 元素
        
        该元素可选，最多配置一个。
        
        如果不配置该元素，就不会生成Mapper接口。
        
        该元素有3个必选属性：
        
        org.mybatis.generator.codegen.AbstractJavaClientGenerator类，必选有一个默认的构造方法。该属性提供了以下预定的代码生成器，首先根据targetRuntime分成三类：
        
        MyBatis3:
        
        ANNOTATEDMAPPER:基于注解的Mapper接口，不会有对应的XML映射文件
        
        MIXEDMAPPER:XML和注解的混合形式，(上面这种情况中的)XMLMAPPER:所有的方法都在XML中，接口调用依赖XML文件。
        
        MyBatis3Simple:
        
        ANNOTATEDMAPPER:基于注解的Mapper接口，不会有对应的XML映射文件
        
        XMLMAPPER:所有的方法都在XML中，接口调用依赖XML文件。
        
        Ibatis2Java2或**Ibatis2Java5**:
        
        IBATIS:生成的对象符合iBATIS的DAO框架（不建议使用）。
        
        GENERIC-CI:生成的对象将只依赖于SqlMapClient，通过构造方法注入。
        
        GENERIC-SI:生成的对象将只依赖于SqlMapClient，通过SPRING:生成的对象符合Spring的DAO接口
        
        <table>中会提到)。
        
        ，可以是绝对路径或相对路径（"）。
        
        该元素还有一个可选属性：
        
        该元素支持<property>子元素设置的属性：
        
        这几个属性不太常用，具体作用请看完整的文档，这里对 <table>配置的这个属性对于通用Mapper来说，可以让生成的所有接口都继承该接口。
        
        配置示例：
        
        3.3.8 <table> 元素
        
        该元素至少要配置一个，可以配置多个。
        
        该元素用来配置要通过内省的表。只有配置的才会生成实体类和其他文件。
        
        该元素有一个必选属性：
        
        SQL通配符匹配多个表。
        
        例如要生成全部的表，可以按如下配置：
        
        该元素包含多个可选属性：
        
        SQL通配符匹配。如果设置了该值，生成SQL的表名会变成如catalog.tableName的形式。
        
        <context>的<context>的false。
        
        false。当schema或true。
        
        false。
        
        该元素包含多个可用的<property>子元素，可选属性为：
        
        <javaModelGenerator>中的属性含义一样。
        
        schema和<javaModelGenerator>中的属性含义一样。
        
        true就不会有Mapper接口。如果配置了modelOnly为<resultMap>)。如果为enableXXX方法，将不会生成任何CRUD方法。
        
        <javaModelGenerator>中的属性含义一样。
        
        <javaClientGenerator>中的属性含义一样。
        
        catalog，当生成表和运行环境的表的schema，当生成表和运行环境的表的tableName，当生成表和运行环境的表的selectAll方法后的SQL中，会直接跟除了<table>还包含以下子元素：
        
        <ignoreColumn> (0个或多个)
        
        下面对这4个元素进行详细讲解。
        
        1. <generatedKey> 元素
        
        这个元素最多可以配置一个。
        这个元素用来指定自动生成主键的属性（identity字段或者sequences序列）。如果指定这个元素，MBG在生成insert的SQL映射文件中插入一个<selectKey>元素。这个元素**非常重要**，这个元素包含下面两个必选属性：
        
        Cloudscape
        
        DB2
        
        DB2_MF
        
        Derby
        
        HSQLDB
        
        Informix
        
        MySql
        
        SqlServer
        
        SYBASE
        
        JDBC:这会配置MBG使用MyBatis3支持的JDBC标准的生成key来生成代码。这是一个独立于数据库获取标识列中的值的方法。重要: 只有当目标运行为MyBatis3时才会产生正确的代码。如果与iBATIS2一起使用目标运行时会产生运行时错误的代码。
        
        这个元素还包含两个可选属性：
        
        true时,该列会被标记为<selectKey>元素会被插入在false时，insert之前（通常是序列）。**重要**: 即使您post，您仍然需要为true。这将标志MBG从插入列表中删除该列。默认值是type=post and identity=true的时候生成的order=AFTER,当identity只能为false，生成的order=BEFORE。可以这么理解，自动增长的列只有插入到数据库后才能得到ID，所以是BEFORE。
        
        配置示例一：
        
        对应的生成的结果：
        
        配置示例二：
        
        对应的生成结果：
        
        2. <columnRenamingRule> 元素
        
        该元素最多可以配置一个，使用该元素可以在生成列之前，对列进行重命名。这对那些存在同一前缀的字段想在生成属性名时去除前缀的表非常有用。例如假设一个表包含以下的列：
        
        生成的所有属性名中如果都包含

注意，在内部，MBG使用 当<columnRenamingRule>）会被忽略。<columnOverride>优先于重命名的规则。

该元素有一个必选属性：

该元素有一个可选属性：

关于<property>属性 3. <columnOverride> 元素

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

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

该元素有一个必选属性:

该元素有多个可选属性：
- STRT_DTE，MBG会根据useActualColumnNames属性生成strtDte。
- JavaTypeResolver计算出的类型。对某些数据库来说，这是必要的用来处理**“奇怪的”**数据库类型（例如MySql的java.lang.Object)。
- INTEGER, DECIMAL, NUMERIC, VARCHAR等等)。如果需要，这可以覆盖由LONGVARCHAR类型需要为iBATIS 映射为TypeHandler类或配置示例：
  4. <ignoreColumn> 元素
  
  该元素可选，可以配置多个。
  
  该元素可以用来屏蔽不需要生成的列。
  
  该元素有一个必选属性：
  
  该元素还有一个可选属性：
  - true则区分。默认值为
  MyBatis Generator最佳实践
  
  本节内容针对MyBatis3，使用iBATIS的不一定适用。
  
  以下根据个人经验（对此有意见的可以留言）对一些配置看法列出如下几点：
  1. 关于实体类的defaultModelType="flat"，只有一个对象的情况下管理毕竟方便，使用也简单。
  2. 关于注释@mbggenerated,MBG通过该字符串来判断代码是否为代码生成器生成的代码，有该标记的的代码在重新生成的时候会被删除，不会重复。不会在XML中出现重复元素。
  3. 使用MBG生成的代码时，建议尽可能不要去修改自动生成的代码，而且要生成带有
    
    仍然是注释相关，在suppressAllComments属性(使用默认值true)时间戳
    
    <classPathEntry>来引入jar包，主要考虑到所有开发人员的统一性。
  4. 当数据库字段使用<javaModelGenerator>中设置<property name="trimStrings" value="true" />，可以自动去掉不必要的空格。
  5. 在type="XMLMAPPER",不建议使用注解或混合模式，比较代码和SQL完全分离易于维护。
  6. 建议尽可能在<generatedKey>，避免手工操作，以便于MBG重复执行代码生成。
  如果有其他有价值的经验，会继续补充。
  
  综合以上信息，这里给出一个
```
<?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="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"/>
        </table>
    </context>
</generatorConfiguration>
```
  id字段。如果不是所有表的配置都一样，可以做针对性的配置。
  
  改动：去掉来不建议使用Example查询的建议，Example在单表操作上优势明显，可以看个人情况使用。
- 转自 http://blog.csdn.net/isea533/article/details/42102297

posted on 2017-06-13 12:13 xiaopangzhi 阅读(106) 评论(0) 收藏举报

MyBatis Generator 详解（转）

运行MyBatis Generator

XML配置详解

1. 配置文件头

3. `<generatorConfiguration>`子元素

3.1 `<properties>` 元素

3.2 `<classPathEntry>` 元素

3.3 `<context>` 元素

3.3.1 `<plugin>` 元素

3.3.2 `<commentGenerator>` 元素

3.3.3 `<jdbcConnection>` 元素

3.3.4 `<javaTypeResolver>` 元素

3.3.5 `<javaModelGenerator>` 元素

3.3.6 `<sqlMapGenerator>` 元素

3.3.7 `<javaClientGenerator>` 元素

3.3.8 `<table>` 元素

MyBatis Generator最佳实践

MyBatis Generator 详解 （转）

运行MyBatis Generator

XML配置详解

1. 配置文件头

3. <generatorConfiguration>子元素

3.1 <properties> 元素

3.2 <classPathEntry> 元素

3.3 <context> 元素

3.3.1 <plugin> 元素

3.3.2 <commentGenerator> 元素

3.3.3 <jdbcConnection> 元素

3.3.4 <javaTypeResolver> 元素

3.3.5 <javaModelGenerator> 元素

3.3.6 <sqlMapGenerator> 元素

3.3.7 <javaClientGenerator> 元素

3.3.8 <table> 元素

MyBatis Generator最佳实践

MyBatis Generator 详解（转）

3. `<generatorConfiguration>`子元素

3.1 `<properties>` 元素

3.2 `<classPathEntry>` 元素

3.3 `<context>` 元素

3.3.1 `<plugin>` 元素

3.3.2 `<commentGenerator>` 元素

3.3.3 `<jdbcConnection>` 元素

3.3.4 `<javaTypeResolver>` 元素

3.3.5 `<javaModelGenerator>` 元素

3.3.6 `<sqlMapGenerator>` 元素

3.3.7 `<javaClientGenerator>` 元素

3.3.8 `<table>` 元素