Mybatis-plus 学习笔记

不想长高的一米九

已于 2022-03-05 21:13:49 修改

阅读量586

点赞数

分类专栏： # Mybatis-plus 文章标签： java mybatis mybatis-plus java-ee

于 2022-02-04 18:46:19 首次发布

本文链接：https://blog.csdn.net/Sgxlebron/article/details/122784778

版权

Mybatis-plus 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

前言

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window) 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

完整学习源码已托管至Gitee：https://gitee.com/sgxcodehouse/mybatis-plus-learning-code.git

1 Mybatis-plus 介绍

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window) 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

1.1特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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.2 支持数据库

任何能使用 MyBatis 进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下：

MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb
达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库

2 Mybatis-plus 快速入门

创建数据库和user表
创建springboot项目导入依赖

<!--MySQL驱动-->
<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.0.5</version>
</dependency>

注意：尽量不要同时导入mybatis和mybatis-plus！

编写配置文件连接数据库

# mysql 5 驱动：com.mysql.jdbc.Driver,但高版本兼容低版本
# mysql 8 驱动：com.mysql.cj.jdbc.Driver 需要配置时区
# useSSl:是否使用安全连接
# serverTimezone=GMT%2B8 (东八区) 5.7.8以上版本都需要配置时区
spring.datasource.username=root
spring.datasource.password=52741
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSl=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8&zeroDateTimeBehavior=convertToNull
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

编写pojo的实体类

public class User {

    private Long id;
    private String name;
    private Integer age;
    private String email;
}

编写mapper接口继承BaseMapper

@Repository
public interface UserMapper extends BaseMapper<User> {
    
}

测试即可

3 配置日志输出

作用：配置日志输出，查看sql执行情况；

log4j和slf4j需要导入对应依赖
默认的控制台输出：StdOutImpl

mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

启动测试类：

4 CRUD增删改查

4.1 Insert插入

编写测试，调用insert方法插入

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

    int insert = userMapper.insert(user);
    System.out.println(insert);
}

控制台输出

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

4.1.1 主键生成策略

默认 ID_WORKER 全局唯一id

分布式系统唯一id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html

4.1.2 雪花算法：

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：

使用41bit作为毫秒数，

10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），

12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），

最后还有一个符号位，永远是0。可以保证几乎全球唯一！

4.1.3 主键自增

在对应数据库的主键字段的实体类属性上添加注解@TableId(type = IdType.AUTO)

public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

保证数据库上该字段是自增的
测试插入数据

4.1.4 其余主键策略

@TableId注解的type 属性的 IdType其它设置：

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

4.2 Update更新操作

测试更新数据，调用updateById方法，参数是一个指定的泛型

// 测试更新
@Test
public void testUpdate(){
    User user = new User();
    user.setName("lebron1111")
            .setAge(38)
            .setEmail("11111@qq.com")
            .setId(6L);

    int insert = userMapper.updateById(user);
    System.out.println(insert);
}

在这里插入图片描述

根据我们传入的参数不同，mybatis-plus会帮我们拼接动态sql

4.2.1 关于时间的自动填充

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

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

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

在数据库表中新增两个字段 create_time,update_time
给实体类添加属性

private Date createTime;
private Date updateTime;

测试插入

在这里插入图片描述

方式二：代码级别（建议使用）

删除数据库中的默认值、自动更新操作

在这里插入图片描述

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

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

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

@Slf4j
@Component
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.2.2 乐观锁

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

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

乐观锁实现方式：

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

实现乐观锁：

数据库添加version字段实现乐观锁

在这里插入图片描述

实体类添加对应属性，添加@Version注解

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

注册组件

