程序员的成长之路
互联网/程序员/技术/资料共享
关注
阅读本文大概需要 12 分钟。
来自：/post/7054726274362638350
本文主要介绍 mybatis-plus 这款插件，针对 springboot 用户。包括引入，配置，使用，以及扩展等常用的方面做一个汇总整理，尽量包含大家常用的场景内容。
原文链接：/post/7054726274362638350 作者：我犟不过你
关于 mybatis-plus 是什么，不多做介绍了，看官方文档：/，咱们直接代码撸起来。
一、快速开始
本文基于 springboot、maven、jdk1.8、mysql 开发，所以开始前我们需要准备好这套环境。我的环境使用了 nacos 作为注册中心，不了解或需要搭建的参考：
/post/7053977860612030477)
新建如下数据库：
建议大家选择 utf8mb4 这种字符集，做过微信的同学应该会知道，微信用户名称的表情，是需要这种字符集才能存储的。
我就默认其他环境已经准备好了，咱们直接从 mybatis-plus 开始。
1.1 依赖准备
想要什么依赖版本的去 maven 仓库查看：
/
引入 mybatis-plus 依赖：
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.0</version></dependency>
引入 mysql 依赖：
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.27</version></dependency>
目前，多数项目会有多数据源的要求，或者是主从部署的要求，所以我们还需要引入 mybatis-plus 关于多数据源的依赖：
<!--mybatis-plus多数据源--><dependency><groupId>com.baomidou</groupId><artifactId>dynamic-datasource-spring-boot-starter</artifactId><version>3.5.0</version></dependency>
1.2 配置准备
springboot 启动类。配置@MapperScan 注解，用于扫描 Mapper 文件位置:
importorg.mybatis.spring.annotation.MapperScan;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.cloud.client.discovery.EnableDiscoveryClient;@EnableDiscoveryClient@MapperScan(\"com.wjbgn.user.mapper\")@SpringBootApplicationpublicclassRobNecessitiesUserApplication{publicstaticvoidmain(String[]args){SpringApplication.run(RobNecessitiesUserApplication.class,args);}}
数据源配置，此处配置一主一从的环境，当前我只有一台，所以此处配置一样的：
spring:datasource:dynamic:primary:master#设置默认的数据源或者数据源组,默认值即为masterstrict:false#严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源datasource:master:url:jdbc:mysql://127.0.0.1:3306/rob_necessities?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghaiusername:rootpassword:123456slave_1:url:jdbc:mysql://127.0.0.1:3306/rob_necessities?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghaiusername:rootpassword:123456
补充：这里面因为默认使用的是HikariCP数据源,目前也推荐使用这个，相比于druid有更高的性能，但是不能忽略下面的配置，否则服务会不断抛出异常，原因是数据库的连接时常和连接池的配置没有做好。
spring:datasource:dynamic:hikari:max-lifetime:1800000connection-timeout:5000idle-timeout:3600000max-pool-size:12min-idle:4connection-test-query:/**ping*/
1.3 启动服务
下面直接启动服务：
得到如上结果表示启动成功了。
二、使用
前面我们成功的集成进来了 mybatis-plus，配合 springboot 使用不要太方便。下面我们看看如何使用它来操作我们的数据库。介绍一下常规的用法。
2.1 实体类注解
mybatis-plus 为使用者封装了很多的注解，方便我们使用，我们首先看下实体类中有哪些注解。有如下的实体类：
@TableName(value=\"user\")publicclassUserDO{/***主键*/@TableId(value=\"id\",type=IdType.AUTO)privateLongid;/***昵称*/@TableField(\"nickname\")privateStringnickname;/***真实姓名*/privateStringrealName;}
@TableName 表名注解，用于标识实体类对应的表。
其说明如下，关于这些书写，常规情况基本很少用到，不做多余解释了：
@Documented@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.ANNOTATION_TYPE})public@interfaceTableName{/***实体对应的表名*/Stringvalue()default\"\";/***schema**@since3.1.1*/Stringschema()default\"\";/***是否保持使用全局的tablePrefix的值*<p>只生效于既设置了全局的tablePrefix也设置了上面{@link#value()}的值</p>*<li>如果是false,全局的tablePrefix不生效</li>**@since3.1.1*/booleankeepGlobalPrefix()defaultfalse;/***实体映射结果集,*只生效与mp自动注入的method*/StringresultMap()default\"\";/***是否自动构建resultMap并使用,*只生效与mp自动注入的method,*如果设置resultMap则不会进行resultMap的自动构建并注入,*只适合个别字段设置了typeHandler或jdbcType的情况**@since3.1.2*/booleanautoResultMap()defaultfalse;/***需要排除的属性名**@since3.3.1*/String[]excludeProperty()default{};}
@TableId 主键注解
看看其源码：
@Documented@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.FIELD,ElementType.ANNOTATION_TYPE})public@interfaceTableId{/***字段值（驼峰命名方式，该值可无）*/Stringvalue()default\"\";/***主键ID*{@linkIdType}*/IdTypetype()defaultIdType.NONE;}
其中 IdType 很重要：
名称
描述
@TableFiled 表字段标识
下面看看其主要常用属性：
名称
描述
关于其他的属性，我不太推荐使用，用得越多，越容易蒙圈。可以通过 wapper 查询去设置。
2.2 CRUD
mybatis-plus 封装好了一条接口供我们直接调用。关于内部的具体方法，在使用时候自己体会吧，此处不列举了。
2.2.1 Service 层 CRUD
我们使用的时候，需要在自己定义的 service 接口当中继承IService接口：
importcom.baomidou.mybatisplus.extension.service.IService;importcom.wjbgn.user.entity.UserDO;/***@description：用户服务接口*@author：weirx*@date：/1/17 15:02*@version：3.0*/publicinterfaceIUserServiceextendsIService<UserDO>{}
同时要在我们的接口实现 impl 当中继承ServiceImpl，实现自己的接口：
importcom.baomidou.mybatisplus.extension.service.impl.ServiceImpl;importcom.wjbgn.user.entity.UserDO;importcom.wjbgn.user.mapper.UserMapper;importcom.wjbgn.user.service.IUserService;/***@description：用户接口实现*@author：weirx*@date：/1/17 15:03*@version：3.0*/publicclassUserServiceImplextendsServiceImpl<UserMapper,UserDO>implementsIUserService{}
所以我们的
2.2.2 Mapper 层 CRUD
mybatis-plus 将常用的 CRUD 接口封装成了BaseMapper接口,我们只需要在自己的 Mapper 中继承它就可以了：
/***@description：用户mapper*@author：weirx*@date：/1/17 14:55*@version：3.0*/@MapperpublicinterfaceUserMapperextendsBaseMapper<UserDO>{}
2.3 分页
使用分页话需要增加分页插件的配置：
importcom.baomidou.mybatisplus.annotation.DbType;importcom.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;importcom.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;importorg.mybatis.spring.annotation.MapperScan;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;@Configuration@MapperScan(\"com.wjbgn.*.mapper*\")publicclassMybatisPlusConfig{@BeanpublicMybatisPlusInterceptormybatisPlusInterceptor(){MybatisPlusInterceptorinterceptor=newMybatisPlusInterceptor();interceptor.addInnerInterceptor(newPaginationInnerInterceptor(DbType.MYSQL));returninterceptor;}}
如上配置后，我们直接使用分页方法就行。
2.4 逻辑删除配置
很多情况下我们的系统都需要逻辑删除，方便恢复查找误删除的数据。
通过 mybatis-plus 可以通过全局配置的方式，而不需要再去手动处理。针对更新和查询操作有效，新增不做限制。
通常以我的习惯逻辑删除字段通常定义为is_delete,在实体类当中就是isDelete。那么在配置文件中就可以有如下的配置：
mybatis-plus:global-config:db-config:logic-delete-field:isDelete#全局逻辑删除的实体字段名(since3.3.0,配置后可以忽略不配置步骤2)logic-delete-value:1#逻辑已删除值(默认为1)logic-not-delete-value:0#逻辑未删除值(默认为0)
或者通过注解@TableLogic
@TableLogicprivateIntegerisDelete;
2.5 通用枚举配置
相信后端的同学都经历过一个情况，比如性别这个字段，分别值和名称对应1男、2女,这个字段在数据库时是数值类型，而前端展示则是展示字符串的名称。有几种常见实现方案呢？
数据库查询 sql 通过 case 判断，返回名称，以前 oracle 经常这么做
数据库返回的值，重新遍历赋值进去，这时候还需要判断这个值到底是男是女。
前端写死，返回 1 就是男，返回 2 就是女。
相信无论哪种方法都有其缺点，所以我们可以使用 mybatis-plus 提供的方式。我们在返回给前端时：
只需要在遍历时 get 这个枚举，直接赋值其名称，不需要再次判断。
直接返回给前端，让前端去去枚举的 name
这样大家都不需要写死这个值。
下面看看如何实现这个功能：
兴义枚举，实现 IEnum 接口：
importcom.baomidou.mybatisplus.annotation.IEnum;importcom.fasterxml.jackson.annotation.JsonFormat;/***@description：性别枚举*@author：weirx*@date：/1/17 16:26*@version：3.0*/@JsonFormat(shape=JsonFormat.Shape.OBJECT)publicenumSexEnumimplementsIEnum<Integer>{MAN(1,\"男\"),WOMAN(2,\"女\");privateIntegercode;privateStringname;SexEnum(Integercode,Stringname){this.code=code;this.name=name;}@OverridepublicIntegergetValue(){returncode;}publicStringgetName(){returnname;}}
@JsonFormat 注解为了解决枚举类返回前端只展示构造器名称的问题。
实体类性别字段
@TableName(value=\"user\")publicclassUserDO{/***主键*/@TableId(value=\"id\",type=IdType.AUTO)privateLongid;/***昵称*/@TableField(value=\"nickname\",condition=SqlCondition.EQUAL)privateStringnickname;/***性别*/@TableField(value=\"sex\")privateSexEnumsex;/***版本*/@TableField(value=\"version\",update=\"%s+1\")privateIntegerversion;/***时间字段，自动添加*/@TableField(value=\"create_time\",fill=FieldFill.INSERT)privateLocalDateTimecreateTime;}
配置文件扫描枚举
mybatis-plus:#支持统配符*或者;分割typeEnumsPackage:com.wjbgn.*.enums
定义配置文件
@BeanpublicMybatisPlusPropertiesCustomizermybatisPlusPropertiesCustomizer(){returnproperties->{GlobalConfigglobalConfig=properties.getGlobalConfig();globalConfig.setBanner(false);MybatisConfigurationconfiguration=newMybatisConfiguration();configuration.setDefaultEnumTypeHandler(MybatisEnumTypeHandler.class);properties.setConfiguration(configuration);};}
序列化枚举值为数据库值
以下我是使用的 fastjson：
全局（添加在前面的配置文件中）：
@BeanpublicMybatisPlusPropertiesCustomizermybatisPlusPropertiesCustomizer(){//序列化枚举值为数据库存储值FastJsonConfigconfig=newFastJsonConfig();config.setSerializerFeatures(SerializerFeature.WriteEnumUsingToString);returnproperties->{GlobalConfigglobalConfig=properties.getGlobalConfig();globalConfig.setBanner(false);MybatisConfigurationconfiguration=newMybatisConfiguration();configuration.setDefaultEnumTypeHandler(MybatisEnumTypeHandler.class);properties.setConfiguration(configuration);};}
局部
@JSONField(serialzeFeatures=SerializerFeature.WriteEnumUsingToString)privateSexEnumsex;
2.6 自动填充
还记得前面提到的实体类当中的注解@TableFeild吗？当中有个属性叫做 fill，通过FieldFill设置属性，这个就是做自动填充用的。
publicenumFieldFill{/***默认不处理*/DEFAULT,/***插入填充字段*/INSERT,/***更新填充字段*/UPDATE,/***插入和更新填充字段*/INSERT_UPDATE}
但是这个直接是不能使用的，需要通过实现 mybatis-plus 提供的接口，增加如下配置：
importcom.baomidou.mybatisplus.core.handlers.MetaObjectHandler;importorg.apache.ibatis.reflection.MetaObject;importorg.ponent;importjava.time.LocalDateTime;/***description:启动自动填充功能*@return:*@author:weirx*@time:/1/1717:00*/@ComponentpublicclassMyMetaObjectHandlerimplementsMetaObjectHandler{@OverridepublicvoidinsertFill(MetaObjectmetaObject){//起始版本3.3.0(推荐使用)this.strictInsertFill(metaObject,\"createTime\",LocalDateTime.class,LocalDateTime.now());}@OverridepublicvoidupdateFill(MetaObjectmetaObject){//起始版本3.3.0(推荐)this.strictUpdateFill(metaObject,\"updateTime\",LocalDateTime.class,LocalDateTime.now());}}
字段如下：
/***时间字段，自动添加*/@TableField(value=\"create_time\",fill=FieldFill.INSERT)privateLocalDateTimecreateTime;
2.7 多数据源
前面提到过，配置文件当中配置了主从的方式，其实 mybatis-plus 还支持更多的方式：
多主多从
spring:datasource:dynamic:primary:master#设置默认的数据源或者数据源组,默认值即为masterstrict:false#严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源datasource:master_1:master_2:slave_1:slave_2:slave_3:
多种数据库
spring:datasource:dynamic:primary:mysql#设置默认的数据源或者数据源组,默认值即为masterstrict:false#严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源datasource:mysql:oracle:postgresql:h2:sqlserver:
混合配置
spring:datasource:dynamic:primary:master#设置默认的数据源或者数据源组,默认值即为masterstrict:false#严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源datasource:master_1:slave_1:slave_2:oracle_1:oracle_2:
上面的三种方式，除了混合配置，我觉得都有肯能出现的吧。
@DS 注解
可以注解在方法上或类上，同时存在就近原则 【方法上注解】 优先于 【类上注解】：
@DS(\"slave_1\")publicclassUserServiceImplextendsServiceImpl<UserMapper,UserDO>implementsIUserService{@DS(\"salve_1\")@OverridepublicList<UserDO>getList(){returnthis.getList();}@DS(\"master\")@OverridepublicintsaveUser(UserDOuserDO){booleansave=this.save(userDO);if(save){return1;}else{return0;}}}
三、测试
经过上面的配置，下面开始进入测试验证阶段。
建立一张表：
CREATETABLE`user`(`id`int(11)NOTNULLAUTO_INCREMENT,`nickname`varchar(255)NOTNULLCOMMENT'昵称',`sex`tinyint(1)NOTNULLCOMMENT'性别，1男2女',`create_time`datetimeNOTNULLCOMMENT'创建时间',`is_delete`tinyint(1)NOTNULLDEFAULT'0'COMMENT'是否删除1是，0否',PRIMARYKEY(`id`))ENGINE=InnoDBAUTO_INCREMENT=50DEFAULTCHARSET=utf8mb4;
controller：
/***@description：用户controller*@author：weirx*@date：/1/17 17:39*@version：3.0*/@RestController@RequestMapping(\"/user\")publicclassUserController{@AutowiredprivateIUserServiceuserService;/***description:新增*@return:boolean*@author:weirx*@time:/1/1719:11*/@RequestMapping(\"/save\")publicbooleansave(){UserDOuserDO=newUserDO();userDO.setNickname(\"大漂亮\");userDO.setSex(SexEnum.MAN);returnuserService.save(userDO);}/***description:修改*@paramnickname*@paramid*@return:boolean*@author:weirx*@time:/1/1719:11*/@RequestMapping(\"/update\")publicbooleanupdate(@RequestParamStringnickname,@RequestParamLongid){UserDOuserDO=newUserDO();userDO.setNickname(nickname);userDO.setId(id);returnuserService.updateById(userDO);}/***description:删除*@paramid*@return:boolean*@author:weirx*@time:/1/1719:11*/@RequestMapping(\"/delete\")publicbooleandelete(@RequestParamLongid){UserDOuserDO=newUserDO();userDO.setId(id);returnuserService.removeById(userDO);}/***description:列表*@return:java.util.List<com.wjbgn.user.entity.UserDO>*@author:weirx*@time:/1/1719:11*/@RequestMapping(\"/list\")publicList<UserDO>list(){returnuserService.list();}/***description:分页列表*@paramcurrent*@paramsize*@return:com.baomidou.mybatisplus.extension.plugins.pagination.Page*@author:weirx*@time:/1/1719:11*/@RequestMapping(\"/page\")publicPagepage(@RequestParamintcurrent,@RequestParamintsize){returnuserService.page(newPage<>(current,size),newQueryWrapper(newUserDO()));}}
记过上面的接口验证，功能没有问题，集成成功。上文基本覆盖了 mybatis-plus 常用的特性，有同学说自动代码生成没说？
本文项目代码 gitee 地址: /wei_rong_xin/rob-necessities.git
<END>
推荐阅读：
Spring Boot 并行任务，这才是优雅的实现方式！
实现一个简单的 Spring Bean 容器
互联网初中高级大厂面试题(9个G)内容包含Java基础、JavaWeb、MySQL性能优化、JVM、锁、百万并发、消息队列、高性能缓存、反射、Spring全家桶原理、微服务、Zookeeper......等技术栈！⬇戳阅读原文领取！朕已阅
如果觉得《看了我的 mybatis-plus 用法 全公司同事开始悄悄模仿了。。》对你有帮助，请点赞、收藏，并留下你的观点哦！
