jackson學習之七：常用Field注解

歡迎訪問我的GitHub

https://github.com/zq2599/blog_demos

內容：所有原創文章分類匯總及配套源碼，涉及Java、Docker、Kubernetes、DevOPS等；

系列文章匯總

• jackson學習之一：基本信息
• jackson學習之二：jackson-core
• jackson學習之三：常用API操作
• jackson學習之四：WRAP_ROOT_VALUE（root對象）
• jackson學習之五：JsonInclude注解
• jackson學習之六：常用類注解
• jackson學習之七：常用Field注解
• jackson學習之八：常用方法注解
• jackson學習之九：springboot整合(配置文件)
• jackson學習之十(終篇)：springboot整合(配置類)

本篇概覽

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)	[e-mail]: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靠前：

    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注解：

    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注解：

    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，只能按照類型注入：

    static class Test {
        private String field0;
        @JacksonInject(value = "defaultField1")
        private String field1;
        @JacksonInject
        private String field2;

3. 注入時所需的數據來自哪里呢？如下所示，通過代碼配置的，可以指定key對應的注入值，也可以指定類型對應的注入值：

        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類型：

    static class Date2LongSerialize extends JsonSerializer<Date> {

        @Override
        public void serialize(Date value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
            gen.writeNumber(value.getTime());
        }
    }

3. Test類的field0字段是私有的，且沒有get和set方法，但是添加了注釋JsonDeserialize就能被反序列化了，並且使用Date2LongSerialize類對將json中的long型轉成field0所需的Date型：

    static class Test {
        @JsonDeserialize(using = Long2DateDeserialize.class)
        private Date field0;
        @Override
        public String toString() { return "Test{" + "field0='" + field0 + '\'' + '}'; }
    }

4. 執行結果如下：

JsonDeserialize

1. JsonDeserialize用於反序列化場景，被此注解修飾的字段或者set方法會被用於反序列化，並且using屬性指定了執行反序列化操作的類；
2. 執行反序列化操作的類需要繼承自JsonDeserializer，如下所示，Long2DateDeserialize的作用是將Long類型轉成field0字段對應的Date類型：

    static class Long2DateDeserialize extends JsonDeserializer<Date> {

        @Override
        public Date deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {

            if(null!=p && null!=ctxt && p.getLongValue()>0L ) {
                return new Date(p.getLongValue());
            }

            return null;
        }
    }

3. 測試反序列化，結果如下：

JsonRawValue

最后要介紹的是JsonRawValue，使用該注解的字段或者方法，都會被序列化，但是序列化結果是原始值，例如字符串是不帶雙引號的：

• 至此，常用的Filed注解就操作完畢了，希望能帶給您一些參考，助您更精確控制自己的序列化和反序列化操作；

你不孤單，欣宸原創一路相伴

1. Java系列
2. Spring系列
3. Docker系列
4. kubernetes系列
5. 數據庫+中間件系列
6. DevOps系列

歡迎關注公眾號：程序員欣宸

微信搜索「程序員欣宸」，我是欣宸，期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos