MyBatis Generator 逆向工程详解

本文工程示例源码:https://github.com/woodwhales/woodwhales-study/tree/master/generate-mapper

一、Mysql 数据库数据准备

1.1 创建数据库
创建数据库
1
2
CREATE DATABASE `my_test_db` /*!40100 COLLATE 'utf8mb4_unicode_ci' */;
SHOW DATABASES;
2.2 创建用户表
创建数据库表
1
2
3
4
5
6
7
8
9
10
11
12
CREATE TABLE `User` (
`id` INT NOT NULL,
`username` VARCHAR(120) NOT NULL,
`password` VARCHAR(120) NOT NULL,
`gender` BIT NOT NULL,
`email` VARCHAR(120) NOT NULL,
`born` TIMESTAMP NOT NULL,
`extraInfo` VARCHAR(500) NOT NULL,
PRIMARY KEY (`id`)
)
COLLATE='utf8mb4_unicode_ci'
ENGINE=InnoDB;
1.3 创建购物车表
创建数据库表
1
2
3
4
5
6
7
8
9
10
11
12
CREATE TABLE `Cart` (
`id` INT NOT NULL,
`logisticId` VARCHAR(50) NOT NULL,
`number` INT NOT NULL,
`discount` DOUBLE NULL,
`total` DOUBLE NULL,
`extrainfo` VARCHAR(500) NULL,
PRIMARY KEY (`id`),
UNIQUE INDEX `logisticId` (`logisticId`)
)
COLLATE='utf8mb4_unicode_ci'
ENGINE=InnoDB;

二、逆向工程生成

2.1 pom 依赖配置

在 pom.xml 依赖文件中增加 mybatis generator 插件依赖

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.9.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>org.woodwhales.king</groupId>
<artifactId>generate-mapper</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>generate-mapper</name>
<description>king redis project for Spring Boot</description>

<properties>
<java.version>1.8</java.version>
</properties>

<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.17</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<phase>package</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<configuration>
<!--允许移动生成的文件 -->
<verbose>true</verbose>
<!-- 是否覆盖 -->
<overwrite>true</overwrite>
<!-- 自动生成的配置 -->
<configurationFile>src/main/resources/generator/config.xml</configurationFile>
</configuration>
</plugin>
</plugins>
</build>
</project>

pom 依赖配置

2.2 配置映射文件

<configurationFile>配置的对应目录下,创建对应的逆向生成工程映射文件,并将下列配置粘贴到其中:

mybatis 逆向工程配置映射
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!--xml引入外部配置文件-->
<properties resource="generator/init.properties"/>

<context id="Tables" targetRuntime="MyBatis3">
<!--字符集必须指定,否则生成的文件会根据系统的字符集生成-->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 增加生成序列化等插件 -->
<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
<plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin" />
<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />

<commentGenerator>
<property name="suppressDate" value="true"/>
<!-- 是否[去除]自动生成的注释 true表示是,false表示否 -->
<property name="suppressAllComments" value="false"/>
<!-- 是否携带注释 -->
<property name="addRemarkComments" value="true" />
</commentGenerator>

<!--数据库链接URL、用户名、密码 -->
<jdbcConnection driverClass="${jdbc.driverClass}"
connectionURL="${jdbc.connectionURL}"
userId="${jdbc.userId}"
password="${jdbc.password}">
</jdbcConnection>

<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>

<!-- 生成 model 和 example的包名和位置-->
<javaModelGenerator targetPackage="${javaModelGenerator.targetPackage}"
targetProject="${javaModelGenerator.targetProject}">
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>

<!-- 生成 DAO 接口文件的包名和位置-->
<sqlMapGenerator targetPackage="${sqlMapGenerator.targetPackage}"
targetProject="${sqlMapGenerator.targetProject}">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>

<!-- 生成XML映射文件的包名和位置-->
<javaClientGenerator type="XMLMAPPER" targetPackage="${javaClientGenerator.targetPackage}"
targetProject="${javaClientGenerator.targetProject}">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>

