李幽微

V1

2022/12/06阅读:99主题:Pornhub黄

MyBatis-Plus

本文档基于数据持久化技术 MyBatis-Plus 3.5.2

需要用到的技术:

  • 数据源:HikariDataSource

  • 数据库:h2/MySQL 8

  • 容器:SpringBoot 2.7.5

开发工具:旗舰版 IDEA2022.2

版本管理工具: Maven 3.6.3

序言

MyBatis-Plus 的思维导图

MyBatis-Plus思维导图
MyBatis-Plus思维导图

MyBatis-Plus 的工作原理

MyBatis-Plus工作原理
MyBatis-Plus工作原理

1.入门案例

1.1 创建数据库

1.1.1 设计数据表

user表
id name age email
1 Jone 18 test1@baomidou.com
2 Jack 20 test2@baomidou.com
3 Tom 28 test3@baomidou.com
4 Sandy 21 test4@baomidou.com
5 Billie 24 test5@baomidou.com

1.1.2 数据库 Schema 脚本

DROP TABLE IF EXISTS user;

CREATE TABLE user
(
    id INT NOT NULL COMMENT '主键ID',
    name VARCHAR(30NULL DEFAULT NULL COMMENT '姓名',
    age INT NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);

1.1.3 数据库 Data 脚本

DELETE FROM user;
INSERT INTO user (idname, age, email) VALUES
(1'Jone'18'test1@baomidou.com'),
(2'Jack'20'test2@baomidou.com'),
(3'Tom'28'test3@baomidou.com'),
(4'Sandy'21'test4@baomidou.com'),
(5'Billie'24'test5@baomidou.com');

1.2 初始化 Spring Boot 过程

1.2.1 添加相关依赖

数据层技术=内置默认数据库H2 +数据持久层技术mybatis-plus+内置的数据源HikariDataSource

<!--pom.xml配置-->
  <!--数据持久化技术-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.2</version>
        </dependency>
        <!--jdbc规范,没有配置相关jdbc会报错(可以选择添加)-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
       <!--SpringBoot默认内置h2数据库(可以更换为其它类型的数据库)-->
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--web,为了使用内置数据库h2的管理工具-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--测试-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!--使用junit相关API--->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>

1.2.2 修改配置文件

# application.yml配置
## 配置数据源
spring:
  datasource:
    url: jdbc:h2:~/test
    hikari:
      username: sa
      password: 123456
      driver-class-name: org.h2.Driver
   ## h2相关配置
    h2:
    console:
      ### 开启h2管理工具
      enabled: true
      ### 设置h2访问路径(http://localhost:端口/h2)
      path: /h2

## 配置mybatis-plus
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl ### 开启日志

1.2.3 测试开发环境

步骤一:运行引导类Application.java

步骤二:在浏览器中输入:http://localhost:端口/h2,进入h2可是化管理工具。

步骤三:在h2可视化管理工具中执行相关SQL脚本

1.3 编码开发

1.3.1 编写实体类

package com.example.entity;

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

1.3.2 编写 Mapper 接口

package com.example.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User{

}

小提示:

    另外一种方法是在引导类前加个@MapperScanner 注解指定需要扫描的 Mapper 接口所在的包,就可以不在每个 Mapper 接口上加@Mapper 注解了。

    若采用这种方法,IDEA 在 userMapper 处报错,因为找不到注入的对象,因为类是动态创建的,但是程序可以正确的执行。为了避免报错,可以在 mapper 接口上添加 @Repository 注解或者@Mapper 注解。

1.3.3 编写测试类

package com.example;

import com.example.entity.User;
import com.example.mapper.UserMapper;
import org.junit.Assert;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.List;

@RunWith(SpringRunner.class)
@SpringBootTest
public class ApplicationTests 
{
    @Autowired
    private UserMapper userMapper;

    @Test
    void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        Assert.assertEquals(5, userList.size());
        userList.forEach(System.out::println);
    }

}

1.3.4 控制台输出信息

	----- selectAll method test ------
Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@544e6b] was not registered for synchronization because synchronization is not active
JDBC Connection [HikariProxyConnection@393528546 wrapping conn0: url=jdbc:h2:~/test user=SA] will not be managed by Spring
==>  Preparing: SELECT id,name,age,email FROM user
==> Parameters: 
<==    Columns: ID, NAME, AGE, EMAIL
<==        Row: 1, Jone, 18, test1@baomidou.com
<==        Row: 2, Jack, 20, test2@baomidou.com
<==        Row: 3, Tom, 28, test3@baomidou.com
<==        Row: 4, Sandy, 21, test4@baomidou.com
<==        Row: 5, Billie, 24, test5@baomidou.com
<==      Total: 5
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@544e6b]
 
User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)    

2. 基本 CRUD

2.1 BaseMapper接口

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

package com.baomidou.mybatisplus.core.mapper;
public interface BaseMapper<Textends Mapper<T{
 /**
  * 插入一条记录
  * @param entity 实体对象
  */

  int insert(T entity);

 //____________________________________________delete____________________________________________________
 /**
  * 根据 ID 删除
  * @param id 主键ID
  */

  int deleteById(Serializable id);
 /**
  * 根据实体(ID)删除
  * @param entity 实体对象
  * @since 3.4.4
  */

   int deleteById(T entity);
 /**
  * 根据 columnMap 条件,删除记录
  * @param columnMap 表字段 map 对象
  */

  int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
 /**
  * 根据 entity 条件,删除记录
  * @param queryWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成 where
语句)
  */

  int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
 /**
  * 删除(根据ID 批量删除)
  * @param idList 主键ID列表(不能为 null 以及 empty)
  */

  int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

 //____________________________________________update____________________________________________________
 /**
  * 根据 ID 修改
  * @param entity 实体对象
  */

  int updateById(@Param(Constants.ENTITY) T entity);
 /**
  * 根据 whereEntity 条件,更新记录
  * @param entity    实体对象 (set 条件值,可以为 null)
  * @param updateWrapper 实体对象封装操作类(可以为 null,里面的 entity 用于生成
where 语句)
  */

  int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

 //____________________________________________select____________________________________________________
 /**
  * 根据 ID 查询
  * @param id 主键ID
  */

  selectById(Serializable id);
 /**
  * 查询(根据ID 批量查询)
  * @param idList 主键ID列表(不能为 null 以及 empty)
  */

  List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
 /**
  * 查询(根据 columnMap 条件)
  * @param columnMap 表字段 map 对象
  */

  List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object>columnMap);

 //____________________________________________条件查询__________________________________________________
 /**
  * 根据 entity 条件,查询一条记录
  * <p>查询一条记录,例如 qw.last("limit 1") 限制取一条记录, 注意:多条数据会报异常
</p>
  * @param queryWrapper 实体对象封装操作类(可以为 null)
  */

   default T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper) {
    List<T> ts = this.selectList(queryWrapper);
    if (CollectionUtils.isNotEmpty(ts)) {
      if (ts.size() != 1) {
        throw ExceptionUtils.mpe("One record is expected, but the query result is multiple records");
     }
      return ts.get(0);
   }
    return null;
 }
 /**
  * 根据 Wrapper 条件,查询总记录数
  * @param queryWrapper 实体对象封装操作类(可以为 null)
  */

  Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  /**
  * 根据 entity 条件,查询全部记录
  * @param queryWrapper 实体对象封装操作类(可以为 null)
  */

  List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  /**
  * 根据 Wrapper 条件,查询全部记录
  * @param queryWrapper 实体对象封装操作类(可以为 null)
  */

  List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  /**
  * 根据 Wrapper 条件,查询全部记录
  * <p>注意: 只返回第一个字段的值</p>
  * @param queryWrapper 实体对象封装操作类(可以为 null)
  */

  List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  /**
  * 根据 entity 条件,查询全部记录(并翻页)
  * @param page     分页查询条件(可以为 RowBounds.DEFAULT)
  * @param queryWrapper 实体对象封装操作类(可以为 null)
  */

  <P extends IPage<T>> selectPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
  /**
  * 根据 Wrapper 条件,查询全部记录(并翻页)
  * @param page     分页查询条件
  * @param queryWrapper 实体对象封装操作类
  */

  <P extends IPage<Map<String, Object>>> selectMapsPage(P page,@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}

2.2 插入

//添加
@Test
void testInsert(){
    User user = new User();
    user.setName("Helen");
    user.setAge(18);
    user.setEmail("55317332@qq.com");
    //INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
    int result = userMapper.insert(user);
    System.out.println(result);
    //1475754982694199298
    System.out.println(user);
}

