Mybatis-Plus

2023-10-23 20:06:16

Mybatis-Plus

一、Mybatis-plus简介

是什么

官网：https://mp.baomidou.com/

特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

支持数据库

mysql，oracle，db2，h2，hsql，sqlite，postgresql，sqlserver，Phoenix，Gauss ，clickhouse，Sybase，OceanBase，Firebird，cubrid，goldilocks，csiidb
达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库

框架结构

二、快速入门

数据库搭建

1.创建数据库 mybatis-plus

2.创建User 表，其表结构如下：

id	name	age	email
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

其对应的数据库 Schema 脚本如下：

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

其对应的数据库 Data 脚本如下：

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

项目搭建

1.创建spirngboot项目

2.导入依赖

        <!--数据库驱动-->
        <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>

3.配置application.properties

# mysql
spring.datasource.username=root
spring.datasource.password=123
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT

4.在pojo包中编写实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

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

5.在对应的Mapper上面继承基本的类 BaseMapper,所有的CRUD操作已经完成

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

6.测试

三、配置日志

此时我们的所有sql都是不可见的，我们想要知道它是怎么执行的，所以我们需要看日志！

产品上线时删除该配置

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

此时再次测试，控制台可以查看到

四、CRUD扩展

插入操作

@Test
void testInsert(){
    User user = new User();
    user.setAge(10);
    user.setEmail("123");
    user.setName("小明");
    userMapper.insert(user);
}

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

主键生成策略

分布式系统唯一id生成：

雪花算法：

主键自增

我们需要配置主键自增

实体类字段上配置**@TableId(type = IdType.AUTO)**
数据库子弹一定要是自增的

主键其余原码解释

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

自动填充

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

方式一：数据库级别(工作中不允许使用)

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

2.同步实体类

public class User {

    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date createTime;
    private Date updateTime;
}

再次测试

方式二：代码级别

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

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

3.编写处理器来处理这个注解即可

@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.测试插入

乐观锁

**乐观锁：**它总认为不会出现问题，无论干什么不去上锁！如果出现问题，再次更新值测试。

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

乐观锁机制

乐观锁实现方式：

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

乐观锁： 1.先查询，获得版本号 version = 1

--A线程
update user set username = "li",version = version +1
where id = 2 and version = 1

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

测试mybatis-plus

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

2.修改实体类

3.注册组件

@MapperScan("com.example.demo.mapper") //扫描mapper文件夹
@EnableTransactionManagement     //开启事务
@Configuration    //配置类
public class MybatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

查询操作

@Test
    void testSelect(){
        //测试单个id查询
        System.out.println(userMapper.selectById(1L));

        //根据多个id查询
        userMapper.selectBatchIds(Arrays.asList(1,2,3)).forEach(System.out::println);

        //条件查询
        HashMap<String, Object> map = new HashMap<>();
        map.put("name","l");
        map.put("age",3);
        userMapper.selectByMap(map).forEach(System.out::println);

        //模糊查询
        userMapper.li
    }

分页查询

分页查询在网站使用十分多

原始的limit进行分页
pageHelper第三方插件
mybatis-plus内置了

mybatis-plus使用

1.注册分页插件

@MapperScan("com.example.demo.mapper") //扫描mapper文件夹
@EnableTransactionManagement     //开启事务
@Configuration    //配置类
public class MybatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }

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

2.测试分页查询

@Test
void testPage(){
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page,null);
    page.getRecords().forEach(System.out::println);

}

删除操作

基本的删除操作

@Test
void testDelete(){
    //通过id删除
    userMapper.deleteById(1L);
    //通过id批量删除
    userMapper.selectBatchIds(Arrays.asList(1,2,3));
    //通过条件删除
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","l");
    userMapper.deleteByMap(map);
}

逻辑删除

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

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

测试一下：

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

2.在实体类中增加属性

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

    @Version//乐观锁
    private Integer version;

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

3.注册逻辑删除插件

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

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

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

4.在propertisy文件中配置逻辑删除

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

性能分析插件

我们在平时的开发中，会遇到一些慢sql。测试！duid…

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

1.导入插件

注意，要在主配置文件中配置环境为dev或test

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

注册性能分析插件

