Mybatis-Plus的使用

Mybatis-Plus的使用

版本 3.05

为什么使用？可以节省时间，所有 CRUD 代码都可以自动完成！

简介

是什么？Mybatis 本来就是简化 JDBC操作的！对 Mybatis 的增强

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求，基本的 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)
   );
   
   DELETE FROM user;
   
   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（乐观锁）,deleted（逻辑锁）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 8 驱动 驱动不同于 5 的要使用 com.mysql.cj.jdbc.Driver,需要增加时区的配置 serverTimezone=GMT%2B8
   spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
   spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
   spring.datasource.username=root
   spring.datasource.password=123456
   

6.传统方式 pojo-dao（连接 mybatis，配置 mapper.xml 文件）-service-controller

6. 使用 mybatis-plus 之后

   • pojo

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

   • mapper 接口

     //在对应的 Mapper 上面继承基本的类 BaseMapper
     @Repository //代表是持久层的
     public interface UserMapper extends BaseMapper<User> {
         //所有的 crud 操作编写完成，你不需要像以前一样配置一大堆文件
     }
     

   • 注意点，我们需要在主启动类上去扫描我们的 mapper 包下个所有接口, @MapperScan(basePackages = "com.example.mapper”)

   • 测试类中测试

     @SpringBootTest
     class MybatisPlusApplicationTests {
     
         //继承了 BaseMapper，所有方法来自父类，我们可以编写自己的方法
         @Autowired
         private UserMapper userMapper;
     
         @Test
         void contextLoads() {
             //参数是一个 Wrapper，条件构造器，这里先不用写 null
             //查询全部用户
             List<User> users = userMapper.selectList(null);
             users.forEach(System.out::println);
         }
     
     }
     

   • 结果

     @SpringBootApplication
     @MapperScan(basePackages = "com.example.mapper")//扫描 mapper 文件夹
     public class MybatisPlusApplication {
     
         public static void main(String[] args) {
             SpringApplication.run(MybatisPlusApplication.class, args);
         }
     
     }
     

     

思考问题？

1. SQL 谁帮我们写的？Mybatis-plus
2. 方法哪里来的？Mybatis-plus

配置日志

我们所有 sql 是不可见的，我们希望看到是如何执行的，所以我们要看日志

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

配置完毕后，学习就需要注意这个自动生产的 SQL

CRUD 扩展

insert 插入

 //测试插入
    @Test
    public void testInsert() {
        User user = new User();
        user.setName("新年好");
        user.setAge(3);
        user.setEmail("714860063@qq.com");
        int index = userMapper.insert(user);//自动生成 id
        System.out.println(index);//受影响的行数
        System.out.println(user);//发现，自动生成 id
    }

数据库插入的 id 默认值为：全局唯一 id

插入操作

主键生成策略

默认ID_WORKER全局 id

分布式系统唯一 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。可以保证全球唯一！

主键自增

我们需要配置主键自增：

1. 实体类字段上增加 @TableId(type =IdType.ID_WORKER)

2. 数据库字段一定要自增

   

3. 再次测试插入即可

   

其余源码解释

public enum IdType {
    AUTO(0), //数据库 id 自增
    NONE(1),//未设置主键 默认
    INPUT(2),//手动输入，不输入 id 就是 null
    ID_WORKER(3),//全局唯一 id
    UUID(4),//全局唯一 id
    ID_WORKER_STR(5);//ID_WORKER字符串表示

更新操作

 //测试更新
    @Test
    public void testUpdate(){
        User user = new User();
        //通过条件自动拼接动态 sql
        user.setId(5L);
        user.setName("快过年了");
        user.setAge(3);
        user.setEmail("714860063@qq.com");
        
        //updateById，这里参数需要一个对象！
        int i = userMapper.updateById(user);
        System.out.println(i);
    }

所有 sql 都是自动帮助你动态配置

自动填充

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

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

方式一：数据库级别修改(工作中不允许使用)

1. 在表中新增字段 create_time，update_time(设置更新)
2. 再次测试插入方法，我们需要先把实体类同步
3. 再次更新查看结果即可

方式二：代码级别

1. 删除数据库默认值、更新操作

2. 实体类字段属性上增加注解

    //字段添加填充内容
       @TableField(fill = FieldFill.INSERT)
       private Date createTime;
       
       @TableField(fill = FieldFill.INSERT_UPDATE)
       private Date updateTime;
   }
   

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

   @Component//一定要把主键放到 IOC 容器中
   @Slf4j
   public class MyMetaObjectHandler implements MetaObjectHandler {
   
       Date date = new Date();
   
       //插入时的填充策略
       @Override
       public void insertFill(MetaObject metaObject) {
           log.info("start insert");
           this.setFieldValByName("createTime", date, metaObject);
           this.setFieldValByName("updateTime", date, metaObject);
       }
   
       //更新时的填充策略
       @Override
       public void updateFill(MetaObject metaObject) {
           log.info("start update");
           this.setFieldValByName("updateTime", date, metaObject);
       }
   }
   

4. 测试插入

5. 更新时间

乐观锁

在面试过程中，经常会被问乐观锁，悲观锁

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

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

乐观锁实现方式：

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

乐观锁：1.先查询，获得版本号 version = 1
--A
update user set name ="hello",version = version+1
where id = 2 and version = 1

--B 线程抢先完成，这个时候 version = 2 ，会导致 A 修改失败！
update user set name ="hello",version = version+1
where id = 2 and version = 1

测试 MP 乐观锁插件

1. 给数据库增加字段 version 默认值为 1

2. 增加实体类对象

   import com.baomidou.mybatisplus.annotation.*;
   
   @Version// 乐观锁注解
       private Integer version;
   

3. 注册乐观锁插件

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

4. 测试

   //测试乐观锁成功(单线程）
       @Test
       public void testOptimisticLocker() {
           //查询用户信息
           User user = userMapper.selectById(1L);
           //修改用户信息
           user.setName("he");
           user.setAge(88);
           user.setEmail("123456@qq.com");
           //执行更新操作
           userMapper.updateById(user);
       }
   
    //测试乐观锁失败（多线程）
       @Test
       public void testOptimisticLocker2() {
           //线程 1
           User user = userMapper.selectById(1L);
           user.setName("he");
           user.setAge(88);
           user.setEmail("123456@qq.com");
   
           //线程 2 模拟线程插队操作
           User user2 = userMapper.selectById(1L);
           user2.setName("she");
           user2.setAge(66);
           user2.setEmail("123456@qq.com");
           userMapper.updateById(user2);
   
         //可以用自旋锁多次尝试提交
          userMapper.updateById(user);//如果没有乐观锁就会覆盖插队线程的值
       }
   

查询操作

 //测试查询
    @Test
    public void testSelectById() {
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }

    //测试批量查询
    @Test
    public void testSelectByBatchId() {
        List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
        users.forEach(System.out::println);
    }

    //条件查询使用 map
    @Test
    public void testSelectByBatchIds() {
        HashMap<String, Object> map = new HashMap<>();
        map.put("name", "Tom");
        List<User> users = userMapper.selectByMap(map);
        users.forEach(System.out::println);
    }

分页查询

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

1. 原始的 limit 分页
2. pageHelper 第三方插件
3. MP 内置了分页插件

如何使用

1. 配置拦截器组件即可

   //分页插件
       @Bean
       public PaginationInterceptor paginationInterceptor() {
           return new PaginationInterceptor();
       }
   

2. 配置 page 对象即可

   @Test
       public void testPage(){
           //参数一：当前页
           //参数二：页面大小
           Page<User> page = new Page<>(1,5);
           userMapper.selectPage(page,null);
           page.getRecords().forEach(System.out::println);
           System.out.println("总条数:"+page.getTotal());
       }
   

删除操作

删除有通过 id 删除，通过 id 批量删除，通过 map 删除，通过条件

逻辑删除

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

逻辑删除：在数据库中没有被移除，而是通过一个变量来让它失效！防止数据丢失，类似于回收站

1. 在数据表中增加 deleted 字段，默认值为 0

2. 实体类中增加属性和注解

   @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. 测试

   

这个时候就是逻辑删除，实际上是更新操作！

性能分析插件

平时开发中，会遇到一些慢 sql。可以通过测试！druid...

作用：性能分析拦截器，用于输出每条 SQL 语句及其执行时间

MP 也提供性能分析，如果超过这个时间就停止

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() {
           //参数是一个 Wrapper，条件构造器，这里先不用写 null
           //查询全部用户
           List<User> users = userMapper.selectList(null);
           users.forEach(System.out::println);
       }
   

   

   只要超过执行时间就会报异常，使用性能分析插件可以提供效率

条件构造器（重要）

我们写一些复杂的 SQL 就可以使用它替代

@SpringBootTest
public class WrapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    void test1() {
        //查询 name 不为空，且邮箱不为空的用户，年龄不大于 18 岁的
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age", 18);
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

    @Test
    void test2() {
        //查询名字为hhh 的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name", "hhh");
        User user = userMapper.selectOne(wrapper);
        System.out.println(user);

    }

    @Test
    void test3() {
        //查询年龄在 20 岁到 30 岁的用户有多少个
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age", 20, 30);
        int i = userMapper.selectCount(wrapper);
        System.out.println(i);

    }

    @Test
    void test4() {
        //模糊查询
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.notLike("name", "e")//不包含
                //左和右 就是%在左边还是右边 t%
                .likeRight("email", "t");//以 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.orderByDesc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }
    
}

代码自动生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

需要添加模板引擎依赖这里使用默认

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>

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

import java.util.ArrayList;

//代码自动生成器
public class AutoCode {
    public static void main(String[] args) {
        //需要构建一个代码生产器对象
        AutoGenerator autoGenerator = new AutoGenerator();
        //配置策略

        //1.全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");//获取当前项目的目录
        gc.setOutputDir(projectPath + "/src/main/java");//输出这个目录下的什么位置
        gc.setAuthor("jay");
        gc.setOpen(false);//是否打开任务管理器
        gc.setFileOverride(false);//是否覆盖
        gc.setServiceName("%sService");//去 service 的 i 前缀
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);
        autoGenerator.setGlobalConfig(gc);

        //2.设置数据源
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUrl("输入url");
        dataSourceConfig.setUsername("输入数据库用户名");
        dataSourceConfig.setPassword("输入密码");
        dataSourceConfig.setDbType(DbType.MYSQL);//数据库类型
        autoGenerator.setDataSource(dataSourceConfig);

        //3.包的配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setModuleName("blog");//设置模块名
        packageConfig.setParent("com.java");//放在哪个包下com.java.blog
        packageConfig.setEntity("entity");
        packageConfig.setMapper("mapper");
        packageConfig.setController("controller");
        autoGenerator.setPackageInfo(packageConfig);

        //4.策略配置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("user");//映射哪一张表，要映射的表名，是可变参数
        strategyConfig.setNaming(NamingStrategy.underline_to_camel);//设置包命名规则，下划线转驼峰命名
        strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
        strategyConfig.setSuperEntityClass("你自己的父类实体，没有就不用设置");
        strategyConfig.setEntityLombokModel(true);//自动生成 lombok；
        strategyConfig.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);
        strategyConfig.setTableFillList(tableFills);

        //乐观锁
        strategyConfig.setVersionFieldName("version");
        //设置controller驼峰命名
        strategyConfig.setRestControllerStyle(true);

        //设置连接请求为这种形式：localhost:8080/hello_id_2
        strategyConfig.setControllerMappingHyphenStyle(true);
        autoGenerator.setStrategy(strategyConfig);

      	//执行
        autoGenerator.execute();
    }
}