MyBatisPlus的讲解与实践

MyBatisPlus概述

需要的基础：Mybatis，Spring，SpringMVC

• 为什要学习他呢？
  MyBatisPlus可以节省大量的工作时间，所有的CRUD代码它都是可以自动化完成的。

简介

• 是什么？
  Mybatis本来就是简化JDBC的操作的。MyBatisPlus是简化Mybatis的。
• 官网地址：https://mp.baomidou.com/
  
  

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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. 导入对应的依赖
2. 研究依赖如何配置
3. 代码如何编写
4. 提高扩展技术的能力

步骤

1. 创建数据库 mybatis_plus
2. 创建user表

DROP TABLE IF EXISTS user;
CREATE TABLE user
(
	id BIGINT(20) NOT NULL COMMENT '主键ID',
	name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
	age INT(11) NULL DEFAULT NULL COMMENT '年龄',
	email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
	PRIMARY KEY (id)
);
INSERT INTO user (id, name, 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');
-- 真实开发中，version(乐观锁)，delete(逻辑删除)，gmt_create,gmt_modified

3. 编写项目，初始化项目！使用Springboot初始化！
4. 导入依赖

<!-- 数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<!--mybatis-plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>

说明：使用mybatis-plus，可以节省大量的代码，尽量不要同时导入mybatis和mybatis-plus，版本差异。

5. 连接数据库，这一步和mybatis相同！

spring.datasource.username=root
spring.datasource.password=7zhangqi
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=uft-8&serverTimezone=GTM%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#mysql8要增加时区的配置  serverTimezone=GTM%2B8

6. 传统的方式pojo-dao(连接mybatis，配置mapper.xml文件)-service-controller
7. 使用了 mybatis-plus之后

• pojo

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    //数据库中对应的主键（uuid、自增id，雪花算法，redis，zookeeper）
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

• mapper接口

//在对应的Mapper上面继承基本的类BaseMapper
@Repository  //代表持久层的
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD已经编写完成了
    //不需要想mybatis以前一样配置一大堆文件
}

注意：我们需要在主启动类上去扫描我们的mapper包下的所有接口

@MapperScan("com.qi.mapper")

• 测试类

