MyBatisPlus学习笔记

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

测试项目： mybatis_plus

数据库：mybatis_plus

---

一、创建并初始化数据库 1、创建数据库：

mybatis_plus

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hi3zzWuF-1637296818259)(index_files1.png)]

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

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

二、初始化工程

maven的阿里云镜像配置方式：

https://developer.aliyun.com/mvn/guide

aliyunmaven * 阿里云公共仓库 https://maven.aliyun.com/repository/public

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

Group：com.javaclimb

Artifact：mybatis-plus

版本：2.2.1.RELEASE

三、添加依赖 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
        
            
                org.junit.vintage
                junit-vintage-engine
            
        
    
    
    
        com.baomidou
        mybatis-plus-boot-starter
        3.0.5
    
    
        mysql
        mysql-connector-java
    
    
    
        org.projectlombok
        lombok
        

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

2、idea中安装lombok插件

（1）idea2018版本

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-LwJ9frtc-1637296818262)(index_files/303533a2-0148-4329-a770-c4af5114b22c.png)]

（2）idea2019版本

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hq7FbcmH-1637296818265)(index_files/ba5bc431-832b-4bcb-81fe-893d02ad3c6f.png)]

离线安装方式：

https://plugins.jetbrains.com/plugin/6317-lombok/versions

https://github.com/mplushnikov/lombok-intellij-plugin/releases

用上面两个网址都可以，找到自己idea版本对应的lombok版本下载。

四、配置

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

mysql5

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

mysql8以上（spring boot 2.1）

**注意：**driver和url的变化

#mysql数据库连接
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 ，在mysql 8 中 建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

五、编写代码

1、主类

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

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

@SpringBootApplication
@MapperScan("com.javaclimb.mybatisplus.mapper")
public class MybatisPlusApplication {
     public static void main(String[] args) {
        SpringApplication.run(QuickStartApplication.class, args);
    }
}

2、实体

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

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

3、mapper

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

public interface UserMapper extends baseMapper {

}

六、开始使用

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

@SpringBootTest
public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        //UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，
        //所以不填写就是无任何条件
        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 文件都不用编写！

七、配置日志

查看sql输出日志

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

八、insert 1、插入操作

@Test
public void testInsert(){
    User user = new User();
    user.setAge(20);
    user.setEmail("781505696@qq.com");
    user.setName("孙悟空");

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

注意：数据库插入id是MP默认用雪花算法生成的

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-BOquoiYT-1637296818268)(D:/%E6%96%B0%E8%B5%84%E6%BA%90/mybatisPuls/10%20MyBatisPlus%E4%BB%8E%E5%85%A5%E9%97%A8%E5%88%B0%E8%BF%9B%E9%98%B6/%E8%AE%B2%E4%B9%89/007~018-MyBatisPlus%E7%9A%84CRUD%20%E6%8E%A5%E5%8F%A3/index_files/01.png)]

2、主键策略

（1）ID_WORKER

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

（2）自增策略

• 要想主键自增需要配置如下主键策略
• • 需要在创建数据表的时候设置主键自增
  • 实体字段中配置 @TableId(type = IdType.AUTO)

要想影响所有实体的配置，可以设置全局主键配置

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

其它主键策略：分析 IdType 源码

九、update 1、根据Id更新操作

@Test
public void testUpdateBtId(){
    User user = new User();
    user.setId(1449689775719071745L);
    user.setName("zhubajie");
    user.setAge(10);
    user.setEmail("123123@qq.com");
    int result = userMapper.updateById(user);
    System.out.println(user);
}

注意：update时生成的sql语句是：UPDATE user SET name=?, age=?, email=? WHERe id=?

2、自动填充

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

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

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

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

（2）实体上添加注解

@Data
public class User {
	......
	@TableField(fill = FieldFill.INSERT)
	private Date createTime;
	
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

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

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

import com.baomidou.mybatisplus.core.handlers.metaObjectHandler;
import org.apache.ibatis.reflection.metaObject;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;
import java.util.Date;

@Component
public class MymetaObjectHandler implements metaObjectHandler {

    @Override
    public void insertFill(metaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", () -> new Date(), Date.class); // 起始版本 3.3.3(推荐)
        this.strictInsertFill(metaObject, "updateTime", () -> new Date(), Date.class);
    }

    @Override
    public void updateFill(metaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", () -> new Date(), Date.class); // 起始版本 3.3.3(推荐)
    }
}

3、乐观锁

悲观锁
总是假设最坏的情况，每次去拿数据的时候都认为别人会修改，所以每次在拿数据的时候都会上锁，这样别人想拿这个数据就会阻塞直到它拿到锁（共享资源每次只给一个线程使用，其它线程阻塞，用完后再把资源转让给其它线程）。传统的关系型数据库里边就用到了很多这种锁机制，比如行锁，表锁等，读锁，写锁等，都是在做操作之前先上锁。Java中synchronized和ReentrantLock等独占锁就是悲观锁思想的实现。

乐观锁
总是假设最好的情况，每次去拿数据的时候都认为别人不会修改，所以不会上锁，但是在更新的时候会判断一下在此期间别人有没有去更新这个数据，可以使用版本号机制和CAS算法实现。乐观锁适用于多读的应用类型，这样可以提高吞吐量，像数据库提供的类似于write_condition机制，其实都是提供的乐观锁。在Java中java.util.concurrent.atomic包下面的原子变量类就是使用了乐观锁的一种实现方式CAS实现的。

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

乐观锁实现方式：

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

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

ALTER TABLE `user` ADD COLUMN `version` INT

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-JiMdaiEd-1637296818270)(D:/%E6%96%B0%E8%B5%84%E6%BA%90/mybatisPuls/10%20MyBatisPlus%E4%BB%8E%E5%85%A5%E9%97%A8%E5%88%B0%E8%BF%9B%E9%98%B6/%E8%AE%B2%E4%B9%89/007~018-MyBatisPlus%E7%9A%84CRUD%20%E6%8E%A5%E5%8F%A3/index_files/7bf260f8-d483-49fe-b448-b2fbea3dddaf.png)]

