备案控制台
开发者社区 开发与运维 文章 正文

Mybatis-Plus字段策略FieldStrategy详解

2022-10-21 1349
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Mybatis-Plus字段策略FieldStrategy详解

前言

最近都是Mybatis-Plus系列的小白文，算是对工作中最常使用的框架的细节扫盲。

有在学习Mybatis-Plus使用的，可以关注一波。


今天主要是对Mybatis-Plus字段策略FieldStrategy进行介绍。


一、官方文档

Mybatis-Plus中FieldStrategy说明：https://baomidou.com/pages/223848/#tableid


Tip⚠️：

官网链接，自力更生。


二、字段策略介绍

1、FieldStrategy作用

Mybatis-Plus字段策略FieldStrategy的作用主要是在进行新增、更新时，根据配置的策略判断是否对实体对象的值进行空值判断，如果策略为字段不能为空，则不会对为空的字段进行赋值或更新。

同样，在进行where条件查询时，根据whereStrategy策略判断是否对字段进行空值判断，如果策略为字段不能为空，则为空的字段不会作为查询条件组装到where条件中。


三个配置，对应三种使用场景


insertStrategy 在insert操作时的字段策略，是否进行空值判断，插入空值

updateStrategy 在update操作时的字段策略，是否进行空值判断，插入空值

whereStrategy 在where条件组装时，是否进行控制判断，将空值作为查询条件

22.png


2、FieldStrategy类型

FieldStrategy的源码中，一共有5种策略类型。


public enum FieldStrategy {
    IGNORED,
    NOT_NULL,
    NOT_EMPTY,
    DEFAULT,
    NEVER;
    private FieldStrategy() {
    }
}


每种策略的作用：

值

描述

IGNORED

忽略空值判断，实体对象的字段是什么值就用什么值更新，支持null值更新操作

NOT_NULL

进行非NULL判断，也是默认策略，相当于age!=null

NOT_EMPTY

进行非空判断，主要是针对字符串类型，相当于name != null and name != ‘’

NEVER

从不更新，不管字段是否有值，都不进行更新

DEFAULT

追随全局配置


3、FieldStrategy配置

全局策略配置

在全局配置中，三者的默认值都是FieldStrategy.NOT_NULL，即进行空值判断，不对NULL值数据进行处理。


public DbConfig() {
    this.idType = IdType.ASSIGN_ID;
    this.tableUnderline = true;
    this.capitalMode = false;
    this.logicDeleteValue = "1";
    this.logicNotDeleteValue = "0";
    this.insertStrategy = FieldStrategy.NOT_NULL;
    this.updateStrategy = FieldStrategy.NOT_NULL;
    this.whereStrategy = FieldStrategy.NOT_NULL;
}


在spring boot中可以通过配置属性修改全局字段策略：

mybatis-plus.global-config.db-config.update-strategy=not_null
mybatis-plus.global-config.db-config.insert-strategy=not_null
mybatis-plus.global-config.db-config.where-strategy=not_null


单字段策略配置

在实体对象中，通过@TableField注解可以针对单个字段指定字段策略。


示例：

@TableName(value ="user")
@Data
public class User implements Serializable {
   @TableId
   private Long id;
   private String name;
   private Integer age;
  //配置字段更新策略：不能为空
   @TableField(updateStrategy = FieldStrategy.NOT_EMPTY)
   private String email;
}


@TableField注解的源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface TableField {
    String value() default "";
    boolean exist() default true;
    String condition() default "";
    String update() default "";
    //插入策略
    FieldStrategy insertStrategy() default FieldStrategy.DEFAULT;
    //更新策略
    FieldStrategy updateStrategy() default FieldStrategy.DEFAULT;
    //where条件策略
    FieldStrategy whereStrategy() default FieldStrategy.DEFAULT;
    FieldFill fill() default FieldFill.DEFAULT;
    boolean select() default true;
    boolean keepGlobalFormat() default false;
    String property() default "";
    JdbcType jdbcType() default JdbcType.UNDEFINED;
    Class<? extends TypeHandler> typeHandler() default UnknownTypeHandler.class;
    boolean javaType() default false;
    String numericScale() default "";
}


其中，insertStrategy、updateStrategy和whereStrategy的默认策略都是FieldStrategy.DEFAULT，表示跟随全局配置。


三、实战说明

以更新操作updateById为例，演示各种策略的作用。


1.默认策略 - NOT_NULL

默认策略为FieldStrategy.NOT_NULL，表示需要进行非NULL判断，只有不为NULL的字段才会参与数据处理。

相当于mybatis的xml文件中的if判定条件判断：age!=null


