您的位置:首页 > 其它

MyBatisPlus详解

2022-05-20 16:14 711 查看

1、MyBatisPlus概述

需要的基础:MyBatis、Spring、SpringMVC

为什么要学习?MyBatisPlus可以节省我们大量工作时间,所有的CRUD代码它都可以自动化完成!

简介

是什么?MyBatis本来就是简化JDBC操作的!

官网:https://baomidou.com/ MyBatis Plus,简化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 操作智能分析阻断,也可自定义拦截规则,预防误操作

所有学不会都是给懒找的借口!伸手党,白嫖党!

2、快速入门

地址:https://baomidou.com/pages/226c21/

使用第三方组件:

  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)
    );
    
    -- 真实开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
    
    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');
  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-->
    <!--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.datasource.username=root
    spring.datasource.password=123456
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT
  6. 传统方式pojo-dao(连接mybatis,配置mapper.xml文件)-service-controller

    使用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("com.kuang.mapper")

      启动类

      //扫描我们的mapper文件夹
      @MapperScan("com.kuang.mapper")
      @SpringBootApplication
      public class MybatisPlusApplication {
      
      public static void main(String[] args) {
      SpringApplication.run(MybatisPlusApplication.class, args);
      }
      
      }
    • 测试

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

思考问题?

  1. SQL谁帮我们写的?MyBatis-Plus 都写好了
  2. 方法哪里来的?MyBatis-Plus 都写好了

3、配置日志

我们所有的sql现在是不可见的,我们希望知道它是怎么执行的,所以我们必须要看日志!

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

配置完毕日志之后,后面的学习就需要注意这个自动生成的SQL,喜欢上MyBatis-Plus!

4、CRUD扩展

插入操作

Insert 插入

//测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("狂神说Java");
user.setAge(3);
user.setEmail("406623380@qq.com");

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

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

主键生成策略

默认 ID_WORKER 全局唯一id

分布式系统唯一id生成:https://www.cnblogs.com/liujianping/p/10401842.html

雪花算法:

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

主键自增

我们需要配置主键自增:

  1. 实体类字段上

    @TableId(type = IdType.AUTO)

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

  3. 再次测试插入即可!

其余的源码解释

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

更新操作

//测试更新
@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都是自动帮你动态配置的!

自动填充

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

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

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

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

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

    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class User {
    // 对应数据库中的主键(uuid、自增id、雪花算法、redis、zookeeper!)
    @TableId(type = IdType.INPUT) //一旦手动输入id之后,就需要自己配置id了!
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date createTime;
    private Date updateTime;
    }
  3. 再次更新查看结果即可

方式二:代码级别

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

  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 update fill......");
    this.setFieldValByName("updateTime",new Date(),metaObject);
    }
    }
  4. 测试插入、测试更新,观察时间即可!

    //测试插入
    @Test
    public void testInsert(){
    User user = new User();
    user.setName("狂神说Java");
    user.setAge(3);
    user.setEmail("406623380@qq.com");
    
    int result = userMapper.insert(user); //帮我们自动生成id
    System.out.println(result); //受影响的行数
    System.out.println(user); //发现,id会自动回填
    }
    //测试更新
    @Test
    public void testUpdate(){
    User user = new User();
    //通过条件自动拼接动态sql
    user.setId(6L);
    user.setName("关注公众号:狂神说");
    user.setAge(19);
    
    //注意:updateById 但是参数是一个对象!
    int i = userMapper.updateById(user);
    System.out.println(i);
    }
    

乐观锁

在面试过程中,我们经常会被问到乐观锁、悲观锁!这个其实非常简单!

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

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

version、new version

我们这里主要讲解 乐观锁 机制!

乐观锁实现方式:

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

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

