Springboot2.x整合Mybatis-plus

小灰灰 2022-12-31 04:28 183阅读 0赞

**目录**

一、概述

二、准备工作

1、创建数据库名为mybatis\_plus

2、引入依赖

3、配置文件

4、实体类

5、mapper接口

三、测试CRUD

插入

删除

修改

查询

性能分析插件

代码生成器

--------------------

# 一、概述 #

[MyBatis-Plus][][ ][MyBatis-Plus][ (opens new window)][MyBatis-Plus]（简称 MP）是一个 [MyBatis][][ ][MyBatis][ (opens new window)][MyBatis] 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

特点

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作， BaseMapper

强大的 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 操作智能分析阻断，也可自定义拦截规则，预防误 操作

官网地址：[https://baomidou.com/][https_baomidou.com]

# 二、准备工作 #

## 1、创建数据库名为mybatis\_plus ##

创建表

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)
    );

注意：-- 真实开发中往往都会有这四个字段，version（乐观锁）、deleted（逻辑删除）、gmt\_create（创建时间）、gmt\_modified（修改时间）

## 2、引入依赖 ##

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

注意：尽量不要同时导入 mybatis 和 mybatis-plus！避免版本的差异造成无法预知的问题。

## 3、配置文件 ##

spring:
      profiles:
        active: dev
      datasource:
    # 驱动不同 mysql 5  com.mysql.jdbc.Driver
    #         mysql 8  com.mysql.cj.jdbc.Driver、需要增加时区的配置serverTimezone=GMT%2B8
        url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
        driver-class-name: com.mysql.cj.jdbc.Driver
        username: root
        password: root
    
    #我们所有的sql现在是不可见的，我们希望知道它是怎么执行的，所有我们要配置日志的输出 #application.yml文件添加日志配置
    mybatis-plus:
      configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

## 4、实体类 ##

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

## 5、mapper接口 ##

// 在对应的Mapper上面继承基本的类 BaseMapper
    @Repository // 代表持久层
    public interface UserMapper extends BaseMapper<User> {
      // 所有的CRUD操作都已经编写完成了
    }

注意点，我们需要在主启动类上去扫描我们的mapper包下的所有接口 @MapperScan(“com.demo.mapper”)

# 三、测试CRUD #

## 插入 ##

// 测试插入
        @Test
        public void testInsert(){
            User user = new User();
            user.setName("测试");
            user.setAge(15);
            user.setEmail("111@qq.com");
    
            int result = userMapper.insert(user); // 帮我们自动生成id
            System.out.println(result); // 受影响的行数
            System.out.println(user); // 看到id会自动填充。    }

看到id会自动填充。数据库插入的id的默认值为：全局的唯一id

主键生成策略，实体类字段上 @TableId(type = IdType.AUTO)

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

## 删除 ##

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

逻辑删除 ：在数据库中没有被移除，而是通过一个变量来让它失效！deleted = 0 => deleted = 1 管理员可以查看被删除的记录！防止数据的丢失，类似于回收站！

1、物理删除

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

2、逻辑删除

在数据表中增加一个 deleted 字段以及实体类中增加属性

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

配置

// 逻辑删除组件！
        @Bean
        public ISqlInjector sqlInjector() {
            return new LogicSqlInjector();
        }

配置文件配置

global-config:
        db-config:
          logic-delete-value: 1
          logic-not-delete-value: 0

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDkxNTA4_size_16_color_FFFFFF_t_70][]

字段值也从0修改成了1测试查询

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDkxNTA4_size_16_color_FFFFFF_t_70 1][]

## 修改 ##

1、基础修改

@Test
        public void testUpdate(){
            User user = new User();
            // 通过条件自动拼接动态sql
            user.setId(1);
            user.setName("测试");
            user.setAge(20);
            // 注意：updateById 但是参数是一个对象！
            int i = userMapper.updateById(user);
            System.out.println(i);
        }

2、自动填充

创建时间、修改时间！这两个字段操作都是自动化完成的，我们不希望手动更新！阿里巴巴开发手册：所有的数据库表都要配置上gmt\_create、gmt\_modified！而且需要自动化！

实体类字段属性上需要增加注解

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

编写处理器来处理这个注解即可！

@Slf4j
    @Component // 一定不要忘记把处理器加到IOC容器中！
    public class MyMetaObjectHandler implements MetaObjectHandler {
        // 插入时的填充策略
        @Override
        public void insertFill(MetaObject metaObject) {
            log.info("start insert fill.....");
            // setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject
            this.setFieldValByName("gmt_create",new Date(),metaObject);
            this.setFieldValByName("gmt_modified",new Date(),metaObject);
        }
    
        // 更新时的填充策略
        @Override
        public void updateFill(MetaObject metaObject) {
            log.info("start update fill.....");
            this.setFieldValByName("gmt_modified",new Date(),metaObject);
        }
    }

