Mybatis-Plus字段策略FieldStrategy详解

最新推荐文章于 2025-04-10 23:03:11 发布
最新推荐文章于 2025-04-10 23:03:11 发布
阅读量2.7w 收藏 93
点赞数 34
分类专栏： Mybatis 文章标签： mybatis java spring boot FieldStrategy
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/w1014074794/article/details/125644080
版权

文章目录

前言

最近都是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条件组装时，是否进行控制判断，将空值作为查询条件

在这里插入图片描述

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());
 }

执行结果：
在这里插入图片描述
为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;
}

再次执行上面的单元测试：
在这里插入图片描述
可以看到，尽管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());
 }

执行结果：
在这里插入图片描述
尽管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字段有值的时候，正常更新。
在这里插入图片描述

指定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字段为空字符串时，不会参与更新操作。
在这里插入图片描述

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 追随全局配置
MyBatis-Plus Generator配置详解
09-07
你可以设置全局变量，比如命名策略（`NamingStrategy`），字段策略（`FieldStrategy`），是否开启驼峰命名（`entityTableFieldNaming`），是否生成Lombok注解等。 9. **包配置**： 除了基础包名外，还需要配置...
Mybatis-Plus通用枚举的使用详解
09-07
在实体类中，我们可以将`sex`字段声明为`SexEnum`类型，这样在插入和查询数据时，Mybatis-Plus会自动处理枚举与数据库之间的转换： ```java private SexEnum sex; // 性别，枚举类型 ``` 在测试代码中，我们可以...
mybatisPlus中的field-strategy（字段更新插入策略）：null值插入和更新问题
weixin_36894490的博客
06-09 1万+
目录mybatisPlus中null值更新和插入问题实际项目解决方法示例field-strategy字段更新插入策略介绍枚举类FieldStrategy源码枚举类字段简介 mybatisPlus中null值更新和插入问题 配置mybatisPlus的项目中，默认进行了不是全量更新的策略：NOT_NULL。 即在利用updateWrapper更新时，会做null判断，如果传参数为null，就不会更新。 在实际项目需求中可能配置更新策略为：NOT_NULL，但是某些场景更新时需要插入这个null值进行更新。如何
mybatisPlus中FieldStrategy策略
weixin_43451397的博客
12-09 1034
FieldStrategy
MyBatis-Plus 的 FieldStrategy 属性
最新发布
wang_666_888的博客
04-10 341
FieldStrategy 是 MyBatis-Plus 灵活性的重要体现，合理使用可以大大简化数据持久层代码，同时可以保证数据操作的精确性和安全性。
MybatisPlus的FieldStrategy
小匠的Blog
04-04 1364
MybatisPlus的FieldStrategy 更新策略 # 2.x配置 mybatis-plus: mapper-locations: - classpath*:mapper/**/*Mapper.xml typeAliasesPackage: com.test.assist.dao.domain global-config: id-type: 0 field-strategy: 2 db-column-underline: true configura
mybatis-plus字段策略注解strategy
海康张师傅的博客
03-13 1万+
最近项目中遇到一个问题，是关于mybatis-plus的字段注解策略，记录一下。 1问题 调用了A组件（基础组件），来更新自身组件的数据，发现自己组件有个字段总是被清空。 2原因分析 调用的A组件的字段，属于基础字段，自己业务组件，对这个基础字段做了扩展，增加了业务字段。但是在自己的组件中的实体注解上，有一个注解使用错误。 mybatis-plus封装的updateById方法，如果...
MybatisPlus 字段更新策略 FieldStrategy使用
kang1011的博客
06-10 6381
qq
Mybatis-Plus BaseMapper的用法详解
09-07
Mybatis-Plus提供了自动填充策略，通过设置`@TableId`的`type`属性，可以指定主键生成策略。`IdType.UUID`意味着在插入数据时，Mybatis-Plus会自动为`id`字段生成一个唯一的UUID值，无需开发者手动处理。 3. **...
详解基于Mybatis-plus多租户实现方案
08-19
【Mybatis-plus多租户实现方案】 在软件开发中，多租户架构是一种常见的设计模式，尤其在SaaS（Software as a Service）应用中。它允许一个系统服务于多个客户（称为租户），同时确保各租户的数据隔离。多租户架构...
mybitis-puls FieldStrategy 字段策略 排障记录
花裤衩
12-13 766
mybitis-puls 更新有null值，更新失败
MybatisPlus
SunnerChen的博客
11-06 1598
MybatisPlus
【Mybatis-Plus】Mybatis-Plus数据库字段更新操作之更新策略
qq_50446805的博客
04-02 1199
我在yml中并没有配置这一参数，所以我的配置是默认的策略是NOT NULL，也就是说如果参数是空字符串则会进行更新保存。而默认更新策略是NOT NULL:非 NULL;也就是通过接口更新数据时数据为NULL值时将不更新进数据库。测试用户信息修改，你会发现空字段会被覆盖。这是因为mp的更新策略导致的。我们需要进行配置修改。
mybatis -plus学习笔记-1
fighting_on_way的博客
05-16 578
mybatis-plus是Mybatis的增强包,只做增强,不做改变,简化CRUD操作其mapper文件默认继承baseMapperMP创建SqlSession实例工程类,(与与Mybatis-spring的工厂bean类似,只是加入了Map特设的Map)...
MyBatis-Plus（实用篇）
热门推荐
从基础到源码解析的学习记录
12-22 1万+
Wrapper：条件构造抽象类，最顶端父类AbstractWrapper：用于查询条件封装，生成sql的where条件QueryWrapper：查询条件封装UpdateWrapper：update条件封装AbstractLambdaWrapper：使用Lambda语法LambdaQueryWrapper：用于Lambda语法使用的查询WrapperLambdaUpdateWrapper：用于Lambda语法更新WrapperUserMapper中定义接口方法。
mysqlplus 字段验证策略fieldStrategy
入门菜鸟程序员的成长
12-27 1155
ignored 不管有没有有设置属性，所有的字段都会设置到insert语句中，如果没设置值，全为null，这种在update 操作中会有风险，把有值的更新为null not_null,也是默认策略，也就是忽略null的字段，不忽略"" not-empty 为null，为空串的忽略，就是如果设置值为null，“”，不会插入数据库 实际业务中，如果非要把有值变为空，可以在对象属性字段上面加上： @TableField(strategy = FieldStrategy.IGNORED) Fi...
一文学会mybatis-plus
qq_42861526的博客
02-27 521
一、配置 依赖安装 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.2</version> </dependency> <dep
CAN长字节DM1报文
07-28
CAN长字节DM1报文是指在CAN总线上传输的长度超过8个字节的DM1报文。根据引用\[1\]，当要传输的数据长度超过8个字节时，首先使用TPCM进行广播，广播内容包含即将传输报文的PGN、总的数据包长度等信息，然后使用TP.DT进行数据传输。相邻两个TP.DT之间的时间间隔是50ms到200ms。根据引用\[2\]，当字节数大于8时，将会使用多帧传输参数组。根据引用\[3\]，DM1报文是Diagnostic Message 1, Active Diagnostic Trouble Codes的缩写，用于点亮故障指示灯、红色停机灯等，并周期性播报控制器中处于激活状态的故障码。DM1报文的格式包括各个字节的定义，如故障指示灯、红色停机灯、琥珀色警告指示灯等。因此，CAN长字节DM1报文是指在CAN总线上传输的长度超过8个字节的DM1报文，用于传输更多的故障码信息。 #### 引用[.reference_title] - *1* [车载通信——J1939 DM1](https://blog.csdn.net/weixin_64064747/article/details/130193432)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] - *2* [J1939广播DM1报文](https://blog.csdn.net/mengdeguodu_/article/details/108173263)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] - *3* [J1939商用车在线诊断DM1报文](https://blog.csdn.net/traveller93/article/details/120735912)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

斗者_2013

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值