mybatisPlus插件使用

最新推荐文章于 2024-10-24 14:36:17 发布

wo不信~

最新推荐文章于 2024-10-24 14:36:17 发布

阅读量1k

点赞数 1

本文链接：https://blog.csdn.net/weixin_44993578/article/details/99642023

版权

撸了今年阿里、头条和美团的面试，我有一个重要发现…>>>

环境idea+springboot+mybatisplus

数据库mysql5.7，这个5.5及其以上版本就可以了

MyBatis-Plus介绍

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

参考教程：http://mp.baomidou.com/guide/

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

4.2 特性
无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库
支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
支持 XML 热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML 启动
支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
支持关键词自动转义：支持数据库关键词（order、key…）自动转义，还可自定义关键词
内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

快速开始参考：http://mp.baomidou.com/guide/quick-start.html

测试项目： mybatis_plus

数据库：mybatis_plus

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 脚本如下：

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

4.3.3 初始化工程
使用 Spring Initializr 快速初始化一个 Spring Boot 工程

Group：com.atguigu

Artifact：mybatis-plus

版本：2.0.7.RELEASE

4.3.4 添加依赖
4.3.4.1 引入依赖
spring-boot-starter、spring-boot-starter-test

添加：mybatis-plus-boot-starter、MySQL、lombok、

在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写，

org.springframework.boot spring-boot-starter org.springframework.boot spring-boot-starter-test test com.baomidou mybatis-plus-boot-starter 3.0.5 mysql mysql-connector-java org.projectlombok lombok

注意：引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring，以避免因版本差异导致的问题。

4.3.5 idea中安装lombok插件

4.3.6 配置
在 application.properties 配置文件中添加 MySQL 数据库的相关配置：

mysql5

#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus
spring.datasource.username=root
spring.datasource.password=123456

mysql8以上（spring boot 2.1）

注意：driver和url的变化

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
注意：

1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value ‘ÖÐ¹ú±ê×¼Ê±¼ä’ is unrecognized or represents more

2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

4.4 MP入门-编写代码
4.4.1 主类
在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹

注意：扫描的包名根据实际情况修改

package com.mp;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan(“com.mp.mapper”)
public class MpDemoApplication {

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

}
4.4.2 实体
创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码）

@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
查看编译结果

Lombok使用参考：

https://blog.csdn.net/motui/article/details/79012846

4.4.3 mapper
创建包 mapper 编写Mapper 接口： UserMapper.java

package com.mp.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.mp.entity.User;
import org.springframework.stereotype.Repository;

/**

Created by Administrator on 2019/8/14.
*/
@Repository
public interface UserMapper extends BaseMapper {

}

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

@RunWith(SpringRunner.class)
@SpringBootTest
public class MpDemoApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
public void testSelectList() {
List userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
}
注意：
IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。

为了避免报错，可以在 dao 层的接口上添加 @Repository 注

控制台输出：

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)
通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！
4.6 配置日志
查看sql输出日志

#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
5.MP-对表的CRUD操作【重点】
5.1 insert
@RunWith(SpringRunner.class)
@SpringBootTest
public class MpDemoApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
public void testSelectList() {
List userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}

@Test
public void testInsert(){
    User user = new User();
    user.setName("刘源源111");
    user.setAge(20);
    user.setEmail("18336090709@163.com");
    userMapper.insert(user);
}

}
注意：数据库插入id值默认为：全局唯一id

5.2 主键策略
（1）ID_WORKER

MyBatis-Plus默认的主键策略是：ID_WORKER 全局唯一ID

参考资料：分布式系统唯一ID生成方案汇总：https://www.cnblogs.com/haoxinyue/p/5208136.html

5.3 update
5.3.1 根据Id更新操作
注意：update时生成的sql自动是动态sql：UPDATE user SET age=? WHERE id=?

@Test
public void testInsert(){
    User user = new User();
    user.setName("刘源源111");
    user.setAge(20);
    user.setEmail("18336090709@163.com");
    userMapper.insert(user);
}
@Test
public void testUpdateById(){

    User user = new User();
    user.setId(1161584779686621185l);
    user.setAge(66);

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

}

}

5.3.2 自动填充
项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。

我们可以使用MyBatis Plus的自动填充功能，完成这些字段的赋值工作：

（1）数据库表中添加自动填充字段

在User表中添加datetime类型的新的字段 create_time、update_time

（2）实体上添加注解

package com.mp.entity;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableLogic;
import com.baomidou.mybatisplus.annotation.Version;
import lombok.Data;

import java.util.Date;

@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill= FieldFill.UPDATE)
private Date updateTime;
@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;
@TableLogic
@TableField(fill = FieldFill.INSERT)
private Integer deleted;

}

（3）实现元对象处理器接口

注意：不要忘记添加 @Component 注解

package com.mp.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import java.util.Date;

/**

Created by Administrator on 2019/8/14.
*/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

private static final Logger LOGGER = LoggerFactory.getLogger(MyMetaObjectHandler.class);

