MyBatis Plus学习笔记

Posted 2023-01-09 Pistachiout

MyBatis Plus

国产的开源框架，基于 MyBatis
在Mybatis-Plus中，内置了代码生成器，我们可以通过该工具，生成我们需要的代码，例如：entity层，controller层，mapper层，service层。如此一来，我么就可以节省编码的时间，优化开发。

MyBatis Plus 快速上手

Spring Boot(2.3.0) + MyBatis Plus（国产的开源框架，并没有接入到 Spring 官方孵化器中）

1、创建 Maven 工程

2、pom.xml 引入 MyBatis Plus 的依赖mybatis-plus-boot-starter

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.3.1.tmp</version>
</dependency>

3、创建实体类

package com.mybatisplus.entity;

import lombok.Data;

@Data
public class User 
    private Integer id;
    private String name;
    private Integer age;

4、创建 Mapper 接口，继承 BaseMapper，不用自己写代码

package com.mybatisplus.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.mybatisplus.entity.User;

public interface UserMapper extends BaseMapper<User> 

5、application.yml

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/db?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

6、启动类main需要添加 @MapperScan(扫描"mapper所在的包")，否则无法加载 Mppaer bean。

package com.southwind.mybatisplus;

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

@SpringBootApplication
@MapperScan("com.southwind.mybatisplus.mapper")
public class MybatisplusApplication 

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

7、测试

package com.southwind.mybatisplus.mapper;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class UserMapperTest 

    @Autowired
    private UserMapper mapper;

    @Test
    void test()
        mapper.selectList(null).forEach(System.out::println);
    

常用注解

@TableName映射数据库的表名

package com.southwind.mybatisplus.entity;

import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName(value = "user")
public class Account 
    private Integer id;
    private String name;
    private Integer age;

@TableId设置主键映射，value 映射主键字段名

type 设置主键的生成策略，如雪花算法或自增等

AUTO(0),
NONE(1),
INPUT(2),
ASSIGN_ID(3),
ASSIGN_UUID(4),
/** @deprecated */
@Deprecated
ID_WORKER(3),
/** @deprecated */
@Deprecated
ID_WORKER_STR(3),
/** @deprecated */
@Deprecated
UUID(4);

值	描述
AUTO	数据库自增
NONE	MP set 主键，雪花算法实现
INPUT	开发者手动赋值
ASSIGN_ID	MP 分配 ID，Long、Integer、String
ASSIGN_UUID	分配 UUID，Strinig

INPUT 如果开发者没有手动赋值，则数据库通过自增的方式给主键赋值，如果开发者手动赋值，则存入该值。

AUTO 默认就是数据库自增，开发者无需赋值。

ASSIGN_ID MP 自动赋值，雪花算法。

ASSIGN_UUID 主键的数据类型必须是 String，自动生成 UUID 进行赋值

@TableField映射非主键字段，value 映射字段名

exist 表示是否为数据库字段 false，如果实体类中的成员变量在数据库中没有对应的字段，则可以使用 exist，VO、DTO

select 表示是否查询该字段

fill 表示是否自动填充，将对象存入数据库的时候，由 MyBatis Plus 自动给某些字段赋值，create_time、update_time

1、给表添加 create_time、update_time 字段

2、实体类中添加成员变量

package com.southwind.mybatisplus.entity;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

import java.util.Date;

@Data
@TableName(value = "user")
public class User 
    @TableId
    private String id;
    @TableField(value = "name",select = false)
    private String title;
    private Integer age;
    @TableField(exist = false)
    private String gender;//在数据库中没有该字段
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;//自动导入创建时间
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;//自动导入更新时间

3、创建自动填充处理器，需要实现MetaObjectHandler ，然后重写insertFill()与updateFill()。

package com.southwind.mybatisplus.handler;

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

import java.util.Date;

@Component
public class MyMetaObjectHandler implements MetaObjectHandler 
    @Override
    public void insertFill(MetaObject metaObject) 
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    

    @Override
    public void updateFill(MetaObject metaObject) 
        this.setFieldValByName("updateTime",new Date(),metaObject);
    

@Version标记乐观锁

乐观锁：十分乐观，它总是认为不会出现问题，无论干什么都不去上锁！ 如果出现了问题，再去上锁。
通过 version 字段来保证数据的安全性，当修改数据的时候，会以 version 作为条件，当条件成立的时候才会修改成功。

乐观锁实现机制：
取出记录时，获取当前 version
更新时，带上这个 version
执行更新时， set version = newVersion where version = oldVersion
如果 version 不对，就更新失败

1、数据库表添加 version 字段，默认值为 1

2、实体类添加 version 成员变量，并且添加 @Version

    @Version
    private int version;

3、注册乐观锁配置类optimisticLockerInterceptor

package com.southwind.mybatisplus.config;

import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisPlusConfig 
    
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor()
        return new OptimisticLockerInterceptor();
    
    