测试一下MP的乐观锁插件

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

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

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

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

    //测试乐观锁成功!
    @Test
    public void testOptimisticLock(){
    //1、查询用户信息
    User user = userMapper.selectById(1L);
    //2、修改用户信息
    user.setName("kuangshen");
    user.setEmail("406623380@qq.com");
    //3、执行更新操作
    userMapper.updateById(user);
    }
    
    //测试乐观锁失败!多线程下
    @Test
    public void testOptimisticLock2(){
    //线程 1
    User user = userMapper.selectById(1L);
    user.setName("kuangshen111");
    user.setEmail("406623380@qq.com");
    
    //模拟另外一个线程执行了插队操作
    User user2 = userMapper.selectById(1L);
    user2.setName("kuangshen222");
    user2.setEmail("406623380@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","狂神说Java");
map.put("age",3);

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<>(2,5);
    userMapper.selectPage(page,null);
    
    page.getRecords().forEach(System.out::println);
    System.out.println(page.getTotal());
    }

删除操作

基本的删除操作

//测试删除
@Test
public void testDeleteById(){
userMapper.deleteById(1525818619938652164L);
}

//通过id批量删除
@Test
public void testDeleteBatchId(){
userMapper.deleteBatchIds(Arrays.asList(1525818619938652161L,1525818619938652162L));
}

//通过map删除
@Test
public void testDeleteMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","狂神说Java");

userMapper.deleteByMap(map);
}

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

逻辑删除

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

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

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

测试一下:

  1. 在数据表中增加一个

    deleted
    字段

  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. 测试一下删除!

    //测试删除
    @Test
    public void testDeleteById(){
    userMapper.deleteById(1L);
    }

    记录依旧在数据库,但是值却已经变化了

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

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

性能分析插件

我们在平时开发中,会遇到一些慢sql。测试!druid......

作用:性能分析拦截器,用于输出每条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;
    }

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

    # 设置开发环境
    spring.profiles.active=dev
  2. 测试使用

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

    使用性能分析插件,可以帮助我们提高效率!

条件构造器

十分重要:Wrapper

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

  1. 测试一,记住查看输出的SQL进行分析

    @Test
    void contextLoads() {
    //查询name不为空的用户,并且邮箱不为空的用户,年龄大于等于12
    QueryWrapper<User> wrapper = new QueryWrapper<User>();
    wrapper
    .isNotNull("name")
    .isNotNull("email")
    .ge("age",12);
    userMapper.selectList(wrapper).forEach(System.out::println); //和我们刚才学习的map对比一下
    }
  2. 测试二,记住查看输出的SQL进行分析

    @Test
    void test2(){
    //查询名字狂神说
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","狂神说");
    User user = userMapper.selectOne(wrapper);
    System.out.println(user); //查询一个数据,出现多个结果使用List或者Map
    }
  3. 测试三,记住查看输出的SQL进行分析

    @Test
    void test3(){
    //查询年龄在20~30岁之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",20,30); //区间
    Integer count = userMapper.selectCount(wrapper); //查询结果数
    System.out.println(count);
    }
  4. 测试四,记住查看输出的SQL进行分析

    //模糊查询
    @Test
    void test4(){
    //查询年龄在20~30岁之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //左和右 %e e% %e%
    wrapper
    .notLike("name","e")
    .likeRight("email","t");
    
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
    }
  5. 测试五

    //模糊查询
    @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);
    }
  6. 测试六

    //测试六
    @Test
    void test6(){
    
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //通过id进行排序
    wrapper.orderByDesc("id");
    
    List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
    }

其余的测试,可以自己下去多练习!

代码自动生成器

dao、pojo、service、controller都给我自己去编写完成!

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

导入依赖:

<dependencies>
<!--文件上传-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.80</version>
</dependency>
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--mybatis-plus-->
<!--mybatis-plus 是自己开发的,并非官方的!-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency><!--代码生成器依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.0.5</version>
</dependency>
<!--velocity模板引擎,Mybatis Plus代码生成器需要-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<!--druid-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.9</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

测试:

//代码自动生成器
public class KuangCode {
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("狂神说");
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=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT");
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.kuang");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");

mpg.setPackageInfo(pc);

//4、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("user"); //设置要映射的表名
strategy.setNaming(NamingStrategy.underline_to_camel);

strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
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);
strategy.setControllerMappingHyphenStyle(true); //localhost:8080/hello_id_2

mpg.setStrategy(strategy);

mpg.execute(); //执行
}
}
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: