MyBatisPlus

1.简介

官网：https://www.baomidou.com/

2.相关依赖以及配置

2.1. pom引入依赖

  <!--MyBatisPlus 启动器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.3</version>
        </dependency>
        <!--MyBatisPlus  代码生成器核心依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.3</version>
        </dependency>
        <!--freemarker 依赖-->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.31</version>
        </dependency>

2.2. 配置application.yml

spring:
  datasource:
    #type: com.zaxxer.hikari.HikariDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus
    username: root
    password: 2002

# 配置MyBatis日志
mybatis-plus:
  configuration:
    #配置MyBatis的日志，输出到指定控制台
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    #开启MyBatis的驼峰命名自动映射开关 a_colum --->  aColum
    map-underscore-to-camel-case: true
    #配置类型别名所对应的包
  type-aliases-package: com.huntouzai.mybatisplus.pojo
  #扫描通用枚举的包  3.5.2极其之后的版本不需要配置
  #type-enums-package: com.huntouzai.mybatisplus.enums

3.基本DQL与DML

3.1.BaseMapper

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用，案例如
下：

package com.baomidou.mybatisplus.core.mapper;
public interface BaseMapper<T> extends Mapper<T> {
  /**
  * 插入一条记录
  * @param entity 实体对象
  */
  int insert(T entity);
}

3.2.通用Service – IService

MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑
详情查看源码IService和ServiceImpl
使用方法如下：
创建Service接口和实现类

/**
* UserService继承IService模板提供的基础功能
*/
public interface UserService extends IService<User> {
 
}

**
* ServiceImpl实现了IService，提供了IService中基础功能的实现
* 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现
*/
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements
UserService {
 
}

可以在测试方法中直接使用

@Autowired
private UserService userService;
@Test
public void testGetCount(){
  long count = userService.count();
  System.out.println("总记录数：" + count);
}

3.3.查询指定字段

  QueryWrapper<User> lqw = new QueryWrapper<User>();
  lqw.select("id","name","age","tel");
  List<User> userList = userDao.selectList(lqw);
//SELECT id,name,age FROM user

3.4.聚合查询

聚合函数查询，count、max、min、avg、sum的使用

QueryWrapper<User> lqw = new QueryWrapper<User>();
 //lqw.select("count(*) as count");
 //SELECT count(*) as count FROM user
 //lqw.select("max(age) as maxAge");
 //SELECT max(age) as maxAge FROM user
 //lqw.select("min(age) as minAge");
 //SELECT min(age) as minAge FROM user
 //lqw.select("sum(age) as sumAge");
 //SELECT sum(age) as sumAge FROM user
 lqw.select("avg(age) as avgAge");
 //SELECT avg(age) as avgAge FROM user
 List<Map<String, Object>> userList = userDao.selectMaps(lqw);

3.5.分组查询

分组查询，group by的使用

QueryWrapper<User> lqw = new QueryWrapper<User>();
lqw.select("count(*) as count,tel");
lqw.groupBy("tel");
List<Map<String, Object>> list = userDao.selectMaps(lqw);

3.6.条件查询

• eq()： 相当于 =,对应的sql语句为
• selectList：查询结果为多个或者单个
• selectOne:查询结果为单个
• gt():大于(>)
• ge():大于等于(>=)
• lt():小于(<)
• lte():小于等于(<=)
• between():between ? and ?
• like():前后加百分号,如 %J%
• likeLeft():前面加百分号,如 %J
• likeRight():后面加百分号,如 J%
• orderBy排序
  • condition:条件，true则添加排序，false则不添加排序
  • isAsc:是否为升序，true升序，false降序
  • columns:排序字段，可以有多个
• orderByAsc/Desc(单个column):按照指定字段进行升序/降序
• orderByAsc/Desc(多个column):按照多个字段进行升序/降序
• orderByAsc/Desc
  • condition:条件，true添加排序，false不添加排序
  • 多个columns：按照多个字段进行排序

