Mybatis-Plus学习笔记

本文详细介绍了MyBatis-Plus的快速入门步骤,包括创建数据库表、配置项目依赖、编写POJO和Mapper层,以及进行CRUD操作。此外,还深入探讨了MyBatis-Plus的特性,如无侵入性、损耗小、强大的CRUD操作、Lambda支持、主键生成策略、自动填充功能、乐观锁、分页查询、性能分析插件和条件构造器。同时,展示了如何配置日志、使用代码生成器以及代码自动生成器的示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1. 简介

MyBatis-Plus官方文档:https://mp.baomidou.com/guide/

MyBatis-Plus(简称 MP)是一个MyBatis的增强工具,在 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. 快速入门

  1. 创建数据库mybatisplus

  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)
    );
    -- 真实开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
    
    
    DELETE FROM user;
    
    INSERT INTO user (id, name, age, email) VALUES
    (1, 'Jone', 18, 'test1@qq.com'),
    (2, 'Jack', 20, 'test2@qq.com'),
    (3, 'Tom', 28, 'test3@qq.com'),
    (4, 'Sandy', 21, 'test4@qq.com'),
    (5, 'Billie', 24, 'test5@qq.com');
    
  3. 创建项目,导入依赖

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

    说明:我们使用mybatis-plus可以节省我们大量的代码,尽量不要同时导入mybatis和mybatis-plus!

  4. application.yml文件配置数据库信息

    # mysql 5 驱动不同  com.mysql.jdbc.Driver
    # mysql 8 驱动不同 com.mysql.cj.jdbc.Driver . 需要增加时区的配置 serverTimezone=GMT%2B8
    spring:
      datasource:
        username: root
        password: 123456
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://localhost:3306/mybatisplus?userSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT
    
  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 代表持久层
    @Mapper
    public interface UserMapper extends BaseMapper<User> {
        //所有CRUD操作都已经编写完成了
    }
    

    注意点:如果不标注解,则需要在主启动类MybatisPlusApplication上扫描我们Mapper包下的所有接口

    @MapperScan("com.template.mapper")
    
    • 测试

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

    在这里插入图片描述

3. 配置日志

在application.yaml文件中添加:

# 配置日志  (默认控制台输出)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

在这里插入图片描述

4. CRUD扩展

4.1 插入操作

@Test
void insertTest() {
    User user = new User();
    user.setAge(15);
    user.setName("lize");
    user.setEmail("670551262@qq.com");
    int res = userMapper.insert(user);//自动生成id
    System.out.println(res);// 受影响的行数
    System.out.println(user);// 发现: id自动回填
}

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

4.2 主键生成策略

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

主键自增

实体类字段上添加注解@TableId(type = IdType.xxx)

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

4.3 更新操作

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

所有的sql都是动态配置的

4.4 自动填充功能

阿里巴巴开发手册:所有的数据库表都需要字段:gmt_create .gmt_modified,而且需要自动化!

方式一:数据库级别

  1. 在表中新增字段create_Time和update_Time

在这里插入图片描述

  1. 实体类同步添加

    private Data creatTime;
    private Data updateTime;
    
  2. 再次执行插入方法

    在这里插入图片描述
    可以发现,时间自动被填充了

方式二:代码级别

  1. 删除数据库默认值

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

    //记住用util包下的Date!!
    //字段添加填充内容
    @TableField(fill = FieldFill.INSERT)
    private Data createTime;
    
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Data updateTime;
    
  3. 编写处理器来处理这个注解

    package com.codeyuaiiao.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);
        }
    }
    
  4. 测试插入,观察时间是否被自动填充

4.5 乐观锁

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

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

乐观锁实现方式:

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

使用乐观锁组件

  1. 数据库中增加version字段

  2. 实体类上添加对应的字段属性

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

    @EnableTransactionManagement
    @Configuration
    public class MyBatisPlusConfig {
    
        // 注册乐观锁插件
        @Bean
        public OptimisticLockerInterceptor optimisticLockerInterceptor() {
            return new OptimisticLockerInterceptor();
        }
    }
    
  4. 测试

    // 测试乐观锁成功
    @Test
    public void testVersionSuccess(){
        // 1. 查询用户信息
        User user = userMapper.selectById(1L);
        // 2. 修改用户信息
        user.setName("fan");
        user.setAge(24);
        // 3. 执行更新操作
        userMapper.updateById(user);
    }
    
    // 测试乐观锁失败!多线程下,此处模拟一下
    @Test
    public void testVersionFall(){
        // 线程1
        User user1 = userMapper.selectById(1L);
        user1.setName("fan111");
        user1.setAge(14);
    
        // 线程2
        User user2 = userMapper.selectById(1L);
        user2.setName("fan222");
        user2.setAge(24);
        userMapper.updateById(user2);
    
        //自旋锁来多次尝试提交!
        userMapper.updateById(user1); //如果没有乐观锁就会覆盖插队线程的值
    }
    

4.6 查询操作

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

// 批量查询
// SELECT * FROM user WHERE id IN ( ? , ? , ? ) 
@Test
public void testSelectByBatchIds(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1L, 2L, 3L));
    users.forEach(System.out::println);
}

// 按照条件查询之一使用 map
// SELECT * FROM user WHERE name = ? AND age = ? 
@Test
public void testSelectByMap(){
    HashMap<String, Object> map = new HashMap<>();
    // 自定义要查询
    map.put("name","lize");
    map.put("age","6");
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

4.7 分页查询

分页方式:

  1. 原始使用limit进行分页
  2. pageHelper第三方插件
  3. MybatisPlus内置了分页插件

如何使用

  • 配置拦截器

    // 分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
    
  • 使用,进行测试

    // 测试分页查询
    @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());
    }
    

4.8 删除操作

// 测试删除
// DELETE FROM USER WHERE ID=?
@Test
public void testdelete(){
    userMapper.deleteById(6L);
}

// 测试批量删除
// DELETE FROM USER WHERE ID IN (?,?)
@Test
public void testdeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1L,2L));
}

//通过map删除
// DELETE FROM USER WHERE NAME=?
@Test
public void testDeleteByMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","lize");
    userMapper.deleteByMap(map);
}

4.9 逻辑删除

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

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

  2. 实体类中增加属性

    @TableLogic // 逻辑删除
    private Integer deleted;
    
  3. 配置

    mybatis-plus:
      global-config:
        db-config:
          logic-delete-value: 1 # 逻辑已删除值(默认为 1)
          logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
    
  4. 测试

    // UPDATE user SET deleted=1 WHERE id=? AND deleted=0
    // SELECT * FROM user WHERE id=? AND deleted=0
    @Test
    public void testLoginDelete(){
        userMapper.deleteById(1L);
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }
    

4.10 性能分析插件

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

  1. 导入插件

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

    // SQL执行效率插件
    @Bean
    @Profile({"dev","test"})
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100); //ms 设置sql执行的最大时间,如果超过了则不执行
        performanceInterceptor.setFormat(true); // 是否格式化
        return performanceInterceptor;
    }
    
  2. 测试使用

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

    在这里插入图片描述

4.11 条件构造器

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

@Test
void contextLoads(){
    // 查询name不为null的用户,并且邮箱不为null的永不,年龄大于等于20的用户
    QueryWrapper<User> wrapper =new QueryWrapper<>();
    wrapper.isNotNull("name");
    wrapper.isNotNull("email");
    wrapper.ge("age",12);
    userMapper.selectList(wrapper).forEach(System.out::println);
}

@Test
void test2(){
    // 查询name为shuishui的用户
    QueryWrapper<User> wrapper =new QueryWrapper<>();
    wrapper.eq("name","shuishui");
    User user=userMapper.selectList(wrapper)
    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(){
    QueryWrapper<User> wrapper =new QueryWrapper<>();
    
    wrapper.notLike("name",“s”);//相当于NOT LIKE '%s%'
    wrapper.likeRight("email",“s”);//相当于LIKE 's%'
    List<Map<String,Object>>maps =userMapper.selectMaps(wrapper);//查询结果数
    maps.forEach(System.out::println);
}

@Test
void test5(){
    QueryWrapper<User> wrapper =new QueryWrapper<>();
    //子查询
    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);/
    objects.forEach(System.out::println);
}

4.12 代码自动生成器

// 代码自动生成器 
public class AutoCode{
     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("xxx");     
         gc.setOpen(false);      
         gc.setFileOverride(false);  // 是否覆盖     
         gc.setServiceName("%sService"); // 去Service的I前缀      
         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/kuang_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.template");    
         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); 
         strategy.setControllerMappingHyphenStyle(true);
         // localhost:8080/hello_id_2     
         mpg.setStrategy(strategy);
         mpg.execute(); //执行   
     } 
}

更多的方法都在官方文档里https://mp.baomidou.com/guide/

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值