1.前言
MyBatis-Plus (简称 MP)是Mybatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
本章主要是配置MP及代码自动生成器相关测试,没有介绍MP主要功能使用。
MyBatis-Plus在3.5.1版本之后,改变了代码生成器的用法,由于对历史版本的不兼容,这次重新梳理一份新的用法。
2.特性
无侵入
:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑。损耗小
:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作。强大的 CRUD 操作
:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求。支持 Lambda 形式调用
:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错。支持主键自动生成
:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题。支持 ActiveRecord 模式
:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作。支持自定义全局通用操作
:支持全局通用方法注入( Write once, use anywhere )。内置代码生成器
:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用。内置分页插件
:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询。分页插件支持多种数据库
:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库。内置性能分析插件
:可输出 SQL 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询。内置全局拦截插件
:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作。
3.开始使用
(1)创建一个SpringBoot工程项目。
环境:
开发工具:IDEA、JDK版本:1.8、SpringBoot版本:2.5.1(建议不要大于2.6.0版本,因为新特性在启动项目时会报循环引用错误。),选择添加模块:SpringWeb/MySQL Driver。
(2)工程准备好之后,在pom.xml
中引入mybatis-plus+mysql
及相关依赖:
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
<scope>provided</scope>
</dependency>
<!--阿里 JSON-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.78</version>
</dependency>
<!--swagger 接口说明文档框架-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<!-- freemarker模板引擎,代码自动生成时调用 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
<!-- Mybatis-Plus start MyBatis-Plus代码生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
<!-- mybatis plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
(3)MySQL建表,增加两条测试用户数据:
DROP TABLE IF EXISTS `t_user_login`;
CREATE TABLE `t_user_login` (
`user_id` int(0) NOT NULL AUTO_INCREMENT COMMENT '登录自增ID',
`user_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '登录名',
`pass_word` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '登录密码',
PRIMARY KEY (`user_id`) USING BTREE,
UNIQUE INDEX `AK_Key_2`(`user_name`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 3 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci COMMENT = '用户登录表' ROW_FORMAT = Dynamic;
INSERT INTO `t_user_login` VALUES (1, 'admin', 'admin');
INSERT INTO `t_user_login` VALUES (2, 'root', 'root');
(4)依赖准备好后,创建Java类,在main()方法中:配置连接mysql数据库信息+调用自动生成API并设置各类参数,根据自定义策略,执行自动生成代码操作。这里新建一个
FastAutoGeneratorTest.java
,提供主方法main()。package com.demo.utils;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.TemplateType;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.LikeTable;
import com.baomidou.mybatisplus.generator.config.querys.MySqlQuery;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.keywords.MySqlKeyWordsHandler;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* @Author zf
* @ClassName MPG.java
* @ProjectName demo
*/
public class MPG {
/**
* 数据源配置
*/
private static final DataSourceConfig.Builder DATA_SOURCE_CONFIG = new DataSourceConfig
.Builder("jdbc:mysql://localhost:3306/test", "root", "abc123")
.dbQuery(new MySqlQuery()) //数据库查询
.schema("mybatis-plus") //数据库schema(部分数据库适用)
.typeConvert(new MySqlTypeConvert()) //数据库类型转换器
.keyWordsHandler(new MySqlKeyWordsHandler()); //数据库关键字处理器
/**
* 执行 run
*/
public static void main(String[] args) {
//要生成的表
List<String> list = new ArrayList<>();
list.add("INVITE_RECORD");
//模糊表匹配
String likeTable = "INVITE_RECORD";
//过滤表前缀
String tablePrefix = "INVITE_";
FastAutoGenerator.create(DATA_SOURCE_CONFIG)
// 全局配置
.globalConfig((scanner, builder) -> builder
//.fileOverride() //覆盖已生成文件,默认值:false
.outputDir(System.getProperty("user.dir") + "/src/main/java") //指定输出目录,默认值: windows:D://
.author(scanner.apply("请输入开发者名称:"))//作者名,baomidou 默认值:作者
.dateType(DateType.TIME_PACK)//时间策略,DateType.ONLY_DATE 默认值: DateType.TIME_PACK
.commentDate("yyyy-MM-dd")//注释日期,默认值: yyyy-MM-dd
//.disableOpenDir()// 禁止打开输出目录,默认值:true
//.enableKotlin() //开启 kotlin 模式,默认值:false
.enableSwagger() //开启 swagger 模式,默认值:false
.build()//加入构建队列
)
// 包配置
.packageConfig((scanner, builder) -> builder
.parent(scanner.apply("请输入包名:"))//父包名,默认值:com.baomidou
//.moduleName("sys")//父包模块名,默认值:无
.entity("entity")//Entity 包名,默认值:entity
.service("service")//Service 包名,默认值:service
.serviceImpl("service.impl")//Service Impl 包名,默认值:service.impl
.mapper("mapper")//Mapper 包名,默认值:mapper
.xml("mapper.xml")//Mapper XML 包名,默认值:mapper.xml
.controller("controller")//Controller 包名,默认值:controller
//.other("other")//自定义文件包名, 输出自定义文件时所用到的包名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, "src/main/resources/mapper")) //路径配置信息,Collections.singletonMap(OutputFile.mapperXml, "D://")
.build()//加入构建队列
)
//模板配置
.templateConfig((scanner, builder) -> builder
//.disable()//禁用所有模板
//.entityKt("/templates/entity.java")// 设置实体模板路径(kotlin),/templates/entity.java
.disable(TemplateType.ENTITY)//禁用模板 TemplateType.ENTITY
.entity("/templates/entity.java") //设置实体模板路径(JAVA),/templates/entity.java
.service("/templates/service.java")//设置 service 模板路径,/templates/service.java
.serviceImpl("/templates/serviceImpl.java")//设置 serviceImpl 模板路径,/templates/serviceImpl.java
.mapper("/templates/mapper.java")//设置 mapper 模板路径,/templates/mapper.java
.mapperXml("/templates/mapper.xml")//设置 mapperXml 模板路径,/templates/mapper.xml
.controller("/templates/controller.java")//设置 controller 模板路径,/templates/controller.java
.build()//加入构建队列
)
//注入配置————自定义模板
.injectionConfig(builder -> builder
.beforeOutputFile((tableInfo, objectMap) -> {
System.out.println("tableInfo: " + tableInfo.getEntityName() + " objectMap: " + objectMap.size());
}) //输出文件之前消费者
.customMap(Collections.singletonMap("my_field", "你好!这是我自己注入的属性哦.")) //自定义配置 Map 对象
//.customFile(Collections.singletonMap("test.txt", "/templates/test.vm")) //自定义配置模板文件
.build()//加入构建队列
)
// 策略配置
/**
* schema:在数据库中表示的是数据库对象集合,它包含了各种对像,比如:表,视图,存储过程,索引等等。
* 一般情况下一个用户对应一个集合,所以为了区分不同的集合就需要给不同的集合起名字。
* 用户的schema名就相当于用户名,并作为该用户缺省schema。所以说schema集合看上去像用户名。
* 例如当我们访问一个数据表时,如果该表没有指明属于哪个schema,系统就会自动的加上缺省的schema。
*/
.strategyConfig(builder -> builder
/** 基本参数配置 */
.enableCapitalMode()//开启大写命名,默认值:false
.enableSkipView()//开启跳过视图,默认值:false
.disableSqlFilter()//禁用 sql 过滤,默认值:true,语法不能支持使用 sql 过滤表的话,可以考虑关闭此开关
.likeTable(new LikeTable(likeTable))//模糊表匹配(sql 过滤) likeTable 与 notLikeTable 只能配置一项
/** 设置需要生成的表名 */
.addInclude(list)// 增加表匹配(内存过滤),include 与 exclude 只能配置一项
/** 前缀配置*/
// .addTablePrefix(tablePrefix)//增加过滤表前缀
//.addFieldSuffix("_")//增加过滤表后缀
//.addFieldPrefix("ul_")//增加过滤字段前缀 本人不建议使用,去掉后缀,会导致驼峰命名实体类的变量名不带前缀,去掉后,错误:Username,正确:ulUsername
//.addFieldSuffix("_")//增加过滤字段后缀
/** 实体策略配置 */
.entityBuilder()//实体策略配置
.disableSerialVersionUID()//禁用生成 serialVersionUID,默认值:true
.enableLombok()//开启 lombok 模型,默认值:false
.enableChainModel()//开启链式模型,默认值:false
.enableRemoveIsPrefix()//开启 Boolean 类型字段移除 is 前缀,默认值:false
.enableTableFieldAnnotation()//开启生成实体时生成字段注解,默认值:false
.enableActiveRecord()//开启 ActiveRecord 模型,默认值:false
.naming(NamingStrategy.underline_to_camel)//数据库表映射到实体的命名策略,默认下划线转驼峰命名:NamingStrategy.underline_to_camel
.columnNaming(NamingStrategy.underline_to_camel)//数据库表字段映射到实体属性的命名策略,默认为 null,未指定按照 naming 执行
.idType(IdType.AUTO)//全局主键类型
.formatFileName("%sBean")//格式化文件名称,生成实体的后缀,建议这样使用,生成后:UserLoginBean
//.superClass(BaseEntity.class)//设置父类
//.enableColumnConstant()//开启生成字段常量,默认值:false
//.addIgnoreColumns("age")//添加忽略字段
//.nameConvert(INameConvert)//名称转换实现
//.versionColumnName("version")//乐观锁字段名(数据库)
//.versionPropertyName("version")//乐观锁属性名(实体)
//.logicDeleteColumnName("deleted")//逻辑删除字段名(数据库)
//.logicDeletePropertyName("deleteFlag")//逻辑删除属性名(实体)
//.enableSchema()//启用 schema,默认值:false,多 schema 场景的时候打开
//.addExclude("t_simple")//增加表排除匹配(内存过滤),include 与 exclude 只能配置一项
//.notLikeTable(new LikeTable("USER"))//模糊表排除(sql 过滤) likeTable 与 notLikeTable 只能配置一项
/** controller 策略配置 */
.controllerBuilder()//controller 策略配置
.enableHyphenStyle()//开启驼峰转连字符,默认值:false
.enableRestStyle()//开启生成@RestController 控制器,默认值:false
.formatFileName("%sController")//格式化文件名称——controller包下自动生成的类后缀,例如UserLoginController
/** Service 策略配置 */
.serviceBuilder()//service 策略配置
.formatServiceFileName("%sService")//转换 service 接口文件名称,例如:UserLoginService
.formatServiceImplFileName("%sServiceImpl")//转换 service 实现类文件名称,例如:UserLoginServiceImpl
/** mapper 策略配置 */
.mapperBuilder()//mapper 策略配置
.superClass(BaseMapper.class)//设置父类,BaseMapper是com.baomidou.mybatisplus.core.mapper中的
.enableMapperAnnotation()//开启 @Mapper 注解,默认值:false
.enableBaseResultMap()//启用 BaseResultMap 生成,默认值:false
.enableBaseColumnList()//启用 BaseColumnList,默认值:false
.formatMapperFileName("%sMapper")//转换 mapper 接口文件名称后缀,mapper目录下的,例如:UserLoginMapper(有@Mapper)
.formatXmlFileName("%sMapper")//转换 xml 文件名称后缀,例如:UserLoginMapper.xml,Mybatis的xml映射文件
.build()//加入构建队列
)
/**
* 模板引擎
*/
//Velocity
//.templateEngine(new VelocityTemplateEngine())
//Beetl
//.templateEngine(new BeetlTemplateEngine())
//Freemarker
.templateEngine(new FreemarkerTemplateEngine())
/**
* 开始自动生成代码,执行队列构建操作
*/
.execute();
}
}
@MapperScan("com.demo.mapper")
。注意:自动生成的映射xml文件,需要在配置文件声明。yml格式配置样式:
# SpringBoot资源配置
spring:
datasource:
name: test #数据库名
url: jdbc:mysql://localhost:3306/test?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=Asia/Shanghai #url
username: root #用户名
password: abc123 #密码
driver-class-name: com.mysql.cj.jdbc.Driver #数据库链接驱动
# 启动默认端口
server:
port: 8085
mybatis-plus:
mapper-locations: classpath*:mapper/*Mapper.xml # 根据项目工程更改
type-aliases-package: com.demo.entity #根据项目工程更改
configuration:
cache-enabled: false
map-underscore-to-camel-case: true
auto-mapping-behavior: full
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # mybatis打印日志
global-config:
# 逻辑删除配置
db-config:
#id-type: AUTO
# 删除前
logic-not-delete-value: 1
# 删除后
logic-delete-value: 0
(5)到这里所有的准备工程已完成,下面测试自动生成代码自带的CRUD能否获取MySQL数据库的用户表信息。
4.测试实例
UserLoginController(测试自带的[CRUD]):
(1)写个简单的接口测试数据:
@RestController
@RequestMapping("/user-login-bean")
public class UserLoginController {
/** 常规写法:Spring容器中查询对应类型的bean,然后根据名称来查找资源 */
@Autowired
UserLoginService userLoginService;
//浏览器访问 http://localhost:8085/user-login-bean/getUserById
@RequestMapping("/getUserById")
public UserLoginBean getUserById(){
//getById是mybatisplus封装好的,通过ID值,查找映射表中的信息
return userLoginService.getById(1);
}
}
(2)运行SpringBoot工程:
(3)浏览器URL地址栏键入:http://localhost:8085/user-login-bean/getUserById
页面返回数据:{"userId":1,"userName":"admin","passWord":"admin"}
5.自定义SQL语句
上面测试的是MyBatis-Plus代码自动生成的测试,显然单表的CRUD不符合我们的开发需求,那下面演示一下,在Mapper.xml映射文件中,自定义SQL语句,然后通过Bean、Mapper、Service、Controller、是否能成功查询用户登录表信息,废话不多说,开始!
(1)UserLoginMapper.xml,增添findAllUser内容:
<!-- 查询全部用户信息,t_user_login:是我MySQL数据中的用户登录表,可以改为自己的 -->
<select id="findAllUser" resultType="com.demo.entity.UserLoginBean">
select * from t_user_login
</select>
(2)UserLoginMapper接口,增添findAllUser内容:
@Mapper
public interface UserLoginMapper extends BaseMapper<UserLoginBean> {
List<UserLoginBean> findAllUser();
}
(3)UserLoginService接口,增添findAllUser内容:
public interface UserLoginService extends IService<UserLoginBean> {
List<UserLoginBean> findAllUser();
}
(4)UserLoginServiceImpl服务实现类,注入Mapper的findAllUser()方法:
@Service
public class UserLoginServiceImpl extends ServiceImpl<UserLoginMapper, UserLoginBean> implements UserLoginService {
@Autowired
UserLoginMapper userLoginMapper;
@Override
public List<UserLoginBean> findAllUser() {
return userLoginMapper.findAllUser();
}
}
(5)UserLoginService接口,增添findAllUser内容:
@RestController
@RequestMapping("/user-login-bean")
public class UserLoginController {
/** 常规写法:Spring容器中查询对应类型的bean,然后根据名称来查找资源 */
@Autowired
UserLoginService userLoginService;
//浏览器访问 http://localhost:8085/user-login-bean/getUserById
@RequestMapping("/getUserById")
public UserLoginBean getUserById(){
//getById是mybatisplus封装好的,通过ID值,查找映射表中的信息
return userLoginService.getById(1);
}
//浏览器访问 http://localhost:8085/user-login-bean/findAllUser
@RequestMapping("/findAllUser")
public List<UserLoginBean> findAllUser(){
//findAllUser() 是自定义的SQL查询映射方法——查询t_user_login表中全部用户信息
return userLoginService.findAllUser();
}
}
(6)重新运行SpringBoot工程项目,浏览器URL键入:http://localhost:8085/user-login-bean/findAllUser
页面返回数据:[{"userId":1,"userName":"admin","passWord":"admin"},{"userId":2,"userName":"root","passWord":"root"}]
6.Swagger2接口文档配置类
回忆一下,我们是不是在pom.xml文件引入了Swagger2和它的ui的依赖,还有在全局配置中开启了Swagger的自动文档生成的方法:
——“.enableSwagger() //开启 swagger 模式,默认值:false”
——pom.xml
<!--swagger 接口说明文档框架-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
如果不引入Swagger2
依赖,当你运行项目后,会在entity
中的UserLoginBean
发现报错,解决方法,添加以上两个依赖。
重点:你以为添加了依赖就行了?这里还需要Swagger2
配置类,才能访问接口文档首页。在工程目录config中新建Swagger2Config.java
配置类,代码如下:
/**
* 描述:Swagger接口文档配置类+添加摘要信息
*
* @author youthme.org
*/
@Configuration //标记配置类
@EnableSwagger2 //是springfox提供的一个注解,代表swagger2相关技术开启,会扫描当前类所在包,及子包中所有的类型中的注解。做swagger文档的定值。
public class Swagger2Config {
@Bean
public Docket buildDocket(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(buildApiInf())
.select()
.apis(RequestHandlerSelectors.basePackage("com.demo")) //这里必须与包名一致,否则报错
.paths(PathSelectors.any())
.build();
}
private ApiInfo buildApiInf(){
return new ApiInfoBuilder()
.title("YouthMe示例")
.description("一个用于演示的Swagger2文档。")
.termsOfServiceUrl("http://youthme.org/")
.contact(new Contact("柚子蜜", "http://youthme.org/", null))
.build();
}
}
浏览器访问Swagger2文档首页:http://localhost:8085/swagger-ui.html
补充:
MyBatis-Plus时间自动填充处理类,需要配置此项才能在新增和修改数据时自动添加或更新时间字段:
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
/**
* 自动填充处理类
* @author zf
* @version 1.0
* @see
**/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
this.strictInsertFill(metaObject, "updateTime", Date.class, new Date());
}
@Override
public void updateFill(MetaObject metaObject) {
this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
}
}
MyBatis-Plus分页配置:
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import java.util.Collections;
@EnableTransactionManagement
@Configuration
@MapperScan("com.demo.mapper")
public class MybatisPlusConfig {
/**
* 分页插件 3.5.X
* @author zf
*/
@Bean
public PaginationInnerInterceptor paginationInnerInterceptor() {
PaginationInnerInterceptor paginationInterceptor = new PaginationInnerInterceptor();
// 设置最大单页限制数量,默认 500 条,-1 不受限制
paginationInterceptor.setMaxLimit(-1L);
paginationInterceptor.setDbType(DbType.MYSQL);
// 开启 count 的 join 优化,只针对部分 left join
paginationInterceptor.setOptimizeJoin(true);
return paginationInterceptor;
}
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
mybatisPlusInterceptor.setInterceptors(Collections.singletonList(paginationInnerInterceptor()));
return mybatisPlusInterceptor;
}
}