jackson 学习之七：常用 Field 注解

作者：程序员欣宸

2022 年 4 月 12 日
本文字数：3140 字
阅读完需：约 10 分钟

欢迎访问我的 GitHub

这里分类和汇总了欣宸的全部原创(含配套源码)：https://github.com/zq2599/blog_demos

本篇概览

本文是《jackson 学习》系列的第七篇，继续学习 jackson 强大的注解能力，本篇学习的是常用的 Field 注解，并通过实例来加深印象，下图是常用 Field 注解的简介：

不止是 Filed

虽然标题说是常用 Field 注解，其实上图中的这些注解也能用在方法上，只不过多数情况下这些注解修饰在 field 上更好理解一些，例如 JsonIgnore，放在 field 上和 get 方法上都是可以的；
接下来逐个学习；

源码下载

如果您不想编码，可以在 GitHub 下载所有源码，地址和链接信息如下表所示(https://github.com/zq2599/blog_demos)：

这个 git 项目中有多个文件夹，本章的应用在 jacksondemo 文件夹下，如下图红框所示：
jacksondemo 是父子结构的工程，本篇的代码在 annotation 子工程中，里面的 fieldannonation 这个 package 下，如下图：

JsonProperty

JsonProperty 可以作用在成员变量和方法上，作用是在序列化和反序列化操作中指定 json 字段的名称；
先来看序列化操作（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;        }    }

复制代码

执行结果如下图红框所示，可见 JsonProperty 的 value 就是序列化后的属性名，另外带有 JsonProperty 注解的成员变量，即使是私有而且没有 get 和 set 方法，也能被成功序列化，而且顺序也和 index 属性对应：

接下来看反序列化操作（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 + '\'' +                    '}';        }    }

复制代码

用 json 字符串尝试反序列化，结果如下，可见 field0 和 field1 都能被正确赋值：

JsonIgnore

JsonIgnore 好理解，作用在成员变量或者方法上，指定被注解的变量或者方法不参与序列化和反序列化操作；
先看序列化操作（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; }    }

复制代码

给 field0、field1、field2 三个字段都赋值，再看序列化结果，如下图，可见 field0 和 field2 都被忽略了：
再来尝试 JsonIgnore 注解在反序列化场景的作用，注意反序列化的时候，JsonIgnore 作用的方法应该是 set 了，如下图：

另外实测发现，反序列化的时候，JsonIgnore 注解在 get 方法上也可以让对应字段被忽略；

JacksonInject

JacksonInject 的作用是在反序列化的时候，将配置好的值注入被 JacksonInject 注解的字段；
如下所示，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;

复制代码

注入时所需的数据来自哪里呢？如下所示，通过代码配置的，可以指定 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);

复制代码

反序列化结果如下图，可见 field1 和 field2 的值都是被注入的：

JsonSerialize

JsonSerialize 用于序列化场景，被此注解修饰的字段或者 get 方法会被用于序列化，并且 using 属性指定了执行序列化操作的类；
执行序列化操作的类，需要继承自 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());        }    }

复制代码

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 + '\'' + '}'; }    }

复制代码

执行结果如下：

JsonDeserialize

JsonDeserialize 用于反序列化场景，被此注解修饰的字段或者 set 方法会被用于反序列化，并且 using 属性指定了执行反序列化操作的类；
执行反序列化操作的类需要继承自 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;        }    }