【Java开发】Springboot集成mybatis-plus

1、引入 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>

2 、配置准备 

1、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.zkaw.mapper")
@SpringBootApplication
public class RobNecessitiesUserApplication {public static void main(String[] args) {SpringApplication.run(RobNecessitiesUserApplication.class, args);}}

2、数据源配置

此处配置一主一从的环境，当前我只有一台，所以此处配置一样的

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*/

2、使用

前面我们成功的集成进来了 mybatis-plus，配合 springboot 使用不要太方便。下面我们看看如何使用它来操作我们的数据库。介绍一下常规的用法。

1、实体类注解

mybatis-plus 为使用者封装了很多的注解，方便我们使用，我们首先看下实体类中有哪些注解。有如下的实体类

import com.baomidou.mybatisplus.annotation.*;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Getter;
import lombok.Setter;import java.io.Serializable;
import java.util.Date;@Getter
@Setter
@TableName("sys_dept")
@ApiModel(value = "SysDept对象", description = "")
public class SysDept implements Serializable {private static final long serialVersionUID = 1L;@ApiModelProperty("主键ID")@TableId(type = IdType.ASSIGN_UUID)private String id;@ApiModelProperty("部门名称")private String deptName;@ApiModelProperty("部门编码")private String deptCode;@ApiModelProperty("排序")private Integer sort;@ApiModelProperty("创建时间")@TableField(fill = FieldFill.INSERT)private Date createTime;@ApiModelProperty("修改时间")@TableField(fill = FieldFill.UPDATE)private Date updateTime;@ApiModelProperty("是否删除（0-否；1-是）")@TableLogicprivate int delFlag;@ApiModelProperty("租户id")private String tenantId;}

@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 的值* <p> 只生效于 既设置了全局的 tablePrefix 也设置了上面 {@link #value()} 的值 </p>* <li> 如果是 false , 全局的 tablePrefix 不生效 </li>** @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;
}

@TableFiled 表字段标识

 2、CRUD

mybatis-plus 封装好了一条接口供我们直接调用。

2.1 Service 层 CRUD

我们使用的时候，需要在自己定义的 service 接口当中继承IService接口

import com.baomidou.mybatisplus.extension.service.IService;
import com.zkaw.pojo.SysDept;public interface ISysDeptService extends IService<SysDept> {int insert(SysDept sysDept);}

同时要在我们的接口实现 impl 当中继承ServiceImpl，实现自己的接口

import com.zkaw.pojo.SysDept;
import com.zkaw.mapper.SysDeptMapper;
import com.zkaw.service.ISysDeptService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;@Service
public class SysDeptServiceImpl extends ServiceImpl<SysDeptMapper, SysDept> implements ISysDeptService {@Autowiredprivate SysDeptMapper mapper;@Overridepublic int insert(SysDept sysDept) {return mapper.insert(sysDept);}
}

2.2、Mapper 层 CRUD

mybatis-plus 将常用的 CRUD 接口封装成了BaseMapper接口,我们只需要在自己的 Mapper 中继承它就可以了

import com.zkaw.pojo.SysDept;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;@Mapper
public interface SysDeptMapper extends BaseMapper<SysDept> {}

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.zkaw.mapper")
public class MybatisPlusConfig {@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));return interceptor;}}

如上配置后，我们直接使用分页方法就行。

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

@TableLogic
private Integer isDelete;

5、通用枚举配置 

import com.baomidou.mybatisplus.annotation.IEnum;
import com.fasterxml.jackson.annotation.JsonFormat;/*** @description： 性别枚举* @date：2022/1/17 16:26* @version：3.0*/
@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum SexEnum implements IEnum<Integer> {MAN(1, "男"),WOMAN(2, "女");private Integer code;private String name;SexEnum(Integer code, String name) {this.code = code;this.name = name;}@Overridepublic Integer getValue() {return code;}public String getName() {return name;}}

@JsonFormat 注解为了解决枚举类返回前端只展示构造器名称的问题。

实体类性别字段

配置文件扫描枚举

mybatis-plus:# 支持统配符 * 或者 ; 分割typeEnumsPackage: com.zkaw.*.enums

定义配置文件

@Bean
public MybatisPlusPropertiesCustomizer mybatisPlusPropertiesCustomizer() {return properties -> {GlobalConfig globalConfig = properties.getGlobalConfig();globalConfig.setBanner(false);MybatisConfiguration configuration = new MybatisConfiguration();configuration.setDefaultEnumTypeHandler(MybatisEnumTypeHandler.class);properties.setConfiguration(configuration);};
}

序列化枚举值为数据库值

//全局

@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; 

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:*/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {// 起始版本 3.3.0(推荐使用)this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now());}@Overridepublic 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;

7、@DS 注解

@DS注解实现了数据源的切换

可以注解在方法上或类上，同时存在就近原则 【方法上注解】 优先于 【类上注解】

@DS("slave_1")
public class UserServiceImpl extends ServiceImpl<UserMapper, UserDO> implements IUserService {@DS("salve_1")@Overridepublic List<UserDO> getList() {return this.getList();}@DS("master")@Overridepublic int saveUser(UserDO userDO) {boolean save = this.save(userDO);if (save){return 1;}else{return 0;}}
}

3、controller使用

/*** @description： 用户controller* @version：3.0*/
@RestController
@RequestMapping("/user")
public class UserController {@Autowiredprivate IUserService userService;/*** description: 新增* @return: boolean*/@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*/@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*/@RequestMapping("/delete")public boolean delete(@RequestParam Long id) {UserDO userDO = new UserDO();userDO.setId(id);return userService.removeById(userDO);}/*** description: 列表* @return: java.util.List<com.wjbgn.user.entity.UserDO>*/@RequestMapping("/list")public List<UserDO> list() {return userService.list();}/*** description: 分页列表* @param current* @param size* @return: com.baomidou.mybatisplus.extension.plugins.pagination.Page*/@RequestMapping("/page")public Page page(@RequestParam int current,@RequestParam int size) {return userService.page(new Page<>(current,size), new QueryWrapper(new UserDO()));}}