前情摘要

上回說(shuō)道，小明同學(xué)用@JsonProperty解決了，在接口通訊中的Json反序列化問(wèn)題。

經(jīng)過(guò)研究，小明發(fā)現(xiàn)@JsonProperty在特定場(chǎng)景下，還有更人性化的作用。

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

場(chǎng)景分析一

小明做了一個(gè)web表單，用來(lái)填寫(xiě)并保存數(shù)據(jù)，后臺(tái)寫(xiě)restful接口接收數(shù)據(jù)并保存。

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

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

代碼展示如下：

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

(注：這里為了測(cè)試方便未按照標(biāo)準(zhǔn)的restApi書(shū)寫(xiě)，如需學(xué)習(xí)標(biāo)準(zhǔn)的restful接口風(fēng)格請(qǐng)移步百度。請(qǐng)見(jiàn)諒)

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

Postman測(cè)試如下：

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

Postman測(cè)試結(jié)果如下

（條件：只寫(xiě)real_name,不填寫(xiě)idCard。報(bào)錯(cuò)）

注意接口書(shū)寫(xiě)時(shí)，用@RequestBody接收輸入?yún)?shù)時(shí)，這時(shí)候也需要匹配你預(yù)先定義的@JsonProperty的值。

參考real_name.并且，在參數(shù)前需要加上@Valid，你定義的@NotNull校驗(yàn)才會(huì)生效。

@JsonProperty(value="real_name")

private String name ;

場(chǎng)景分析二

idCard為用戶的敏感信息，在接口返回?cái)?shù)據(jù)中不能展示出來(lái)，以免用戶敏感信息直接暴露在外。

這時(shí)候，小明想到了另外一個(gè)注解，@JsonIgnore，在Student對(duì)象序列化為json數(shù)據(jù)的返回的時(shí)候，忽略該屬性。

代碼及測(cè)試如下：

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

Postman測(cè)試如下

（條件：正常輸入real_name和idCard,觀察返回?cái)?shù)據(jù)，只包含real_name）

場(chǎng)景分析三

在場(chǎng)景二中提到使用@JsonIgnore可以讓接口在返回?cái)?shù)據(jù)的時(shí)候不序列化一些屬性。

但是小明又想了，若場(chǎng)景一和場(chǎng)景二結(jié)合使用，及在用戶輸入表單保存數(shù)據(jù)的時(shí)候，某個(gè)字段不能為空，并且返回?cái)?shù)據(jù)的時(shí)候又不能包含該屬性，是不是可以使用組合注解@JsonIngore和@NotNull呢，

代碼和測(cè)試結(jié)果如下：

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

Postman測(cè)試結(jié)果如下

（條件：idCard及為上述特殊字段，結(jié)果報(bào)錯(cuò)）

經(jīng)過(guò)嘗試，小明想到了如下解決方案，代碼及測(cè)試結(jié)果如下：

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

Postman測(cè)試結(jié)果如下

（條件：用JsonProperty代替JsonIgnore）

成功實(shí)現(xiàn)需求。

場(chǎng)景分析四

由于小明公司秉承盡最大努力少使用第三方的資源的原因，項(xiàng)目中關(guān)于JsonObject相關(guān)的jar都是使用的org.json，并未使用阿里的fastjson，如果項(xiàng)目使用的是fastjson，再使用上述的注解就不起作用了，它有自己的一套注解來(lái)解決上述問(wèn)題，

如：@JSONField，具體可參考com.alibaba.fastjson.annotation包。感興趣的可以查一下。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論