注意:最终执行的结果,所获取的 id 为 1475754982694199298 这是因为 MyBatis-Plus 在实现插入数据时,会默认基于雪花算法的策略生成 id(详情参考:主键策略

2.3 删除

2.3.1 通过 id 删除记录

    @Test
    void testDeleteById(){
        //通过id删除用户信息
        //DELETE FROM user WHERE id=?
        int result = userMapper.deleteById(8L);
        System.out.println(result);
    }

2.3.2 通过 id 批量删除记录

    @Test
  void testDeleteBatchIds() {
        //通过多个id批量删除
      //DELETE FROM user WHERE id IN ( ? , ? , ? )
     int result = userMapper.deleteBatchIds(Arrays.asList(8910));
     System.out.println(result);
 }

2.3.3 通过 map 条件删除记录

    @Test
    void testDeleteByMap() {
        //根据map集合中所设置的条件删除记录
        //DELETE FROM user WHERE name = ? AND age = ?
        HashMap<String, Object> map = new HashMap<>();
        map.put("name""Helen");
        map.put("age"18);
        int result = userMapper.deleteByMap(map);
        System.out.println(result);
    }

2.4 修改

    //修改操作
    @Test
    void testUpdate() {
        User user = new User();
        user.setId(6L);
        user.setAge(120);
        //根据Id更新操作
        //UPDATE user SET name=?, age=? WHERE id=?
        int row = userMapper.updateById(user);
        System.out.println(row);
    }

2.5 查询

2.5.1 根据 id 查询记录

@Test
void testSelectById(){
    //根据id查询用户信息
    //SELECT id,name,age,email FROM user WHERE id=?
    User user = userMapper.selectById(1L);
    System.out.println(user);
}

2.5.2 通过多个 id 批量查询

完成了动态 sql 的 foreach 的功能

@Test
void testSelectBatchIds(){
    //根据多个id查询多个用户信息
    //SELECT id,name,age,email FROM user WHERE id IN ( ? , ? )
    List<User> users = userMapper.selectBatchIds(Arrays.asList(123));
    users.forEach(System.out::println);
}

2.5.3 简单的条件查询

通过 map 封装查询条件

@Test
void testSelectByMap(){
   //通过map条件查询用户信息
   //SELECT id,name,age,email FROM user WHERE name = ? AND age = ?
    HashMap<String, Object> map = new HashMap<>();
    map.put("name""Helen");
    map.put("age"18);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

注意:map 中的 key 对应的是数据库中的列名。例如数据库 user_id,实体类是 userId,这时 map 的 key 需要填写 user_id

2.5.4 查询所有数据

@Test
void testSelectList(){
   //查询所有用户信息
   //SELECT id,name,age,email FROM user
   List<User> list = userMapper.selectList(null);
   list.forEach(System.out::println);
}

通过观察BaseMapper接口中的方法,大多方法中都有Wrapper类型的形参,此为条件构造器,可针 对于SQL语句设置不同的条件,若没有条件,则可以为该形参赋值 null,即查询(删除/修改)所 有数据

2.6 通用 Service

说明:

  • 通用 Service CRUD 封装IService接口,进一步封装 CRUD 采用 get 查询单行 remove 删 除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆,
  • 泛型 T 为任意实体对象
  • 建议如果存在自定义通用 Service 方法的可能,请创建自己的IBaseService 继承 MyBatis-Plus 提供的基类
  • 参考:MyBatis-Plus 官网

2.6.1 IService接口

MyBatis-Plus 中有一个接口 IService和其实现类 ServiceImpl,封装了常见的业务层逻辑,详情查看源码IServiceServiceImpl

2.6.2 创建 Service 接口和实现类

创建 Service 接口

/**
 * UserService继承IService模板提供的基础功能
 */

 public interface UserService extends IService<User{

 }

创建 Service 接口实现类

/**
 * ServiceImpl实现了IService,提供了IService中基础功能的实现
 * 若ServiceImpl无法满足业务需求,则可以使用自定的UserService定义方法,并在实现类中实现
 */

 @Service
 public class UserServiceImpl extends ServiceImpl<UserMapperUserimplements UserService {

 }

2.6.3 测试查询记录数

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

2.6.4 测试批量插入

@Test
void testSaveBatch(){
  // SQL长度有限制,海量数据插入单条SQL无法实行,
  // 因此MP将批量插入放在了通用Service中实现,而不是通用Mapper
  ArrayList<User> users = new ArrayList<>();
  for (int i = 0; i < 5; i++) {
    User user = new User();
    user.setName("ybc" + i);
    user.setAge(20 + i);
    users.add(user);
 }
  //SQL:INSERT INTO user ( username, age ) VALUES ( ?, ? )
  userService.saveBatch(users);
}

3. 常用注解

3.1 @TableName

3.1.1 前提

经过以上的测试,在使用 MyBatis-Plus 实现基本的 CRUD 时,我们并没有指定要操作的表,只是在 Mapper 接口继承BaseMapper时,设置了泛型 User,而操作的表为 user 表。

由此得出结论,MyBatis-Plus在确定操作的表时,由BaseMapper 的泛型决定,即实体类型决定,且默认操作的表名和实体类型的类名一致。

3.1.2 问题

若实体类类型的类名和要操作的表的表名不一致,会出现什么问题?我们将表 user 更名为 t_user,测试查询功能程序抛出异常,Table 'mybatis_plus.user' doesn't exist,因为现在的表名为 t_user,而默认操作的表名和实体类型的类名一致,即 user 表。

mybatis_plus表名与实体类不一致异常
mybatis_plus表名与实体类不一致异常

3.1.1 两种解决方案

方案一:通过@TableName解决问题

package com.example.entity;
//省略了import...
@TableName('t_user')
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

方案二:通过全局配置解决问题

在开发的过程中,我们经常遇到以上的问题,即实体类所对应的表都有固定的前缀,例如 t或 tbl

此时,可以使用MyBatis-Plus提供的全局配置,为实体类所对应的表名设置默认的前缀,那么就不需要在每个实体类上通过@TableName标识实体类对应的表。

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

3.2 @TableId

3.2.1 前提

经过以上的测试,MyBatis-Plus在实现 CRUD 时,会默认将 id 作为主键列,并在插入数据时,默认基于雪花算法的策略生成 id

3.2.2 问题

若实体类和表中表示主键的不是 id,而是其他字段,例如uid,MyBatis-Plus 会自动识别uid为主键列吗?

我们实体类中的属性 id 改为uid,将表中的字段 id 也改为uid,测试添加功能,程序抛出异常,Field 'uid' doesn't have a default value,说明 MyBatis-Plus 没有将uid作为主键赋值。

uid不作为主键赋值问题
uid不作为主键赋值问题

3.2.3 两种解决方案

方案一:通过@TableId解决问题

在实体类中 uid 属性上通过@TableId 将其标识为主键,即可成功执行 SQL 语句

package com.example.entity;
//省略了import...
public class User {
 @TableId
 private Long uid;
    private String name;
    private Integer age;
    private String email;
}

方案二:@TableId的 value 属性

若实体类中主键对应的属性为 id,而表中表示主键的字段为uid,此时若只在属性 id 上添加注解@TableId,则抛出异常Unknown column 'id' in 'field list',即 MyBatis-Plus 仍然会将 id 作为表的主键操作,而表中表示主键的是字段uid

主键为uid的情况
主键为uid的情况

此时需要通过@TableId注解的 value 属性,指定表中的主键字段,@TableId("uid")@TableId(value="uid")

3.2.4 主键策略

@TableId的 type 属性用来定义主键策略

主键策略
描述
IdType.ASSIGN_ID(默 认) 基于雪花算法的策略生成数据id,与数据库id是否设置自增无关
IdType.AUTO 使用数据库的自增策略,注意,该类型请确保数据库设置了id自增, 否则无效

(1)单个主键配置

要想主键自增,需要配置如下主键策略:

  • 需要在创建数据表的时候设置主键自增
  • 实体字段中配置 @TableId(type = IdType.AUTO)
package com.example.entity;
//省略了import...
public class User {
 @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

(2)全局主键配置

要想影响所有实体的配置,可以设置全局主键配置

# application.yml的配置
#全局设置主键生成策略
mybatis-plus:
 global-config:
  db-config:
   # 配置MyBatis-Plus的主键策略
   id-type: auto

(3)其它主键策略

分析 枚举类IdType 源码可知:

  @Getter
    public enum IdType {
        /**
         * 数据库ID自增
         */

        AUTO(0),
        /**
         * 该类型为未设置主键类型
         */

        NONE(1),
        /**
         * 用户输入ID
         * 该类型可以通过自己注册自动填充插件进行填充
         */

        INPUT(2),

        /* 以下3种类型、只有当插入对象ID 为空,才自动填充。 */
        /**
         * 全局唯一ID (idWorker)
         */

        ID_WORKER(3),
        /**
         * 全局唯一ID (UUID)
         */

        UUID(4),
        /**
         * 字符串全局唯一ID (idWorker 的字符串表示)
         */

        ID_WORKER_STR(5);

        private int key;

        IdType(int key) {
            this.key = key;
        }
    }

(4)拓展:常用主键生成策略

常用主键生成策略
常用主键生成策略

参考资料:分布式系统唯一 ID 生成方案汇总

3.2.5 雪花算法

  • 背景

     需要选择合适的方案去应对数据规模的增长,以应对逐渐增长的访问压力和数据量。

     数据库的扩展方式主要包括:业务分库、主从复制,数据库分表。

  • 数据库分表

     将不同业务数据分散存储到不同的数据库服务器,能够支撑百万甚至千万用户规模的业务,但如果业务继续发展,同一业务的单表数据也会达到单台数据库服务器的处理瓶颈。例如,淘宝的几亿用户数据,如果全部存放在一台数据库服务器的一张表中,肯定是无法满足性能要求的,此时就需要对单表数据进行拆分。

​     单表数据拆分有两种方式:垂直分表和水平分表。示意图如下:

数据库分表-两种单表数据拆分方式
数据库分表-两种单表数据拆分方式
  • 垂直分表

     垂直分表适合将表中某些不常用且占了大量空间的列拆分出去。
     例如,前面示意图中的 nickname 和 description 字段,假设我们是一个婚恋网站,用户在筛选其他用户的时候,主要是用 age 和 sex 两个字段进行查询,而 nickname 和 description 两个字段主要用于展示,一般不会在业务查询中用到。description 本身又比较长,因此我们可以将这两个字段独立到另外一张表中,这样在查询 age 和 sex 时,就能带来一定的性能提升。

  • 水平分表

​     水平分表适合表行数特别大的表,有的公司要求单表行数超过 5000 万就必须进行分表,这个数字可以作为参考,但并不是绝对标准,关键还是要看表的访问性能。对于一些比较复杂的表,可能超过 1000 万就要分表了;而对于一些简单的表,即使存储数据超过 1 亿行,也可以不分表。但不管怎样,当看到表的数据量达到千万级别时,作为架构师就要警觉起来,因为这很可能是架构的性能瓶颈或者隐患。
​     水平分表相比垂直分表,会引入更多的复杂性,例如要求全局唯一的数据 id 该如何处理:

          ›主键自增

① 以最常见的用户 ID 为例,可以按照 1000000 的范围大小进行分段,1 ~ 999999 放到表 1 中,1000000 ~ 1999999 放到表 2 中,以此类推。

② 复杂点:分段大小的选取。分段太小会导致切分后子表数量过多,增加维护复杂度;分段太大可能会导致单表依然存在性能问题,一般建议分段大小在 100 万至 2000 万之间,具体需要根据业务选取合适的分段大小。

③ 优点:可以随着数据的增加平滑地扩充新的表。例如,现在的用户是 100 万,如果增加到 1000 万,只需要增加新的表就可以了,原有的数据不需要动。

④ 缺点:分布不均匀。假如按照 1000 万来进行分表,有可能某个分段实际存储的数据量只有 1 条,而另外一个分段实际存储的数据量有 1000 万条。

         ›取模

① 同样以用户 ID 为例,假如我们一开始就规划了 10 个数据库表,可以简单地用 user_id % 10 的值来表示数据所属的数据库表编号,ID 为 985 的用户放到编号为 5 的子表中,ID 为 10086 的用户放到编号为 6 的子表中。

② 复杂点:初始表数量的确定。表数量太多维护比较麻烦,表数量太少又可能导致单表性能存在问题。

③ 优点:表分布比较均匀。

④ 缺点:扩充新的表很麻烦,所有数据都要重分布。

        ›雪花算法

雪花算法是由 Twitter 公布的分布式主键生成算法,它能够保证不同表的主键的不重复性,以及相同表的主键的有序性。

① 核心思想:
​     长度共 64 bit(一个 long 型)。

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

雪花算法
雪花算法

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

3.3 @TableField

3.3.1 问题

经过以上的测试,我们可以发现,MyBatis-Plus 在执行 SQL 语句时,要保证实体类中的属性名和表中的字段名一致。

如果实体类中的属性名和字段名不一致的情况,会出现什么问题呢?

3.3.2 情况 1

若实体类中的属性使用的是驼峰命名风格,而表中的字段使用的是下划线命名风格。例如实体类属性 userName,表中字段 user_name

此时 MyBatis-Plus 会自动将下划线命名风格转化为驼峰命名风格,相当于在 MyBatis 中配置。

3.3.3 情况 2

若实体类中的属性和表中的字段不满足情况 1,例如实体类属性 name,表中字段 username

此时需要在实体类属性上使用@TableField("username")设置属性所对应的字段名。

package com.example.entity;
//省略了import...
public class User {
    private Long id;
    @TableField("username")
    private String name;
    private Integer age;
    private String email;
}

3.3.4 自动填充

mp实现自动填充
mp实现自动填充

项目中经常会遇到一些数据,每次都使用相同的方式填充,例如记录的创建时间更新时间等。

我们可以使用 MyBatis-Plus 的自动填充功能,完成这些字段的赋值工作:

步骤一:数据库表中添加自动填充字段

在 t_user 表中添加datetime类型的新的字段 create_time、update_time

步骤二:实体类上添加相关属性

package com.example.entity;
import java.util.Date;
//省略了import...
@Data
public class User {
   //省略了其它属性
   private Date createTime;
   private Date updateTime;
}

步骤三:实体上添加注解

package com.example.entity;
//省略了import...
@Data
public class User {
    //省略了其它属性
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

步骤四:实现元对象处理器接口

package com.example.handler;

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

import java.util.Date;

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime",new Date(),metaObject);//只要执行添加方法,就自动更新创建时间
        this.setFieldValByName("updateTime",new Date(),metaObject);//只要执行添加方法,就自动更新更新时间
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime",new Date(),metaObject);//只要执行更新方法,就自动更新更新时间
    }
}

注意:不要忘记添加 @Component 注解

步骤五:在测试类,执行testInsert()以及testUpdate()方法

3.4 @TableLogic

3.4.1 逻辑删除的概念

物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除数据

逻辑删除:假删除,将对应数据中代表是否被删除字段状态修改为“被删除状态”,之后在数据库中仍旧能看到此条数据记录

使用场景:可以进行数据恢复

3.4.2 逻辑删除的实现

mp实现逻辑删除
mp实现逻辑删除

步骤一:数据库中添加 deleted 字段

ALTER TABLE `t_user` ADD COLUMN `deleted` int
实现逻辑删除-t_user表添加字段
实现逻辑删除-t_user表添加字段

步骤二:实体类添加 deleted 字段

① 方法一:t_user 表中给 deleted 字段设置 default 约束

package com.example.entity;
//省略了import...
public class User {
    private Long id;
    @TableField("username")
    private String name;
    private Integer age;
    private String email;
  @TableLogic
    private Integer deleted;
}

② 方法二:使用自动填充进行默认取值

加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解

package com.example.entity;
public class User {
    //省略了其它属性
  @TableLogic
    @TableField(fill = FieldFill.INSERT)
    private Integer deleted;
}

元对象处理器接口添加 deleted 的 insert 默认值

package com.example.handler;
//省略了import...
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
   @Override
    public void insertFill(MetaObject metaObject) {
        ......
        this.setFieldValByName("deleted"0, metaObject);
    }
}

注意:也可不使用自动填充的方式,直接在 tb_user 中为 deleted 字段添加 default 约束,设置默认值。

application.yml 加入配置

注意:此为默认值,如果你的默认值和 mp 默认的一样,该配置可无

# application.yml的配置
mybatis-plus:
 global-config:
  db-config:
   logic-delete-value: 1
            logic-not-delete-value: 0

步骤三:测试逻辑删除

  • 测试后发现,数据并没有被删除,deleted 字段的值由 0 变成了 1
  • 测试后分析打印的 sql 语句,是一条 update
  • 注意:被删除数据的 deleted 字段的值必须是 0,才能被选取出来执行逻辑删除的操作
//测试逻辑删除
    @Test
    void testLogicDelete() {
        int result = userMapper.deleteById(1L);
        System.out.println(result);
    }

步骤四:测试逻辑删除后的查询

MyBatis-Plus中查询操作也会自动添加逻辑删除字段的判断

    /**
     * 测试 逻辑删除后的查询:
     * 不包括被逻辑删除的记录
     */

    @Test
    void testLogicDeleteSelect() {
        User user = new User();
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

测试后分析打印的sql语句,包含 WHERE deleted=0

SELECT id,name,age,email,create_time,update_time,deleted FROM user WHERE deleted=0

4.条件构造器和常用接口

4.1 Wrapper 体系结构

mp的Wrapper体系结构
mp的Wrapper体系结构
  • Wrapper : 条件构造抽象类,最顶端父类
    • AbstractWrapper : 用于查询条件封装,生成 sql 的 where 条件
      • QueryWrapper: Entity 对象封装操作类,不是用 lambda 语法
      • UpdateWrapper : Update 条件封装,用于 Entity 对象更新操作
      • AbstractLambdaWrapper : Lambda 语法使用 Wrapper 统一处理解析 lambda 获取 column。
        • LambdaQueryWrapper :看名称也能明白就是用于 Lambda 语法使用的查询 Wrapper
        • LambdaUpdateWrapper : Lambda 更新封装 Wrapper

4.2 QueryWrapper

注意:以下条件构造器的方法入参中的 column均表示数据库字段

mp实现复杂查询知识图
mp实现复杂查询知识图

4.2.1 例 1:组装查询条件

Test
void test01()
{
  //查询用户名包含a,年龄在20到30之间,并且邮箱不为null的用户信息
  //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE deleted=0 AND (username LIKE ? AND age BETWEEN ? AND ? AND email IS NOT NULL)
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  queryWrapper.like("username""a")
     .between("age"2030)
     .isNotNull("email");
  List<User> list = userMapper.selectList(queryWrapper);
  list.forEach(System.out::println);
}

4.2.2 例 2:组装排序条件

@Test
void test02(){
  //按年龄降序查询用户,如果年龄相同则按id升序排列
  //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE deleted=0 ORDER BY age DESC,id ASC
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  queryWrapper
     .orderByDesc("age")
     .orderByAsc("id");
  List<User> users = userMapper.selectList(queryWrapper);
  users.forEach(System.out::println);
}

4.2.3 例 3:组装删除条件

@Test
void test03(){
  //删除email为空的用户
  //DELETE FROM t_user WHERE (email IS NULL)
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  queryWrapper.isNull("email");
  //条件构造器也可以构建删除语句的条件
  int result = userMapper.delete(queryWrapper);
  System.out.println("受影响的行数:" + result);
}

4.2.4 例 4:条件的优先级

@Test
void test04() {
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  //将(年龄大于20并且用户名中包含有a)或邮箱为null的用户信息修改
  //UPDATE t_user SET age=?, email=? WHERE (username LIKE ? AND age > ? OR email IS NULL)
  queryWrapper
     .like("username""a")
     .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);
}
@Test
void test04() {
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  //将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
  //UPDATE t_user SET age=?, email=? WHERE (username LIKE ? AND (age > ? OR email 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);

4.2.5 例 5:组装 select 子句

@Test
void test05() {
  //查询用户信息的username和age字段
  //SELECT username,age FROM t_user
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  queryWrapper.select("username""age");
  //selectMaps()返回Map集合列表,通常配合select()使用,避免User对象中没有被查询到的列值为null
  List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
  maps.forEach(System.out::println);
}

4.2.6 例 6:实现子查询

@Test
void test06() {
  //查询id小于等于3的用户信息
  //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (id IN (select id from t_user where id <= 3))
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  queryWrapper.inSql("id""select id from t_user where id <= 3");
  List<User> list = userMapper.selectList(queryWrapper);
  list.forEach(System.out::println);
}

4.3 UpdateWrapper

@Test
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 > ? OR email IS NULL))
  int result = userMapper.update(null, updateWrapper);
  System.out.println(result);
}

