13、SpringBoot整合Mybatis-Plus

本文为Mybatis-plus的进阶版，基本使用参考Spring中使用Mybatis-Plus

SpringBoot集成MP

1、pom文件中添加MP依赖

<!-- mybatis-plus -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.0</version>
</dependency>
<!-- mybatis-plus generator -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.0</version>
</dependency>

<!-- thymeleaf模板引擎 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- web -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- 数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<!-- lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

2、编写实体类（数据库表默认使用之前的）

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("mp_user")
public class User implements Serializable {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

3、配置application.yml

# 端口
server:
  port: 8080

# 数据源
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8
    username: root
    password: root123

注意：SpringBoot默认使用MySQL8.0的版本，我们可以使用MySQL5.7的版本。区别是MySQL8.0的版本的driver-class-name为com.mysql.cj.jdbc.Driver，而MySQL5.7版本为com.mysql.jdbc.Driver。另外，在MySQL8.0的版本中还要加入时区的设置：serverTimezone=GMT%2B。GMT%2B表示东八区。

4、编写mapper接口

package com.coydone.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.coydone.entity.User;

/**
 * 在对应的mapper上继承BaseMapper<T>,所有基本的CRUD操作都编写完成
 */
public interface UserMapper extends BaseMapper<User> {
}

5、在主启动类上加入扫描mapper的接口

@SpringBootApplication
@MapperScan("com.coydone.mapper")
public class Day02BootMpApplication {

    public static void main(String[] args) {
        SpringApplication.run(Day02BootMpApplication.class, args);
    }
}

6、在yaml文件中配置MP的控制台输出SQL日志，方便我们查看输出的SQL语句。

# mybatis-plus 配置
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #配置控制台输出sql日志

CRUD扩展

真实开发中，我们数据库表的字段还可能有如下字段：version（乐观锁）、deleted（逻辑删除）、gmt_create（创建时间）、gmt_modified（修改时间）。

主键生成策略

我们在数据库插入的id的默认值必须为全局的唯一id来保证数据的唯一性，在MP中也提供了主键生成策略来保证主键的唯一性。

主键生成策略：默认采用雪花算法（snowflake）。

【分布式系统唯一id生成】参考文章：https://www.cnblogs.com/haoxinyue/p/5208136.html

snowflake 是 Twitter 开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。具体实现的代码可以参看 https://github.com/twitter/snowflake

在MP中使用@TableId注解来表示实体类字段来对应数据库表的id，Type用来设置主键生成策略。

@TableId(type = IdType.AUTO)

MP中支持的数据库主键设置自增的值

public enum IdType {
    AUTO(0),//自增
    NONE(1),//未设置主键
    INPUT(2),//手动输入
    ASSIGN_ID(3),//默认值
    ASSIGN_UUID(4),
    @Deprecated//表示已过时
    ID_WORKER(3), 
    @Deprecated
    ID_WORKER_STR(3),//ID_WORKER的字符串表示
    @Deprecated
    UUID(4);
}

我们可以通过测试插入方法来测试。

@SpringBootTest
class Day02BootMpApplicationTests {

