Jackson全面解析--注解全讲解七(@JsonGetter @JsonSetter)

这一对注解用于序列化和反序列化,我们先看

@JsonGetter

先看个简单的例子,如下

 @AllArgsConstructor(staticName = "of")
    @NoArgsConstructor
    class  Pojo{

        @Getter
        @Setter //后面源码分析的时候要把这个地方看下,什么样的方法会被序列化
        private String att1;

        public String getTheAtt2(){

            return "anyNull";
        }

    }
运行测试代码
  @Test
    public void JsonGetterTest() throws Exception{

        CombineJacksonAnnotation.Pojo pojo = CombineJacksonAnnotation.Pojo.of("att1");
        System.out.println(om.writeValueAsString(pojo));

    }
结果如下
{
  "att1" : "att1",
  "theAtt2" : "anyNull"
}

可以看到
getTheAtt2()方法也被序列化了,按照驼峰命名规则去掉get剩下的就是默认的序列化之后的生成的属性名,而@JsonGetter的作用就是给这个被序列化的方法命名一个逻辑的属性名,如下,我们修改下代码

@AllArgsConstructor(staticName = "of")
    @NoArgsConstructor
    class  Pojo{

        @Getter
        @Setter //后面源码分析的时候要把这个地方看下,什么样的方法会被序列化
        private String att1;
        
        @JsonGetter("att2")
        public String getTheAtt2(){

            return "anyNull";
        }

    }
再运行测试代码,返回如下
{
  "att1" : "att1",
  "att2" : "anyNull"
}

可以看到getTheAtt2()序列化后的属性名变成了att2,这就是@JsonGetter的作用。
我们可以继续的看下@JsonGetter的详细作用。

/**
 * Marker annotation that can be used to define a non-static,
 * no-argument value-returning (non-void) method to be used as a "getter"
 * for a logical property.
 * It can be used as an alternative to more general
 * {@link JsonProperty} annotation (which is the recommended choice in
 * general case).
 *<p>
 * Getter means that when serializing Object instance of class that has
 * this method (possibly inherited from a super class), a call is made
 * through the method, and return value will be serialized as value of
 * the property.
 */
注释写的很清楚,用于一个无参的非静态的有一个返回值的方法,但是这个注解可以用@JsonProperty同样来实现,我们点到源码里面看下

JacksonAnnotationIntrospector.class
 @Override
    public PropertyName findNameForSerialization(Annotated a)
    {
        boolean useDefault = false;
        JsonGetter jg = _findAnnotation(a, JsonGetter.class);
        if (jg != null) {
            String s = jg.value();
            // 04-May-2018, tatu: Should allow for "nameless" `@JsonGetter` too
            if (!s.isEmpty()) {
                return PropertyName.construct(s);
            }
            useDefault = true;
        }
        JsonProperty pann = _findAnnotation(a, JsonProperty.class);
        if (pann != null) {
            return PropertyName.construct(pann.value());
        }
        if (useDefault || _hasOneOf(a, ANNOTATIONS_TO_INFER_SER)) {
            return PropertyName.USE_DEFAULT;
        }
        return null;
    }

可以看到@JsonGetter比@JsonProperty的优先级高,我们试验下,改下代码,如下

 @AllArgsConstructor(staticName = "of")
    @NoArgsConstructor
    class  Pojo{

        @Getter
        @Setter //后面源码分析的时候要把这个地方看下,什么样的方法会被序列化
        private String att1;

        @JsonGetter("att2")
        @JsonProperty("att3")
        public String getTheAtt2(){

            return "anyNull";
        }

    }
返回结果没变
{
  "att1" : "att1",
  "att2" : "anyNull"
}

再次修改代码,如下
 @AllArgsConstructor(staticName = "of")
    @NoArgsConstructor
    class  Pojo{

        @Getter
        @Setter //后面源码分析的时候要把这个地方看下,什么样的方法会被序列化
        private String att1;

        @JsonProperty("att3")
        public String getTheAtt2(){

            return "anyNull";
        }

    }
返回结果变了
{
  "att1" : "att1",
  "att3" : "anyNull"
}

那如果我们修改成如下,如果方法序列化后的属性名与已存在的属性名重复会怎么样呢

 @AllArgsConstructor(staticName = "of")
    @NoArgsConstructor
    class  Pojo{

        @Getter
        @Setter //后面源码分析的时候要把这个地方看下,什么样的方法会被序列化
        private String att1;

        @JsonGetter("att1")
        public String getTheAtt2(){

            return "anyNull";
        }

    }
返回如下
{
  "att1" : "anyNull"
}

上面的这点很重要,如果用的不好,可能发现序列化的结果不满足要求了。

@JsonSetter

既然@JsonGetter用于序列化,那么@JsonSetter就是用于反序列化了,
指定的method会去修改指定的属性。使用方法如下

 @AllArgsConstructor(staticName = "of")
    @NoArgsConstructor
    class  Pojo{

        @Getter
        @Setter //后面源码分析的时候要把这个地方看下,什么样的方法会被序列化
        private String att1;



        @JsonSetter(value = "att2")
        public void setTheXxx(String xxx){

            this.att1 = xxx;

        }

    }

上面的意思是说,解析出来的att2,然后将其值赋值给了att1,


image.png

所以反序列化出来就是上面的结果。

可以认为Jackson是按照标准的setter和getter来反序列化和序列化对象的,如果不是标准的方法,可以使用@JsonGetter @JsonSetter来转义。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容