4.4 condition

在真正开发的过程中,组装条件是常见的功能,而这些条件数据来源于用户输入,是可选的,因此我们在组装这些条件时,必须先判断用户是否选择了这些条件。若选择,则需要组装该条件;若没有选择,则一定不能组装,以免影响 SQL 执行的结果。

4.4.1 思路一

@Test
void testCondtion() {
  //定义查询条件,有可能为null(用户未输入或未选择)
  String username = null;
  Integer ageBegin = 10;
  Integer ageEnd = 24;
  QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  //MyBatisPlus提供的StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace)构成
  if(StringUtils.isNotBlank(username)){
    queryWrapper.like("username","a");
 }
  if(ageBegin != null){
    queryWrapper.ge("age", ageBegin);
 }
  if(ageEnd != null){
    queryWrapper.le("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);
}

4.4.2 思路二

上面的实现方案没有问题,但是代码比较复杂,我们可以使用带 condition 参数的重载方法构建查 询条件,简化代码的编写

@Test
public void testUseCondition() {
  //定义查询条件,有可能为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);
}

4.5 LambdaQueryWrapper

@Test
void testLambdaQueryWrapper() {
  //定义查询条件,有可能为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);
}

4.6 LambdaUpdateWrapper

@Test
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);
}

5.插件