<if test="age != null">
     AND t.age = #{age}
</if>


代码如下（示例）：


@TableName(value ="user")
@Data
public class User implements Serializable {
   @TableId
   private Long id;
   private String name;
   private Integer age;
   //NOT_NULL为默认的全局策略
   //@TableField(updateStrategy = FieldStrategy.NOT_NULL)
   private String email;
}


单元测试：

@Test
 public void testUpdateById() {
     System.out.println("----- updateById method test ------");
     User user = new User();
     user.setId(1543920054188400641L);
     user.setName("test");
     user.setAge(13);
     //email字段为null
     //user.setEmail("");
     userMapper.updateById(user);
     System.out.println(user.toString());
 }


执行结果：

23.png

为null的字段email没有参与更新操作。

updateStrategy的默认策略是FieldStrategy.DEFAULT，表示跟随全局配置。而全局的默认策略是FieldStrategy.NOT_NULL，即进行NULL值判断，如果为NULL，则不更新对应的字段。


2.忽略判断-IGNORED

@TableName(value ="user")
@Data
public class User implements Serializable {
   @TableId
   private Long id;
   private String name;
   private Integer age;
   @TableField(updateStrategy = FieldStrategy.IGNORED)
   private String email;
}


再次执行上面的单元测试：

24.png

可以看到，尽管email字段的值为null，但还是进行了更新操作。

说明策略FieldStrategy.IGNORED会忽略字段值的空值判断，无论实体对象的字段值是否为空，都会进行更新操作。


3.从不处理-NEVER

@TableName(value ="user")
@Data
public class User implements Serializable {
   @TableId
   private Long id;
   private String name;
   private Integer age;
   @TableField(updateStrategy = FieldStrategy.NEVER)
   private String email;
}


指定email字段不为空，进行单元测试：


@Test
 public void testUpdateById() {
     System.out.println("----- updateById method test ------");
     User user = new User();
     user.setId(1543920054188400641L);
     user.setName("test");
     user.setAge(13);
     //email字段不为空
     user.setEmail("101@qq.com");
     userMapper.updateById(user);
     System.out.println(user.toString());
 }


执行结果：

25.png

尽管email字段有值，但还是没有进行了更新操作。

说明策略FieldStrategy.NEVER不但会忽略字段值的空值判断，而且不管标识的字段是否有值，都不会进行更新操作。


4.字符不为空-NOT_EMPTY

策略FieldStrategy.NOT_EMPTY表示需要对字符串进行空值判断，只有非空字符串的字段才会参与数据处理。

相当于mybatis的xml文件中的if判定条件判断：name != null and name != ''

