MyBatisPlus常用注解

MyBatisPlus常用注解

@TableName

映射数据库的表名

package com.southwind.mybatisplus.entity;
import
com.baomidou.mybatisplus.annotation.TableNa
me;
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),

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.FieldFi
ll;
import
com.baomidou.mybatisplus.annotation.TableFi
eld;
import
com.baomidou.mybatisplus.annotation.TableId
;
import
com.baomidou.mybatisplus.annotation.TableNa
me;
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、创建自动填充处理器

package com.southwind.mybatisplus.handler;
import
com.baomidou.mybatisplus.core.handlers.Meta
ObjectHandler;
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 = 2
线程 1:update … set version = 2 where version = 1
线程2 ：update … set version = 2 where version = 1
1、数据库表添加 version 字段，默认值为 1
2、实体类添加 version 成员变量，并且添加 @Version

package com.southwind.mybatisplus.entity;
import
com.baomidou.mybatisplus.annotation.*;
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;
 @Version
 private Integer version; }

3、注册配置类

package com.southwind.mybatisplus.config;
import
com.baomidou.mybatisplus.extension.plugins.
OptimisticLockerInterceptor;
import
org.springframework.context.annotation.Bean
;
import
org.springframework.context.annotation.Conf
iguration;
@Configuration
public class MyBatisPlusConfig {
 
 @Bean
 public OptimisticLockerInterceptor
optimisticLockerInterceptor(){
 return new
OptimisticLockerInterceptor();
 }
 
}

@EnumValue

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

package com.southwind.mybatisplus.enums;
import
com.baomidou.mybatisplus.annotation.EnumVal
ue;
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; }

package com.southwind.mybatisplus.entity;
import
com.baomidou.mybatisplus.annotation.*;
import
com.southwind.mybatisplus.enums.StatusEnum;
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;
 @Version
 private Integer version;
 private StatusEnum status; }

application.yml

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

2、实现接口

package com.southwind.mybatisplus.enums;
import
com.baomidou.mybatisplus.core.enums.IEnum;
public enum AgeEnum implements
IEnum<Integer> {
 ONE(1,"⼀岁"),
 TWO(2,"两岁"),
 THREE(3,"三岁");
 private Integer code;
 private String msg;
 AgeEnum(Integer code, String msg) {
 this.code = code;
 this.msg = msg;
 }
 @Override
 public Integer getValue() {
 return this.code;
 }
}

@TableLogic

映射逻辑删除
1、数据表添加 deleted 字段
2、实体类添加注解

package com.southwind.mybatisplus.entity;
import
com.baomidou.mybatisplus.annotation.*;
import
com.southwind.mybatisplus.enums.AgeEnum;
import
com.southwind.mybatisplus.enums.StatusEnum;
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 AgeEnum age;
 @TableField(exist = false)
 private String gender;
 @TableField(fill = FieldFill.INSERT)
 private Date createTime;
 @TableField(fill =
FieldFill.INSERT_UPDATE)
 private Date updateTime;
 @Version
 private Integer version;
 @TableField(value = "status")
 private StatusEnum statusEnum;
 @TableLogic
 private Integer deleted; }

3、application.yml 添加配置

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