除了上面介绍的这几种查询条件构建方法以外还会有很多其他的方法，比如isNull,isNotNull,in,notIn等等方法可供选择，具体参考官方文档的条件构造器来学习使用，具体的网址为:

https://mp.baomidou.com/guide/wrapper.html#abstractwrapper

3.7.ID生成策略

1、在主键上添加注解@TableId(type=IdType.AUTO)
2、统一配置

mybatis-plus:
  global-config:
    db-config:
    	id-type: assign_id

配置完成后，每个模型类的主键ID策略都将成为assign_id.

• AUTO
• NONE: 不设置id生成策略
• INPUT:用户手工输入id
• ASSIGN_ID:雪花算法生成id(可兼容数值型与字符串型)
• ASSIGN_UUID:以UUID生成算法作为id生成策略
• 其他的几个策略均已过时，都将被ASSIGN_ID和ASSIGN_UUID代替掉。

对比各类主键生成策略

• NONE: 不设置id生成策略，MP不自动生成，约等于INPUT,所以这两种方式都需要用户手动设置，但是手动设置第一个问题是容易出现相同的ID造成主键冲突，为了保证主键不冲突就需要做很多判定，实现起来比较复杂
• AUTO:数据库ID自增,这种策略适合在数据库服务器只有1台的情况下使用,不可作为分布式ID使用
• ASSIGN_UUID:可以在分布式的情况下使用，而且能够保证唯一，但是生成的主键是32位的字符串，长度过长占用空间而且还不能排序，查询性能也慢
• ASSIGN_ID:可以在分布式的情况下使用，生成的是Long类型的数字，可以排序性能也高，但是生成的策略和服务器时间有关，如果修改了系统时间就有可能导致出现重复主键
• 综上所述，每一种主键策略都有自己的优缺点，根据自己项目业务的实际情况来选择使用才是最明智的选择。

4.常用注解

4.1. @TableName处理数据库表名

• 问题：之前BaseMapper中设置了泛型User，自动匹配操作的表为user，如果命名不一致，则无法匹配
• 解决方案：需要在实体类上增加该注解@TableName(“t_user”)
• 属性：注解内的属性为数据库表名
  也可以使用全局配置解决

mybatis-plus:
configuration:
  # 配置MyBatis日志
 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
global-config:
 db-config:
   # 配置MyBatis-Plus操作表的默认前缀
  table-prefix: t_

4.2. @TableId处理主键

• 问题：默认将ID作为主键列，用雪花算法生成id
• 解决方案：在主键属性上增加@TableId(value=“uid”,type=idType.ASSIGN_ID)
• 属性：将这个属性对应的字段作为当前主键，通过value属性设置数据库主键字段名，type属性设置主键id生成算法，递增（IdType.AUTO）、雪花算法（idType.ASSIGN_ID）等等
  也可以配置全局主键策略

mybatis-plus:
configuration:
  # 配置MyBatis日志
 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
global-config:
 db-config:
   # 配置MyBatis-Plus操作表的默认前缀
  table-prefix: t_
   # 配置MyBatis-Plus的主键策略
  id-type: auto

4.2.1. 雪花算法

长度共64bit（一个long型）。
首先是一个符号位，1bit标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负
数是1，所以id一般是正数，最高位是0。
41bit时间截(毫秒级)，存储的是时间截的差值（当前时间截 - 开始时间截)，结果约等于69.73年。
10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID，可以部署在1024个节点）。
12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID）。

优点：整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高。

4.3. @TableField

• 处理数据库字段名

• 问题：实体类属性名和类名不一致

• 解决方案：在实体类属性上使用@TableField(“数据库对应字段名”)设置属性所对应的字段名

• 自动填充

    @TableField(fill = FieldFill.INSERT)//插入时填充字段
    private LocalDateTime createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)//插入和更新时填充字段
    private LocalDateTime updateTime;

自定义元数据对象处理器

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

