mybatis-plus

头像
InmotionLay
    阅读 13 分钟

    简介

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

    官方地址：https://mp.baomidou.com/

    愿景

    我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

    特性

    无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
    损耗小：启动即会自动注入基本 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 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver
    达梦数据库 、 虚谷数据库 、 人大金仓数据库
    快速指南

    我们将通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能，在此之前，我们假设您已经：

    拥有 Java 开发环境以及相应 IDE
    熟悉 Spring Boot
    熟悉 Maven
    使用第三方组件：

    1、导入对应的依赖

    2、研究依赖如何配置

    3、代码如何编写

    4、提高扩展技术的能力

    步骤
    1、创建数据库 mybatis_plus

    现有一张 Userimage.png
    其对应的数据库 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)
);
-- 真实开发中，version（乐观锁），deleted（逻辑删除）、gmt_create、gem_mo

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

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

    2、导入相应的依赖

    <dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <scope>runtime</scope>
 </dependency>
<!--mybatis-plus 是自己开发的，非官方的！-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.3.1.tmp</version>
</dependency>
<!--lombok-->
 <dependency>
     <groupId>org.projectlombok</groupId>
     <artifactId>lombok</artifactId>
     <version>1.18.10</version>
     <scope>provided</scope>
 </dependency>

    说明：我们使用mybatis-plus可以节省我们大量的代码，尽量不要同时导入mybatis和mybatis-plus！ 版本的差异！

    3、连接数据库

    # mysql 5 驱动不同 com.mysql.jsbc.Driver

# mysql 8 驱动不同 com.mysql.cj.jsbc.Driver、需要增加时区的配置
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%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

    4、编写代码

    ​ pojo–>dao–>(连接mybatis，配置mapper.xml文件)–>service-controller (传统方式 )

    ​ 使用mybatis-plus之后

        * pojo
    * dao接口（不用写mapper.xml文件）
    * 使用

    编写实体类 User.java（此处使用了 Lombok 简化代码）

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

    编写Mapper类 UserMapper.java

    //在对应的Mapper上继承基本的类baseMapper
public interface UserMapper extends BaseMapper<User> {
//所有的CRUD已经编写完成
//不需要像以前的配置一些xml

}

    在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

    @SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.mapper")//扫描mapper文件夹
public class Application {

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

 }

    添加测试类，进行功能测试：

    @RunWith(SpringRunner.class)
@SpringBootTest
public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
         System.out.println(("----- selectAll method test ------"));
         //参数是一个Wrapper，条件结构器，这里先不用 填null
         //查询所有的用户 
         List<User> userList = userMapper.selectList(null);
         Assert.assertEquals(5, userList.size());
         userList.forEach(System.out::println);
     }

 }

    UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件
    控制台输出：

    User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)

    完整的代码示例请移步：Spring Boot 快速启动示例 [Spring MVC 快速启动示例]
    5、小结

    通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！

    从以上步骤中，我们可以看到集成MyBatis-Plus非常的简单，只需要引入 starter 工程，并配置 mapper 扫描路径即可。

    但 MyBatis-Plus 的强大远不止这些功能，想要详细了解 MyBatis-Plus 的强大功能？那就继续往下看吧！

    配置日志

    我们所用的sql现在是不可见的，我们希望知道他是怎么执行的，所以我们必须要查看日志！

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

    image.png
    CRUD扩展

    Insert 插入

    // 插入一条记录
int insert(T entity);

    参数说明
    image.png

    @Test
    public void testInsert() {
        System.out.println(("----- selectAll method test ------"));
        User user = new User();
        user.setName=("shuishui");
        user.setAge(3);
        user.setEmail("12434141@qq.com");
         
        userMapper.insert(user);
    }

    数据库插入的id为全局默认的id（ID_WORKER)

    主键生成策略

    分布式系统唯一id生成
    雪花算法
    SnowFlake 算法，是 Twitter 开源的分布式 id 生成算法。其核心思想就是：使用一个 64 bit 的 long 型的数字作为全局唯一 id。在分布式系统中的应用十分广泛，且ID 引入了时间戳，基本上保持自增的。

    这 64 个 bit 中，其中 1 个 bit 是不用的，然后用其中的 41 bit 作为毫秒数，用 10 bit 作为工作机器 id，12 bit 作为序列号。
    https://blog.csdn.net/lq18050...

    主键自增
    我们需要配置主键自增

    1、实体类字段上 @TableId（type =IdType.AUTO）
    image.png
    2、数据库字段一定要是自增的

    其他的码源详解
    image.png
    更新操作

    // 根据 whereEntity 条件，更新记录
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
// 根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);

    参数说明

    image.png
    举例测试
    image.png
    自动填充
    创建时间、修改时间！这些个操作一遍都是自动化完成，我们不希望手动更新！

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

    方式一：数据库级别

    ​ 在表中新增字段 create_time 、update_time(默认CURRENT_TIMESIAMP)

    方式二：代码级别

    ​ 实体类上的属性需要增加注解==@TableField==
    image.png

    乐观锁
    面试中经常会问到乐观锁，悲观锁

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

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

    乐观锁实现方式

    取出记录是，获取当前version
    更新时，带上这个version
    执行更新事，set version=newVersion where version =oldVersion
    如果version不对，就更新失败
    image.png
    测试乐观锁
    1、表中创建乐观锁字段version 默认值为1
    image.png
    2、同步实体类

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

    3、注册组件 （config包下）

    springboot：
    image.png
    spring xml:

    <bean class="com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor"/>

    特别说明:

    支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime
    整数类型下 newVersion = oldVersion + 1
    newVersion 会回写到 entity 中
    仅支持 updateById(id) 与 update(entity, wrapper) 方法
    在 update(entity, wrapper) 方法下, wrapper 不能复用!!!
    测试一下：
    image.png
    查询操作

    // 根据 ID 查询
