MyBatis-Generator 是 MyBatis 提供的一个代码生成工具,可以帮助我们生成数据库表对应的持久化对象(也称作 Model、PO)、操作数据库的接口(dao)、简单 SQL 的 mapper(XML 形式或注解形式)。

MyBatis-Generator (常简写为 MBG 或 mbg)是一个独立工具,你可以下载它的 jar 包来运行,也可以在 Ant 和 Maven 中运行。其官方网址为:https://mybatis.org/generator/

一、引入 MyBatis-Generator 及环境

对于这篇博文,我是在基于 SpringBoot 的 Maven 项目环境中配置、使用和讲解的,使用的 IDE 是 IntelliJ IDEA。

既然需要使用 MyBatis-Generator,那么在项目中就一定使用了 MyBatis 和某一种数据库,并且这些依赖应该已经在 Maven 中配置好了。例如 pom 文件中的配置:

1
2
3
4
5
6
7
8
9
10
11
12
<dependencies>
<!-- 为了方便,不展示其它配置... -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
</dependencies>

对于在 Maven 项目中引入 MyBatis-Generator,这里介绍两种方式,具体需要用哪种方式取决于你使用哪种方式来运行 MyBatis-Generator 工具:(对于如何运行 MyBatis-Generator 工具,参见本文第三节)

1. 方式一:在 Maven 中导入依赖

这种方式适用于:用 Java 代码来运行 MyBatis-Generator 工具。在 pom 文件中引入 mybatis-generator-core 依赖:

1
2
3
4
5
6
7
8
<dependencies>
<!-- 为了方便,不展示其它配置... -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>

2. 方式二:在 Maven 中引入插件

这种方式适用于:通过 Maven 项目的 Plugins 或 Maven 的命令行来运行 MyBatis-Generator 工具。在 pom 文件中引入 mybatis-generator-maven-plugin 插件:

1
2
3
4
5
6
7
8
9
10
<build>
<!-- 为了方便,不展示其它配置... -->
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
</plugin>
</plugins>
</build>

二、MyBatis-Generator 配置文件

MyBatis-Generator 需要一个 xml 配置文件,来详细配置生成代码的各种细节。例如,在项目的 resources 目录下新建一个 mybatis-generator-config.xml 配置文件:

mbg-config-目录路径.png

其内容如下:

1
2
3
4
5
6
7
8
9
10
11
<?xml version="1.0" encoding="UTF-8"?>
<!-- MyBatis-Generator 相关配置 -->
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<!-- 所有的配置均在根元素 generatorConfiguration 下 -->
<generatorConfiguration>
...
...
</generatorConfiguration>