@SpringBootTest
class MybatisPlusApplicationTests {
    @Autowired
    private UserMapper userMapper;
    @Test
    void contextLoads() {
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

• 结果
  

思考问题

• SQL谁帮我们写的？Mybatis-plus都写好了
• 方法哪里来的？Mybatis-plus都写好了

配置日志

• 我们所有的sql是不可见的,我们希望知道他是怎么执行的,所以我们必须看日志!
  在properties中配置

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

配置完日志之后你会喜欢上mybatis-plus!后面学习注意这个自动生成的SQL

CRUD扩展

Insert插入

@Test
public void testInsert(){
    User user = new User();
    user.setName("codeyuaiiao");
    user.setAge(3);
    user.setEmail("747557612@qq.com");
    int result = userMapper.insert(user);//帮我们自动生成id
    System.out.println(result);//受影响的行数
    System.out.println(user);//发现，id会自动回填
}

注意点:数据库插入的id默认值为:全局的唯一id

主键生成策略

默认 ID_WORKER 全局唯一id
对应数据库中的主键(uuid.自增id.雪花算法.redis.zookeeper)

分布式系统唯一id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html

• 雪花算法：Twitter的snowflake算法
  snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0.可以保证几乎全球唯一

主键自增

1. 实体类字段上

@TableId(type = IdType.AUTO)

2. 数据库字段一定要是自增!
   
3. 再次插入即可！
   

• 其余源码解释

public enum IdType {
    AUTO(0),//数据库ID自增  
    NONE(1),//该类型为未设置主键类型      
    INPUT(2),//用户输入ID，手动输入，需要自己配置id
      		 //该类型可以通过自己注册自动填充插件进行填充   
    //以下3种类型、只有当插入对象ID 为空，才自动填充。     
    ID_WORKER(3),//默认的全局唯一ID (idWorker)      
    UUID(4),//全局唯一ID (UUID)          
    ID_WORKER_STR(5);//字符串全局唯一ID (idWorker 的字符串表示)    
}

更新操作

@Test
public void testUpdate(){
    User user = new User();
    //通过条件自动拼接动态sql
    user.setId(5L);
    user.setName("阿峧");
    //注意:updateById()参数是一个对象!
    int i = userMapper.updateById(user);
    System.out.println(i);
}

• 所有的sql都是动态帮你配置的

自动填充

创建时间 . 修改时间! 这些个操作都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create .gmt_modified几乎所有的表都要配置上!而且需要自动化!

• 方式一:数据库级别（工作中一般不允许修改数据库的）

1. 在表中新增字段 create_time , update_time
   
2. 再次测试插入方法，我们需要先把实体类同步！

private Date createTime;
private Date updateTime;

3. 再次更新查看结果即可
   

• 方式二:代码级别

1. 删除数据库的默认的值，更新操作！
   
2. 实体类字段属性上添加注解

//记住用util包下的Date!!
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date creatTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

3. 编写处理器来处理这个注解即可!

@Slf4j
@Component//一定不要忘记把处理器加到IOC容器中
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. 测试插入
5. 测试更新,观察时间即可!
   

乐观锁

在面试的过程中，我们经常会被问到乐观锁，悲观锁！这个其实非常的简单。

乐观锁: 顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不去上锁!如果出现了问题,再次更新值测试
悲观锁;顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作!

我们这里主要讲解 乐观锁机制!
乐观锁实现方式：

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

测试一下Mybatis-plus的乐观锁机制

1. 给数据库中增加version字段
   
2. 实体类中加对应的字段

@Version   //乐观锁的注解
private Integer version;

3. 注册组件

@MapperScan("com.qi.mapper")
@Configuration   //配置类
@EnableTransactionManagement
public class MybatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4. 测试一下

//测试乐观锁成功
 @Test
 public void testOptimisticLocker(){
     //1. 查询用户信息
     User user = userMapper.selectById(1L);
     //2. 修改用户信息
     user.setName("zhangqi");
     user.setEmail("144577349@qq.com");
     //执行更新操作
     userMapper.updateById(user);
 }
 //测试乐观锁失败！多线程下
 @Test
 public void testOptimisticLocker2(){
     //线程1
     User user = userMapper.selectById(1L);
     user.setName("zhang222");
     user.setEmail("144577349@qq.com");
     //模拟另外一个线程执行了插队操作
     User user2 = userMapper.selectById(1L);
     user2.setName("lisi");
     user2.setEmail("14449@qq.com");
     userMapper.updateById(user2);
     //如果没有乐观锁，就会覆盖插队线程的值，如果想要提交，自旋锁来多次尝试提交
     userMapper.updateById(user);
 }

查询操作

//测试查询
@Test
public void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}
//测试批量查询
public void testSelectBatchId(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}
//按条件查询之--使用Map操作
@Test
public void testSelectBatchIds(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","阿峧说java");
    map.put("age","18");
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

分页在网站使用的十分之多！

1. 原始的limit进行分页
2. pageHelper第三方的插件
3. mybatis-plus也内置了分页插件

如何使用

1. 配置拦截器即可

//分页插件，可以直接使用
@Bean
public PaginationInterceptor paginationInterceptor() {
    return new PaginationInterceptor();
}

2. 直接使用page对象即可

//测试分页查询
@Test
public void testPage(){
    //参数一：当前页，
    //参数二：页面大小
    //使用了分页插件之后，所有的分页操作也变得简单了
    Page<User> page = new Page<>(2, 5);
    userMapper.selectPage(page,null);
    page.getRecords().forEach(System.out::println);
    System.out.println(page.getTotal());
}

删除操作

• 基本的删除操作

//测试删除
@Test
public void testDeleteById(){
    userMapper.deleteById(1L);
}
//通过id批量删除
@Test
public void testDeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1L,2L));
}
//通过map批量删除
@Test
public void testDeleteMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","zhangsan");
    userMapper.deleteByMap(map);
}

我们在工作中会遇到一些问题，逻辑删除！

逻辑删除

物理删除:从数据库中直接移除
逻辑删除: 在数据库中没有被移除,而是通过一个变量来让他失效! deleted=0=>deleted=1

管理员可以查看被删除的记录!防止数据的丢失,类似于回收站!
测试一下：

1. 在数据库中增加一个字段deleted
   
2. pojo

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

3. 配置(高版本已经不需要了，省略)

//注册逻辑删除
@Bean
public ISqlInjector sqlInjector(){
    return new LogicSqlInjector();
}

# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

4. 测试一下删除
   

• 记录依旧在数据库，但是值确已经变化了
  
• 查询的时候会自动过滤删除的数据
  
• 以上的所有CRUD操作及其扩展,我们都必须精通掌握!会大大提好你的工作和写项目的效率

性能分析插件（新版好像移除了）

我们在平时的开发中,会遇到一些慢sql.
作用：性能分析拦截器，用于输出每条SQL语句及其执行时间
MybatisPlus也提供了性能分析插件,如果超过这个时间就停止运行!

1. 导入插件

//SQL执行效率插件
@Bean
@Profile({"dev","test"}) //设置dev 和 test环境开启
public PerformanceInterceptor performanceInterceptor(){
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    //在工作中，不允许用户等待
    performanceInterceptor.setMaxTime(100); //设置sql执行的最大的时间，如果超过了则不执行
    performanceInterceptor.setFormat(true);//是否开启格式化支持
    return performanceInterceptor;
}

• 记住在SpringBoot中配置环境为 dev或者test环境

#设置开发环境
spring.profiles.active=dev

2. 测试使用

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

使用性能分析插件，可以帮助我们提高效率！

条件构造器