3、乐观锁、悲观锁

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

乐观锁实现方式：

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

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

给数据库中增加version字段！实体类增加对应属性

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

注册组件

// 扫描我们的 mapper 文件夹
    @MapperScan("com.demo.mapper")
    @EnableTransactionManagement
    @Configuration // 配置类
    public class MyBatisPlusConfig {
        // 注册乐观锁插件
        @Bean
        public OptimisticLockerInterceptor optimisticLockerInterceptor() {
            return new OptimisticLockerInterceptor();
        }
       }

// 测试乐观锁成功！
        @Test
        public void testOptimisticLocker(){
            // 1、查询用户信息
            User user = userMapper.selectById(1L);
            // 2、修改用户信息
            user.setName("测试");
            user.setEmail("111@qq.com");
            // 3、执行更新操作
            userMapper.updateById(user);
        }

// 测试乐观锁失败！多线程下
        @Test
        public void testOptimisticLocker2(){
    
            // 线程 1
            User user = userMapper.selectById(1L);
            user.setName("测试111");
            user.setEmail("111@qq.com");
    
            // 模拟另外一个线程执行了插队操作
            User user2 = userMapper.selectById(1L);
            user2.setName("测试222");
            user2.setEmail("111@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","测试");
            map.put("age",15);
    
            List<User> users = userMapper.selectByMap(map);
            users.forEach(System.out::println);
        }

配置拦截器组件

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

直接使用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());
    }

条件构造器(Wrapper)

isNotNull .gt

@Test
        void contextLoads() {
            // 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
            QueryWrapper<User> wrapper = new QueryWrapper<>();
            wrapper
                    .isNotNull("name") //不为空
                    .isNotNull("email")
                    .ge("age",18);
            userMapper.selectList(wrapper).forEach(System.out::println); // 和我们刚才学习的map对比一下
        }

.eq

@Test
        void test2(){
            // 查询名字kwhua
            QueryWrapper<User> wrapper = new QueryWrapper<>();
            wrapper.eq("name","kwhua");
            User user = userMapper.selectOne(wrapper); // 查询一个数据用selectOne，查询多个结果使用List 或者 Map
            System.out.println(user);
        }

其他方法可以自己测试...

# 性能分析插件 #

作用：性能分析拦截器，用于输出每条 SQL 语句及其执行时间 MP也提供性能分析插件，如果超过这个时间就停止运行！1、导入插件

/**
         * SQL执行效率插件
         */
        @Bean
        @Profile({"dev","test"})// 设置 dev test 环境开启，保证我们的效率
        public PerformanceInterceptor performanceInterceptor() {
            PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
            performanceInterceptor.setMaxTime(100); //ms 设置sql执行的最大时间，如果超过了则不执行
            performanceInterceptor.setFormat(true);
            return performanceInterceptor;
        }

效果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDkxNTA4_size_16_color_FFFFFF_t_70 2][]

# 代码生成器 #

// 代码自动生成器
    public class generateCode {
       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("lph");//作者名称
        gc.setOpen(false);
        gc.setFileOverride(false); // 是否覆盖
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);//实体属性 Swagger2 注解
    
        // 自定义文件命名，注意 %s 会自动填充表实体属性！
        gc.setServiceName("%sService"); 
        gc.setControllerName("%sController");
        gc.setServiceName("%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
    
        mpg.setGlobalConfig(gc);
    
        //2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/demo?
    useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        // dsc.setDriverName("com.mysql.jdbc.Driver"); //mysql5.6以下的驱动
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);
        //3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.kwhua"); //包名
        pc.setModuleName("model"); //模块名
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);
    
        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user","course"); // 设置要映射的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true); // 自动lombok；
        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");
        //根据你的表名来建对应的类名，如果你的表名没有下划线，比如test，那么你就可以取消这一步
        strategy.setTablePrefix("t_");
        strategy.setRestControllerStyle(true); //rest请求
        //自动转下划线，比如localhost:8080/hello_id_2
        strategy.setControllerMappingHyphenStyle(true); 
        mpg.setStrategy(strategy);
        mpg.execute(); //执行
     }
    }

[MyBatis-Plus]: https://github.com/baomidou/mybatis-plus
[MyBatis]: http://www.mybatis.org/mybatis-3/
[https_baomidou.com]: https://baomidou.com/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDkxNTA4_size_16_color_FFFFFF_t_70]: /images/20221120/f4c0951e696e48cabdddf069c593a80c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDkxNTA4_size_16_color_FFFFFF_t_70 1]: /images/20221120/245dc5954dbb4a98b5dcc26c3aae2380.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0NDkxNTA4_size_16_color_FFFFFF_t_70 2]: /images/20221120/b4b5623b422f499880f12739f3f88acd.png