2022-10-05 11:23 北京大学 Java 发布于湖南

关注

你还没用过Mybatis-Plus？丝般顺滑，快速上手！

一、概述

1.1、什么是MyBatis-Plus

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

1.2、特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

1.3、支持数据库

任何能使用 MyBatis 进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下，如果不在下列表查看分页部分教程 PR 您的支持。

MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb
达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库

1.4、框架结构

二、快速集成

2.1、SpringBoot项目快速集成

如果你的项目已经配置了MyBatis，那么，你只需

1、引入mybatis-plus依赖，替换掉mybatis的依赖

2、将application配置中的mybatis改为mybatis-plus即可

引入依赖

<dependencies> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>最新版本</version> </dependency> </dependencies>

application修改配置

mybatis-plus: mapper-locations: xxx executor-type: simple configuration: log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl

2.2、MyBatis-Plus类的特殊定义

MyBatis-Plus分别对Service层、Mapper层提供了功能拓展

想要使用MyBatis-Plus内置的方法，需要实现MyBatis-Plus的特殊接口

Service层

// service接口需要继承IService<User>接口 public interface UserService extends IService<User> {
 
 } // service实现类需要继承ServiceImpl<UserMapper, User>接口 public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
 
 }

Mapper层

// 需要继承BaseMapper<User>接口 public interface UserMapper extends BaseMapper<User> {
 
 }

三、CRUD Boy

3.1、CRUD

对于CRUD，MyBatis-Plus提供了两类接口：Service层、Mapper层。功能一样，不同层有不同的方法。

【Service层】
private finally MyService myService; // 保存用户（Service CRUD） myService.save(User);
【Mapper层】
private finally MyMapper myMapper; // 保存用户（Mapper CRUD） myMapper.insert(User);

使用示例

// 单个查询 User user = userMapper.selectById(id); // 批量查询 List<User> users =  userMapper.selectBatchIds(Arrays.asList(1, 2, 3)); // 条件查询 HashMap<String, Object> map = new HashMap(); map.put("name", "十年"); map.put("age", 12);
 userMapper.selectByMap(map);

更多操作

MyBatis-Plus官方文档-CRUD

3.2、条件构造器

Mybatis提供了QueryWrapper，可以让我们自定义较为复杂的sql查询条件

📢

不支持以及不赞成在 RPC 调用中把 Wrapper 进行传输

wrapper 很重
传输 wrapper 可以类比为你的 controller 用 map 接收值(开发一时爽,维护火葬场)
正确的 RPC 调用姿势是写一个 DTO 进行传输,被调用方再根据 DTO 执行相应的操作
我们拒绝接受任何关于 RPC 传输 Wrapper 报错相关的 issue 甚至 pr

使用示例

QueryWrapper<User> wrapper = new QueryWrapper<>();
 wrapper.isNotNull("name")
   .ge("age", 12) // 年龄小于12的 .notLike("name", "e") // and name not like '%e%' .likeRight("name", "est") // and name like 'est% .likeLeft("name", "est") // and name like '%est' .inSql("id", "select id from user where id < 3") // and id in (select id from user where id < 3) .orderByAsc("id");// 根据id正序 List<User> users = userMapper.selectList(wrapper);

更多参考

MyBatis-Plus官方文档-条件构造器

3.3、主键策略

Mybatis-Plus提供了多种主键策略

public enum IdType {
     AUTO(0), // 数据库id自增 NONE(1), // 未设置主键 INPUT(2), // 手动输入 ASSIGN_ID(3), // 默认的全局唯一id（雪花算法） ASSIGN_UUID(4); // uuid private final int key; private IdType(int key) { this.key = key;
     } public int getKey() { return this.key;
     }
 }

3.3.1、基本使用

比如Mysql数据库，在定义表的时候，字段可以直接设置自增，那么可以直接使用IdType.AUTO做自增

1、数据库字段设置自增

2、实体类添加注解：@TableId(type = IdType.AUTO)

@TableId(type = IdType.AUTO) // 这个需要配合数据库设置自增来使用 private Integer id;

3.3.2、INPUT的使用

对于Postgresql数据库，并不支持直接设置字段自增，需要额外设置sequence来完成，那需要使用type = IdType.INPUT来设置

1、配置类中编写主键策略

内置支持：

DB2KeyGenerator
H2KeyGenerator
KingbaseKeyGenerator
OracleKeyGenerator
PostgreKeyGenerator

@Configuration public class MyBatisPlusConfig { /**
      * postgresql数据库主键生成策略
      */ @Bean public IKeyGenerator keyGenerator() { return new PostgreKeyGenerator();
     }
 }

2、实体类配置seq

// 类上使用@KeySequence指定sequence、数据库类型 @KeySequence(value = "seq_user", dbType = DbType.POSTGRE_SQL) public class User extends Model<User> { // 字段上使用@TableId，指定数据库字段名、主键策略类型 @TableId(value = "user_id", type = IdType.INPUT) private Integer userId;
 }

四、拓展

4.1、插件

编写配置文件，在配置文件里集成插件

