本文主要介绍mybatis-plus这款插件,针对springboot用户。包括引入,配置,使用,以及扩展等常用的方面做一个汇总整理,尽量包含大家常用的场景内容。
关于mybatis-plus是什么,不多做介绍了,看官方文档:baomidou.com ,咱们直接代码撸起来。
一、快速开始 本文基于springboot、maven、jdk1.8、mysql开发,所以开始前我们需要准备好这套环境。我的环境使用了nacos作为注册中心,不了解或需要搭建的参考:https://juejin.cn/post/7053977860612030477
新建如下数据库:
建议大家选择utf8mb4这种字符集,做过微信的同学应该会知道,微信用户名称的表情,是需要这种字符集才能存储的。
我就默认其他环境已经准备好了,咱们直接从mybatis-plus开始。
1.1 依赖准备 想要什么依赖版本的去maven仓库查看:https://mvnrepository.com/
引入mybatis-plus依赖:
com.baomidou mybatis-plus-boot-starter 3.5.0 引入mysql依赖:
mysql mysql-connector-java 8.0.27 目前,多数项目会有多数据源的要求,或者是主从部署的要求,所以我们还需要引入mybatis-plus关于多数据源的依赖:
com.baomidou dynamic-datasource-spring-boot-starter 3.5.0 1.2 配置准备 springboot启动类。配置@mapperscan注解,用于扫描mapper文件位置:
import org.mybatis.spring.annotation.mapperscan;import org.springframework.boot.springapplication;import org.springframework.boot.autoconfigure.springbootapplication;import org.springframework.cloud.client.discovery.enablediscoveryclient;@enablediscoveryclient@mapperscan(com.wjbgn.user.mapper)@springbootapplicationpublic class robnecessitiesuserapplication { public static void main(string[] args) { springapplication.run(robnecessitiesuserapplication.class, args); }} 数据源配置,此处配置一主一从的环境,当前我只有一台,所以此处配置一样的:
spring: datasource: dynamic: primary: master #设置默认的数据源或者数据源组,默认值即为master strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源 datasource: master: url: jdbc//127.0.0.1:3306/rob_necessities?useunicode=true&characterencoding=utf-8&usessl=false&servertimezone =asia/shanghai username: root password: 123456 slave_1: url: jdbc//127.0.0.1:3306/rob_necessities?useunicode=true&characterencoding=utf-8&usessl=false&servertimezone =asia/shanghai username: root password: 123456 补充:这里面因为默认使用的是hikaricp数据源,目前也推荐使用这个,相比于druid有更高的性能,但是不能忽略下面的配置,否则服务会不断抛出异常,原因是数据库的连接时常和连接池的配置没有做好。
spring: datasource: dynamic: hikari: max-lifetime: 1800000 connection-timeout: 5000 idle-timeout: 3600000 max-pool-size: 12 min-idle: 4 connection-test-query: /**ping*/ 1.3 启动服务 下面直接启动服务:
得到如上结果表示启动成功了。
二、使用 前面我们成功的集成进来了mybatis-plus,配合springboot使用不要太方便。下面我们看看如何使用它来操作我们的数据库。介绍一下常规的用法。
2.1 实体类注解 mybatis-plus为使用者封装了很多的注解,方便我们使用,我们首先看下实体类中有哪些注解。有如下的实体类:
@tablename(value = user)public class userdo { /** * 主键 */ @tableid(value = id, type = idtype.auto) private long id; /** * 昵称 */ @tablefield(nickname) private string nickname; /** * 真实姓名 */ private string realname;} @tablename 表名注解,用于标识实体类对应的表。其说明如下,关于这些书写,常规情况基本很少用到,不做多余解释了: @documented@retention(retentionpolicy.runtime)@target({elementtype.type, elementtype.annotation_type})public @interface tablename { /** * 实体对应的表名 */ string value() default ; /** * schema * * @since 3.1.1 */ string schema() default ; /** * 是否保持使用全局的 tableprefix 的值 * 只生效于 既设置了全局的 tableprefix 也设置了上面 {@link #value()} 的值
* 如果是 false , 全局的 tableprefix 不生效 * * @since 3.1.1 */ boolean keepglobalprefix() default false; /** * 实体映射结果集, * 只生效与 mp 自动注入的 method */ string resultmap() default ; /** * 是否自动构建 resultmap 并使用, * 只生效与 mp 自动注入的 method, * 如果设置 resultmap 则不会进行 resultmap 的自动构建并注入, * 只适合个别字段 设置了 typehandler 或 jdbctype 的情况 * * @since 3.1.2 */ boolean autoresultmap() default false; /** * 需要排除的属性名 * * @since 3.3.1 */ string[] excludeproperty() default {};} @tableid 主键注解,看看其源码: @documented@retention(retentionpolicy.runtime)@target({elementtype.field, elementtype.annotation_type})public @interface tableid { /** * 字段值(驼峰命名方式,该值可无) */ string value() default ; /** * 主键id * {@link idtype} */ idtype type() default idtype.none;} 其中idtype很重要:
名称 描述
auto 数据库自增id
none 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 input)
input 用户自己设置的id
assign_id 当用户传入为空时,自动分配类型为number或string的主键(雪花算法)
assign_uuid 当用户传入为空时,自动分配类型为string的主键
@tablefiled 表字段标识,下面看看其主要常用属性:
名称 描述
value 数据库字段名
condition 字段 where 实体查询比较条件,通过sqlcondition设置 如果未设置条件,则按照正常相等来查询 若设置则按照以下规则: 等于:equal = %s=#{%s}; 不等于:not_equal = %s#{%s}; 左右模糊:like = %s like concat('%%',#{%s},'%%'); oracle左右模糊oracle_like = %s like concat(concat('%%',#{%s}),'%%'); 左模糊:like_left = %s like concat('%%',#{%s}); 右模糊:like_right = %s like concat(#{%s},'%%');
fill 自动填充策略,通过fieldfill设置 不处理:fieldfill.default 插入时填充字段:fieldfill.insert 更新时填充字段:fieldfill.update 插入或新增时填充字段:fieldfill.insert_update
关于其他的属性,我不太推荐使用,用得越多,越容易蒙圈。可以通过wapper查询去设置。
2.2 crud mybatis-plus封装好了一条接口供我们直接调用。关于内部的具体方法,在使用时候自己体会吧,此处不列举了。
2.2.1 service层crud 我们使用的时候,需要在自己定义的service接口当中继承iservice接口:
import com.baomidou.mybatisplus.extension.service.iservice;import com.wjbgn.user.entity.userdo;/** * @description: 用户服务接口 * @author:weirx * @date:2022/1/17 15:02 * @version:3.0 */public interface iuserservice extends iservice {} 同时要在我们的接口实现impl当中继承serviceimpl,实现自己的接口:
import com.baomidou.mybatisplus.extension.service.impl.serviceimpl;import com.wjbgn.user.entity.userdo;import com.wjbgn.user.mapper.usermapper;import com.wjbgn.user.service.iuserservice;/** * @description: 用户接口实现 * @author:weirx * @date:2022/1/17 15:03 * @version:3.0 */public class userserviceimpl extends serviceimpl implements iuserservice {} 2.2.2 mapper层crud mybatis-plus将常用的crud接口封装成了basemapper接口,我们只需要在自己的mapper中继承它就可以了:
/** * @description: 用户mapper * @author:weirx * @date:2022/1/17 14:55 * @version:3.0 */@mapperpublic interface usermapper extends basemapper {} 2.3 分页 使用分页话需要增加分页插件的配置:
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;@configuration@mapperscan(com.wjbgn.*.mapper*)public class mybatisplusconfig { @bean public mybatisplusinterceptor mybatisplusinterceptor() { mybatisplusinterceptor interceptor = new mybatisplusinterceptor(); interceptor.addinnerinterceptor(new paginationinnerinterceptor(dbtype.mysql)); return interceptor; }} 如上配置后,我们直接使用分页方法就行。
2.4 逻辑删除配置 很多情况下我们的系统都需要逻辑删除,方便恢复查找误删除的数据。
通过mybatis-plus可以通过全局配置的方式,而不需要再去手动处理。针对更新和查询操作有效,新增不做限制。
通常以我的习惯逻辑删除字段通常定义为is_delete,在实体类当中就是isdelete。那么在配置文件中就可以有如下的配置:
mybatis-plus: global-config: db-config: logic-delete-field: isdelete # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2) logic-delete-value: 1 # 逻辑已删除值(默认为 1) logic-not-delete-value: 0 # 逻辑未删除值(默认为 0) 或者通过注解@tablelogic
@tablelogicprivate integer isdelete; 2.5 通用枚举配置 相信后端的同学都经历过一个情况,比如性别这个字段,分别值和名称对应1男、2女,这个字段在数据库时是数值类型,而前端展示则是展示字符串的名称。有几种常见实现方案呢?
数据库查询sql通过case判断,返回名称,以前oracle经常这么做 数据库返回的值,重新遍历赋值进去,这时候还需要判断这个值到底是男是女。 前端写死,返回1就是男,返回2就是女。 相信无论哪种方法都有其缺点,所以我们可以使用mybatis-plus提供的方式。我们在返回给前端时:
只需要在遍历时get这个枚举,直接赋值其名称,不需要再次判断。 直接返回给前端,让前端去去枚举的name 这样大家都不需要写死这个值。
下面看看如何实现这个功能:
性别枚举,实现ienum接口: import com.baomidou.mybatisplus.annotation.ienum;import com.fasterxml.jackson.annotation.jsonformat;/** * @description: 性别枚举 * @author:weirx * @date:2022/1/17 16:26 * @version:3.0 */@jsonformat(shape = jsonformat.shape.object)public enum sexenum implements ienum { man(1, 男), woman(2, 女); private integer code; private string name; sexenum(integer code, string name) { this.code = code; this.name = name; } @override public integer getvalue() { return code; } public string getname() { return name; }} @jsonformat注解为了解决枚举类返回前端只展示构造器名称的问题。
实体类性别字段 @tablename(value = user)public class userdo { /** * 主键 */ @tableid(value = id, type = idtype.auto) private long id; /** * 昵称 */ @tablefield(value = nickname,condition = sqlcondition.equal) private string nickname; /** * 性别 */ @tablefield(value = sex) private sexenum sex; /** * 版本 */ @tablefield(value = version,update = %s+1) private integer version; /** * 时间字段,自动添加 */ @tablefield(value = create_time,fill = fieldfill.insert) private localdatetime createtime;} 配置文件扫描枚举 mybatis-plus: # 支持统配符 * 或者 ; 分割 typeenumspackage: com.wjbgn.*.enums 定义配置文件 @beanpublic mybatispluspropertiescustomizer mybatispluspropertiescustomizer() { return properties -> { globalconfig globalconfig = properties.getglobalconfig(); globalconfig.setbanner(false); mybatisconfiguration configuration = new mybatisconfiguration(); configuration.setdefaultenumtypehandler(mybatisenumtypehandler.class); properties.setconfiguration(configuration); };} 序列化枚举值为数据库值,以下我是使用的fastjson,全局(添加在前面的配置文件中):
bean public mybatispluspropertiescustomizer mybatispluspropertiescustomizer() { // 序列化枚举值为数据库存储值 fastjsonconfig config = new fastjsonconfig(); config.setserializerfeatures(serializerfeature.writeenumusingtostring); return properties -> { globalconfig globalconfig = properties.getglobalconfig(); globalconfig.setbanner(false); mybatisconfiguration configuration = new mybatisconfiguration(); configuration.setdefaultenumtypehandler(mybatisenumtypehandler.class); properties.setconfiguration(configuration); }; } 局部 jsonfield(serialzefeatures= serializerfeature.writeenumusingtostring) private sexenum sex; 2.6 自动填充 还记得前面提到的实体类当中的注解@tablefeild吗?当中有个属性叫做fill,通过fieldfill设置属性,这个就是做自动填充用的。
public enum fieldfill { /** * 默认不处理 */ default, /** * 插入填充字段 */ insert, /** * 更新填充字段 */ update, /** * 插入和更新填充字段 */ insert_update} 但是这个直接是不能使用的,需要通过实现mybatis-plus提供的接口,增加如下配置:
import com.baomidou.mybatisplus.core.handlers.metaobjecthandler;import org.apache.ibatis.reflection.metaobject;import org.springframework.stereotype.component;import java.time.localdatetime;/** * description: 启动自动填充功能 * @return: * @author: weirx * @time: 2022/1/17 17:00 */@componentpublic class mymetaobjecthandler implements metaobjecthandler { @override public void insertfill(metaobject metaobject) { // 起始版本 3.3.0(推荐使用) this.strictinsertfill(metaobject, createtime, localdatetime.class, localdatetime.now()); } @override public void updatefill(metaobject metaobject) { // 起始版本 3.3.0(推荐) this.strictupdatefill(metaobject, updatetime, localdatetime.class, localdatetime.now()); }} 字段如下:
/** * 时间字段,自动添加 */@tablefield(value = create_time,fill = fieldfill.insert)private localdatetime createtime; 2.7 多数据源 前面提到过,配置文件当中配置了主从的方式,其实mybatis-plus还支持更多的方式:
多主多从 spring: datasource: dynamic: primary: master #设置默认的数据源或者数据源组,默认值即为master strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源 datasource: master_1: master_2: slave_1: slave_2: slave_3: 多种数据库 spring: datasource: dynamic: primary: mysql #设置默认的数据源或者数据源组,默认值即为master strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源 datasource: mysql: oracle: postgresql: h2: sqlserver: 混合配置 spring: datasource: dynamic: primary: master #设置默认的数据源或者数据源组,默认值即为master strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源 datasource: master_1: slave_1: slave_2: oracle_1: oracle_2: 上面的三种方式,除了混合配置,我觉得都有肯能出现的吧。
@ds注解 可以注解在方法上或类上,同时存在就近原则 【方法上注解】 优先于 【类上注解】:
@ds(slave_1)public class userserviceimpl extends serviceimpl implements iuserservice { @ds(salve_1) @override public list getlist() { return this.getlist(); } @ds(master) @override public int saveuser(userdo userdo) { boolean save = this.save(userdo); if (save){ return 1; }else{ return 0; } }} 三、测试 经过上面的配置,下面开始进入测试验证阶段。
建立一张表:
create table `user` ( `id` int(11) not null auto_increment, `nickname` varchar(255) not null comment '昵称', `sex` tinyint(1) not null comment '性别,1男2女', `create_time` datetime not null comment '创建时间', `is_delete` tinyint(1) not null default '0' comment '是否删除 1是,0否', primary key (`id`)) engine=innodb auto_increment=50 default charset=utf8mb4; controller:
/** * @description: 用户controller * @author:weirx * @date:2022/1/17 17:39 * @version:3.0 */@restcontroller@requestmapping(/user)public class usercontroller { @autowired private iuserservice userservice; /** * description: 新增 * @return: boolean * @author: weirx * @time: 2022/1/17 19:11 */ @requestmapping(/save) public boolean save() { userdo userdo = new userdo(); userdo.setnickname(大漂亮); userdo.setsex(sexenum.man); return userservice.save(userdo); } /** * description: 修改 * @param nickname * @param id * @return: boolean * @author: weirx * @time: 2022/1/17 19:11 */ @requestmapping(/update) public boolean update(@requestparam string nickname,@requestparam long id) { userdo userdo = new userdo(); userdo.setnickname(nickname); userdo.setid(id); return userservice.updatebyid(userdo); } /** * description: 删除 * @param id * @return: boolean * @author: weirx * @time: 2022/1/17 19:11 */ @requestmapping(/delete) public boolean delete(@requestparam long id) { userdo userdo = new userdo(); userdo.setid(id); return userservice.removebyid(userdo); } /** * description: 列表 * @return: java.util.list * @author: weirx * @time: 2022/1/17 19:11 */ @requestmapping(/list) public list list() { return userservice.list(); } /** * description: 分页列表 * @param current * @param size * @return: com.baomidou.mybatisplus.extension.plugins.pagination.page * @author: weirx * @time: 2022/1/17 19:11 */ @requestmapping(/page) public page page(@requestparam int current,@requestparam int size) { return userservice.page(new page(current,size), new querywrapper(new userdo())); }} 记过上面的接口验证,功能没有问题,集成成功。
项目源码地址 https://gitee.com/wei_rong_xin/rob-necessities
工业PaaS是工业互联网平台的核心 工业PaaS平台的核心又是什么呢?
AR+航空工业的六大应用场景介绍
影响单相异步电机寿命的因素
情人节送男朋友什么礼物最好,情人节礼物指南
苹果又引领潮流?
MyBatis-Plus的使用与测试
CMOS传感器及未来发展应用的介绍
北通阿修罗2游戏手柄拆机评测:操作神感受
很给力!小米MIUI9功能大曝光:必须要升级
单片机必须了解的外设功能——GPIO/串行通信
AMD嵌入式GPU为医疗成像领域提供解决方案
飞利浦电视I2C总线进入方式
华为自研SSD的历史变革
近期华为手机冰点价:华为P9、华为Mate8、华为荣耀8青春版、华为荣耀V8,值得购买
Pogopin的内部结构设计是怎样的
解散后,Hardlight VR决定开源VR背心
全球首台电子计算器现身:超2斤重、现价值近34万元
混动车的性能价值与技术
非稳压电源示意图,非稳压电源的缺点
曝三星专利:可用便携“戒指”为手机充电