（2）实体类添加version字段

并添加 @Version 注解

@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;

（3）元对象处理器接口添加version的insert默认值

this.strictInsertFill(metaObject, "version", () -> 1, Integer.class);

特别说明:

支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime

整数类型下 newVersion = oldVersion + 1

newVersion 会回写到 entity 中

仅支持 updateById(id) 与 update(entity, wrapper) 方法

在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

（4）在 MybatisPlusConfig 中注册 Bean

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@Configuration
@MapperScan("com.javaclimb.mybatisplus.mapper")
public class MybatisPlusConfig {

    
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

（5）测试

@Test
public void testOptimisticLocker(){
    User user = new User();
    user.setAge(11);
    user.setEmail("1112212222@qq.com");
    user.setName("tangsheng");

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


@Test
public void testUpdateOptimisticLocker(){
    //注意：必须先查询才能再更新
    User user = userMapper.selectById(1449689775719071753L);
    user.setName("zhubajie1");
    user.setAge(12);
    user.setEmail("123123@qq.com");
    int result = userMapper.updateById(user);
    System.out.println(user);
}

十、select 1、根据id查询记录

@Test
public void testSelectById() {
    User user = userMapper.selectById(1L);
    System.out.println(user);
}

2、通过多个id批量查询

完成了动态sql的foreach的功能

@Test
public void testSelectBatchIds(){
    List users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

3、简单的条件查询

通过map封装查询条件

@Test
public void testSelectByMap(){
    HashMap map = new HashMap<>();
    map.put("name", "bailongma");
    map.put("age", 33);
    List users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

**注意：**map中的key对应的是数据库中的列名。例如数据库user_id，实体类是userId，这时map的key需要填写user_id

4、分页

（1）在 MybatisPlusConfig 中注册 Bean

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@Configuration
@MapperScan("com.javaclimb.mybatisplus.mapper")
public class MybatisPlusConfig {

    
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();        
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

(2) 测试

@Test
public void testSelectPage(){
    Page page = new Page<>(2,3);
    userMapper.selectPage(page, Wrappers.lambdaQuery().ge(User::getAge,10));
    List records = page.getRecords();
    records.forEach(System.out::println);
    page.hasNext();
    page.hasPrevious();
}

十一、delete 1、根据id删除记录

@Test
public void testDeleteById() {
    int result = userMapper.deleteById(1449689775719071753L);
    System.out.println(result);
}

2、批量删除

@Test
public void testDeleteBatchByIds() {
    int result = userMapper.deleteBatchIds(Arrays.asList(1449689775719071745L, 1449689775719071746L));
    System.out.println(result);
}

3、简单的条件查询删除

@Test
public void testDeleteByMap() {
    HashMap map = new HashMap<>();
    map.put("name", "shasheng");
    int result = userMapper.deleteByMap(map);
    System.out.println(result);
}

十二、复杂查询

如果想进行复杂条件查询，那么需要使用条件构造器 Wapper，常用它的子类QueryWrapper来实现。UpdateWrapper ： Update 条件封装，用于Entity对象更新操作。

1、ge、gt、le、lt、isNull、isNotNull

@Test
public void test1(){
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.ge("age",11)
            .isNull("name");
    int result = userMapper.delete(queryWrapper);
    System.out.println(result);
}

2、eq、ne

@Test
public void test2(){
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.eq("name","zhubajie");
    User user = userMapper.selectOne(queryWrapper);
    System.out.println(user);
}

3、between、notBetween

@Test
public void test3(){
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.between("age",20,30);
    List users = userMapper.selectList(queryWrapper);
    System.out.println(users);
}

4、allEq

@Test
public void test4(){
    QueryWrapper queryWrapper = new QueryWrapper<>();
    Map map = new HashMap<>();
    map.put("id",1L);
    map.put("name","Jack");
    map.put("age",30);
    queryWrapper.allEq(map);
    List users = userMapper.selectList(queryWrapper);
    System.out.println(users);
}

5、like、notLike、likeLeft、likeRight

@Test
public void test5() {
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.like("name","a")
                .notLike("name","b");
    List> maps = userMapper.selectMaps(queryWrapper);
    System.out.println(maps);
}

6、in、notIn、inSql、notinSql、exists、notExists

in、notIn:

in(“age”,1,2,3)------->age in (1,2,3)

in(“age”,{1,2,3})------->age in (1,2,3)

notIn(“age”,1,2,3)------->age not in (1,2,3)

inSql、notinSql:往往用来实现子查询

inSql(“id”,“select id from user where id<4”)----> id in (select id from user where id<4)

@Test
public void test6() {
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.inSql("id","select id from user where id<3");
    List