MybatisPlus的学习笔记

最新推荐文章于 2024-01-11 11:37:42 发布

qq_41993091

最新推荐文章于 2024-01-11 11:37:42 发布

阅读量254

点赞数

文章标签：学习 mybatis java

本文链接：https://blog.csdn.net/qq_41993091/article/details/127538982

版权

一、快速入门

文档：https://mp.baomidou.com/

使用第三方组件：

导入对应依赖
研究依赖如何配置
代码如何编写
提高扩展技术能力
步骤
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.编写项目，初始化项目（spring boot)
4.导入依赖

<!--数据库驱动-->
<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！可能会产生版本的差异
5、连接数据库，这一步和mybatis相同（application.properties)

# mysql
spring.datasource.username=root
spring.datasource.password=填自己数据库的密码
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?userSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

6、使用了mybatis-plus 之后

pojo

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

mapper接口

package com.wei.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.wei.pojo.User;
import org.springframework.stereotype.Repository;


// 在对应的Mapper上面继承基本的接口 BaseMapper
@Repository // 代表持久层
public interface UserMapper extends BaseMapper<User> {
    // 所有的CRUD操作都已经基本完成了
    // 你不需要像以前的配置一大堆文件了
}

注意点：我们需要在主启动类上去扫描我们的mapper包下的所有接口(MybatisPlusApplication)

//扫描我们的mapper文件夹
@MapperScan("com.wei.mapper")
@SpringBootApplication
public class MybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }

}

测试类中测试（MybatisPlusApplicationTests）

@SpringBootTest
class MybatisPlusApplicationTests {

    // 继承了BaseMapper,所有的方法都来自父类
    // 我们也可以编写自己的扩展方法
    @Autowired
    UserMapper userMapper;

    @Test
    void contextLoads() {
        // 参数是一个 Wrapper , 条件构造器，这里我们先不用 null
        // 查询全部用户
        List<User> users = userMapper.selectList(null);
        //userMapper.selectList().var就可以直接生成这句
        users.forEach(System.out::println);
    }
}

1、SQL是谁帮我们写的？MyBatis-Plus都写好了

2、方法哪里来的？MyBatis-Plus 都写好了

这就是快速入门，运行测试文件即可进行查询操作

二、配置日志

我们所有的sqld现在都是不可见的，我们希望知道它是怎么执行的，所以我们必须要看日志！

（application.properties)

# 配置日志 (系统自带的，控制台输出)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

在这里插入图片描述

三、CRUD

1. 插入操作
Insert 插入

@Test
public void testInsert() {
    User user = new User();
    user.setName("Dainel");
    user.setAge(3);
    user.setEmail("daniel@alibaba.com");

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

数据库插入的id默认值为：全局的唯一id
在这里插入图片描述
2. 主键生成策略
分布式系统唯一id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html
默认：
@TableId(type = IdType.ASSIGN_ID)（使用了雪花算法）

雪花算法：snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。可以保证几乎全球唯一！
主键自增
我们需要配置主键自增
实体类字段上 @TableId(type = IdType.AUTO)
数据库字段上一定是自增的
在这里插入图片描述
再次测试插入即可
要想影响所有实体的配置，可以设置全局主键配置

#全局设置主键生成策略
mybatis-plus.global-config.db-config.id-type=auto

3. 更新操作

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 字符串表示法
}

//测试更新
@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. 自动填充（使用这个就不需要自己set了）
创建时间、修改时间！这些个操作一般都是自动化完成的，我们不希望手动更新！

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

方式一：数据库级别（工作中不允许修改数据库）

1.在表中新增字段 create_time,update_time
在这里插入图片描述
2.再次测试插入方法，我们需要先把实体类同步

package com.wei.pojo;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;


@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    //对应数据库中的主键（uuid、自增id、雪花算法)
    @TableId(type = IdType.INPUT)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date createTime;
    private Date updateTime;

}

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

//字段添加填充内容
//添加的时候设置这个时间
@TableField(fill = FieldFill.INSERT)
private Date createTime;
//修改的时候设置这个时间
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

4.编写处理器来处理这个注解即可
com.wei.handler.MyMetaObjectHandler.java

package com.kuang.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 ...");
        // 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);
    }

}

5. 乐观锁（针对并发操作中的问题）
主要适用场景：当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新

在面试过程中，我们经常会被问到乐观锁，悲观锁。
乐观锁：顾名思义，它总是认为不会出现问题，无论干什么都不去上锁！如果出现了问题，再次更新值测试！

悲观锁：顾名思义，它总是认为总是出现问题，无论干什么都上锁！再去操作！
乐观锁实现方式：

取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion 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

测试一下MyBatisPlus乐观锁的插件：

1.数据库中增加一个version字段
在这里插入图片描述
2.需要实体类加上对应的字段

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

3.注册组件（com.wei.config.MyBatisPlusConfig) 配置乐观锁插件

// 扫描我们的 mapper文件夹
@MapperScan("com.kuang.mapper")
@EnableTransactionManagement
@Configuration
public class MyBatisPlusConfig {