@MapperScan("com.example.demo.mapper") //扫描mapper文件夹
@EnableTransactionManagement     //开启事务
@Configuration    //配置类
public class MybatisPlusConfig {
    //注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }

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

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

    //sql执行效率插件
    @Bean
    @Profile({"dev","test"})//设置 dev test 环境开启，保证效率
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        // 在实际中，不允许客户等待
        performanceInterceptor.setMaxTime(100); //ms 设置sql执行的最大时间，如果超过就不执行
        performanceInterceptor.setFormat(true);
        return performanceInterceptor;
    }
}

条件构造器

@Test
void testFinda( ){
    /**
         * 查找name,email不为空，年龄大于12的用户
         */
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.isNotNull("name")
        .isNotNull("email")
        .ge("age",22);
    userMapper.selectList(wrapper).forEach(System.out::println);

    /**
         * 查询名字为li的user
         */
    QueryWrapper<User> wrapper2 = new QueryWrapper<>();
    wrapper2.eq("name","li");
    System.out.println(userMapper.selectOne(wrapper2));

    /**
         * 查询年龄在20~30之间的user
         */
    QueryWrapper<User> wrapper3 = new QueryWrapper<>();
    wrapper3.between("age",21,23);
    userMapper.selectList(wrapper3).forEach(System.out::println);

    /**
         * 模糊查询
         */
    QueryWrapper<User> wrapper4 = new QueryWrapper<>();
    wrapper4.notLike("name","e")
        .likeRight("email","t");
    userMapper.selectList(wrapper4).forEach(System.out::println);

    /**
         * 子查询
         */
    QueryWrapper<User> wrapper5 = new QueryWrapper<>();
    wrapper5.inSql("id","select id from user where id<3");
    userMapper.selectList(wrapper5).forEach(System.out::println);

    /**
         * 按照名字降序查询
         */
    QueryWrapper<User> wrapper6 = new QueryWrapper<>();
    wrapper6.orderByDesc("name");
    userMapper.selectList(wrapper6).forEach(System.out::println);
}

代码生成器

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

1.导入依赖

<!--mybatis-plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>
<!--velocity模板引擎:代码生成器需要-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.0</version>
</dependency>
<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>

2.编写代码自动生成器

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;
import java.util.Arrays;

//代码自动生成器
public class AutoGeneratorCode {
    public static void main(String[] args) {
        //构建代码自动生成器对象
        AutoGenerator autoGenerator = new AutoGenerator();

        //配置策略
        //1.全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        globalConfig.setOutputDir(projectPath+"/src/main/java");
        globalConfig.setAuthor("li");
        globalConfig.setOpen(false);
        globalConfig.setFileOverride(false);
        globalConfig.setServiceName("%sService");
        globalConfig.setIdType(IdType.AUTO);
        globalConfig.setDateType(DateType.ONLY_DATE);
        globalConfig.setSwagger2(true);
        autoGenerator.setGlobalConfig(globalConfig);

        //2.设置数据源设计
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT");
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("1");
        dataSourceConfig.setDbType(DbType.MYSQL);
        autoGenerator.setDataSource(dataSourceConfig);

        //3.包的配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setModuleName("api");
        packageConfig.setParent("com.example.demo");
        packageConfig.setEntity("entity");
        packageConfig.setMapper("mapper");
        packageConfig.setService("service");
        packageConfig.setController("controller");
        autoGenerator.setPackageInfo(packageConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);//下划线转驼峰命名
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);  //自动Lombok
        strategy.setRestControllerStyle(true);

        //设置要映射的表名字
        strategy.setInclude("product");
        //设置逻辑删除
        strategy.setLogicDeleteFieldName("deleted");
        //乐观锁
        strategy.setVersionFieldName("version");
        //自动填充
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModify = new TableFill("gmt__modify", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFillList = new ArrayList<>();
        tableFillList.add(gmtCreate);
        tableFillList.add(gmtModify);
        strategy.setTableFillList(tableFillList);

        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);
        autoGenerator.setStrategy(strategy);

        autoGenerator.execute();//执行

    }
}

码农公寓

Mybatis-Plus

一、Mybatis-plus简介

二、快速入门

三、配置日志

四、CRUD扩展

插入操作

主键生成策略

自动填充

乐观锁

查询操作

分页查询

删除操作

性能分析插件

条件构造器

代码生成器

相关文章