狂神说mybatisPlus笔记

1.简介

MybatisPlus可以节省大量的时间，所有的CRUD代码都可以自动化完成

官网：https://baomidou.com/

mybatis是简化jdbc的操作的，mybatisplus是简化mybatis操作的

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

2.快速入门

步骤：

• 创建数据库

  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, '[email protected]'),
  (2, 'Jack', 20, '[email protected]'),
  (3, 'Tom', 28, '[email protected]'),
  (4, 'Sandy', 21, '[email protected]'),
  (5, 'Billie', 24, '[email protected]');
  
  

• 初始化一个springboot项目

• 导入依赖

  
  <dependency>
      <groupId>mysqlgroupId>
      <artifactId>mysql-connector-javaartifactId>
  dependency>
  
  
  <dependency>
      <groupId>org.projectlombokgroupId>
      <artifactId>lombokartifactId>
  dependency>
  
  
  <dependency>
      <groupId>com.baomidougroupId>
      <artifactId>mybatis-plus-boot-starterartifactId>
      <version>3.0.5version>
  dependency>
  

• 尽量不要同时导入mybatis和mybatis-plus

传统方式的mybatis需要配置mapper.xml，但是mybatis-plus之后不需要编写mapper.xml

使用mybatis-plus的步骤

1. 创建表的对应实体类，生成get和set方法

2. 创建实体类对应的mapper接口并加上注解以及继承BaseMapper类

   import com.baomidou.mybatisplus.core.mapper.BaseMapper;
   import com.hty.entity.User;
   import org.springframework.stereotype.Repository;
   
   //代表持久层
   @Repository
   //在对应的Mapper上面继承基本的类BaseMapper
   public interface UserMapper extends BaseMapper<User> {
       //所有的CRUD编写完成了
   }
   

3. 在主启动类中配置扫描的范围

   import org.mybatis.spring.annotation.MapperScan;
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   //扫描Mapper文件夹
   @MapperScan("com.hty.mapper")
   @SpringBootApplication
   public class MybatisPlusApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(MybatisPlusApplication.class, args);
       }
   }
   

4. 进行测试

   import com.hty.entity.User;
   import com.hty.mapper.UserMapper;
   import org.junit.jupiter.api.Test;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.boot.test.context.SpringBootTest;
   
   import java.util.List;
   
   @SpringBootTest
   class MybatisPlusApplicationTests {
   
       //继承了BaseMapper，所有的方法都来自父类 我们还可以继续编写自己的扩展方法
       @Autowired
       UserMapper userMapper;
   
       @Test
       void test1(){
           //查询全部用户 参数是一个Wrapper  是一个条件构造器 这个地方先不用
           List<User> users = userMapper.selectList(null);
           System.out.println(users);
       }
   
   }
   

3.配置日志

因为我们所有的sql现在是不可见的，我们希望知道它是怎么执行的，所以我们需要看日志

#配置日志
#使用控制台输入
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

4.mybatis-plus的insert

//测试插入
@Test
void testInset() {
    User user = new User();
    user.setName("lisi");
    user.setAge(1);
    user.setEmail("123123123");
    //mybatis-plus会帮助我们自动生成id
    int stat = userMapper.insert(user);
    System.out.println(stat);
}

在我们编写插入操作的时候，如果没有填入id，mybatis-plus会自动帮助我们填入一个id，这个id为全局唯一id

主键生成策略

@TableId(type=IdType.ID_WORKER)//全局唯一id 这个注解加载实体类的一个字段上，如果未给字段赋值则会自动赋值
private Integer id;

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

---

自动递增策略

@TableId(type=IdType.AUTO)//自动递增策略 数据库字段一定要是自增的 如果数据库不是自增的就会报错
private Integer id;

---

其他的方案

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

5.mybatis-plus的update操作

//测试更新
@Test
void testUpdate(){
    User user = new User();
    user.setId(7);
    user.setName("wangwu");
    user.setAge(12);
    user.setEmail("1133224");
    int i = userMapper.updateById(user);
    System.out.println(i);
}

6.自动填充

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

阿里巴巴开发手册：所有的数据库表都应该包括:gmt_create、gmt_modified这两个字段，一个是创建时间，一个是修改时间，而且这些应该是自动化处理的

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

在表中，新增字段create_time、update_time并将这两个字段的默认值设置为CURRENT_TIMESTAMP即可

同步实体类

private Date createTime;
private Date updateTime;

再次测试插入方法，就可以看见新插入的数据后面有了时间戳

方式二：代码级别

首先删除数据库的默认值

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

@TableField(fill = FieldFill.INSERT)//插入的时候更新
private Date createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)//修改的时候更新
private Date updateTime;

编写一个处理器来处理注解

package com.hty.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//一定不要忘记将处理器加入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);
    }
}

7.乐观锁处理

乐观锁：他总是会认为不会出现问题，所以无论干什么都不会上锁，如果出现问题，再次更新值测试，需要使用version字段，每次更新的时候，携带一个版本号

