關于@JsonProperty,@NotNull,@JsonIgnore的具體使用

更新時間：2022年08月30日 09:45:04 作者：peng-peng-

這篇文章主要介紹了關于@JsonProperty,@NotNull,@JsonIgnore的具體使用，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

前情摘要

上回說道，小明同學用@JsonProperty解決了，在接口通訊中的Json反序列化問題。

經過研究，小明發(fā)現@JsonProperty在特定場景下，還有更人性化的作用。

并且在項目中相繼使用了@JsonIgnore和@NotNull兩兄弟。下面繼續(xù)場景分析。

場景分析一

小明做了一個web表單，用來填寫并保存數據，后臺寫restful接口接收數據并保存。

寫完之后讓老大review的時候，自信滿滿的小明，又收到了很多comment。

小明看到了這些comment發(fā)現確實有不足之處，比如表單里的有些數據是必須不為空的，雖然在頁面上加上了強校驗（Js校驗），但是后臺接口是對外開放的restful接口，別人不走頁面直接訪問接口存儲數據，這時候頁面的校驗就顯得很尷尬了，小明又想這好辦啊，直接拿接收到的參數進行非空判斷不就行了么，其實也是可以的，但是小明在研究@JsonProperty的時候發(fā)現@NotNull正好解決這個問題。

代碼展示如下：

Student類

public class Student {
   
   @JsonProperty(value="real_name")
   private String name ;
   
   @NotNull(message="idcard is not null")
   private String idCard;
   
   
   public String getName() {
      return name;
   }
   public void setName(String name) {
      this.name = name;
   }
   public String getIdCard() {
      return idCard;
   }
   public void setIdCard(String idCard) {
      this.idCard = idCard;
   }
   
   
}

StudentController.java

(注：這里為了測試方便未按照標準的restApi書寫，如需學習標準的restful接口風格請移步百度。請見諒)

@RestController
public class StudentController {
 
   @RequestMapping(value="/student",method=RequestMethod.POST)
   public Student save(@RequestBody @Valid Student student) {
      return student;
   }
}

Postman測試如下：

（條件是：正常輸入real_name和idCard,返回結果正常）

Postman測試結果如下

（條件：只寫real_name,不填寫idCard。報錯）

注意接口書寫時，用@RequestBody接收輸入參數時，這時候也需要匹配你預先定義的@JsonProperty的值。

參考real_name.并且，在參數前需要加上@Valid，你定義的@NotNull校驗才會生效。

@JsonProperty(value="real_name")

private String name ;

場景分析二

idCard為用戶的敏感信息，在接口返回數據中不能展示出來，以免用戶敏感信息直接暴露在外。

這時候，小明想到了另外一個注解，@JsonIgnore，在Student對象序列化為json數據的返回的時候，忽略該屬性。

代碼及測試如下：

 @JsonProperty(value="real_name")
   private String name ;
   
   @JsonIgnore
   private String idCard;

Postman測試如下

（條件：正常輸入real_name和idCard,觀察返回數據，只包含real_name）

場景分析三

在場景二中提到使用@JsonIgnore可以讓接口在返回數據的時候不序列化一些屬性。

但是小明又想了，若場景一和場景二結合使用，及在用戶輸入表單保存數據的時候，某個字段不能為空，并且返回數據的時候又不能包含該屬性，是不是可以使用組合注解@JsonIngore和@NotNull呢，

代碼和測試結果如下：

 @JsonProperty(value="real_name")
   private String name ;
   
   @JsonIgnore
   @NotNull(message="idcard is not null")
   private String idCard;

Postman測試結果如下

（條件：idCard及為上述特殊字段，結果報錯）

經過嘗試，小明想到了如下解決方案，代碼及測試結果如下：

   @JsonProperty(value="real_name")
   private String name ;
   
   @JsonProperty(access=Access.WRITE_ONLY)
   @NotNull(message="idcard is not null")
   private String idCard;

Postman測試結果如下

（條件：用JsonProperty代替JsonIgnore）