作者 | 阿进的写字台

链接 | www.cnblogs.com/homejim/p/9782403.html

在使用 mybatis 过程中， 当手写 JavaBean和XML 写的越来越多的时候， 就越来越同意出错。这种重复性的工作， 我们当然不希望做那么多。

还好， mybatis 为我们提供了强大的代码生成--MybatisGenerator。

通过简单的配置， 我们就可以生成各种类型的实体类， Mapper接口， MapperXML文件， Example对象等。通过这些生成的文件， 我们就可以方便的进行单表进行增删改查的操作。

Tips：关注微信公众号：Java后端，获取每日推送。

以下的工具使用的都是 IDEA

1.1 创建Maven项目

1.1.1 菜单上选择新建项目

File | New | Project

1.1.2 选择左侧的Maven

由于我们只是创建一个普通的项目， 此处点击 Next即可。

1.1.3 输入GroupId和ArtifactId

在我的项目中，

GroupId 填 com.homejim.mybatis

ArtifactId 填 mybatis-generator

点击 Next。

1.1.4Finish

通过以上步骤， 一个普通的Maven项目就创建好了。

1.2 配置 generator.xml

其实名字无所谓， 只要跟下面的 pom.xml 文件中的对应上就好了。

/p>

"-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"

"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >

driverClass="com.mysql.jdbc.Driver"

connectionURL="jdbc:mysql://localhost:3306/mybatis"

userId="root"

password="jim777"/>

targetPackage="com.homejim.mybatis.entity"

targetProject=".\src\main\java">

targetPackage="mybatis/mapper"

targetProject=".\src\main\resources">

targetPackage="com.homejim.mybatis.mapper"

targetProject=".\src\main\java">

需要改一些内容：

1. 本地数据库驱动程序jar包的全路径(必须要改)。

2. 数据库的相关配置(必须要改)

3. 相关表的配置(必须要改)

4. 实体类生成存放的位置。

5. MapperXML 生成文件存放的位置。

6. Mapper 接口存放的位置。

如果不知道怎么改， 请看后面的配置详解。

1.3 配置 pom.xml

在原基础上添加一些内容。

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

4.0.0

com.homejim.mybatis

mybatis-generator

1.0-SNAPSHOT

mybatis-generator

org.mybatis.generator

mybatis-generator-maven-plugin

1.3.7

src/main/resources/generator.xml

true

true

Generate MyBatis Artifacts

generate

org.mybatis.generator

mybatis-generator-core

1.3.7

需要注意的是 configurationFile 中的文件指的是 generator.xml。因此路径写的是该文件的相对路径， 名称也跟该文件相同。

到此， mybatis-generator 就可以使用啦。

1.4 使用及测试

1.4.1 打开 Maven Projects 视图

在 IDEA 上， 打开：

View | Tools | Windwos | Maven Projects

1.4.2 Maven Projects 中双击 mybatis-generator

在右侧此时可以看到 Maven Projects 了。找到 mybatis-generator 插件。

mybatis-generator | Plugins | mybatis-generator | mybatis-generator

1.4.3 双击运行

运行正确后， 生成代码， 得到如下的结构

仅仅是上面那么简单的使用还不够爽。那么我们就可以通过更改 generator.xml 配置文件的方式进行生成的配置。

2.1 文档

推荐查看官方的文档。

英文不错的：http://www.mybatis.org/generator/configreference/xmlconfig.html

中文翻译版：http://mbg.cndocs.ml/index.html

2.2 官网没有的

2.2.1 property 标签

该标签在官网中只是说用来指定元素的属性， 至于怎么用没有详细的讲解。

2.2.1.1 分隔符相关

以上的配置对应的是 mysql， 当数据库中的字段和数据库的关键字一样时， 就会使用分隔符。

比如我们的数据列是 delete, 按以上的配置后， 在它出现的地方， 就变成 `delete`。

2.2.1.2 编码

默认是使用当前的系统环境的编码， 可以配置为 GBK 或 UTF-8。

我想项目为 UTF-8， 如果指定生成 GBK， 则自动生成的中文就是乱码。

2.2.1.3 格式化

这些显然都是可以自定义实现的的。

2.2.2 plugins 标签

plugins 标签用来扩展或修改代码生成器生成的代码。

在生成的 XML 中， 是没有  这个标签的。该标签是配置缓存的。

如果我们想生成这个标签， 那么可以 plugins 中进行配置。

比如你想生成的 JavaBean 中自行实现 Serializable 接口。

还能自定义插件。

这些插件都蛮有用的， 感觉后续可以专门开一篇文章来讲解。

看名称， 就知道是用来生成注释用的。

默认配置：

suppressAllComments： 阻止生成注释， 默认值是false。

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

addRemarkComments: 注释中添加数据库的注释， 默认为 false。

还有一个就是我们可以通过 type 属性指定我们自定义的注解实现类， 生成我们自己想要的注解。自定义的实现类需要实现 org.mybatis.generator.api.CommentGenerator。

2.2.4 源码

https://github.com/homejim/mybatis-cn

推荐阅读

介绍一款贼美的Vue+Element开源后台管理UI

骚操作：不重启 JVM，如何替换掉已经加载的类？

放弃Spring Boot 中的 RestTemplate，我选择 Retrofit ！

腾讯 Git 规范出炉，写给开发者的指南!

最棒 Spring Boot 干货总结(超详细，建议收藏)

我的天，Spring Boot 居然还有 Plus 版本