<!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名-->
<table tableName="${tableName}"
enableCountByExample="true"
enableDeleteByExample="true"
enableSelectByExample="true"
enableUpdateByExample="true">
<generatedKey column="id" sqlStatement="Mysql" identity="true"/>
</table>
</context>
</generatorConfiguration>
2.3 配置自定义配置文件

在映射文件配置中,可以看到:<properties>元素指定了generator/mybatisGeneratorinit.properties,因此需要创建对应的配置文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
#Mybatis Generator configuration

# JDBC config
jdbc.driverClass=com.mysql.cj.jdbc.Driver
#jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
jdbc.userId=root
jdbc.password=root

#JavaBean location
javaModelGenerator.targetProject=src/main/java
javaModelGenerator.targetPackage=org.woodwhales.king.user.entity

#interface location
javaClientGenerator.targetProject=src/main/java
javaClientGenerator.targetPackage=org.woodwhales.king.user.mapper

#mapping location
sqlMapGenerator.targetProject=src/main/resources
sqlMapGenerator.targetPackage=mapper.user

tableName=hello

注意:配置的目录需要提前手动创建出来。

2.4 运行 mybatis 逆向工程

在项目根目录右击选择"Show in"中的"Terminal"选项,进入 dos 窗口,执行逆向生成命令:mvn mybatis-generator:generate

项目生成之后,需要刷新项目。

2.5 mapper 接口既映射文件注册配置

将 mapper 接口注册到 springboot 中,在要注册的类上增加@Mapper注解,或者使用包扫描的方式进行注册:在启动类上增加@MapperScan(basePackages="org.woodwhale.demo.mapper"),强烈推荐第二种。

将 mapper 映射的 xml 文件注册到 springboot:在application.yml配置文件中增加映射文件扫描:

