解放双手！MyBatis官方代码生成工具给力！
在我们使用MyBatis的过程中，如果所有实体类和单表CRUD代码都需要手写，那将会是一件相当麻烦的事情。MyBatis官方代码生成器MyBatis Generator可以帮助我们解决这个问题，在我的开源项目mall中也是使用的这个代码生成器，用习惯了也挺不错的。本文将介绍MyBatis Generator的使用方法及使用技巧，希望对大家有所帮助！
简介
MyBatis Generator（简称MBG）是MyBatis官方提供的代码生成工具。可以通过数据库表直接生成实体类、单表CRUD代码、mapper.xml文件，从而解放我们的双手！
开始使用
首先我们通过一个入门示例将MBG用起来，该示例会包含基础的CRUD操作。
集成MBG
在
pom.xml中添加如下依赖，主要添加了MyBatis、PageHelper、Druid、MBG和MySQL驱动等依赖；
org.mybatis.spring.boot
mybatis-spring-boot-starter
2.1.3
com.github.pagehelper
pagehelper-spring-boot-starter
1.3.0
com.alibaba
druid-spring-boot-starter
1.1.10
org.mybatis.generator
mybatis-generator-core
1.4.0
mysql
mysql-connector-java
8.0.15
在
application.yml中对数据源和MyBatis的mapper.xml文件路径进行配置，这里做个约定，MBG生成的放在resources/com/**/mapper目录下，自定义的放在resources/dao目录下；
# 数据源配置
spring:
datasource:
url: jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
username: root
password: root
# MyBatis mapper.xml路径配置
mybatis:
mapper-locations:
- classpath:dao/*.xml
- classpath*:com/**/mapper/*.xml
添加Java配置，用于扫码Mapper接口路径，这里还有个约定，MBG生成的放在
mapper包下，自定义的放在dao包下。
/**
* MyBatis配置类
* Created by macro on 2019/4/8.
*/
@Configuration
@MapperScan({"com.macro.mall.tiny.mbg.mapper","com.macro.mall.tiny.dao"})
public class MyBatisConfig {
}
使用代码生成器
在使用MBG生成代码前，我们还需要对其进行一些配置，首先在
generator.properties文件中配置好数据库连接信息；
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.password=root
然后在
generatorConfig.xml文件中对MBG进行配置，配置属性说明直接参考注释即可；
这里值得一提的是
targetRuntime这个属性，设置不同的属性生成的代码和生成代码的使用方式会有所不同，常用的有MyBatis3和MyBatis3DynamicSql两种，这里使用的是MyBatis3；如果你想自定义MBG生成的代码的话，可以自己写一个CommentGenerator来继承DefaultCommentGenerator，这里我自定义了实体类代码的生成，添加了Swagger注解的支持；
package com.macro.mall.tiny.mbg;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.CompilationUnit;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;
import java.util.Properties;
/**
* 自定义注释生成器
* Created by macro on 2018/4/26.
*/
public class CommentGenerator extends DefaultCommentGenerator {
private boolean addRemarkComments = false;
private static final String EXAMPLE_SUFFIX="Example";
private static final String MAPPER_SUFFIX="Mapper";
private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME="io.swagger.annotations.ApiModelProperty";
/**
* 设置用户配置的参数
*/
@Override
public void addConfigurationProperties(Properties properties) {
super.addConfigurationProperties(properties);
this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
}
/**
* 给字段添加注释
*/
@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {
String remarks = introspectedColumn.getRemarks();
//根据参数和备注信息判断是否添加备注信息
if(addRemarkComments&&StringUtility.stringHasValue(remarks)){
//数据库中特殊字符需要转义
if(remarks.contains("\"")){
remarks = remarks.replace("\"","'");
}
//给model的字段添加swagger注解
field.addJavaDocLine("@ApiModelProperty(value = \""+remarks+"\")");
}
}
@Override
public void addJavaFileComment(CompilationUnit compilationUnit) {
super.addJavaFileComment(compilationUnit);
//只在model中添加swagger注解类的导入
String fullyQualifiedName = compilationUnit.getType().getFullyQualifiedName();
if(!fullyQualifiedName.contains(MAPPER_SUFFIX)&&!fullyQualifiedName.contains(EXAMPLE_SUFFIX)){
compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME));
}
}
}
最后我们写个Generator类用于生成代码，直接运行main方法即可生成所有代码；
/**
* 用于生产MBG的代码
* Created by macro on 2018/4/26.
*/
public class Generator {
public static void main(String[] args) throws Exception {
//MBG 执行过程中的警告信息
List warnings = new ArrayList();
//当生成的代码重复时，覆盖原代码
boolean overwrite = true;
//读取我们的 MBG 配置文件
InputStream is = Generator.class.getResourceAsStream("/generatorConfig.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方法，生成代码结构信息如下。
实现基本的CRUD操作
这里使用的是
mall-tiny项目中权限管理功能相关表，具体可以参考《还在从零开始搭建项目？手撸了款快速开发脚手架！》。
查看下MBG生成的Mapper接口，发现已经包含了基本的CRUD方法，具体SQL实现也已经在mapper.xml中生成了，单表CRUD直接调用对应方法即可；
public interface UmsAdminMapper {
long countByExample(UmsAdminExample example);
int deleteByExample(UmsAdminExample example);
int deleteByPrimaryKey(Long id);
int insert(UmsAdmin record);
int insertSelective(UmsAdmin record);
List selectByExample(UmsAdminExample example);
UmsAdmin selectByPrimaryKey(Long id);
int updateByExampleSelective(@Param("record") UmsAdmin record, @Param("example") UmsAdminExample example);
int updateByExample(@Param("record") UmsAdmin record, @Param("example") UmsAdminExample example);
int updateByPrimaryKeySelective(UmsAdmin record);
int updateByPrimaryKey(UmsAdmin record);
}
生成代码中有一些Example类，比如UmsAdminExample，我们可以把它理解为一个条件构建器，用于构建SQL语句中的各种条件；
利用好MBG生成的代码即可完成单表的CRUD操作了，比如下面最常见的操作。
/**
* 后台用户管理Service实现类
* Created by macro on 2020/12/8.
*/
@Service
public class UmsAdminServiceImpl implements UmsAdminService {
@Autowired
private UmsAdminMapper adminMapper;
@Autowired
private UmsAdminDao adminDao;
@Override
public void create(UmsAdmin entity) {
adminMapper.insert(entity);
}
@Override
public void update(UmsAdmin entity) {
adminMapper.updateByPrimaryKeySelective(entity);
}
@Override
public void delete(Long id) {
adminMapper.deleteByPrimaryKey(id);
}
@Override
public UmsAdmin select(Long id) {
return adminMapper.selectByPrimaryKey(id);
}
@Override
public List listAll(Integer pageNum, Integer pageSize) {
PageHelper.startPage(pageNum, pageSize);
return adminMapper.selectByExample(new UmsAdminExample());
}
}
进阶使用
想要用好MBG，上面的基础操作是不够的，还需要一些进阶的使用技巧。
条件查询
使用Example类构建查询条件可以很方便地实现条件查询。
这里以按用户名和状态查询后台用户并按创建时间降序排列为例，SQL实现如下；
SELECT
id,
username,
PASSWORD,
icon,
email,
nick_name,
note,
create_time,
login_time,
STATUS
FROM
ums_admin
WHERE
( username = 'macro' AND STATUS IN ( 0, 1 ) )
ORDER BY
create_time DESC;
对应的Java代码实现如下。
/**
* 后台用户管理Service实现类
* Created by macro on 2020/12/8.
*/
@Service
public class UmsAdminServiceImpl implements UmsAdminService {
@Override
public List list(Integer pageNum, Integer pageSize, String username, List statusList) {
PageHelper.startPage(pageNum, pageSize);
UmsAdminExample umsAdminExample = new UmsAdminExample();
UmsAdminExample.Criteria criteria = umsAdminExample.createCriteria();
if(StrUtil.isNotEmpty(username)){
criteria.andUsernameEqualTo(username);
}
criteria.andStatusIn(statusList);
umsAdminExample.setOrderByClause("create_time desc");
return adminMapper.selectByExample(umsAdminExample);
}
}
子查询
使用MBG生成的代码并不能实现子查询，需要自己手写SQL实现。
这里以按角色ID查询后台用户为例，首先定义一个UmsAdminDao接口，这里约定下Dao里面存放的方法都是自定义SQL实现的方法，首先在Dao接口中添加
subList方法；
/**
* Created by macro on 2020/12/9.
*/
public interface UmsAdminDao {
List subList(@Param("roleId") Long roleId);
}
然后创建一个UmsAdminDao.xml文件，对应UmsAdminDao接口的SQL实现，写好对应的SQL实现，注意使用的resultMap MBG已经帮我们生成好了，无需自己手写。
SELECT *
FROM ums_admin
WHERE id IN (SELECT admin_id FROM ums_admin_role_relation WHERE role_id = #{roleId})
Group和Join查询
Group和Join查询也不能使用MBG生成的代码实现。
这里以按角色统计后台用户数量为例，首先在Dao接口中添加
groupList方法；
public interface UmsAdminDao {
List groupList();
}
然后在mapper.xml中添加对应的SQL实现，我们可以通过给查询出来的列起别名，直接把列映射到resultType所定义的对象中去。
SELECT ur.id AS roleId,
ur.NAME AS roleName,
count(ua.id) AS count
FROM ums_role ur
LEFT JOIN ums_admin_role_relation uarr ON ur.id = uarr.role_id
LEFT JOIN ums_admin ua ON uarr.admin_id = ua.id
GROUP BY ur.id;
条件删除
条件删除很简单，直接使用Example类构造删除条件即可。
这里以按用户名删除后台用户为例，SQL实现如下；
DELETE
FROM
ums_admin
WHERE
username = 'andy';
对应Java中的实现为。
/**
* 后台用户管理Service实现类
* Created by macro on 2020/12/8.
*/
@Service
public class UmsAdminServiceImpl implements UmsAdminService {
@Override
public void deleteByUsername(String username) {
UmsAdminExample example = new UmsAdminExample();
example.createCriteria().andUsernameEqualTo(username);
adminMapper.deleteByExample(example);
}
}
条件修改
条件删除很简单，直接使用Example类构造修改条件，然后传入修改参数即可。
这里以按指定ID修改后台用户的状态为例，SQL实现如下；
UPDATE ums_admin
SET STATUS = 1
WHERE
id IN ( 1, 2 );
对应Java中的实现为。
/**
* 后台用户管理Service实现类
* Created by macro on 2020/12/8.
*/
@Service
public class UmsAdminServiceImpl implements UmsAdminService {
@Override
public void updateByIds(List ids, Integer status) {
UmsAdmin record = new UmsAdmin();
record.setStatus(status);
UmsAdminExample example = new UmsAdminExample();
example.createCriteria().andIdIn(ids);
adminMapper.updateByExampleSelective(record,example);
}
}
一对多查询
一对多查询无法直接使用MBG生成的代码实现，需要手写SQL实现，并使用resultMap来进行结果集映射。
这里以按ID查询后台用户信息（包含对应角色列表）为例，先在Dao接口中添加
selectWithRoleList方法；
/**
* Created by macro on 2020/12/9.
*/
public interface UmsAdminDao {
AdminRoleDto selectWithRoleList(@Param("id") Long id);
}
然后在mapper.xml中添加对应的SQL实现，这里有个小技巧，可以给角色表查询出来的列取个别名，添加一个
role_前缀；
SELECT ua.*,
ur.id AS role_id,
ur.NAME AS role_name,
ur.description AS role_description,
ur.create_time AS role_create_time,
ur.STATUS AS role_status,
ur.sort AS role_sort
FROM ums_admin ua
LEFT JOIN ums_admin_role_relation uarr ON ua.id = uarr.admin_id
LEFT JOIN ums_role ur ON uarr.role_id = ur.id
WHERE ua.id = #{id}
然后定义一个叫做
AdminRoleResult的ResultMap，通过collection标签直接将以role_开头的列映射到UmsRole对象中去即可。
一对一查询
一对一查询无法直接使用MBG生成的代码实现，需要手写SQL实现，并使用resultMap来进行结果集映射。
这里以按ID查询资源信息（包括分类信息）为例，先在Dao接口中添加
selectResourceWithCate方法；
/**
* Created by macro on 2020/12/9.
*/
public interface UmsAdminDao {
ResourceWithCateDto selectResourceWithCate(@Param("id")Long id);
}
然后在mapper.xml中添加对应的SQL实现，可以给分类表查询出来的列取个别名，添加一个
cate_前缀；
SELECT ur.*,
urc.id AS cate_id,
urc.`name` AS cate_name,
urc.create_time AS cate_create_time,
urc.sort AS cate_sort
FROM ums_resource ur
LEFT JOIN ums_resource_category urc ON ur.category_id = urc.id
WHERE ur.id = #{id}
然后定义一个叫做
ResourceWithCateResult的ResultMap，通过association标签直接将以cate_开头的列映射到UmsResourceCategory对象中去即可。
总结
总的来说MyBatis官方代码生成器MBG还是很强大的，可以生成一些常用的单表CRUD方法，减少了我们的工作量。但是对于子查询、多表查询和一些复杂查询支持有点偏弱，依然需要在mapper.xml中手写SQL实现。
参考资料
官方文档：https://mybatis.org/generator/index.html
项目源码地址
https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-generator
推荐阅读
船新 IDEA 2020.3 正式发布，新特性真香！
给IDEA换个酷炫的主题，这几个有点哇塞啊！
DockerHub访问慢怎么破？自建个企业级镜像仓库试试！
CTO怒了：如果中台不省钱，我建个屁中台啊！
新来的小哥这样写代码！同事直呼“中毒了”~
当Swagger遇上YApi，瞬间高大上了！
还在使用第三方Docker插件？SpringBoot官方插件真香！
MacBook M1到底行不行？一枚程序猿的使用体验！
40K+Star！Mall电商实战项目开源回忆录！
mall-swarm 微服务电商项目发布重大更新，打造Spring Cloud最佳实践！
欢迎关注，点个在看