MyBatis Generator介绍

时间 2019-12-13

原文原文链接

MyBatis Generator中文文档地址：html

http://generator.sturgeon.mopaas.com/java

该中文文档因为尽量和原文内容一致，因此有些地方若是不熟悉，看中文版的文档的也会有必定的障碍，因此本章根据该中文文档以及实际应用，使用通俗的语言来说解详细的配置。mysql

本文使用Markdown进行编辑，可是博客显示效果很差，因此建议移步这里进行阅读

本文是做为我的筹划的《Mybatis最佳实践》(gitbook)其中的一节。

本文中全部节点的连接都是对应的中文文档地址，能够点击查看详细信息。

下载本文档的PDF版本
git

注:本文后面提到的**MBG**所有指代MyBatis Generator。sql

运行MyBatis Generator

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

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

后续会专门为gitbook完善此部分mybatis

XML配置详解

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

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

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或多个，不受限制。

这个元素的做用是将MBG运行时须要用到的jar包(或zip格式)添加到**classpath**下。

最多见的用法是，当**classpath**下面**没有**JDBC驱动的时候，咱们一般经过这个属性指定驱动的路径，例如：

若是须要用到其余的jar包，也能够这么配置，例如若是你开发了一个MBG的插件，你就能够经过这种方式加入到**classpath**

这里注意上面重点强调的没有,通常在项目中使用的时候，**classpath**下面都有JDBC驱动，所以从项目中启动的时候不须要配置该项。

建议:因为该参数使用了绝对路径，所以不利用在不一样电脑上通用，所以建议最好把须要的jar包放到项目的**classpath**下，避免每一个人都得单独配置路径。

3.3 `<context>` 元素

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

<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的默认值为双引号(

属性 最后两个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>中会提到)。
    - 该元素支持如下几个<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. 关于Example方法虽然很强大，可是SQL不易管理，所以不建议使用。
  2. 取消<table>上的<context>上设置
    
    关于实体类的defaultModelType="flat"，只有一个对象的状况下管理毕竟方便，使用也简单。
  3. 关于注释@mbggenerated,MBG经过该字符串来判断代码是否为代码生成器生成的代码，有该标记的的代码在从新生成的时候会被删除，不会重复。不会在XML中出现重复元素。
  4. 使用MBG生成的代码时，建议尽量不要去修改自动生成的代码，并且要生成带有
    
    仍然是注释相关，在suppressAllComments属性(使用默认值true)时间戳
    
    <classPathEntry>来引入jar包，主要考虑到全部开发人员的统一性。
  5. 当数据库字段使用<javaModelGenerator>中设置<property name="trimStrings" value="true" />，能够自动去掉没必要要的空格。
  6. 在type="XMLMAPPER",不建议使用注解或混合模式，比较代码和SQL彻底分离易于维护。
  7. 建议尽量在<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="MyBatis3Simple" 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="G:\MyProject\src\main\java"> <property name="trimStrings" value="true" /> </javaModelGenerator> <sqlMapGenerator targetPackage="test.xml" targetProject="G:\MyProject\src\main\resources"/> <javaClientGenerator type="XMLMAPPER" targetPackage="test.dao" targetProject="G:\MyProject\src\main\java"/> <table tableName="%"> <generatedKey column="id" sqlStatement="Mysql"/> </table> </context> </generatorConfiguration> 
```
  id字段。若是不是全部表的配置都同样，能够作针对性的配置。

1. MyBatis Generator介绍目录
2. Mybatis Generator使用简介
3. Python generator和yield介绍
4. mybatis0212 mybatis**** （MyBatis Generator）
5. mybatis之mybatis-generator
6. [mybatis]mybatis-generator
7. Mybatis介绍（一）
8. mybatis的介绍
9. Mybatis介绍
10. MyBatis介绍
更多相关文章...
• 网站主机介绍 - 网站主机教程
• RSS 元素 - RSS 教程
• Java Agent入门实战（一）-Instrumentation介绍与使用
• 三篇文章了解 TiDB 技术内幕 —— 说计算

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最佳实践

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>` 元素