<if test="name != null and name != '' ">
    AND t.name like CONCAT('%',#{name},'%')
 </if>
@TableName(value ="user")
@Data
public class User implements Serializable {
   @TableId
   private Long id;
   private String name;
   private Integer age;
   @TableField(updateStrategy = FieldStrategy.NOT_EMPTY)
   private String email;
}


指定email字段不为空，进行单元测试：

@Test
 public void testUpdateById() {
     System.out.println("----- updateById method test ------");
     User user = new User();
     user.setId(1543920054188400641L);
     user.setName("test");
     user.setAge(13);
     //email字段不为空
     user.setEmail("101@qq.com");
     userMapper.updateById(user);
     System.out.println(user.toString());
 }


执行结果：

email字段有值的时候，正常更新。

26.png


指定email字段为空字符串，进行单元测试：

@Test
 public void testUpdateById() {
     System.out.println("----- updateById method test ------");
     User user = new User();
     user.setId(1543920054188400641L);
     user.setName("test");
     user.setAge(13);
     //email字段为空字符串
     user.setEmail("");
     userMapper.updateById(user);
     System.out.println(user.toString());
 }


执行结果：

email字段为空字符串时，不会参与更新操作。

27.png


5.跟随全局-DEFAULT

策略FieldStrategy.DEFAULT表示追随全局配置的字段策略，这也是字段级别的默认策略。而全局的字段策略，默认是FieldStrategy.NOT_NULL。


这里就不做继续演示。


总结

本文主要是详细介绍了Mybatis-Plus字段策略FieldStrategy的作用和使用方法。

1、字段策略的3个使用场景：


insertStrategy insert操作时的字段策略，是否进行空值判断，插入空值

updateStrategy update操作时的字段策略，是否进行空值判断，插入空值

whereStrategy where条件组装时的字段策略，是否进行控制判断，将空值作为查询条件


2、字段策略的5种类型：


IGNORED 忽略空值判断，实体对象的字段是什么值就用什么值更新，支持null值更新操作

NOT_NULL 进行非NULL判断，相当于age!=null，也是默认的策略

NOT_EMPTY 进行非空判断，主要是针对字符串类型的字段，相当于name != null and name != ''

NEVER 从不更新，不管字段是否有值，都不进行更新

DEFAULT 追随全局配置

文章标签：
Java
测试技术
数据处理
Spring
mybatis
数据格式
XML
数据库连接
关键词：
MyBatis字段
星繁
目录
相关文章
风水道人
|
1月前
|
数据库
mybatisplus返回指定字段的两种方式
mybatisplus返回指定字段的两种方式
风水道人
51 1
夏志121
|
5月前
|
SQL 数据库
MyBatisPlus-null判定及查询指定字段
MyBatisPlus-null判定及查询指定字段
夏志121
268 0
No8g攻城狮
|
7月前
|
前端开发 Java 关系型数据库
【Mybatis-Plus】mybatisplus更新时，实体字段为空，数据库不更新的解决方案
【Mybatis-Plus】mybatisplus更新时，实体字段为空，数据库不更新的解决方案
No8g攻城狮
259 0
小小鱼儿小小林
|
8月前
|
Java 数据库连接 mybatis
mybatis返回map类型数据空值字段不显示(三种解决方法)
mybatis返回map类型数据空值字段不显示(三种解决方法)
小小鱼儿小小林
105 0
流烟默
|
5月前
|
Java 数据库连接 开发者
Mybatis Plus公共字段自动填充(MyMetaObjectHandler)
Mybatis Plus公共字段自动填充(MyMetaObjectHandler)
流烟默
145 0
java开发-郭老师
|
1月前
|
SQL XML Java
【mybatis】第二篇：@Select注解中加入字段判断
【mybatis】第二篇：@Select注解中加入字段判断
java开发-郭老师
29 1
讓丄帝愛伱
|
11天前
|
SQL Java 数据库连接
Mybatis Plus字段为空值时未更新解决方案
Mybatis Plus字段为空值时未更新解决方案
讓丄帝愛伱
23 1
程序三两行
|
1月前
|
XML Java 数据库连接
MyBatis返回Map时值为null的字段会丢失
MyBatis返回Map时值为null的字段会丢失
程序三两行
22 2
风水道人
|
1月前
|
数据库
MybatisPlus属性字段为数据库关键字
MybatisPlus属性字段为数据库关键字
风水道人
21 0
风水道人
|
2月前
|
Java 数据库连接 mybatis
mybatis plus字段为null或空字符串把原来的数据也更新了，只需要注解
mybatis plus字段为null或空字符串把原来的数据也更新了，只需要注解
风水道人
24 0

热门文章

最新文章

  • 1
    答案很详细的MyBatis面试题（含示例代码）
  • 2
    【mybatis】第一篇，Springboot中使用插件PageHelper不生效解决方案
  • 3
    【mybatis-plus】自定义多数据源，动态切换数据源事务失效问题
  • 4
    MyBatis二级缓存解密：深入探究缓存机制与应用场景
  • 5
    【mybatis-plus】Springboot+AOP+自定义注解实现多数据源操作（数据源信息存在数据库）
  • 6
    MyBatis初探：揭示初始化阶段的核心流程与内部机制
  • 7
    MyBatis之旅：从零开始的环境搭建与配置
  • 8
    深入源码：解密MyBatis数据源设计的精妙机制
  • 9
    什么是MyBatis持久层框架？
  • 10
    mybatis和mybatiplus中Error attempting to get column ‘xx‘ from result set
  • 1
    SpringBoot整合Mybatis连接Oracle数据库
    72
  • 2
    Mybatis-Plus学习小项目及详细教程
    37
  • 3
    Mybatis查询的时候BigDecimal类型的值查询失效的解决办法
    72
  • 4
    【SpringBoot系列】SpringBoot集成Fast Mybatis
    177
  • 5
    Mybatis拦截器实现带参数SQL语句打印
    46
  • 6
    Mybatis中Mapper.xml 文件使用注释遇到的坑
    21
  • 7
    MyBatis Plus 解决大数据量查询慢问题
    61
  • 8
    Mybatis-Flex框架初体验
    270
  • 9
    【Mybatis】XML映射文件
    28
  • 10
    【MyBatis】主配置文件
    29

    • 相关课程

    更多
  • MyBatis持久层框架入门

    • 相关电子书

    更多
  • Java Spring Boot开发实战系列课程【第6讲】：Spring Boot 2.0实战MyBatis与优化(Java面试题)
  • 低代码开发师（初级）实战教程
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    部署LAMP环境（Alibaba Cloud Linux 3）