5.1 分页插件

MyBatis Plus 自带分页插件,只要简单的配置即可实现分页功能

步骤一:配置分页插件

package com.example.config;

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@MapperScanner("com.example.mapper")
public class MpConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        //1.定义MP拦截器
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //2.添加具体的拦截器
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));//DbType.MYSQL表示针对于MySQL数据库类型
        return interceptor;
    }
}

步骤二:编写分页代码

//测试分页插件
    @Test
    void testSelectPage(){
        //1 创建page对象
        //传入两个参数:当前页 和 每页显示记录数
        Page<User> page = new Page<>(1,5);
        //调用mp分页查询的方法
        //调用mp分页查询过程中,底层封装
        //把分页所有数据封装到page对象里面
        userMapper.selectPage(page,null);
  //获取分页数据
    List<User> list = page.getRecords();
    list.forEach(System.out::println);
        //通过page对象获取分页数据
        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());
    }

测试结果


User(id=1, name=Jone, age=18, email=test1@baomidou.com, isDeleted=0) 
User(id=2,name=Jack, age=20, email=test2@baomidou.com, isDeleted=0) 
User(id=3, name=Tom,age=28, email=test3@baomidou.com, isDeleted=0) 
User(id=4, name=Sandy, age=21,email=test4@baomidou.com, isDeleted=0) 
User(id=5, name=Billie, age=24, email=test5@baomidou.com, isDeleted=0) 

当前页:1 
每页显示的条数:5 
总记录数:17 
总页数:4 
是否有上一页:false 
是否有下一页:true

5.2 XML 自定义分页

步骤一:在 UserMapper 接口中定义方法

package com.example.Mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Mapper;
public class UserMapper extends BaseMapper<User>{
  /**
   * 根据年龄查询用户列表,分页显示
   * @param page 分页对象,xml中可以从里面进行取值,传递参数 Page 即自动分页,必须放在第一位
   * @param age 年龄
   * @return
   */

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

步骤二:编写 SQL 语句

  • 方法一:在 UserMapper 接口中使用@Select 注解
@Select("SELECT * FROM tb_user WHERE age > #{age}")
IPage<User> selectPageVo(@Param("page") Page<User> page, @Param("age") Integer age);
  • 方法二:在 UserMapper.xml 中编写 SQL
<!--UserMapper.xml的配置-->
<!--SQL片段,记录基础字段-->
<sql id="BaseColumns">id,username,age,email</sql>
<!--IPage<User> selectPageVo(Page<User> page, Integer age);-->
<select id="selectPageVo" resultType="User">
  SELECT <include refid="BaseColumns"></include> FROM t_user WHERE age > #{age}
</select>

步骤三:编写并执行测试方法

@Test
void testSelectPageVo(){
  //设置分页参数
  Page<User> page = new Page<>(15);
  userMapper.selectPageVo(page, 20);
  //获取分页数据
  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());
}

输出结果


User(id=3, name=Tom, age=28, email=test3@baomidou.com, isDeleted=null) 
User(id=4,name=Sandy, age=21, email=test4@baomidou.com, isDeleted=null) 
User(id=5, name=Billie,age=24, email=test5@baomidou.com, isDeleted=null) 
User(id=8, name=ybc1, age=21,email=null, isDeleted=null) 
User(id=9, name=ybc2, age=22, email=null, isDeleted=null)

当前页:1 
每页显示的条数:5 
总记录数:12 
总页数:3 
是否有上一页:false 
是否有下一页:true

5.3 乐观锁