1
2
mybatis:
mapper-locations: classpath:org/woodwhale/demo/mapper/*Mapper.xml

三、MyBatis Generator 详解

MyBatis Generator中文文档地址:mbg.cndocs.ml

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

3.1 XML 配置详解
1
2
3
4
<?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">
3.2 根节点

<generatorConfiguration>节点没有任何属性,直接写节点即可,如下:

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

<generatorConfiguration>元素的子元素包含以下子元素(有严格的顺序):

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

四、元素

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

元素用于指定一个需要在配置中解析使用的外部属性文件,引入属性文件后,可以在配置中使用${property}这种形式的引用,通过这种方式引用属性文件中的属性值,如配置jdbc 信息targetProject 属性

这个元素的属性可以通过resource或者url来指定属性文件的位置,这两个属性只能使用其中一个来指定,如果同时使用就会报错。

  • resource:指定 classpath 下的属性文件,使用类似com/myproject/generatorConfig.properties这样的属性值。
  • url:可以指定文件系统上的特定位置,例如file://C:/myfolder/generatorConfig.properties

五、元素

这个元素可以是 0 或多个。最常见的用法是通过这个属性指定驱动的路径,例如:

1
<classPathEntry location="C:\mysql-connector-java-5.1.42.jar"/>

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

六、元素

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

<context>元素用于指定生成一组对象的环境。例如指定要连接的数据库,要生成对象的类型和要处理的数据库中的表。运行MBG的时候还可以指定要运行的<context>

该元素只有一个必选属性

  • id:用来唯一确定一个<context>元素,该id属性可以在运行 MBG 的使用。

此外还有几个可选属性

  • defaultModelType

    这个属性很重要,这个属性定义了 MBG 如何生成实体类

  • conditional:默认值,这个模型和下面的hierarchical类似,除了如果那个单独的类将只包含一个字段,将不会生成一个单独的类。 因此,如果一个表的主键只有一个字段,那么不会为该字段生成单独的实体类,会将该字段合并到基本实体类中。

  • flat:该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段。这种模型最简单,推荐使用。

  • hierarchical:如果表有主键,那么该模型会产生一个单独的主键实体类,如果表还有 BLOB 字段,则会为表生成一个包含所有 BLOB 字段的单独的实体类,然后为所有其他的字段生成一个单独的实体类。MBG 会在所有生成的实体类之间维护一个继承关系。

  • targetRuntime:此属性用于指定生成的代码的运行时环境。该属性支持以下可选值:

    1
    2
    3
    4
    MyBatis3:默认值
    MyBatis3Simple
    Ibatis2Java2
    Ibatis2Java5:一般情况下使用默认值即可,有关这些值的具体作用以及区别请查看中文文档的详细内容。
  • introspectedColumnImpl:该参数可以指定扩展org.mybatis.generator.api.IntrospectedColumn该类的实现类。该属性的作用可以查看扩展 MyBatis Generator。

扩展 MyBatis Generator:
http://mbg.cndocs.ml/reference/extending.html

一般情况下,我们使用如下的配置即可:

1
<context id="Mysql" defaultModelType="flat">

如果你希望不生成和Example查询有关的内容,那么可以按照如下进行配置:

1
<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">

注意:使用MyBatis3Simple可以避免在后面的<table>中逐个进行配置(后面会提到)。

元素的子元素

MBG 配置中的其他几个元素,基本上都是<context>的子元素,这些子元素(有严格的配置顺序)包括:

1
2
3
4
5
6
7
8
9
<property>(0 个或多个)
<plugin>(0 个或多个)
<commentGenerator>(0 个或 1 个)
<jdbcConnection>(1 个)
<javaTypeResolver>(0 个或 1 个)
<javaModelGenerator>(1 个)
<sqlMapGenerator>(0 个或 1 个)
<javaClientGenerator>(0 个或 1 个)
<table>(1 个或多个)
6.1 属性

<property>属性比较特殊,后面讲解的时候都会和父元素一起进行讲解。

在讲解<property>属性前,我们先看看一个重要的概念:分隔符

这里通过一个例子说明。假设在 Mysql 数据库中有一个表名为user info,你没有看错,中间是一个空格,这种情况下如果写出select * from user info这样的语句,肯定是要报错的,在 Mysql 中的时候我们一般会写成如下的样子:

select * from `user info`

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

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

1
2
3
4
5
6
autoDelimitKeywords
beginningDelimiter
endingDelimiter
javaFileEncoding
javaFormatter
xmlFormatter

首先是autoDelimitKeywords,当表名或者字段名为 SQL 关键字的时候,可以设置该属性为 true,MBG 会自动给表名或字段名添加分隔符

由于beginningDelimiterendingDelimiter的默认值为双引号(”),在 Mysql 中不能这么写,所以还要将这两个默认值改为反单引号(`),配置如下:

1
2
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

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

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

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

6.2 元素

该元素可以配置 0 个或者多个。<plugin>元素用来定义一个插件。插件用于扩展或修改通过 MyBatis Generator (MBG) 代码生成器生成的代码。插件将按在配置中配置的顺序执行。

有关插件的详细信息可以参考开发插件和提供的插件了解更多。
开发插件:http://mbg.cndocs.ml/reference/pluggingIn.html
提供的插件:http://mbg.cndocs.ml/reference/plugins.html

6.3 元素

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

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

该元素有一个可选属性 type,可以指定用户的实现类,该类需要实现org.mybatis.generator.api.CommentGenerator接口。而且必有一个默认的构造方法。这个属性接收默认的特殊值 DEFAULT,会使用默认的实现类org.mybatis.generator.internal.DefaultCommentGenerator

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

suppressAllComments阻止生成注释,默认为 false

suppressDate阻止生成的注释包含时间戳,默认为 false

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

1
2
3
4
<commentGenerator>
<property name="suppressAllComments" value="true"/>
<property name="suppressDate" value="true"/>
</commentGenerator>

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

因为系统提供了一个默认的实现类,所以对我们来说,自己实现一个会很容易,最简单的方法就是复制默认实现类代码到一个新的文件中,修改类名如MyCommentGenerator,在你自己的实现类中,你可以选择是否继续支持上面的两个属性,你还可以增加对其他属性的支持。

我们通过下面一个方法的修改来了解,其他几个方法请自行修改(写本章的时候我也没有完全实现该类,所以不提供完整源码了):

1
2
3
4
5
6
7
8
9
@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
if (introspectedColumn.getRemarks() != null && !introspectedColumn.getRemarks().equals("")) {
field.addJavaDocLine("/**");
field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
addJavadocTag(field, false);
field.addJavaDocLine(" */");
}
}

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