T selectById(Serializable id);
// 根据 entity 条件，查询一条记录
 T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 查询（根据ID 批量查询）
 List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根据 entity 条件，查询全部记录
 List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 查询（根据 columnMap 条件）
 List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
// 根据 Wrapper 条件，查询全部记录
 List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
 List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

// 根据 entity 条件，查询全部记录（并翻页）
 IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询全部记录（并翻页）
 IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询总记录数
 Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    参数说明

    image.png
    实例测试
    image.png
    分页查询

    分页在网站使用的十分多

    1、原始的limit进行分页

    2、pageHelper 第三方插件

    3、Mybatis-Plus中也内置了分页插件！

    如何使用
    1、配置拦截器组件即可
    image.png
    2、写测试
    image.png
    删除

    // 根据 entity 条件，删除记录
 int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);
// 删除（根据ID 批量删除）
 int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
// 根据 ID 删除
 int deleteById(Serializable id);
// 根据 columnMap 条件，删除记录
 int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    参数说明

    image.png
    测试删除：
    image.png
    在工作中会遇到逻辑删除

    逻辑删除

    物理删除 ：从数据库中直接移出
    逻辑删除：在数据库中没有被移出，而是通过一个变量来让他失效！deleted=0 ==>deleted =1(失效)
    SpringBoot 配置方式：

    application.yml 加入配置(如果你的默认值和mp默认的一样,该配置可无):
    image.png
    注册 Bean(3.1.1开始不再需要这一步)：
    image.png
    实体类字段上加上@TableLogic注解

    @TableLogic
private Integer deleted;

    效果: 使用mp自带方法删除和查找都会附带逻辑删除功能 (自己写的xml不会)

    example
删除时 update user set deleted=1 where id =1 and deleted=0
查找时 select * from user where deleted=0

    全局逻辑删除: 3.3.0开始支持

    如果公司代码比较规范，比如统一了全局都是flag为逻辑删除字段。

    使用此配置则不需要在实体类上添加 @TableLogic。

    但如果实体类上有 @TableLogic 则以实体上的为准，忽略全局。 即先查找注解再查找全局，都没有则此表没有逻辑删除。
    image.png
    附件说明

    逻辑删除是为了方便数据恢复和保护数据本身价值等等的一种方案，但实际就是删除。
    如果你需要再查出来就不应使用逻辑删除，而是以一个状态去表示。
    如： 员工离职，账号被锁定等都应该是一个状态字段，此种场景不应使用逻辑删除。

    若确需查找删除数据，如老板需要查看历史所有数据的统计汇总信息，请单独手写sql。
    以上的CRUD操作都必须要掌握

    性能更新插件

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

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

    MP也提供性能分析插件，如果超过这和时间就会停止运行

    1、导入插件

    //Spring boot方式
@EnableTransactionManagement
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {

/**
 * SQL执行效率插件
 */
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    performanceInterceptor.setMaxTime(100);// ms 设置sql执行的最大时间，如果超过就停止
    performanceInterceptor.setFormat(true);
    return new PerformanceInterceptor();
}
}

    记得在SpringBoot配置环境为dev或者test环境！

    2、测试使用
    image.png
    image.png
    注意！参数说明：
    参数：maxTime SQL 执行最大时长，超过自动停止运行，有助于发现问题。
    参数：format SQL SQL是否格式化，默认false。
    该插件只用于开发环境，不建议生产环境使用。
    条件构造器

    十分重要：Wrapper

    我们写一些复杂的sql可以用它来完成

    现做几个实例看看：
    image.png
    image.png
    更多的方法都在官方文档里
    代码自动生成器

    dao、pojo、conrtroller、service自动生成

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

    package com.kuang;
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 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=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.kuang");    
     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(); 
     //执行   
 } 
}
    后端
    InmotionLay
    13 声望6 粉丝
    « 上一篇
    Mybatis全面详解

    引用和评论

    推荐阅读
    头像
    在Java程序中监听mysql的binlog

    huan1993赞 13阅读 7.3k

    头像
    Spring 实现 3 种异步流式接口，干掉接口超时烦恼

    程序员小富赞 7阅读 2.6k

    头像
    每一个前端，都要拥有属于自己的埋点库~

    幸福的闹钟赞 3阅读 1k

    头像
    高质量代码的原则

    寒青赞 4阅读 5.8k

    头像
    一文讲清楚static关键字

    seven97_top赞 4阅读 677

    头像
    Spring Boot 中的上下文

    zZ_jie赞 2阅读 634

    头像
    还在用命令行监控服务器？试试这款监控工具吧，直观又易用！

    macrozheng赞 2阅读 408

    0 条评论
    得票最新