5.3.1 场景

     一件商品,成本价是 80 元,售价是 100 元。老板先是通知小李,说你去把商品价格增加 50 元。小李正在玩游戏,耽搁了一个小时。正好一个小时后,老板觉得商品价格增加到 150 元,价格太高,可能会影响销量。又通知小王,你把商品价格降低 30 元。
     此时,小李和小王同时操作商品后台系统。小李操作的时候,系统先取出商品价格 100 元;小王也在操作,取出的商品价格也是 100 元。小李将价格加了 50 元,并将 100+50=150 元存入了数据库;小王将商品减了 30 元,并将 100-30=70 元存入了数据库。是的,如果没有锁,小李的操作就完全被小王的覆盖了。
     现在商品价格是 70 元,比成本价低 10 元。几分钟后,这个商品很快出售了 1 千多件商品,老板亏 1 万多。

乐观锁与悲观锁概念

     上面的故事,如果是乐观锁,小王保存价格前,会检查下价格是否被人修改过了。如果被修改过了,则重新取出的被修改后的价格,150 元,这样他会将 120 元存入数据库。
     如果是悲观锁,小李取出数据后,小王只能等小李操作完之后,才能对价格进行操作,也会保证最终的价格是 120 元。

模拟修改冲突

  • 步骤一:数据库中增加商品表,并添加数据
CREATE TABLE t_product
(
 id BIGINT(20NOT NULL COMMENT '主键ID',
 NAME VARCHAR(30NULL DEFAULT NULL COMMENT '商品名称',
 price INT(11DEFAULT 0 COMMENT '价格',
 VERSION INT(11DEFAULT 0 COMMENT '乐观锁版本号',
 PRIMARY KEY (id)
);
INSERT INTO t_product(`id`,`Name`,`price`)VALUES(1,'外星人笔记',100);
  • 步骤二:添加实体
package com.example.entity;
import lombok.Data;
@Data
public class Product {
  private Long id;
  private String name;
  private Integer price;
  private Integer version;
}
  • 步骤三:添加 mapper
package com.example.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.entity.Product;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface ProductMapper extends BaseMapper<Product{
}
  • 步骤四:编写并执行测试方法
@Test
void testConcurrentUpdate() {
  //1、小李
  Product p1 = productMapper.selectById(1L);
  System.out.println("小李取出的价格:" + p1.getPrice());
  //2、小王
  Product p2 = productMapper.selectById(1L);
  System.out.println("小王取出的价格:" + p2.getPrice());
    //3、小李将价格加了50元,存入了数据库
  p1.setPrice(p1.getPrice() + 50);
  int result1 = productMapper.updateById(p1);
  System.out.println("小李修改结果:" + result1);
  //4、小王将商品减了30元,存入了数据库
  p2.setPrice(p2.getPrice() - 30);
  int result2 = productMapper.updateById(p2);
  System.out.println("小王修改结果:" + result2);
  //最后的结果
  Product p3 = productMapper.selectById(1L);
  //价格覆盖,最后的结果:70
  System.out.println("最后的结果:" + p3.getPrice());
}

5.3.2 乐观锁概念

乐观锁概念
乐观锁概念

主要适用场景:当要更新一条记录的时候,希望这条记录没有被别人更新,也就是说实现线程安全的数据更新

5.3.3 乐观锁实现方式

  • 数据库中添加 version 字段,取出记录时,获取当前 version
SELECT id,`name`,price,`version` FROM t_product WHERE id=1
  • 更新时,version + 1
UPDATE t_product SET price=price+50`version`=`version` + 1 WHERE id=1 AND `version`=1
  • 执行更新时, set version = newVersion where version = oldVersion
  • 如果 version 不对,就更新失败

5.3.4 乐观锁具体实现

乐观锁具体实现流程
乐观锁具体实现流程

步骤一:表添加字段 version,作为乐观锁版本号

在 t_product 表中添加int类型的新的字段 version :

ALTER TABLE t_product ADD COLUMN `version` INT

步骤二:对应实体类添加版本号属性 version

package com.example.entity;
import lombok.data;
@Data
public class Product {
  private Long id;
  private String name;
  private Integer price;
  private Integer version;
}

步骤三:在实体类版本号属性 version 添加注解

package com.example.entity;
import lombok.data;
@Data
public class Product {
   private Long id;
   private String name;
   private Integer price;
   @Version
   @TableField(fill = FieldFill.INSERT)) //添加初始值
   private Integer version;
}

步骤四:元对象处理器接口添加 version 的 insert 默认值

package com.example.handler;
//省略了import...
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
   @Override
    public void insertFill(MetaObject metaObject) {
        ......
        this.setFieldValByName("version"1, metaObject);
    }
}

特别说明:

  • 支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime
  • 整数类型下 newVersion = oldVersion + 1
  • newVersion 会回写到 entity
  • 仅支持 updateById(id)update(entity, wrapper) 方法
  • update(entity, wrapper) 方法下, wrapper 不能复用!!!

步骤五:配置乐观锁插件

package com.example.config;


import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@MapperScan("com.example.mapper")
public class MpConfig {

    //乐观锁插件
    @Bean
 public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
 }

步骤六:测试乐观锁

//测试乐观锁
@Test
void testConcurrentUpdate() {
  //1、小李
  Product p1 = productMapper.selectById(1L);
  System.out.println("小李取出的价格:" + p1.getPrice());
  //2、小王
  Product p2 = productMapper.selectById(1L);
  System.out.println("小王取出的价格:" + p2.getPrice());
    //3、小李将价格加了50元,存入了数据库
  p1.setPrice(p1.getPrice() + 50);
  int result1 = productMapper.updateById(p1);
  System.out.println("小李修改结果:" + result1);
  //4、小王将商品减了30元,存入了数据库
  p2.setPrice(p2.getPrice() - 30);
  int result2 = productMapper.updateById(p2);
  System.out.println("小王修改结果:" + result2);
  //最后的结果
  Product p3 = productMapper.selectById(1L);
  //价格覆盖,最后的结果:70
  System.out.println("最后的结果:" + p3.getPrice());
}

输出结果

小李查询商品信息:
SELECT id,name,price,version FROM t_product WHERE id=?
小王查询商品信息:
SELECT id,name,price,version FROM t_product WHERE id=?
小李修改商品价格,自动将version+1
UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
Parameters: 外星人笔记本(String), 150(Integer), 1(Integer), 1(Long), 0(Integer)
小王修改商品价格,此时version已更新,条件不成立,修改失败
UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?
Parameters: 外星人笔记本(String), 70(Integer), 1(Integer), 1(Long), 0(Integer)
最终,小王修改失败,查询价格:150
SELECT id,name,price,version FROM t_product WHERE id=?    

步骤六:优化流程

@Test
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());
}

5.4 MyBatis-Plus 高级功能 —SQL 性能分析打印插件