@MapperScan("") // 可以把启动类上的dao的文件目录放到这里 @EnableTransactionManagement @Configuration public class MyBatisPlusConfig { /**
      * 插件配置
      */ }

4.1.1、分页插件

注册插件

@MapperScan("") // 可以把启动类上的dao的文件目录放到这里 @EnableTransactionManagement @Configuration public class MyBatisPlusConfig { /**
      * MybatisPlus分页插件配置
      */ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor(){
         MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
         PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.POSTGRE_SQL);
         mybatisPlusInterceptor.addInnerInterceptor(paginationInnerInterceptor); return mybatisPlusInterceptor;
     }
 }

使用插件

【内置的mapper方法】

Mybatis-plus的内置方法，进行分页，可以直接使用（方法第一个参数传入page对象）

Page<User> page = new Page<>(1, 5);
 userMapper.selectPage(page, null); return page;

【自定义的mapper方法】

对于自定义的mapper方法想要分页，需要在mapper层的方法中额外增加page对象参数

IPage<UserVo> selectPageVo(IPage<?> page, Integer state); // or (class MyPage extends Ipage<UserVo>{ private Integer state; })
 MyPage selectPageVo(MyPage page); // or List<UserVo> selectPageVo(IPage<UserVo> page, Integer state);

<select id="selectPageVo" resultType="xxx.xxx.xxx.UserVo"> SELECT id,name FROM user WHERE state=#{state} </select>

4.1.2、乐观锁插件

【场景】

当要更新一条记录的时候，在更新的过程中，希望这条记录没有被别人更新

【原理】

乐观锁实现方式：

取出记录时，获取当前 version
更新时，带上这个 version
执行更新时， set version = newVersion where version = oldVersion
如果 version 不对，就更新失败

注册插件

@MapperScan("") // 可以把启动类上的dao的文件目录放到这里 @EnableTransactionManagement @Configuration public class MyBatisPlusConfig { /**
      * 乐观锁插件
      */ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() {
         MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
         mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); return mybatisPlusInterceptor;
     }
 }

使用插件

1、数据库定义字段

2、在字段上加@Version注解
```
@Version private Integer version;
```

4.1.3、性能分析插件

对sql的格式化输出、sql执行时间、当超过设置的时间则报错

【建议】：配置仅在dev和test就环境下生效

注册插件

@MapperScan("") // 可以把启动类上的dao的文件目录放到这里 @EnableTransactionManagement @Configuration public class MyBatisPlusConfig { /**
      * 性能分析插件
      */ @Bean @Profile({"dev", "test"}) // 配置仅在dev和test就环境下生效 public PerformanceInterceptor performanceInterceptor() {
       PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); // 设置sql最大执行时间（毫秒），超过则不执行 performanceInterceptor.setMaxTime(500); // 设置对输出的sql格式化 performanceInterceptor.setFormat(true); return performanceInterceptor;
     }
 }

使用插件

直接在控制台看即可

4.2、代码生成器

mybatis-plus支持通过代码，一键生成：目录、对象文件、代码

使用示例

public class MyFastAutoGenerator { /**
      * 绝对项目根路径
      */ private static final String OUT_DIR = ""; /**
      * 项目包路径
      */ private static final String PROJECT_DIR = ""; /**
      * 模块名
      */ private static final String MODULE_NAME = ""; /**
      * 数据库配置
      */ private static final String URL = ""; private static final String USERNAME = ""; private static final String PASSWORD = ""; /**
      * 需要生成的表名称(可以填多个)
      */ private static final String[] GENERATE_TABLES = {"user"}; public static void main(String[] args) {
         FastAutoGenerator.create(URL, USERNAME, PASSWORD) // 全局配置 .globalConfig(builder -> {
                     builder.outputDir(OUT_DIR) // 配置生成文件中的author .author("") // 注释日期的格式 .commentDate("yyyy-MM-dd HH:mm:ss")
                             .build();
                 }) // 包配置 .packageConfig(builder -> {
                     builder.parent(PROJECT_DIR)
                             .moduleName(MODULE_NAME)
                             .controller("controller")
                             .service("service")
                             .serviceImpl("service.impl")
                             .mapper("dao")
                             .xml("dao.xml")
                             .entity("model");
                 }) // Entity策略配置 .strategyConfig(builder -> {
                     builder.addInclude(GENERATE_TABLES) // 跳过视图的生成 .enableSkipView() // 去除前缀 .addTablePrefix("t_")
                             .entityBuilder() // 驼峰 .naming(NamingStrategy.underline_to_camel)
                             .build();
                 }) // Service策略配置 .strategyConfig(builder -> {
                     builder.serviceBuilder()
                             .formatServiceFileName("%sService")
                             .build();
                 }) // Mapper策略配置 .strategyConfig(builder -> {
                     builder.mapperBuilder()
                             .formatMapperFileName("%sDao")
                             .build();
                 }) // 可以使用Freemarker引擎模板，默认的是Velocity引擎模板 .templateEngine(new VelocityTemplateEngine())
                 .execute();
     }
 }