    // 注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4.测试（先查询出来version在修改）

 // 测试乐观锁成功
    @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); //如果没有乐观锁就会覆盖插队线程的值
    }
}

在这里插入图片描述
6. 查询操作

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

// 多个id的批量查询
@Test
public void testSelectByBatchIds(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

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

7. 分页查询
分页网站频繁使用

原始使用limit进行分页
pageHelper第三方插件
MybatisPlus内置了分页插件
如何使用？
1.配置拦截器（MyBatisPlus Config）

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

2.直接使用Page对象即可

// 测试分页查询
@Test
public void testPage(){
    // 参数一: 当前页
    // 参数二： 页面大小，每页显示几条数据
    // 使用了分页插件之后，所有的分页操作变得简单了
    Page<User> page = new Page<>(1,5);
    //得到分页中的所有数据
    Page<User> userPage = userMapper.selectPage(page, null);
	long pages = userPage.getPages(); //总页数
    long current = userPage.getCurrent(); //当前页
    List<User> records = userPage.getRecords(); //查询数据集合
    long total = userPage.getTotal(); //总记录数
    boolean hasNext = userPage.hasNext();  //是否有下一页
    boolean hasPrevious = userPage.hasPrevious(); //是否有上一页
    System.out.println(pages);
    System.out.println(current);
    System.out.println(records);
    System.out.println(total);
    System.out.println(hasNext);
    System.out.println(hasPrevious);
}

8. 删除操作

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

// 测试批量删除
@Test
public void testdeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1287326823914405893L,1287326823914405894L));
}

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

9. 逻辑删除
物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据

逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

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

逻辑删除的使用场景：

可以进行数据恢复

有关联数据，不便删除
1.在数据库表中增加一个deleted字段
在这里插入图片描述
sql的写法

ALTERTABLE `user` ADD COLUMN `deleted` int DEFAULT 0

2.实体类中增加属性

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

3.配置
MyBatisPlusConfig

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

application.properties

# 配置逻辑删除,每次删除时修改标志位，0没有删除 1删除
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 testdelete(){
        userMapper.deleteById(1L);
    }

在这里插入图片描述
以上所有的CRUD操作及其扩展操作，我们必须精通掌握！会大大提高工作效率！

四、性能分析插件

我们在平时的开发中，会遇到一些慢sql。解决方案：测试，druid监控…

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

MyBatisPlus也提供性能分析插件，如果超过这个时间就停止运行！

1.导入插件

application.properties

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

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

在这里插入图片描述
只要超出时间就会抛出异常
使用性能分析插件可以提高效率，新版本MP已经移除该拆件了，可以使用druid

五、条件构造器

十分重要：wrapper
在这里插入图片描述
Wrapper ：条件构造抽象类，最顶端父类

AbstractWrapper ： 用于查询条件封装，生成 sql 的 where 条件

    QueryWrapper ： 查询条件封装（一般用这个）

    UpdateWrapper ： Update 条件封装

AbstractLambdaWrapper ： 使用Lambda 语法

    LambdaQueryWrapper ：用于Lambda语法使用的查询Wrapper


   LambdaUpdateWrapper ： Lambda 更新封装Wrapper

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

查询方式
在这里插入图片描述

WrapperTest.java

package com.wei;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.wei.mapper.UserMapper;
import com.wei.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;
import java.util.Map;


@SpringBootTest
public class WrapperTest {
    @Autowired
    UserMapper userMapper;


    @Test
    //ge、gt、le、lt、isNull、isNotNull
    void test() {
        // 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age",12);//age>=12这个条件
        userMapper.selectList(wrapper).forEach(System.out::println); // 和我们刚才学习的map对比一下
    }
    @Test
    //eq、ne
    void test2(){
        // 查询名字
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name","Jack");
        User user = userMapper.selectOne(wrapper); // 查询一个数据，出现多个结果使用List或者 Map
        System.out.println(user);
    }
    @Test
    // between、notBetween
    void test3(){
        // 查询年龄在 20 ~ 30 岁之间的用户
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age",11,100);// 区间
        Integer count = userMapper.selectCount(wrapper);// 查询结果数
        System.out.println(count);
    }
    //like、notLike、likeLeft、likeRight
    // 模糊查询
    @Test
    void test4(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper
                .notLike("name","e")
                .likeLeft("name","t");
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

    @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);
        QueryWrapper<User> objectQueryWrapper = new QueryWrapper<>();
        objectQueryWrapper.inSql("name","select name from user where id>=3");
        List<Object> objects1 = userMapper.selectObjs(objectQueryWrapper);
        objects.forEach(System.out::println);
        objects1.forEach(System.out::println);
    }
    //orderBy、orderByDesc、orderByAsc
    @Test
    void test6(){
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        // 通过id进行排序
        wrapper.orderByDesc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

}

六、代码生成器

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

package com.wei;


import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
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 DaiMaZiDong {
    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("wanghang");
        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/mybatis_plus? useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("qwas997997");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);
        //3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.wei");
        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.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(); //执行
    }
}