今天小编给大家分享一下MybatisPlus字段策略FieldStrategy如何使用的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。
Mybatis-Plus字段策略FieldStrategy的作用主要是在进行新增、更新时,根据配置的策略判断是否对实体对象的值进行空值判断,如果策略为字段不能为空,则不会对为空的字段进行赋值或更新。
同样,在进行where条件查询时,根据whereStrategy策略判断是否对字段进行空值判断,如果策略为字段不能为空,则为空的字段不会作为查询条件组装到where条件中。
三个配置,对应三种使用场景
insertStrategy
在insert操作时的字段策略,是否进行空值判断,插入空值
updateStrategy
在update操作时的字段策略,是否进行空值判断,插入空值
whereStrategy
在where条件组装时,是否进行控制判断,将空值作为查询条件
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 | 追随全局配置 |
全局策略配置
在全局配置中,三者的默认值都是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
为例,演示各种策略的作用。
默认策略为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,则不更新对应的字段。
@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
会忽略字段值的空值判断,无论实体对象的字段值是否为空,都会进行更新操作。
@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
不但会忽略字段值的空值判断,而且不管标识的字段是否有值,都不会进行更新操作。
策略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字段为空字符串时,不会参与更新操作。
策略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
追随全局配置
以上就是“MybatisPlus字段策略FieldStrategy如何使用”这篇文章的所有内容,感谢各位的阅读!相信大家阅读完这篇文章都有很大的收获,小编每天都会为大家更新不同的知识,如果还想学习更多的知识,请关注亿速云行业资讯频道。
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。