多线程测试乐观锁

	@Test
    void testOptimisticLocker2()
        //多线程操作乐观锁
        //线程1操作，此时 version = 1
        User user = userMapper.selectById(4L);
        user.setName("66666");
        user.setAge(100);
        //线程2抢占执行
        User user2 = userMapper.selectById(4L);
        user2.setName("88888");
        user2.setAge(200);
        int i2 = userMapper.updateById(user2);
        //执行完成后 version 变为 2
        System.out.println(i2);
        //线程1 继续执行，但是此时发现version = 2，无法满足 version = 1 的要求，无法进行覆盖
        //如果没有乐观锁,线程 1 会进行覆盖线程 2 的修改
        int i = userMapper.updateById(user);
        System.out.println(i);
    

@EnumValue实现枚举

方法1、通用枚举类注解@EnumValue，将数据库字段映射成实体类的枚举类型成员变量

package com.southwind.mybatisplus.enums;

import com.baomidou.mybatisplus.annotation.EnumValue;

public enum StatusEnum 
    WORK(1,"上班"),
    REST(0,"休息");
    StatusEnum(Integer code, String msg) 
        this.code = code;
        this.msg = msg;
    
    @EnumValue
    private Integer code;
    private String msg;

    private StatusEnum status;

application.yml

type-enums-package: 
  com.southwind.mybatisplus.enums

@TableLogic映射逻辑删除

1、数据表添加 deleted 字段

2、实体类添加注解与对应字段

    @TableLogic
    private Integer deleted;

3、application.yml 添加配置

global-config:
  db-config:
    logic-not-delete-value: 0
    logic-delete-value: 1

4.配置类

@Configuration
public class MybatisPlusConfig 
    // 逻辑删除注入 3.0.5
    @Bean
    public ISqlInjector sqlInjector() 
        return new LogicSqlInjector();
    

MyBatis-Plus查询

	mapper.selectList(null);//全部查询
	QueryWrapper wrapper = new QueryWrapper();
       Map<String,Object> map = new HashMap<>();
       map.put("name","小红");
       map.put("age",3);
       wrapper.allEq(map);//等于
      wrapper.gt("age",2);//大于
      wrapper.ne("name","小红");//不等于
      wrapper.ge("age",2);//大于等于

//like '%小'
    wrapper.likeLeft("name","小");
//like '小%'
        wrapper.likeRight("name","小");

//inSQL   
   wrapper.inSql("id","select id from user where id < 10");
   wrapper.inSql("age","select age from user where age > 3");

     wrapper.orderByDesc("age");//排序

     wrapper.orderByAsc("age");
     wrapper.having("id > 8");

mapper.selectList(wrapper).forEach(System.out::println);

       System.out.println(mapper.selectById(7));
       mapper.selectBatchIds(Arrays.asList(7,8,9)).forEach(System.out::println);

   //Map 只能做等值判断，逻辑判断需要使用 Wrapper 来处理
       Map<String,Object> map = new HashMap<>();
        map.put("id",7);
       mapper.selectByMap(map).forEach(System.out::println);

QueryWrapper wrapper = new QueryWrapper();
wrapper.eq("id",7);
       System.out.println(mapper.selectCount(wrapper));
     //将查询的结果集封装到Map中
        mapper.selectMaps(wrapper).forEach(System.out::println);
       System.out.println("-------------------");
       mapper.selectList(wrapper).forEach(System.out::println);

分页查询Page

1.配置分页插件

    @Bean
    public PaginationInterceptor mypaginationInterceptor() 
        return new PaginationInterceptor();
    

2.直接使用page对象进行查询

		 //参数一 ： 当前页
        //参数二 ： 页面大小
       Page<User> page = new Page<>(2,2);
        Page<User> result = mapper.selectPage(page,null);
       System.out.println(result.getSize());
        System.out.println(result.getTotal());
       result.getRecords().forEach(System.out::println);
       Page<Map<String,Object>> page = new Page<>(1,2);
        mapper.selectMapsPage(page,null).getRecords().forEach(System.out::println);
       mapper.selectObjs(null).forEach(System.out::println);
System.out.println(mapper.selectOne(wrapper));

自定义 SQL（多表关联查询）

package com.southwind.mybatisplus.entity;

import lombok.Data;

@Data
public class ProductVO 
    private Integer category;
    private Integer count;
    private String description;
    private Integer userId;
    private String userName;

package com.southwind.mybatisplus.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.southwind.mybatisplus.entity.ProductVO;
import com.southwind.mybatisplus.entity.User;
import org.apache.ibatis.annotations.Select;

import java.util.List;

public interface UserMapper extends BaseMapper<User> 
    @Select("select p.*,u.name userName from product p,user u where p.user_id = u.id and u.id = #id")
    List<ProductVO> productList(Integer id);

添加

User user = new User();
user.setTitleMybatis-Plus入门学习笔记

 Mybatis-Plus学习笔记
 #yyds干货盘点#MyBatis-plus学习笔记
 Mybatis-plus工具学习笔记---[基本概述,入门案例搭建,通用service接口使用]
 MyBatis-Plus-自动填充功能（学习笔记）
 MyBatis Plus学习笔记