完成我们自己的实现类后,我们还需要做<commentGenerator>元素配置:

1
<commentGenerator type="com.github.abel533.mybatis.generator.MyCommentGenerator"/>
6.4 元素

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

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

该元素有两个必选属性

  • driverClass:访问数据库的 JDBC 驱动程序的完全限定类名
  • connectionURL:访问数据库的 JDBC 连接 URL

该元素还有两个可选属性:

  • userId:访问数据库的用户 ID
  • password:访问数据库的密码

此外该元素还可以接受多个<property>子元素,这里配置的<property>属性都会添加到 JDBC 驱动的属性中。

这个元素配置起来最容易,这里举个简单例子:

1
2
3
4
5
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/test"
userId="root"
password="root">
</jdbcConnection>
6.5 元素

该元素最多可以配置一个。这个元素的配置用来指定 JDBC 类型和 Java 类型如何转换。

该元素提供了一个可选的属type<commentGenerator>比较类型,提供了默认的实现 DEFAULT,一般情况下使用默认即可,需要特殊处理的情况可以通过其他元素配置来解决,不建议修改该属性。

该属性还有一个可以配置的<property>元素。

可以配置的属性为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

如果设置为 true,那么一定会使用java.math.BigDecimal

<javaTypeResolver>元素配置示例:

1
2
3
<javaTypeResolver >
<property name="forceBigDecimals" value="true" />
</javaTypeResolver>
6.6 元素

该元素必须配置一个,并且最多一个。该元素用来控制生成的实体类,根据<context>中配置的defaultModelType,一个表可能会对应生成多个不同的实体类。一个表对应多个类实际上并不方便,所以前面也推荐使用 flat,这种情况下一个表对应一个实体类。