在该文件中,所有的配置均在根元素 generatorConfiguration 下。根元素 generatorConfiguration 有 3 个子元素可供配置,这 3 个子元素必须按照下面给出的次数和顺序进行配置:(没错,MyBatis-Generator 对配置的顺序也有严格的要求

  1. properties (0 or 1),可出现 0 次或 1 次。
  2. classPathEntry (0…N),可出现 0 次或多次。
  3. context (1…N),至少出现 1 次。

其中,properties 和 classPathEntry 元素用于引入外部配置或文件;context 是核心元素,里面包含有各种详细配置。

1. 引入外部配置文件

在配置 MyBatis-Generator 时,是可以引入外部配置或文件的。

properties 元素

元素 properties 可以用于加载外部配置项或配置文件,该元素有两个属性,均用来指定外部配置文件的地址:

  • resource:使 MBG 从 classpath 开始查找;一般可以使用相对于当前 xml 配置文件的相对路径。
  • url:采用 URL 的方式;例如可以使用 file 协议 file:///Users/deecyn/Files/mybatis-generator.properties 从计算机本地查找,也可以使用 http 协议在互联网上查找,等等。

注意,这两个属性只能选择一个使用。例如,引入下图中的 mybatis-generator.properties 配置文件:

mbg-properties.png

用于引入文件的代码如下:

1
2
<!-- 引入外部配置文件 -->
<properties resource="mybatis-generator.properties"/>

之后在整个 xml 配置文件中就可以通过 ${propertyKey} 的方式来引用配置项。

classPathEntry 元素

使用 classPathEntry 元素,可以在 MBG 工作的时候,加载额外需要的依赖包。其中,location 属性指明需要加载的 jar/zip 包的全路径。例如:

1
2
<!--  加载需要的额外的依赖包 -->
<classPathEntry location="/Users/deecyn/Files/db2java.zip"/>

2. 配置 context 核心元素

在 generationConfiguration 的子元素中,context 是核心元素,用于配置生成一组对象的环境。context 元素除了一些自身的属性要配置外,还有一些重要的子元素如 jdbcConnection、javaModelGenerator、table 等需要进行配置。配置详情参考文章: 配置 MyBatisGenerator 的核心元素:context

三、运行 MyBatis-Generator

对于 MyBatis-Generator,不同的运行方式,对项目和文件的配置会有一些区别,本文介绍两种运行 MBG 的方式。

方式一:使用 Java 代码编程运行

通过这种方式运行 MBG,在本文的第一节,引入 MyBatis-Generator 时,需要按照方式一在 Maven 的 pom 文件中引入依赖:

1
2
3
4
5
6
7
8
<dependencies>
<!-- 为了方便,不展示其它配置... -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>

然后在项目中新建一个 Java 类,代码类似下面:

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
package deecyn.shop_02.mbg;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

public class Generator {
public static void main(String[] args) throws Exception {
// MBG 执行过程中的警告信息
List<String> warnings = new ArrayList<String>();
// 当生成的代码重复时,覆盖原代码
boolean overwrite = true;
// 读取我们的 MBG 配置文件
InputStream is = Generator.class.getResourceAsStream("/mybatis-generator-config.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(is);
is.close();

DefaultShellCallback callback = new DefaultShellCallback(overwrite);
//创建 MBG
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
//执行生成代码
myBatisGenerator.generate(null);
//输出警告信息
for (String warning : warnings) {
System.out.println(warning);
}
}
}

运行类中的 main() 方法即可在相应的目录下生成对应的代码。

需要注意的是,当你的项目中有多个 Module 时,在配置 javaModelGenerator、sqlMapGenerator 和 javaClientGenerator 元素的 targetProject 属性时,需要在前面加上当前的 Module 名称。例如当前的 Module 名称为 shop_02 时:

1
2
3
4
<javaModelGenerator targetPackage="deecyn.shop_02.mbg.model" targetProject="shop_02/src/main/java"/>
<sqlMapGenerator targetPackage="mbg-mapper" targetProject="shop_02/src/main/resources"/>
<javaClientGenerator type="XMLMAPPER" targetPackage="deecyn.shop_02.mbg.mapper"
targetProject="shop_02/src/main/java"/>

否则会提示找不到对应的 java 和 resource 目录。

方式二:通过 Maven 插件运行

通过这种方式运行 MBG,在本文的第一节,引入 MyBatis-Generator 时,需要按照方式二在 Maven 的 pom 文件中引入插件,此外还需要进行一些配置:

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
<build>
<!-- 为了方便,不展示其它配置... -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>

<configuration>
<!-- 引入 MyBatis-Generator 的配置文件 -->
<configurationFile>./src/main/resources/generatorConfig.xml</configurationFile>
<!-- 允许 MBG 将构建消息写入日志中 -->
<verbose>true</verbose>
<!-- 再次运行 MBG 时,允许覆盖已生成的文件,但是不会覆盖 xml 文件 -->
<overwrite>true</overwrite>
</configuration>

<dependencies>
<!-- 引入 mysql 的 JDBC 驱动,否则会报错找不到驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.48</version>
</dependency>
</dependencies>
</plugin>
</build>

配置好后,双击 Maven –> Plugins 中的 MyBatis-Generator 运行:

mbg-run.png

即可在相应的目录下生成对应的代码。

需要注意的是,此时,在配置 javaModelGenerator、sqlMapGenerator 和 javaClientGenerator 元素的 targetProject 属性时,其路径都是相对于当前 Project 或 Module 的,不需要加前缀。例如当前的 Module 名称为 shop_02 时:

1
2
3
4
<javaModelGenerator targetPackage="deecyn.shop_02.mbg.model" targetProject="src/main/java"/>
<sqlMapGenerator targetPackage="mbg-mapper" targetProject="src/main/resources"/>
<javaClientGenerator type="XMLMAPPER" targetPackage="deecyn.shop_02.mbg.mapper"
targetProject="src/main/java"/>

否则会提示找不到对应的 java 和 resource 目录。

四、完整配置文件参考

1. 完整的 pom 配置文件

参考链接:Notes: mybatis-generator-pom

2. 完整的 MyBatis-Generator 配置文件

参考链接:Notes: mybatis-generator-config

五、参考