@Override
public void insertFill(MetaObject metaObject) {
LOGGER.info(“start insert fill …”);
this.setFieldValByName(“createTime”, new Date(), metaObject);
this.setFieldValByName(“updateTime”, new Date(), metaObject);
this.setFieldValByName(“version”, 1, metaObject);
this.setFieldValByName(“deleted”, 0, metaObject);
}

@Override
public void updateFill(MetaObject metaObject) {
LOGGER.info(“start update fill …”);
this.setFieldValByName(“updateTime”, new Date(), metaObject);
}

}

5.3.3 乐观锁

主要适用场景：当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新

乐观锁实现方式：

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

（1）数据库中添加version字段

ALTER TABLE user ADD COLUMN version INT

（2）实体类添加version字段

并添加 @Version 注解

@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;
（3）元对象处理器接口添加version的insert默认值（已经加过）

特别说明:

支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime
整数类型下 newVersion = oldVersion + 1
newVersion 会回写到 entity 中
仅支持 updateById(id) 与 update(entity, wrapper) 方法
在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

（4）在 MybatisPlusConfig 中注册 Bean

创建配置类，引入乐观锁插件

package com.mp.config;

import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

/**

Created by Administrator on 2019/8/14.
/
@EnableTransactionManagement
@Configuration
@MapperScan(“com.mp.mapper”)
public class MybatisPlusConfig {
/*
- 乐观锁插件，当更新的时候，插件会把版本+1;需要在实体类字段上加@Version注解，我这里只需要在config里面添加一个插入时候，初始版本为1即可
- 其余的事情交给乐观锁插件了。
  */
  @Bean
  public OptimisticLockerInterceptor optimisticLockerInterceptor() {
  return new OptimisticLockerInterceptor();
  }
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}

}

（5）测试乐观锁可以修改成功

测试后分析打印的sql语句，将version的数值进行了加1操作

@Test
public void testOptimisticLocker() {

    //查询
    User user = userMapper.selectById(1L);
    //修改数据
    user.setName("王花花");
    user.setEmail("helen@qq.com");
    //执行更新
    userMapper.updateById(user);
}

5.4 select
5.4.1 根据id查询记录
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
5.4.2 通过多个id批量查询
完成了动态sql的foreach的功能

@Test
public void testSelectBatchIds(){
List users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
注意：map中的key对应的是数据库中的列名。例如数据库user_id，实体类是userId，这时map的key需要填写user_id，驼峰命名。

5.4.4 分页
MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

（1）创建配置类，已经创建

此时可以删除主类中的 @MapperScan 扫描注解

（2）测试selectPage分页

测试：最终通过page对象获取相关数据

@Test
public void testSelectPage() {

    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page, null);

    page.getRecords().forEach(System.out::println);
    System.out.println(page.getCurrent());//当前页
    System.out.println(page.getPages());//总页数
    System.out.println(page.getSize());//每页显示记录数
    System.out.println(page.getTotal());//总记录数
    System.out.println(page.hasNext());//是否有下一页
    System.out.println(page.hasPrevious());//是否有上一页
}

控制台sql语句打印：SELECT id,name,age,email,create_time,update_time FROM user LIMIT 0,5

5.5 delete
5.5.1 根据id删除记录
@Test
public void testDeleteById(){
int result = userMapper.deleteById(8L);
System.out.println(result);
}
5.5.2 批量删除
@Test
public void testDeleteBatchIds() {
int result = userMapper.deleteBatchIds(Arrays.asList(8, 9, 10));
System.out.println(result);
}
5.5.4 逻辑删除
物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据
逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录
（1）数据库中添加 deleted字段

ALTER TABLE user ADD COLUMN deleted boolean

（2）实体类添加deleted 字段

并加上 @TableLogic 注解和 @TableField(fill = FieldFill.INSERT) 注解

@TableLogic
@TableField(fill = FieldFill.INSERT)
private Integer deleted;
（3）元对象处理器接口添加deleted的insert默认值，已添加

（4）application.properties 加入配置

此为默认值，如果你的默认值和mp默认的一样,该配置可无，0代表未删除，1代表删除。

mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
（5）在 MybatisPlusConfig 中注册 Bean，配置sql注入器

@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
（6）测试逻辑删除

测试后发现，数据并没有被删除，deleted字段的值由0变成了1
测试后分析打印的sql语句，是一条update
注意：被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作
@Test
public void testDeleteById(){

    int result = userMapper.deleteById(2L);
    System.out.println(result);
}

6.2 举个栗子：
6.2.1 ge、gt、le、lt、isNull、isNotNull

@Test
public void testDelete() {
QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.isNull(“name”).ge(“age”, 12).isNotNull(“email”);
int result = userMapper.delete(queryWrapper);
System.out.println("delete return count = " + result);
}
SQL：UPDATE user SET deleted=1 WHERE deleted=0 AND name IS NULL AND age >= ? AND email IS NOT NULL

6.2.2 eq、ne
注意：seletOne返回的是一条实体记录，当出现多条时会报错

@Test
public void testSelectOne() {

QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.eq(“name”, “Tom”);

User user = userMapper.selectOne(queryWrapper);

System.out.println(user);

}
SELECT id,name,age,email,create_time,update_time,deleted,version FROM user WHERE deleted=0 AND name = ?