Mybatis-plus最新详细笔记

926 阅读11分钟
img

Mybatis-plus

润物无声

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

效率至上

只需简单配置,即可快速进行 CRUD 操作,从而节省大量时间。

丰富功能

热加载、代码生成、分页、性能分析等功能一应俱全。

愿景

我们的愿景是成为 MyBatis 最好的搭档,就像魂斗罗中的 1P、2P,基友搭配,效率翻倍。

特性

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小:启动即会自动注入基本 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.建立表并插入数据

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

2.创建一个springboot项目

3.导入相关依赖 注意,不要同时导入mybatis和mybatis-plus 避免发生冲突

<!--数据库驱动-->
        <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.3.2</version>
        </dependency>

4.连接数据库

#mysql 5
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

# mysql 8 驱动不同 com.mysql.cj.jdbc.Driver  url需要增加时区, serverTimezone=GMT%2B8

5.传统方式需要配置mapper.xml文件

5.使用了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操作都已经编写完成了
        //你不需要像以前的配置一大堆文件
    }
    
  • 在 Spring Boot 启动类中添加 @MapperScan 注解,扫描 Mapper 文件夹:

    //扫描mapper文件夹
    @MapperScan("com.alan.mapper")
    @SpringBootApplication
    public class MybatisPlusApplication {
    
  • 测试

    @SpringBootTest
    class MybatisPlusApplicationTests {
        @Autowired
        private UserMapper userMapper;
        @Test
        void contextLoads() {
    
            //参数是一个Wrapper  条件构造器,这里我们先不用   null
            //查询全部用户
            List<User> users = userMapper.selectList(null);
            users.forEach(System.out::println);
            System.out.println(users);
        }
    
    }
    
  • 测试结果

    img

配置日志

我们所有的sql现在是不可见的,我们希望知道他是怎么执行的

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

img

配置完毕日志之后,后面的学习就需要注意这个自动生成的sql,感受到mybatis-plus的便捷

CRUD扩展

插入操作

insert

//测试插入
    @Test
    public void testInsert(){
        User user = new User();
        user.setName("jiapeng");
        user.setAge(18);
        user.setEmail("806452789@qq.com");

        int result = userMapper.insert(user);  //帮我们自动生成id
        System.out.println(result);           //受影响行数
        System.out.println(user);            //发现id会自动回填
    }

img

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

主键生成策略

默认 ID_WORKER 全局唯一id

分布式系统唯一id生存: www.cnblogs.com/haoxinyue/p…

雪花算法:

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

主键自增

我们需要配置主键自增

  1. 实体类字段上 @TableId(type = IdType.AUTO)

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

    img

3.再次测试插入即可!

img

其余的源码解释

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

更新操作

 //测试更新
    @Test
    public void testUpdate(){
        User user = new User();
        user.setId(6L);
        user.setName("佳鹏");
        user.setAge(20);
        //注意 : updateById 但是参数是一个对象!
        int i = userMapper.updateById(user);

        System.out.println(i);
    }

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

自动填充

创建时间,修改时间! 这些个操作一遍都是自动化完成的,我们不希望手动更新!

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

方式一:数据库级别

  1. 在表中新增字段create_time , update_time

img

  1. 再次测试插入方法,我们需要把实体类同步

    private Date createTime;
    private Date updateTime;
    
  2. 再次更新查看结果即可

    img

方式二:代码级别

  1. 删除数据库的默认值

    img

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

    //字段增加填充内容
        @TableField(fill = FieldFill.INSERT)
        private Date createTime;
    
        @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.....");
            //setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
            this.setFieldValByName("createTime",new Date(),metaObject);
            this.setFieldValByName("updateTime",new Date(),metaObject);
        }
        
        //更新时的填充策略
        @Override
        public void updateFill(MetaObject metaObject) {
            log.info("start insert fill.....");
            this.setFieldValByName("updateTime",new Date(),metaObject);
        }
    }
    
  4. 测试插入

  5. 测试更新,观察时间变化即可

乐观锁

在面试过程中,我们经常会被问到乐观锁,悲观锁!

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

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

乐观锁机制

乐观锁实现方式:

  • 取出记录时,获取当前version
  • 更新时,带上这个version
  • 执行更新时, set version = newVersion where version = oldVersion
  • 如果version不对,就更新失败
乐观锁:1.先查询,获得版本号 version=1
--A
update user set name="alan", version=version+1
where id=2 and version=1

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