该元素只有两个必选属性

  • targetPackage:生成实体类存放的包名,一般就是放在该包下。实际还会受到其他配置的影响( 中会提到)。
  • targetProject:指定目标项目路径,可以是绝对路径或相对路径(如targetProject="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 不会覆盖和父类中完全匹配的属性。匹配规则:

    1
    2
    3
    4
    属性名完全相同
    属性类型相同
    属性有getter方法
    属性有setter方法
  • trimStrings:是否对数据库查询结果进行 trim 操作,如果设置为 true 就会生成类似这样

    1
    2
    3
    public void setUsername(String username) {
    this.username = username == null ? null : username.trim();
    }

    的 setter 方法。默认值为 false。

<javaModelGenerator>元素配置示例:

1
2
3
4
<javaModelGenerator targetPackage="test.model" targetProject="src\main\java">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
6.7 元素

该元素可选,最多配置一个。但是有如下两种必选的特殊情况:

  • 如果targetRuntime目标是 iBATIS2,该元素必须配置一个。如果targetRuntime目标是 MyBatis3,只有当<javaClientGenerator>需要XML时,该元素必须配置一个。
  • 如果没有配置 ,则使用以下的规则:
    如果指定了一个 ,那么 MBG 将只生成 XML 的 SQL 映射文件和实体类。如果没有指定 ,那么 MBG 将只生成实体类。

该元素只有两个必选属性(和前面提过的<javaModelGenerator>的属性含义一样):

  • targetPackage:生成实体类存放的包名,一般就是放在该包下。实际还会受到其他配置的影响(中会提到)。
  • targetProject:指定目标项目路径,可以是绝对路径或相对路径(如:targetProject="src/main/resources")。

该元素支持<property>子元素,只有一个可以配置的属性:

  • enableSubPackages:如果 true,MBG 会根据 catalog 和 schema 来生成子包。如果 false 就会直接用 targetPackage 属性。默认为 false。

<sqlMapGenerator>元素配置示例:

1
2
3
<sqlMapGenerator targetPackage="test.xml"  targetProject="src\main\resources">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
6.8 元素

该元素可选,最多配置一个,如果不配置该元素,就不会生成 Mapper 接口。

该元素有 3 个必选属性

  1. type:该属性用于选择一个预定义的客户端代码(可以理解为 Mapper 接口)生成器,用户可以自定义实现,需要继承org.mybatis.generator.codegen.AbstractJavaClientGenerator类,必选有一个默认的构造方法。 该属性提供了以下预定的代码生成器,首先根据<context>的 targetRuntime 分成三类:

    1. MyBatis3类:
    ANNOTATEDMAPPER:基于注解的 Mapper 接口,不会有对应的 XML 映射文件。
    MIXEDMAPPER:XML 和注解的混合形式,(上面这种情况中的)SqlProvider 注解方法会被 XML 替代。
    XMLMAPPER:所有的方法都在 XML 中,接口调用依赖 XML 文件。

    2. MyBatis3Simple类:
    ANNOTATEDMAPPER:基于注解的 Mapper 接口,不会有对应的 XML 映射文件。
    XMLMAPPER:所有的方法都在 XML 中,接口调用依赖 XML 文件。

    3. Ibatis2Java2或Ibatis2Java5类:
    IBATIS:生成的对象符合iBATIS的DAO框架(不建议使用)。
    GENERIC-CI:生成的对象将只依赖于SqlMapClient,通过构造方法注入。
    GENERIC-SI:生成的对象将只依赖于SqlMapClient,通过setter方法注入。
    SPRING:生成的对象符合Spring的DAO接口。

  2. targetPackage:生成实体类存放的包名,一般就是放在该包下。实际还会受到其他配置的影响(中会提到)。

  3. targetProject:指定目标项目路径,可以是绝对路径或相对路径(如:targetProject="src/main/java")。

该元素还有一个可选属性

  • implementationPackage:如果指定了该属性,实现类就会生成在这个包中。

    该元素支持<property>子元素设置的属性:

    1
    2
    3
    4
    5
    enableSubPackages
    exampleMethodVisibility
    methodNameCalculator
    rootInterface
    useLegacyBuilder

这几个<property>子元素属性不太常用,具体作用请看完整的文档,这里对rootInterface做个简单介绍:

  • rootInterface:用于指定一个所有生成的接口都继承的父接口。 这个值可以通过&lt;table\&gt;配置的rootInterface属性覆盖。这个属性对于通用 Mapper 来说,可以让生成的所有接口都继承该接口。

<javaClientGenerator>元素配置示例:

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

该元素至少要配置一个。该元素用来配置要通过内省的表。只有配置的才会生成实体类和其他文件。

该元素有一个必选属性

  • tableName:指定要生成的表名,可以使用 SQL 通配符匹配多个表。

    例如要生成全部的表,可以按如下配置:<table tableName="%" />

该元素包含多个可选属性

  • schema:数据库的 schema,可以使用 SQL 通配符匹配。如果设置了该值,生成 SQL 的表名会变成如 schema.tableName 的形式。
  • catalog:数据库的 catalog,如果设置了该值,生成 SQL 的表名会变成如 catalog.tableName 的形式。
  • alias:如果指定,这个值会用在生成的 select 查询 SQL 的表的别名和列名上。 列名会被别名为 alias_actualColumnName(别名_实际列名)这种模式。
  • 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。

该元素包含多个可用的<property>子元素,可选属性为:

  • constructorBased:和中的属性含义一样。
  • ignoreQualifiersAtRuntime:生成的 SQL 中的表名将不会包含 schema 和 catalog 前缀。
  • immutable:和中的属性含义一样。
  • modelOnly:此属性用于配置是否为表只生成实体类。如果设置为 true 就不会有 Mapper 接口。如果配置了,并且 modelOnly 为 true,那么 XML 映射文件中只有实体对象的映射元素( )。如果为 true 还会覆盖属性中的 enableXXX 方法,将不会生成任何 CRUD 方法。
  • rootClass:和中的属性含义一样。
  • rootInterface:和中的属性含义一样。
  • 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。
6.10 子元素

除了<property>子元素外,<table>还包含以下子元素:

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

下面对这 4 个元素进行详细讲解。

6.10.1 元素

这个元素最多可以配置一个。这个元素用来指定自动生成主键的属性(identity 字段或者 sequences 序列)。如果指定这个元素,MBG 在生成 insert 的 SQL 映射文件中插入一个<selectKey>元素。 这个元素非常重要。

这个元素包含下面两个必选属性

  • column:生成列的列名。

  • sqlStatement:将返回新值的 SQL 语句。如果这是一个 identity 列,您可以使用其中一个预定义的的特殊值。预定义值如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    Cloudscape
    DB2
    DB2_MF
    Derby
    HSQLDB
    Informix
    MySql
    SqlServer
    SYBASE
    JDBC

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 的时候生成的中的 order=AFTER,当 type=pre 的时候,identity 只能为 false,生成的中的 order = BEFORE。可以这么理解,自动增长的列只有插入到数据库后才能得到 ID,所以是 AFTER,使用序列时,只有先获取序列之后,才能插入数据库,所以是:BEFORE。

元素配置示例一:

1
2
3
<table tableName="user login info" domainObjectName="UserLoginInfo">
<generatedKey column="id" sqlStatement="Mysql"/>
</table>

对应的生成的结果:

1
2
3
4
5
6
7
<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>

元素配置示例二:

1
2
3
<table tableName="user login info" domainObjectName="UserLoginInfo">
<generatedKey column="id" sqlStatement="select SEQ_ID.nextval from dual"/>
</table>

对应的生成结果:

1
2
3
4
5
6
7
<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>

6.10.2 元素

该元素最多可以配置一个,使用该元素可以在生成列之前,对列进行重命名。这对那些存在同一前缀的字段想在生成属性名时去除前缀的表非常有用。 例如假设一个表包含以下的列:

1
2
3
4
CUST_BUSINESS_NAME
CUST_STREET_ADDRESS
CUST_CITY
CUST_STATE

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

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

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

<columnOverride>匹配一列时,这个元素(<columnRenamingRule>)会被忽略。<columnOverride>优先于重命名的规则。

该元素有一个必选属性

  • searchString:定义将被替换的字符串的正则表达式。

该元素有一个可选属性

  • replaceString:这是一个用来替换搜索字符串列每一个匹配项的字符串。如果没有指定,就会使用空字符串。

关于<table><property>属性useActualColumnNames对此的影响可以查看完整文档。

6.10.3 元素

该元素可选,可以配置多个。该元素从将某些属性默认计算的值更改为指定的值。

该元素有一个必选属性

  • column:要重写的列名。

该元素有多个可选属性

  • property:要使用的 Java 属性的名称。如果没有指定,MBG 会根据列名生成。 例如,如果一个表的一列名为STRT_DTE,MBG会根据 的 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 会自动添加分隔符, 所以这个重写只有当列名需要强制为一个合适的名字或者列名是数据库中的保留字时是必要的。

<columnOverride> 元素配置示例:

1
2
3
<table schema="DB2ADMIN" tableName="ALLTYPES" >
<columnOverride column="LONG_VARCHAR_FIELD" javaType="java.lang.String" jdbcType="VARCHAR" />
</table>

6.10.4 元素

该元素可选,可以配置多个。该元素可以用来屏蔽不需要生成的列。

该元素有一个必选属性

  • column:要忽略的列名。

该元素还有一个可选属性

  • delimitedColumnName:匹配列名的时候是否区分大小写。如果为 true 则区分。默认值为false,不区分大小写。
参考资料:

MyBatis Generator 详解

MyBatis GeneratorXML Configuration File Reference

MyBatis Generator XML 配置参考(中文文档网址失效了,直接看上面官方文档)

扩展 MyBatis Generator

从源码构建

Mybatis Generator实现代码自动生成

updated updated 2020-03-01 2020-03-01
本文结束感谢阅读

本文标题:MyBatis Generator 逆向工程详解

本文作者:木鲸鱼

微信公号:木鲸鱼 | woodwhales

原始链接:https://woodwhales.cn/2018/10/29/015/

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。

0%