关于java:看了我的-mybatisplus-用法全公司同事开始悄悄模仿了

本文次要介绍 mybatis-plus 这款插件，针对 springboot 用户。包含引入，配置，应用，以及扩大等罕用的方面做一个汇总整顿，尽量蕴含大家罕用的场景内容。

作者：我犟不过你 \
原文链接：https://juejin.cn/post/705472…

对于 mybatis-plus 是什么，不多做介绍了，看官网文档，咱们间接代码撸起来。

一、疾速开始

本文基于 springboot、maven、jdk1.8、mysql 开发，所以开始前咱们须要筹备好这套环境。

Spring Boot 根底就不介绍了，举荐看这个收费教程：

https://github.com/javastacks/spring-boot-best-practice

新建如下数据库：

倡议大家抉择 utf8mb4 这种字符集，做过微信的同学应该会晓得，微信用户名称的表情，是须要这种字符集能力存储的。

我就默认其余环境曾经筹备好了，咱们间接从 mybatis-plus 开始。

1.1 依赖筹备

想要什么依赖版本的去 maven 仓库查看：

https://mvnrepository.com/

引入 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 配置筹备

Spring Boot 根底就不介绍了，举荐看这个收费教程：

https://github.com/javastacks/spring-boot-best-practice

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\")
@SpringBootApplication
public 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 的值
     * <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;}

其中 IdType 很重要：

@TableFiled 表字段标识

上面看看其次要罕用属性：

对于其余的属性，我不太举荐应用，用得越多，越容易蒙圈。能够通过 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<UserDO> {}

同时要在咱们的接口实现 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<UserMapper, UserDO> 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
 */
@Mapper
public interface UserMapper extends BaseMapper<UserDO> {}

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

@TableLogic
private 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<Integer> {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

• 定义配置文件

@Bean
public 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
 */
@Component
public 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<UserMapper, UserDO> implements IUserService {@DS(\"salve_1\")
    @Override
    public List<UserDO> 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<com.wjbgn.user.entity.UserDO>
     * @author: weirx
     * @time: 2022/1/17 19:11
     */
    @RequestMapping(\"/list\")
    public List<UserDO> 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 罕用的个性，有同学说主动代码生成没说？

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿(2022 最新版)

2. 劲爆！Java 协程要来了。。。

3.Spring Boot 2.x 教程，太全了！

4. 别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！