MybatisPlus字段策略FieldStrategy如何使用

今天小編給大家分享一下MybatisPlus字段策略FieldStrategy如何使用的相關知識點，內容詳細，邏輯清晰，相信大部分人都還太了解這方面的知識，所以分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后有所收獲，下面我們一起來了解一下吧。

字段策略介紹

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

每種策略的作用：

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 追隨全局配置

以上就是“MybatisPlus字段策略FieldStrategy如何使用”這篇文章的所有內容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會為大家更新不同的知識，如果還想學習更多的知識，請關注億速云行業資訊頻道。