悲观锁：他人认为总是会出现问题，无论干什么都会上锁，再去操作

mybatis-plus实现乐观锁的方式:

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

测试mybatis-plus的乐观锁插件

首先给数据库加入version字段 是int类型的字段

实体类加对应的字段

@Version//代表这是一个乐观锁注解
private Integer version;

注册组件

import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

//扫描Mapper文件夹
@MapperScan("com.hty.mapper")
//开启事务
@EnableTransactionManagement
@Configuration
public class MyBatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

测试

//测试乐观锁成功
@Test
void testLock1(){
    //查询用户信息
    User user = userMapper.selectById(1);
    //修改用户信息
    user.setName("kuang");
    user.setEmail("12312132@qweqw");
    //执行更新操作
    int i = userMapper.updateById(user);
    System.out.println(i);
}

//多线程下  测试乐观锁失败
@Test
void testLock2(){
    //线程一
    User user = userMapper.selectById(1);
    user.setName("kuang");
    user.setEmail("12312132@qweqw");

    //模拟另外一个线程执行插队操作
    User user2 = userMapper.selectById(1);
    user2.setName("kuang222");
    user2.setEmail("2222222@qweqw");
    userMapper.updateById(user2);

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

8.查询操作

//测试查询
@Test
void testSelect(){
    //查询单个用户
    User user = userMapper.selectById(1);
    //        System.out.println(user);

    //查询多个用户
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    //        System.out.println(users);

    //条件查询 map
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","lisi");
    List<User> users1 = userMapper.selectByMap(map);
    System.out.println(users1);

}

9.分页查询

1. 原始的limit分页

2. pageHelper第三方插件分页

3. mybatis-plus内置分页

mybatis-plus内置分页插件的使用

首先配置拦截器

//配置分页
@Bean
public PaginationInterceptor paginationInterceptor() {
    return new PaginationInterceptor();
}

直接使用page对象

//分页查询
@Test
void testPage(){
    //参数一是当前页  参数二是页面大小
    Page<User> page= new Page<>(1,5);
    userMapper.selectPage(page, null);
    List<User> records = page.getRecords();
    System.out.println(records);
}

10.删除操作

根据id删除记录

//测试删除
@Test
void testDelete(){
    userMapper.deleteById(8);
}

11.逻辑删除

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

逻辑删除：在数据库中没有被移除，而是通过变量来让他失效

我们需要在数据表中增加一个deleted字段,默认值为0

实体类中增加注解

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

添加配置

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

还需要在properties中配置

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

测试

//测试删除
@Test
void testDelete() {
    userMapper.deleteById(1);//虽然是删除 本质是更新操作
    User user = userMapper.selectById(1);//查询不出来
    System.out.println(user);
}

12.性能分析插件

mybatis-plus提供了性能分析插件，如果超过这个时间就停止运行

步骤

配置插件

//性功能分析插件
@Bean
@Profile({"dev","test"})//设置dev test环境开启，保证效率
public PerformanceInterceptor performanceInterceptor(){
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    performanceInterceptor.setMaxTime(100);//设置sql执行的最大时间，如果超过了则不执行  单位为ms
    performanceInterceptor.setFormat(true);//是否开启格式化支持
    return performanceInterceptor;
}

在properties中需要配置一下环境

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

13.条件构造器

Wrapper

我们写一些复杂的sql就可以使用他来替代

@Test
void test1() {
    //查询name不为空，邮箱不为空的用户,年龄大于等于12岁的
    QueryWrapper<User> wrapper = new QueryWrapper<>();

    wrapper.isNotNull("name")
        .isNotNull("email")
        .ge("age", 12);

    List<User> users = userMapper.selectList(wrapper);
    for (User user : users) {
        System.out.println(user);
    }
}

@Test
void test2() {
    //查询名字等于 lisi
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name", "zhangsan");
    User user = userMapper.selectOne(wrapper);
    System.out.println(user);
}

@Test
void test3() {
    //查询年龄在20到30岁之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age", 20, 30);
    Integer integer = userMapper.selectCount(wrapper);//查询结果数
    System.out.println(integer);
}

@Test
void test4() {
    //模糊查询 name中没有e  邮箱以e开头
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //左和右的区别就是 %在左边和右边的区别
    wrapper.notLike("name", "e")
        .likeRight("email", "t");
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);//查询结果数
    Iterator iterator = maps.iterator();
    while (iterator.hasNext()) {
        System.out.println(iterator.next());
    }
}

@Test
void test5() {
    //id在子查询中查询
    QueryWrapper<User> wrapper = new QueryWrapper<>();

    wrapper.inSql("id", "select id from user where id < 3");

    List<Object> objects = userMapper.selectObjs(wrapper);
    for (Object object : objects) {
        System.out.println(object);
    }
}

14.代码自动生成器

dao,pojo,service,controller都自动生成

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {

    /**
     * 

     * 读取控制台内容
     * 
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("jobob");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("密码");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.baomidou.ant");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}