测试一下MP的乐观锁插件

  1. 给数据库中增加version字段!

    img

  2. 我们实体类加对应的实体类

    @Version  //乐观锁Version注解
        private Integer version;
    
  3. 注册组件

    //扫描mapper文件夹
    @MapperScan("com.alan.mapper")
    @EnableTransactionManagement   //自动事务
    @Configuration  //配置类
    public class MyBatisPlusConfig {
        
        //注册乐观锁插件
        @Bean
        public OptimisticLockerInterceptor optimisticLockerInterceptor(){
            return new OptimisticLockerInterceptor();
        }
    }
    
  4. 测试一下!

    //测试乐观锁成功!
        @Test
        public void testOptimisticLocker(){
            //1. 查询用户信息
            User user = userMapper.selectById(1L);
            //2. 修改用户信息
            user.setName("林佳鹏");
            user.setEmail("806452@qq.com");
            //3. 执行更新操作
            userMapper.updateById(user);
    
        }
    
        //测试乐观锁失败! 多线程下
        @Test
        public void testOptimisticLocker2(){
    
            //线程1
            User user = userMapper.selectById(1L);
            user.setName("佳鹏111");
            user.setEmail("a806452@qq.com");
    
            // 模拟另外一个线程执行插队操作
            User user2 = userMapper.selectById(1L);
            user2.setName("佳鹏222");
            user2.setEmail("a806452@qq.com");
            userMapper.updateById(user2);
    
            userMapper.updateById(user);  //如果没有乐观锁就会覆盖插队线程的值!
        }
    
    

    img

查询操作

//测试查询
    @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, 4));
        users.forEach(System.out::println);
    }

    // 按条件查询之一 使用map操作
    @Test
    public void testSelectByBatchIds(){
        HashMap<String, Object> map = new HashMap<>();
        //自定义要查询
        map.put("name","佳鹏");
        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();
    }
  1. 直接使用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(2,3,4));
    }

    //通过map批量删除
    @Test
    public void testDeleteMap(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","佳鹏");
        userMapper.deleteByMap(map);
    }

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

逻辑删除

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

逻辑删除:在数据库中没有被移除,而是通过一个变量来让他失效!

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

测试

  1. 在数据表中增加一个deleted字段

    img

  2. 实体类中增加属性

@TableLogic //逻辑删除
private Integer deleted;
  1. 配置
# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
  1. 测试一下
img

记录依旧在数据库中,但是deleted值变化了

img

img

以上的所有CRUD操作及其扩展操作,我们都必须精通!会大大提高你的工作和写项目的效率

性能分析插件

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

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

  1. 导入插件
/**
     * SQL执行效率插件
     */
    @Bean
    @Profile({"dev","test"})// 设置 dev test 环境开启 保证了我们的效率
    public PerformanceInterceptor performanceInterceptor() {
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        // 在工作中,不允许用户等待
        performanceInterceptor.setMaxTime(100);  //设置sql执行的最大时间,如果超过了则不执行
        performanceInterceptor.setFormat(true);
        return new PerformanceInterceptor();
    }

记住要在springboot中配置环境为dev或者test环境!

  1. 测试使用

img

该插件 3.2.0 以上版本移除推荐使用第三方扩展 执行SQL分析打印 功能

条件构造器

  1. 测试一
@Test
    public void testQuery(){
        //查询name不为null的用户  并且邮箱不为null  年龄大于等于18

        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.isNotNull("name").isNotNull("email")
                .ge("age",18);
        userMapper.selectList(wrapper).forEach(System.out::println);
    }
  1. 测试二
@Test
    void test2(){
        //查询名字等于lin 的
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","lin");
        User user = userMapper.selectOne(wrapper);       //查询一个数据

        System.out.println(user);
    }
  1. 测试三
@Test
    void test3(){
        //查询年龄在20到30岁之间的用户

        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",20,30);  //区间
        Integer count = userMapper.selectCount(wrapper);//查询结果数
        System.out.println(count);
    }
  1. 测试四
//模糊查询
    @Test
    void test4(){
        // 查询名字不包含e  邮箱以1开头的
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.notLike("name","e")
                .likeRight("email","1");

        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }
  1. 测试五
//模糊查询
    @Test
    void test5(){

        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //id 在子查询中查出来
        wrapper.inSql("id","select id from user where id > 18");

        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }
  1. 测试六
//测试六
    @Test
    void test6(){

        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //通过id进行降序排序
        wrapper.orderByDesc("id");

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

其余的参见mybatis-plus官网

代码自动生成器

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

package com.alan;

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 AlanCode {

    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("Alan_27");
        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 dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?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);

        autoGenerator.setDataSource(dsc);

        //3. 包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.alan");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");

        autoGenerator.setPackageInfo(pc);

        //4. 策略配置
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user");  //设置要映射的表名
        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");

        strategy.setRestControllerStyle(true);  //开启Restful驼峰命名
        strategy.setControllerMappingHyphenStyle(true);

        autoGenerator.setStrategy(strategy);

        autoGenerator.execute(); //执行


    }
}

最后推荐一个我很喜欢的up主,B站搜索"遇见狂神说",博主的学习都是根据up主的路线一步一步的学习的!大家记得去三连观看哦!