性能分析拦截器,用于输出每条 SQL 语句及其执行时间,SQL 性能执行分析,开发环境使用,超过指定时间,停止运行。有助于发现问题。
这个功能依赖p6spy 组件,完美的输出打印 SQL 以及执行时长,支持MP3.1.0以上版本。

步骤一:引入 p6spy 的 maven 依赖。

<!--pom.xml配置-->
<!--sql 分析打印-->
<dependency>

    <groupId>p6spy</groupId>

    <artifactId>p6spy</artifactId>

    <version>3.9.1</version>

</dependency>

步骤二:更改yml连接数据库配置,主要修改driver-class-nameurljdbc后需要加上p6spy

#### application.yml配置
spring:
  datasource:
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver
    url: jdbc:p6spy:mysql://localhost:3306/test?useSSL=false&serverTimezone=GMT%2B8
    username: root
    password: 123456
  profiles:
    active: dev

步骤三:新增spy.properties文件,内容如下,可以根据需求相对应的修改文件。

# spy.properties的配置
#3.2.1以上使用
# 应用的拦截模块
modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory

# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger

#日志输出到控制台,解开注释就行了

appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger

# 指定输出文件位置

logfile=sql.log

# 使用日志系统记录 sql

#appender=com.p6spy.engine.spy.appender.Slf4JLogger

# 设置 p6spy driver 代理

deregisterdrivers=true

# 取消JDBC URL前缀

useprefix=true

# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.

excludecategories=info,debug,result,batch,resultset

# 日期格式

dateformat=yyyy-MM-dd HH:mm:ss

# 实际驱动可多个

#driverlist=org.h2.Driver
driverlist=com.mysql.cj.jdbc.Driver

# 是否开启慢SQL记录

outagedetection=true

# 慢SQL记录标准 2 秒

outagedetectioninterval=2

# 自定义日志配置
# 可用的变量为:
#   %(connectionId)            connection id
#   %(currentTime)             当前时间
#   %(executionTime)           执行耗时
#   %(category)                执行分组
#   %(effectiveSql)            提交的SQL 换行
#   %(effectiveSqlSingleLine)  提交的SQL 不换行显示
#   %(sql)                     执行的真实SQL语句,已替换占位
#   %(sqlSingleLine)           执行的真实SQL语句,已替换占位 不换行显示
customLogMessageFormat=[%(currentTime)] [%(category)-%(connectionId)] [execute time: %(executionTime) ms] execute sql:\n %(sqlSingleLine)

步骤四:执行测试类。

    @Test
    void testSelectedById(){
        User user = userMapper.selectById(10);
        System.out.println(user);
    }

步骤五:输出文件格式内容如下

[2022-11-29 22:56:45] [statement-0] [execute time: 15 ms] execute sql:
 SELECT id,name,age,email,create_time,update_time,version,deleted FROM tb_user WHERE id=10  AND deleted=0
<==    Columns: id, name, age, email, create_time, update_time, version, deleted
<==      Row: 10, Big, 102, 19428443@qq.com, 2022-11-29 18:14:19, 2022-11-29 18:14:19, null, 0
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@149274cb]
User(id=10, name=Big, age=102, email=19428443@qq.com, createTime=Tue Nov 29 18:14:19 GMT+08:00 2022, updateTime=Tue Nov 29 18:14:19 GMT+08:00 2022, version=null, deleted=0)

6.通用枚举

思考:表中的有些字段值是固定的,例如性别(男或女),此时我们可以使用 MyBatis-Plus 的通用枚举来实现。

步骤一:数据库表 t_user 添加字段sex

数据库表t_uset添加字段sex
数据库表t_uset添加字段sex
ALTER TABLE t_user ADD COLUMN `sex` INT

步骤二:创建通用枚举类型,并给字段 sex 添加@EnumValue注解

package com.example.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;
    }
}

步骤三:在实体类 User 添加属性SexEnum sex

package com.example.entity;
import lombok.data;
@Data
public class User {
    private Long id;
    @TableField("username")
    private String name;
    private Integer age;
    private String email;
  @TableLogic
    private Integer deleted;
    private SexEnum sex;
}

步骤四:配置扫描通用枚举

# application.yml
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.example.enums

步骤五:编写并执行测试方法

    @Test
    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);
    }

注意:如果没有步骤二与步骤四,执行测试类,将把 SexEnum.MALE 中的 MALE 值存进数据库,因数据不匹配,最终报错。

通用枚举存值报错
通用枚举存值报错

7.代码生成器

步骤一:引入依赖

<!--pom.xml配置-->
<!-- MyBatis-Plus 代码生成器-->
<dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-generator</artifactId>
     <version>3.5.2</version>
</dependency>
<!-- MyBatis-Plus 模板渲染器配合代码生成器使用-->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
</dependency>

步骤二:编写代码生成器类

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import org.junit.Test;

import java.util.*;

/**
 * @author 李幽微
 * @since 2022/12/1
 */

public class CodeGenerator {
    // TODO ----设置特别信息----
    // TODO  去除的表前缀(可选)
    private static final String FieldPrefix = "edu_";
    // TODO  作者
    private static final String AUTHOR = "李幽微";
    // TODO 模板路径(可选)
    private static final String TEMPLATE_PATH = "/templates/entity.java";

    // TODO -----配置数据源-----
    // TODO 数据库地址
    private static final String URL = "jdbc:mysql://localhost:3306/db_edu?serverTimezone=GMT%2B8";
    // TODO 数据库用户名
    private static final String USERNAME = "root";
    // TODO 数据库密码
    private static final String PASSWORD = "12345";


    // TODO -----设置项目信息-----
    // TODO ----设置名称----
    // TODO 路径包名(生成的文件放在绝对路径下,为下面路径代码铺垫)
    private static final String PACKAGE_DIR = "/com/liyouwei/";
    // TODO 生成包名
    private static final String PACKAGE_EXE = "com.liyouwei";
    // TODO ----设置路径----
    /**
     * 项目路径
     */

    private static final String PARENT_DIR = System.getProperty("user.dir");

    /**
     * xml路径
     */

    private static final String XML_PATH = PARENT_DIR + "/src/main/resources/mapper";
    /**
     * entity路径
     */

    private static final String ENTITY_PATH = PARENT_DIR +"/src/main/java"+PACKAGE_DIR+"entity";
    /**
     * mapper(Dao)路径
     */

    private static final String MAPPER_PATH = PARENT_DIR +"/src/main/java"+PACKAGE_DIR+"dao";
    /**
     * service路径
     */

    private static final String SERVICE_PATH = PARENT_DIR +"/src/main/java"+PACKAGE_DIR+"service";
    /**
     * serviceImpl路径
     */

    private static final String SERVICE_IMPL_PATH = PARENT_DIR+"/src/main/java"+PACKAGE_DIR+"service/impl/";
    /**
     * controller路径
     */

    private static final String CONTROLLER_PATH = PARENT_DIR +"/src/main/java"+PACKAGE_DIR+"controller";
    @Test
    public void run() {

        FastAutoGenerator.create(URL, USERNAME, PASSWORD)
                // 全局配置
                .globalConfig(builder -> builder
                        // 设置作者
                        .author(AUTHOR)
                        // 开启swagger注解
                        .enableSwagger()
                        .disableOpenDir()
                )
                // 包设置
                .packageConfig(builder -> builder
                        .parent(PACKAGE_EXE)        //设置父包名
                        .xml("mapper")
                        .entity("entity")
                        .mapper("mapper")
                        .service("service")
                        .serviceImpl("service.impl")
                        .controller("controller")
                        .pathInfo(getPathInfo())  //设置mapper.xml生成路径
                )
                // 策略配置
                .strategyConfig( (scanner, builder) -> builder
                        .addInclude("edu_teacher")
                        .addTablePrefix( "tb_","edu_","" ) //设置过滤表前缀
                        .controllerBuilder()
                        .enableRestStyle()
                        .enableHyphenStyle()
                        .entityBuilder()
                        .enableLombok() //设置是否使用Lombok

                        .addTableFills(
                                new Column( "create_time", FieldFill.INSERT ),
                                new Column( "update_time", FieldFill.INSERT_UPDATE )

                        )
                        .build() )
                /*
                   模板引擎配置,默认 Velocity 可选模板引擎 Beetl 或 Freemarker
                  .templateEngine(new BeetlTemplateEngine())
                */

                .templateEngine(new FreemarkerTemplateEngine())
                .execute();

    }
    /**
     *  处理所有情况
     *  @author 李幽微
     */

    protected static List<String> getTables (String tables){
        return "all".equals( tables ) ? Collections.emptyList() : Arrays.asList( tables.split( "," ) );
    }
    /**
     * 获取路径信息map
     * @author 李幽微
     */

    private static Map<OutputFile, String> getPathInfo() {
        Map<OutputFile, String> pathInfo = new HashMap<>(5);
        pathInfo.put(OutputFile.entity, ENTITY_PATH);
        pathInfo.put(OutputFile.mapper, MAPPER_PATH);
        pathInfo.put(OutputFile.service, SERVICE_PATH);
        pathInfo.put(OutputFile.serviceImpl, SERVICE_IMPL_PATH);
        pathInfo.put(OutputFile.controller, CONTROLLER_PATH);
        pathInfo.put(OutputFile.xml, XML_PATH);
        return pathInfo;
    }
}

8.多数据源

适用于多种场景:纯粹多库、 读写分离、 一主多从、 混合模式等
目前我们就来模拟一个纯粹多库的一个场景,其他场景类似。
场景说明: 我们创建两个库,分别为:mybatis_plus(以前的库不动)与 mybatis_plus_1(新建),将 mybatis_plus 库的 product 表移动到 mybatis_plus_1 库,这样每个库一张表,通过一个测试用例分别获取用户数据与商品数据,如果获取到说明多库模拟成功。

步骤一:创建数据库表

创建数据库 mybatis_plus_1 和表 product

CREATE DATABASE `mybatis_plus_1` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
use `mybatis_plus_1`;
CREATE TABLE product
(
 id BIGINT(20NOT NULL COMMENT '主键ID',
 name VARCHAR(30NULL DEFAULT NULL COMMENT '商品名称',
 price INT(11DEFAULT 0 COMMENT '价格',
 version INT(11DEFAULT 0 COMMENT '乐观锁版本号',
 PRIMARY KEY (id)
);

添加数据

INSERT INTO product (idNAME, price) VALUES (1'外星人笔记本'100);

删除 mybatis_plus 库 product 表

USE mybatis_plus;
DROP TABLE IF EXISTS product;

步骤二:引入依赖

<!--pom.xml的配置-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.5.2</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 与 ServiceImpl

  • 创建用户 Service
package com.example.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.example.entity.User;

public interface UserService extends IService<User{
}
package com.example.service.impl;
import com.baomidou.dynamic.datasource.annotation.DS;
import org.springframework.stereotype.Service;
import com.example.mapper.UserMapper;
import com.example.entity.User;
@DS("master"//指定所操作的数据源
@Service
public class UserServiceImpl extends ServiceImpl<UserMapperUserimplements UserService {
}
  • 创建商品 Service
package com.example.service;
import com.example.entity.Product;
import com.baomidou.mybatisplus.extension.service.IService;
public interface ProductService extends IService<Product{
}
package com.example.service.impl;
import com.baomidou.dynamic.datasource.annotation.DS;
import org.springframework.stereotype.Service;
import com.example.mapper.ProductMapper;
import com.example.entity.Product;
@DS("slave_1")
@Service
public class ProductServiceImpl extends ServiceImpl<ProductMapperProduct>
implements ProductService 
{
}

步骤五:编写并执行测试类

@Test
void testDynamicDataSource(@Autowired UserService userService,@Autowired ProductService productService){
  System.out.println(userService.getById(1L));
  System.out.println(productService.getById(1L));
}

输出结果

    Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@69ba3f4e] was not registered for synchronization because synchronization is not active
JDBC Connection [HikariProxyConnection@1739974163 wrapping com.mysql.cj.jdbc.ConnectionImpl@6fc1a8f6] will not be managed by Spring
==>  Preparing: SELECT id,name,age,email,create_time,update_time,version,deleted,sex FROM tb_user WHERE id=? AND deleted=0
==> Parameters: 1(Long)
<==    Columns: id, name, age, email, create_time, update_time, version, deleted, sex
<==       Row: 1, Jone, 18, test1@baomidou.com, null, null, null, 0, null
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@69ba3f4e]
User(id=1, name=Jone, age=18, email=test1@baomidou.com, createTime=null, updateTime=null, version=null, deleted=0, sex=null)
Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@7eae55] was not registered for synchronization because synchronization is not active
JDBC Connection [HikariProxyConnection@1568990051 wrapping com.mysql.cj.jdbc.ConnectionImpl@3ef0e576] will not be managed by Spring
==>  Preparing: SELECT id,name,price,version FROM t_product WHERE id=?
==> Parameters: 1(Long)
<==    Columns: id, name, price, version
<==        Row: 1, 外星人笔记本, 100, 0
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@7eae55]
Product(id=1, name=外星人笔记本, price=100, version=0)

思考:如果我们实现读写分离,将写操作方法加上主库数据源,读操作方法加上从库数据源,自动切换,是不是就能实现读写分离?

9.MaBatisX

     MyBatis-Plus为我们提供了强大的mapper和service模板,能够大大的提高开发效率。 但是在真正开发过程中,MyBatis-Plus并不能为我们解决所有问题,例如一些复杂的SQL,多表联查,我们就需要自己去编写代码和SQL语句,我们该如何快速的解决这个问题呢,这个时候可以使用MyBatisX插件。
     MyBatisX一款基于 IDEA 的快速开发插件,为效率而生。

分类:

后端

标签:

Java

作者介绍

李幽微
V1