    @Autowired
    private UserMapper userMapper;

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

自动填充

创建时间、修改时间，这些操作一般都是自动化完成的，我们不希望手动更新。

阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上，而且需要自动化。

MP官方文档：https://baomidou.com/guide/auto-fill-metainfo.html

方式一：数据库级别

1、在表中新增字段：create_time、update_time，将其默认值设置为CURRENT_TIMESTAMP，将update_time改为自动更新。

同步更新实体类字段。

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("mp_user")
public class User implements Serializable {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date createTime;
    private Date updateTime;
}

方式二：代码级别

1、恢复数据库表（删除默认值、更新操作）

2、在实体类的字段上增加注解

@TableField(fill = FieldFill.INSERT)
private Date createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

3、编写处理器来处理这个注解。

创建com.coydone.handler包，在包下创建MyMetaObjectHandler。

package com.coydone.handler;

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.util.Date;

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    //插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
    //更新时的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

4、测试

@Test
public void testAdd() {
    User user = new User();
    user.setName("zhaoliu");
    user.setAge(20);
    user.setEmail("192728929@qq.com");

    int rows = userMapper.insert(user);
    System.out.println(rows);
    System.out.println(user);
}

@Test
void testUpdate() {
    User user = new User();
    user.setId(6L);
    user.setAge(20);
    int rows = userMapper.updateById(user);
    System.out.println(rows);
}

乐观锁

乐观锁：顾名思义十分乐观，它总认为不会出现问题，无论干什么都不会上锁，如果出现了问题，再次更新值测试。

悲观锁：顾名思义十分悲观，它认为总是出现问题，无论干什么都会上锁，再去操作。

乐观锁实现方式：

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

-- 乐观锁：1、先查询获取版本号，更新操作时携带版本号
update user set name = "coydone",version = version+1
where id = 2 and version = 1

1、给数据库增加version字段

2、实体类加对应的字段

@Version//表示这是一个乐观锁字段
private Integer version;

3、注册组件

在com.coydone.config下创建MyBatisPlusConfig，编写我们自定义的MP配置。我们可以将扫描mapper包的注解设置在配置类中，而不是主启动类上。

@MapperScan("com.coydone.mapper")//扫描mapper包
@Configuration//配置类
@EnableTransactionManagement//自动开启事务
public class MyBatisPlusConfig {

    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4、测试

//测试乐观锁成功
@Test
void testOptimisticLocker1() {
    //1、查询用户信息
    User user = userMapper.selectById(4L);
    //2、修改用户信息
    user.setAge(29);
    //3、更新操作
    userMapper.updateById(user);
}

//测试乐观锁失败,多线程下
@Test
void testUpdateOptimisticLocker2() {
    //线程1
    User user = userMapper.selectById(4L);
    user.setAge(30);

    //模拟另外一个线程执行插队操作
    User user2 = userMapper.selectById(4L);
    user2.setAge(50);
    userMapper.updateById(user2);

    userMapper.updateById(user);//如果没有乐观锁会覆盖插队线程的值
}

分页查询

1、配置拦截器组件

在com.coydone.config下的MyBatisPlusConfig类中编写分页的拦截器方法。

//配置分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
    // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
    // paginationInterceptor.setOverflow(false);
    // 设置最大单页限制数量，默认 500 条，-1 不受限制
    // paginationInterceptor.setLimit(500);
    // 开启 count 的 join 优化,只针对部分 left join
    paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
    return paginationInterceptor;
}

2、测试

//测试分页查询
@Test
void testPage() {
    //参数一：当前页，参数二：页大小
    Page<User> page = new Page<>(2,3);
    Page<User> userPage = userMapper.selectPage(page, null);
    List<User> users = userPage.getRecords();
    for (User user : users) {
        System.out.println(user);
    }
}

逻辑删除

官方文档：https://baomidou.com/guide/logic-delete.html

物理删除：从数据库中直接移除。

逻辑删除：在数据库中没有被移除，而是通过一个变量来让它失效。deleted = 0 → deleted = 1。

管理员可以查看被删除的记录，防止数据的丢失，类似于回收站。

1、在数据库中添加字段

2、在实体类中添加逻辑删除属性

@TableLogic//逻辑删除
private Integer deleted;

3、在yaml中配置逻辑删除

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: deleted  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

4、测试

@Test
void testDelete(){
    userMapper.deleteById(7L);
    User user = userMapper.selectById(7L);
    System.out.println(user);
}

代码自动生成

MP的3版本后对generator进行了单独的封装，在pom文件中导入其依赖。

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.0</version>
</dependency>

2、编写MP的自动生成类设置自动生成的参数。

package com.coydone.generator;

import com.baomidou.mybatisplus.annotation.DbType;
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;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

public class CodeGenerator {
    public static void main(String[] args) {
        // 1、全局配置
        GlobalConfig config = new GlobalConfig();
        config.setActiveRecord(true) // 是否支持AR模式
                .setAuthor("coydone")   // 作者
                .setOutputDir("E:\idea_workspace\zixue\mp_generator\src\main\java") // 生成路径
                .setFileOverride(true) // 文件覆盖
                .setOpen(false)//是否打开文件目录
                .setIdType(IdType.AUTO) // 主键策略自增
                .setServiceName("%sService") //设置生成的service接口名首字母是否为I,默认是以I开头
                .setBaseColumnList(true) // 基本列
                .setBaseResultMap(true); // 返回结果map

        // 2、数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDbType(DbType.MYSQL) // 设置数据库类型
                .setDriverName("com.mysql.jdbc.Driver")
                .setUrl("jdbc:mysql:///kgcnews?useUnicode=true&characterEncoding=UTF-8")
                .setUsername("root")
                .setPassword("root123");

        // 3、策略配置
        StrategyConfig stConfig = new StrategyConfig();
        stConfig.setCapitalMode(true) // 全局大写命名
                .setColumnNaming(NamingStrategy.underline_to_camel)  //表名 字段名 是否使用下滑线命名
                .setNaming(NamingStrategy.underline_to_camel) // 数据库表映射到实体的命名策略
                .setTablePrefix("news_");// 表前缀
                //生成的表,不写表示生成所有的表
                // .setInclude("news_category,news_comment,news_detail,news_user");


        // 4、包名策略配置
        PackageConfig pkConfig = new PackageConfig();
        pkConfig.setParent("com.coydone")
                .setController("controller")
                .setEntity("entity")
                .setMapper("mapper")
                .setService("service")
                .setXml("mapper");

        // 5、整合配置
        AutoGenerator ag = new
                AutoGenerator().setGlobalConfig(config)
                .setDataSource(dataSourceConfig)
                .setStrategy(stConfig)
                .setPackageInfo(pkConfig);

        // 6、执行
        ag.execute();
    }
}