//配置类
//扫描mapper文件夹下的所有接口
@MapperScan("com.guoxin.mapper")
//开启自动提交事务，默认也是开启的
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {

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

测试单线程更新成功

在这里插入图片描述

测试多线程更新失败

在这里插入图片描述

4.3 Select查询操作

4.3.1 普通查询

（1）根据单个ID查询用户selectById方法

//查询单个id
@Test
public void testSelectById(){
    //根据单个id查询
    User user = userMapper.selectById(1L);
    System.out.println(user);
}

在这里插入图片描述

（2）根据多个ID查询用户selectBatchIds方法

//查询多个id
@Test
public void testSelectByIds(){
    //根据多个id查询
    List<User> users = userMapper.selectBatchIds(Arrays.asList( 2, 3,4));
    for (User user1 : users) {
        System.out.println(user1);
    }
}

在这里插入图片描述

（3）条件查询selectByMap方法

//条件查询
@Test
public void testSelectByCondition(){
    //根据条件查询
    HashMap<String, Object> map = new HashMap<>();
    //自定义要查询的条件
    map.put("name","lebron22222");
    map.put("age","38");

    List<User> users = userMapper.selectByMap(map);
    for (User user1 : users) {
        System.out.println(user1);
    }
}

在这里插入图片描述

4.3.2 分页查询

配置拦截器

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

编写测试

//分页查询
@Test
public void testSelectByPage(){
    Page<User> page = new Page<>(1, 5);

    IPage<User> userPage = userMapper.selectPage(page, null);
    page.getRecords().forEach(System.out::println);
}

在这里插入图片描述

4.4 Delete删除操作

4.4.1物理删除（数据库真正删除）

根据id删除deleteById
根据id批量删除deleteBatchIds
根据指定条件删除deleteByMap

//删除
@Test
public void testDeleteById(){
    //根据id删除
    int i = userMapper.deleteById(1489197462533971971L);
    //根据id批量删除
    int i1 = userMapper.deleteBatchIds(Arrays.asList(2, 3));
    //根据指定条件删除
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","Tom");
    int i2 = userMapper.deleteByMap(map);
}

4.4.2逻辑删除（数据库并未真正删除）

物理删除：从数据库中直接删除
逻辑删除：在数据库中没有被删除，而是通过一个变量来使他失效！ deleted=0 ==> deleted=1

回收站：将deleted=1的数据放入其中，清空回收站：将deleted=1的数据从数据库中删除

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

在这里插入图片描述

给实体类增加对应的属性，添加@TableLogic逻辑删除插件注解

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

在配置类中获取逻辑删除组件

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

在配置文件中配置具体的逻辑删除规则

#配置逻辑删除  没删除的为0 删除的为1
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

测试逻辑删除

//删除逻辑删除
@Test
public void testDelete(){
    //根据id删除
    int i = userMapper.deleteById(1489197462533971971L);
}

在这里插入图片描述

再去数据库查询这条数据的时候，就查询不到了

5 性能分析插件

导入插件

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

配置文件当前环境为生产环境

# 配置当前环境为dev开发环境
spring.profiles.active=dev

测试结果

在这里插入图片描述

6 条件构造器Wrapper

6.1 notNull

isNotNull：不为空
ge：大于等于（g大于，e等于）

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

6.2 单条数据查询

selectOne：查询一条数据
eq：XXX等于XXX
@Test
void test1() {
//查询姓名为Tom的用户
QueryWrapper wrapper = new QueryWrapper<>();
wrapper.eq(“name”,“Tom”);
System.out.println(userMapper.selectOne(wrapper));
}

6.3 between和查询结果数count

between：XXX在X到X之间
selectCount：查询满足条件结果数

@Test
void test2() {
    //查询年龄在20~30之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",20,30);
    //selectCount查询满足条件的结果数
    System.out.println(userMapper.selectCount(wrapper));
}

6.4 模糊查询

notLike：不包含
likeRight：t%
likeLeft：%t

@Test
void test3() {
    //模糊查询：名字中不带e的并且邮箱以t开头的用户，
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.notLike("name","e")
            .likeRight("email","t");
    //selectCount查询满足条件的结果数
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

6.5 子查询

@Test
void test4() {
    //子查询：查询id小于五的用户，
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    // SELECT * FROM user WHERE deleted=0 AND id IN (select idfrom user where id<5 )
    wrapper.inSql("id","select id from user where id<5");
    //selectCount查询满足条件的结果数
    List<Object> objects = userMapper.selectObjs(wrapper);
    objects.forEach(System.out::println);
}

6.6 排序查询

@Test
void test5() {
    //排序：通过id降序排序
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.orderByDesc("id");
    //selectCount查询满足条件的结果数
    List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}

7 代码生成器

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

MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>
<!--swagger2-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

详细自动配置类：

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 AutoCoding {
    public static void main(String[] args) {
        //创建一个代码自动生成器对象
        AutoGenerator generator = new AutoGenerator();

        //配置策略

        //1、全局配置
        GlobalConfig gcg = new GlobalConfig();
        //配置代码生成的目录
        //获取系统当前项目目录
        String projectPath = System.getProperty("user.dir");
        gcg.setOutputDir(projectPath + "/src/main/java");
        //注释中的作者
        gcg.setAuthor("guoXin");
        //执行完成是否打开资源管理器目录
        gcg.setOpen(false);
        //是否覆盖之前生成的代码
        gcg.setFileOverride(false);
        //服务的名字,去掉Service的I前缀
        gcg.setServiceName("%sService");
        //设置主键生成策略:全局唯一
        gcg.setIdType(IdType.ID_WORKER);
        //设置日期类型:仅仅是普通日期
        gcg.setDateType(DateType.ONLY_DATE);
        //设置swagger
        gcg.setSwagger2(true);
        //将全局配置加入到生成器对象的配置中
        generator.setGlobalConfig(gcg);

        //2、配置数据源
        DataSourceConfig dsg = new DataSourceConfig();
        dsg.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSl=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8&zeroDateTimeBehavior=convertToNull");
        dsg.setUsername("root");
        dsg.setPassword("52741");
        dsg.setDriverName("com.mysql.cj.jdbc.Driver");
        //设置数据库类型
        dsg.setDbType(DbType.MYSQL);
        //将数据源配置加入到生成器对象的配置中
        generator.setDataSource(dsg);

        //3、包的配置
        PackageConfig pgg = new PackageConfig();
        //设置模块名
        pgg.setModuleName("testModule");
        //设置父包名
        pgg.setParent("com.guoxin");
        //实体类的包名
        pgg.setEntity("pojo");
        //mapper
        pgg.setMapper("mapper");
        //service
        pgg.setService("service");
        //controller
        pgg.setController("controller");
        //将包配置加入到生成器对象的配置中
        generator.setPackageInfo(pgg);

        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        //设置要映射的表名
        strategy.setInclude("user");
        //下划线转驼峰命名
        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 gmtUpdate = new TableFill("gmt_update", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtUpdate);
        strategy.setTableFillList(tableFills);

        //乐观锁配置
        strategy.setVersionFieldName("version");
        //开启驼峰命名
        strategy.setRestControllerStyle(true);
        //localhost:8080/hello_id_2
        strategy.setControllerMappingHyphenStyle(true);

        //将策略配置加入到生成器对象的配置中
        generator.setStrategy(strategy);
        //执行
        generator.execute();

    }
}

测试结果：

不想长高的一米九

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Mybatis-plus 学习笔记

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window) 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
复制链接

扫一扫