jackson學習之七：常用Field註解
阿新 • • 發佈：2021-02-04
### 歡迎訪問我的GitHub
[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)
內容：所有原創文章分類彙總及配套原始碼，涉及Java、Docker、Kubernetes、DevOPS等；
### 系列文章彙總
- [jackson學習之一：基本資訊](https://blog.csdn.net/boling_cavalry/article/details/107135958)
- [jackson學習之二：jackson-core](https://blog.csdn.net/boling_cavalry/article/details/108571629)
- [jackson學習之三：常用API操作](https://blog.csdn.net/boling_cavalry/article/details/108192174)
- [jackson學習之四：WRAP_ROOT_VALUE（root物件）](https://blog.csdn.net/boling_cavalry/article/details/108298858)
- [jackson學習之五：JsonInclude註解](https://blog.csdn.net/boling_cavalry/article/details/108412558)
- [jackson學習之六：常用類註解](https://blog.csdn.net/boling_cavalry/article/details/108333324)
- [jackson學習之七：常用Field註解](https://blog.csdn.net/boling_cavalry/article/details/108589494)
- [jackson學習之八：常用方法註解](https://blog.csdn.net/boling_cavalry/article/details/108433330)
- [jackson學習之九：springboot整合(配置檔案)](https://blog.csdn.net/boling_cavalry/article/details/108460433)
- [jackson學習之十(終篇)：springboot整合(配置類)](https://blog.csdn.net/boling_cavalry/article/details/108559056)
### 本篇概覽
1. 本文是《jackson學習》系列的第七篇，繼續學習jackson強大的註解能力，本篇學習的是常用的Field註解，並通過例項來加深印象，下圖是常用Field註解的簡介：
2. 接下來逐個學習；
### 不止是Filed
- 雖然標題說是常用Field註解，其實上圖中的這些註解也能用在方法上，只不過多數情況下這些註解修飾在field上更好理解一些，例如JsonIgnore，放在field上和get方法上都是可以的；
- 接下來逐個學習；
### 原始碼下載
1. 如果您不想編碼，可以在GitHub下載所有原始碼，地址和連結資訊如下表所示(https://github.com/zq2599/blog_demos)：
| 名稱 | 連結 | 備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| [email protected]:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |
2. 這個git專案中有多個資料夾，本章的應用在jacksondemo資料夾下，如下圖紅框所示：
3. jacksondemo是父子結構的工程，本篇的程式碼在annotation子工程中，裡面的fieldannonation這個package下，如下圖：
### JsonProperty
1. JsonProperty可以作用在成員變數和方法上，作用是在序列化和反序列化操作中指定json欄位的名稱；
2. 先來看序列化操作（JsonPropertySerialization.java），如下所示，JsonProperty修飾了私有成員變數field0和公共方法getField1，並且field0沒有get和set方法，是通過構造方法設定的，另外還要注意JsonProperty註解的index屬性，用來指定序列化結果中的順序，這裡故意將field1的順序設定得比field0靠前：
```java
static class Test {
@JsonProperty(value="json_field0", index = 1)
private String field0;
@JsonProperty(value="json_field1", index = 0)
public String getField1() {
return "111";
}
public Test(String field0) {
this.field0 = field0;
}
}
```
3. 執行結果如下圖紅框所示，可見JsonProperty的value就是序列化後的屬性名，另外帶有JsonProperty註解的成員變數，即使是私有而且沒有get和set方法，也能被成功序列化，而且順序也和index屬性對應：
4. 接下來看反序列化操作（JsonPropertyDeserialization.java），註解相關程式碼如下，field0是私有且沒有get和set方法，另外setField1方法也有JsonProperty註解：
```java
static class Test {
@JsonProperty(value = "json_field0")
private String field0;
private String field1;
@JsonProperty(value = "json_field1")
public void setField1(String field1) {
this.field1 = field1;
}
@Override
public String toString() {
return "Test{" +
"field0='" + field0 + '\'' +
", field1='" + field1 + '\'' +
'}';
}
}
```
5. 用json字串嘗試反序列化，結果如下，可見field0和field1都能被正確賦值：
### JsonIgnore
1. JsonIgnore好理解，作用在成員變數或者方法上，指定被註解的變數或者方法不參與序列化和反序列化操作；
2. 先看序列化操作（JsonIgnoreSerialization.java），如下所示，Test類的field1欄位和getField2方法都有JsonIgnore註解：
```java
static class Test {
private String field0;
@JsonIgnore
private String field1;
private String field2;
public String getField0() { return field0; }
public void setField0(String field0) { this.field0 = field0; }
public String getField1() { return field1; }
public void setField1(String field1) { this.field1 = field1; }
public void setField2(String field2) { this.field2 = field2; }
@JsonIgnore
public String getField2() { return field2; }
}
```
3. 給field0、field1、field2三個欄位都賦值，再看序列化結果，如下圖，可見field0和field2都被忽略了：
4. 再來嘗試JsonIgnore註解在反序列化場景的作用，注意反序列化的時候，JsonIgnore作用的方法應該是set了，如下圖：
5. 另外實測發現，反序列化的時候，JsonIgnore註解在get方法上也可以讓對應欄位被忽略；
### JacksonInject
1. JacksonInject的作用是在反序列化的時候，將配置好的值注入被JacksonInject註解的欄位；
2. 如下所示，Test類的field1和field2都有JacksonInject註解，不同的是field1指定了注入值的key為defaultField1，而field2由於沒有指定key，只能按照型別注入：
```java
static class Test {
private String field0;
@JacksonInject(value = "defaultField1")
private String field1;
@JacksonInject
private String field2;
```
3. 注入時所需的資料來自哪裡呢？如下所示，通過程式碼配置的，可以指定key對應的注入值，也可以指定型別對應的注入值：
```java
InjectableValues.Std injectableValues = new InjectableValues.Std();
// 指定key為"defaultField1"對應的注入引數
injectableValues.addValue("defaultField1","field1 default value");
// 指定String型別對應的注入引數
injectableValues.addValue(String.class,"String type default value");
ObjectMapper mapper = new ObjectMapper(); // 把注入引數的配置設定給mapper
mapper.setInjectableValues(injectableValues);
```
4. 反序列化結果如下圖，可見field1和field2的值都是被注入的：
### JsonSerialize
1. JsonSerialize用於序列化場景，被此註解修飾的欄位或者get方法會被用於序列化，並且using屬性指定了執行序列化操作的類；
2. 執行序列化操作的類，需要繼承自JsonSerializer，如下所示，Date2LongSerialize的作用是將Date型別轉成long型別：
```java
static class Date2LongSerialize extends JsonSe