环球百事通!我的mybatis-plus用法,被全公司同事开始悄悄模仿了!
大家好,我是武哥!
(资料图片)
本文主要介绍 mybatis-plus 这款插件,针对 springboot 用户。包括引入,配置,使用,以及扩展等常用的方面做一个汇总整理,尽量包含大家常用的场景内容。
关于 mybatis-plus 是什么,不多做介绍了,看官方文档:https://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 关于多数据源的依赖:
1.2 配置准备com.baomidou dynamic-datasource-spring-boot-starter 3.5.0
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:mysql://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:mysql://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()} 的值
*
@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 CRUDmybatis-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 ServiceImplimplements IUserService {}
所以我们的
2.2.2 Mapper 层 CRUDmybatis-plus 将常用的 CRUD 接口封装成了 BaseMapper 接口,我们只需要在自己的 Mapper 中继承它就可以了:
/** * @description: 用户mapper * @author:weirx * @date:2022/1/17 14:55 * @version:3.0 */@Mapperpublic interface UserMapper extends BaseMapper2.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())); }}
记过上面的接口验证,功能没有问题,集成成功。上文基本覆盖了 mybatis-plus 常用的特性,有同学说自动代码生成没说?本文项目代码 gitee 地址: https://gitee.com/wei_rong_xin/rob-necessities.git
来源: https://juejin.cn/post/7054726274362638350
最后,再给大家 推荐我之前写的10万字Springboot经典学习笔记 ,在Java开发宝典里回复:笔记,即可领取。
点赞是最大的支持
相关阅读
-
世界热推荐:今晚7:00直播丨下一个突破...
今晚19:00,Cocos视频号直播马上点击【预约】啦↓↓↓在运营了三年... -
NFT周刊|Magic Eden宣布支持Polygon网...
Block-986在NFT这样的市场,每周都会有相当多项目起起伏伏。在过去... -
环球今亮点!头条观察 | DeFi的兴衰与...
在比特币得到机构关注之后,许多财务专家预测世界将因为加密货币的... -
重新审视合作,体育Crypto的可靠关系才能双赢
Block-987即使在体育Crypto领域,人们的目光仍然集中在FTX上。随着... -
简讯:前端单元测试,更进一步
前端测试@2022如果从2014年Jest的第一个版本发布开始计算,前端开发... -
焦点热讯:刘强东这波操作秀
近日,刘强东发布京东全员信,信中提到:自2023年1月1日起,逐步为...