• 十分重要：wrapper
  我们写一些复杂的sql就可以使用它来替代。
• 测试

@SpringBootTest
public class WrapperTest {
    @Autowired
    private UserMapper userMapper;
    @Test
    void contextLoads() {
        // 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age",12);
        userMapper.selectList(wrapper).forEach(System.out::println); // 和我们刚才学习的map对比一下
    }
​
    @Test
    void test2(){
        // 查询名字狂神说
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","狂神说");
        User user = userMapper.selectOne(wrapper); // 查询一个数据，出现多个结果使用List 或者 Map
        System.out.println(user);
    }
​
    @Test
    void test3(){
        // 查询年龄在 20 ~ 30 岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",20,30); // 区间
        Integer count = userMapper.selectCount(wrapper);// 查询结果数
        System.out.println(count);
    }
​
    // 模糊查询
    @Test
    void test4(){
        // 查询年龄在 20 ~ 30 岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 左和右  t%
        wrapper
                .notLike("name","e")
                .likeRight("email","t");
​
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }
​
    // 模糊查询
    @Test
    void test5(){
​
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // id 在子查询中查出来
        wrapper.inSql("id","select id from user where id<3");
​
        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }
​
    //测试六
    @Test
    void test6(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 通过id进行排序
        wrapper.orderByAsc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
}

• 其余的测试自己根据官方文档多多练习。

代码自动生成器

dao、pojo、service、controller都给我自己去编写完成！
AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

准备工作

• 导入mybatis-plus的依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>

• 配置文件MybatisPlusConfig

@MapperScan("com.qi.mapper")
@Configuration   //配置类
@EnableTransactionManagement
public class MybatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
    //分页插件，可以直接使用
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
    //注册逻辑删除
    @Bean
    public ISqlInjector sqlInjector(){
        return new LogicSqlInjector();
    }
    //SQL执行效率插件
    @Bean
    @Profile({"dev","test"}) //设置dev 和 test环境开启
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        //在工作中，不允许用户等待
        performanceInterceptor.setMaxTime(100); //设置sql执行的最大的时间，如果超过了则不执行
        performanceInterceptor.setFormat(true);//是否开启格式化支持
        return performanceInterceptor;
    }
}

• 在applications.properties配置数据库连接

#spring.profiles.active=dev
spring.datasource.username=root
spring.datasource.password=7zhangqi
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=UTF-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

测试

// 代码自动生成器 
public class MelonCode {
public static void main(String[] args) {
    // 需要构建一个 代码自动生成器 对象 
    AutoGenerator mpg = new AutoGenerator(); 
    
    // 配置策略 
    // 1、全局配置 
    GlobalConfig gc = new GlobalConfig();
    String projectPath = System.getProperty("user.dir"); 
    gc.setOutputDir(projectPath+"/src/main/java");
    gc.setAuthor("甜瓜"); 
    //是否打开资源管理器
    gc.setOpen(false);
    // 是否覆盖原来生成的
    gc.setFileOverride(false);
    // 去Service的I前缀
    gc.setServiceName("%sService");
    
    gc.setIdType(IdType.ID_WORKER);
    //日期的类型
    gc.setDateType(DateType.ONLY_DATE);
    gc.setSwagger2(true);
    mpg.setGlobalConfig(gc);
    
    //2、设置数据源
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUrl("jdbc:mysql://localhost:3306/community? useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
    dsc.setDriverName("com.mysql.cj.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("123456");
    dsc.setDbType(DbType.MYSQL); 
    mpg.setDataSource(dsc);
    
    //3、包的配置
    PackageConfig pc = new PackageConfig();
    //只需要改实体类名字 和包名 还有 数据库配置即可
    pc.setModuleName("blog"); pc.setParent("com.kuang");
    pc.setEntity("entity"); pc.setMapper("mapper");
    pc.setService("service"); pc.setController("controller");
    mpg.setPackageInfo(pc);
    
    //4、策略配置
    StrategyConfig strategy = new StrategyConfig();
    // 设置要映射的表名
    strategy.setInclude("blog_tags","course","links","sys_settings","user_record"," user_say");
    strategy.setNaming(NamingStrategy.underline_to_camel);
    strategy.setColumnNaming(NamingStrategy.underline_to_camel);
    // 自动lombok；
    strategy.setEntityLombokModel(true);
    //逻辑删除
    strategy.setLogicDeleteFieldName("deleted"); 
    
    // 自动填充配置
    TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
    TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
    ArrayList<TableFill> tableFills = new ArrayList<>();
    tableFills.add(gmtCreate); tableFills.add(gmtModified);
    strategy.setTableFillList(tableFills);
    
    // 乐观锁
    strategy.setVersionFieldName("version");
    strategy.setRestControllerStyle(true);
    // localhost:8080/hello_id_2
    strategy.setControllerMappingHyphenStyle(true);
    
    mpg.setStrategy(strategy);
    mpg.execute(); //执行 
    }
}

结果