/**
 * 自定义元数据对象处理器
 */
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
    /**
     * 插入操作自动填充
     * @param metaObject 原始数据
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        metaObject.setValue("createTime", LocalDateTime.now());
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("createUser", BaseContext.getCurrentId());
        metaObject.setValue("updateUser", BaseContext.getCurrentId());

    }

    /**
     * 插入和修改操作自动填充
     * @param metaObject 原始数据
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        metaObject.setValue("updateTime", LocalDateTime.now());
        metaObject.setValue("updateUser", BaseContext.getCurrentId());
    }
}

4.4. @TableLogic逻辑删除

• 物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据
• 逻辑删除：假删除，将对应数据中代表是否被删除字段的状态修改为“被删除状态”，之后在数据库
  中仍旧能看到此条数据记录
• 可用于数据恢复
• 使用方式：一般定义实体类的删除属性，数据库真添加删除字段

@TableLogic
private Integer isDeleted;//默认0是未删除，1是已删除

5. wapper条件构造器

• Wrapper ： 条件构造抽象类，最顶端父类
  • AbstractWrapper ： 用于查询条件封装，生成 sql 的 where 条件
    • QueryWrapper ： 查询条件封装
    • UpdateWrapper ： Update 条件封装
    • AbstractLambdaWrapper ： 使用Lambda 语法
      • LambdaQueryWrapper ：用于Lambda语法使用的查询Wrapper
      • LambdaUpdateWrapper ： Lambda 更新封装Wrapper

5.1. QueryWrapper查询条件封装

@Test
public void test04() {
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  //将用户名中包含有a并且（年龄大于20或邮箱为null）的用户信息修改
  //UPDATE t_user SET age=?, email=? WHERE (username LIKE ? AND (age > ? ORemail IS NULL))
  //lambda表达式内的逻辑优先运算
  queryWrapper.like("username", "a")
     .and(i -> i.gt("age", 20).or().isNull("email"));
  User user = new User();
  user.setAge(18);
  user.setEmail("user@atguigu.com");
  int result = userMapper.update(user, queryWrapper);
  System.out.println("受影响的行数：" + result);
}

总结：并且直接链式编程，或者用or()，括号里的则写在and()的括号里边

5.2. UpdateWrapper更新条件封装

@Test
public void test07() {
  //将（年龄大于20或邮箱为null）并且用户名中包含有a的用户信息修改
  //组装set子句以及修改条件
  UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
  //lambda表达式内的逻辑优先运算
  updateWrapper
   .set("age", 18)
   .set("email", "user@atguigu.com")
   .like("username", "a")
   .and(i -> i.gt("age", 20).or().isNull("email"));
  //这里必须要创建User对象，否则无法应用自动填充。如果没有自动填充，可以设置为null
  //UPDATE t_user SET username=?, age=?,email=? WHERE (username LIKE ? AND(age > ? OR email IS NULL))
  //User user = new User();
  //user.setName("张三");
  //int result = userMapper.update(user, updateWrapper);
  //UPDATE t_user SET age=?,email=? WHERE (username LIKE ? AND (age > ? ORemail IS NULL))
  int result = userMapper.update(null, updateWrapper);
  System.out.println(result);
}

5.3. 条件查询

在条件构造器调用的方法中可以判空，注意使用的StringUtils是MyBatisPlus中的

@Test
public void test08UseCondition() {
  //定义查询条件，有可能为null（用户未输入或未选择）
  String username = null;
  Integer ageBegin = 10;
  Integer ageEnd = 24;
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  //StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace)构成
  queryWrapper
     .like(StringUtils.isNotBlank(username), "username", "a")
     .ge(ageBegin != null, "age", ageBegin)
     .le(ageEnd != null, "age", ageEnd);
  //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (age >=
? AND age <= ?)
  List<User> users = userMapper.selectList(queryWrapper);
  users.forEach(System.out::println);
}

5.4. LambdaQueryWrapper

//避免使用字符串表示字段，防止运行时错误，“name”写为User::getName

@Test
public void test09() {
  //定义查询条件，有可能为null（用户未输入）
  String username = "a";
  Integer ageBegin = 10;
  Integer ageEnd = 24;
  LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
  //避免使用字符串表示字段，防止运行时错误
  queryWrapper
     .like(StringUtils.isNotBlank(username), User::getName, username)
     .ge(ageBegin != null, User::getAge, ageBegin)
     .le(ageEnd != null, User::getAge, ageEnd);
  List<User> users = userMapper.selectList(queryWrapper);
  users.forEach(System.out::println);
}

5.5. LambdaUpdateWrapper

@Test
public void test10() {
  //组装set子句
  LambdaUpdateWrapper<User> updateWrapper = new LambdaUpdateWrapper<>();
  updateWrapper
   .set(User::getAge, 18)
   .set(User::getEmail, "user@atguigu.com")
   .like(User::getName, "a")
   .and(i -> i.lt(User::getAge, 24).or().isNull(User::getEmail)); //lambda表达式内的逻辑优先运算
  User user = new User();
  int result = userMapper.update(user, updateWrapper);
  System.out.println("受影响的行数：" + result);
}

6.插件

6.1. 分页

6.1.1. 分页插件

实现步骤

• 添加配置类

@Configuration
//@MapperScan("com.atguigu.mybatisplus.mapper")  //可以将主类中的注解移到此处，包扫描，我个人习惯在Mapper接口上加上@Mapper注解
public class MybatisPlusConfig { 
  @Bean
  public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
    return interceptor;
 }
}

• 测试

@Test
public void testPage(){
  //设置分页参数
  Page<User> page = new Page<>(1, 5);
  userMapper.selectPage(page, null);
  //获取分页数据
  List<User> list = page.getRecords();
  list.forEach(System.out::println);
  System.out.println("当前页："+page.getCurrent());
  System.out.println("每页显示的条数："+page.getSize());
  System.out.println("总记录数："+page.getTotal());
  System.out.println("总页数："+page.getPages());
  System.out.println("是否有上一页："+page.hasPrevious());
  System.out.println("是否有下一页："+page.hasNext());
}

6.1.2. xml自定义分页

Mapper接口方法

Page<User> selectPageVo(@Param("page") Page<User> page, @Param("age") Integer age);

Mapper.xml中编写SQL

    <select id="selectPageVo" resultType="User">
        select *
        from user where age > #{age}
    </select>

6.2.乐观锁

• 1.给实体类和数据库分别新增属性和字段：version，加上并在实体列的属性名上加注解：@Version
• 2.添加配置乐观锁插件

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
  MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  //添加分页插件
  interceptor.addInnerInterceptor(new
PaginationInnerInterceptor(DbType.MYSQL));
  //添加乐观锁插件
  interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
  return interceptor;
}

代码实现

@Test
public void testConcurrentVersionUpdate() {
  //小李取数据
  Product p1 = productMapper.selectById(1L);
  //小王取数据
  Product p2 = productMapper.selectById(1L);
  //小李修改 + 50
  p1.setPrice(p1.getPrice() + 50);
  int result1 = productMapper.updateById(p1);
  System.out.println("小李修改的结果：" + result1);
  //小王修改 - 30
  p2.setPrice(p2.getPrice() - 30);
  int result2 = productMapper.updateById(p2);
  System.out.println("小王修改的结果：" + result2);
  if(result2 == 0){
    //失败重试，重新获取version并更新
    p2 = productMapper.selectById(1L);
    p2.setPrice(p2.getPrice() - 30);
    result2 = productMapper.updateById(p2);
 }
  System.out.println("小王修改重试的结果：" + result2);
  //老板看价格
  Product p3 = productMapper.selectById(1L);
  System.out.println("老板看价格：" + p3.getPrice());
}

7.通用枚举

创建通用枚举类型

package com.atguigu.mp.enums;
import com.baomidou.mybatisplus.annotation.EnumValue;
import lombok.Getter;
@Getter
public enum SexEnum {
  MALE(1, "男"),
  FEMALE(2, "女");
  @EnumValue
  private Integer sex;
  private String sexName;
  SexEnum(Integer sex, String sexName) {
    this.sex = sex;
    this.sexName = sexName;
     }
}

扫描通用枚举

mybatis-plus:
configuration:
  # 配置MyBatis日志
 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
global-config:
 db-config:
   # 配置MyBatis-Plus操作表的默认前缀
  table-prefix: t_
   # 配置MyBatis-Plus的主键策略
  id-type: auto
 # 配置扫描通用枚举
type-enums-package: com.atguigu.mybatisplus.enums

测试

@Test
public void testSexEnum(){
  User user = new User();
  user.setName("Enum");
  user.setAge(20);
  //设置性别信息为枚举项，会将@EnumValue注解所标识的属性值存储到数据库
  user.setSex(SexEnum.MALE);
  //INSERT INTO t_user ( username, age, sex ) VALUES ( ?, ?, ? )
  //Parameters: Enum(String), 20(Integer), 1(Integer)
  userMapper.insert(user);
}

8.代码生成器

自行查看MyBatisPlus官网
下面是一个案例

package com.chen;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;

public class CodeGenerator {
    public static void main(String[] args) {
        //1.获取代码生成器的对象
        AutoGenerator autoGenerator = new AutoGenerator();

        //设置数据库相关配置
        DataSourceConfig dataSource = new DataSourceConfig();
        dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/ssm_db");
        dataSource.setUsername("root");
        dataSource.setPassword("2002");
        autoGenerator.setDataSource(dataSource);

        //设置全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir(System.getProperty("user.dir")+"/src/main/java");    //设置代码生成位置
        globalConfig.setOpen(false);    //设置生成完毕后是否打开生成代码所在的目录
        globalConfig.setAuthor("chen");    //设置作者
        globalConfig.setFileOverride(true);     //设置是否覆盖原始生成的文件
        globalConfig.setMapperName("%sDao");    //设置数据层接口名，%s为占位符，指代模块名称
        globalConfig.setIdType(IdType.ASSIGN_ID);   //设置Id生成策略
        autoGenerator.setGlobalConfig(globalConfig);

        //设置包名相关配置
        PackageConfig packageInfo = new PackageConfig();
        packageInfo.setParent("com.chen");   //设置生成的包名，与代码所在位置不冲突，二者叠加组成完整路径
        packageInfo.setEntity("domain");    //设置实体类包名
        packageInfo.setMapper("dao");   //设置数据层包名
        autoGenerator.setPackageInfo(packageInfo);

        //策略设置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("tbl_book");  //设置当前参与生成的表名，参数为可变参数
        strategyConfig.setTablePrefix("tbl_");  //设置数据库表的前缀名称，模块名 = 数据库表名 - 前缀名  例如： User = tbl_user - tbl_
        strategyConfig.setRestControllerStyle(true);    //设置是否启用Rest风格
        strategyConfig.setVersionFieldName("version");  //设置乐观锁字段名
        strategyConfig.setLogicDeleteFieldName("deleted");  //设置逻辑删除字段名
        strategyConfig.setEntityLombokModel(true);  //设置是否启用lombok
        autoGenerator.setStrategy(strategyConfig);
        //2.执行生成操作
        autoGenerator.execute();
    }
}

9.多数据源

引入依赖

<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
  <version>3.5.0</version>
</dependency>

配置多数据源

spring:
 # 配置数据源信息
datasource:
 dynamic:
   # 设置默认的数据源或者数据源组,默认值即为master
  primary: master
   # 严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源
  strict: false
  datasource:
   master:
    url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 123456
   slave_1:
    url: jdbc:mysql://localhost:3306/mybatis_plus_1?characterEncoding=utf-8&useSSL=false
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 123456

在用户service中，在类上增加@DS（“数据源名称”）来指定所操作的数据源

10. MyBatisX插件

MyBatisX插件用法：https://baomidou.com/pages/ba5b24/