其他分享
首页 > 其他分享> > jackson学习之八:常用方法注解

jackson学习之八:常用方法注解

作者:互联网

欢迎访问我的GitHub

https://github.com/zq2599/blog_demos

内容:所有原创文章分类汇总及配套源码,涉及Java、Docker、Kubernetes、DevOPS等;

系列文章汇总

本篇概览

在这里插入图片描述

源码下载

  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) git@github.com:zq2599/blog_demos.git 该项目源码的仓库地址,ssh协议
  1. 这个git项目中有多个文件夹,本章的应用在jacksondemo文件夹下,如下图红框所示:

在这里插入图片描述

  1. jacksondemo是父子结构的工程,本篇的代码在annotation子工程中,里面的methodannotation这个package下,如下图:

在这里插入图片描述

JsonValue

  1. 在序列化时起作用,可以用来注解get方法或者成员变量;
  2. 一个类中,JsonValue只允许出现一次;
  3. 如果注解的是get方法,那么该方法的返回值就是整个实例的序列化结果;
  4. 如果注解的是成员变量,那么该成员变量的值就是整个实例的序列化结果;
  5. 下面是用来测试的Pojo类,JsonValue注解放在getField0方法上,此方法的返回值已经写死了"abc":
    static class Test {

        private String field0;

        private String field1;

        @JsonValue
        public String getField0() { return "abc"; }

        public void setField0(String field0) { this.field0 = field0; }
        public String getField1() { return field1; }
        public void setField1(String field1) { this.field1 = field1; }
    }
  1. Test类的序列化结果如下,即getField0方法的返回值:

在这里插入图片描述

JsonCreator

  1. 在反序列化时,当出现有参构造方法时(可能是多个有参构造方法),需要通过JsonCreator注解指定反序列化时用哪个构造方法,并且在入参处还要通过JsonProperty指定字段关系:
    static class Test {

        private String field0;
        private String field1;


        public Test(String field0) {
            this.field0 = field0;
        }

        // 通过JsonCreator指定反序列化的时候使用这个构造方法
        // 通过JsonProperty指定字段关系
        @JsonCreator
        public Test(@JsonProperty("field0") String field0,
                    @JsonProperty("field1") String field1) {
            this.field0 = field0;
            this.field1 = field1;
        }

        @Override
        public String toString() {
            return "Test{" +
                    "field0='" + field0 + '\'' +
                    ", field1='" + field1 + '\'' +
                    '}';
        }
    }
  1. 反序列化结果如下:

在这里插入图片描述

JsonSetter

  1. JsonSetter注解在set方法上,被用来在反序列化时指定set方法对应json的哪个属性;
  2. JsonSetter源码中,推荐使用JsonProperty来取代JsonSetter:

在这里插入图片描述
3. 测试代码和结果如下,可见反序列化时,是按照JsonSetter的value去json中查找属性的:

在这里插入图片描述

JsonGetter

  1. JsonGetter只能作为方法注解;
  2. 在序列化时,被JsonGetter注解的get方法,对应的json字段名是JsonGetter的value;
  3. JsonGetter源码中,推荐使用JsonProperty来取代JsonGetter:

在这里插入图片描述
4. 测试代码和结果如下,可见序列化时JsonGetter的value会被作为json字段名:

在这里插入图片描述

JsonAnyGetter

  1. JsonAnyGetter的作用有些特别:在序列化时,用Map对象的键值对转成json的字段和值;
  2. 理解JsonAnyGetter最好的办法,是对比使用前后序列化结果的变化,先来看以下这段代码,是没有JsonAnyGetter注解的,Test有两个成员变量,其中map字段是HashMap类型的:
package com.bolingcavalry.jacksondemo.annotation.methodannotation;

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

import java.util.HashMap;
import java.util.Map;

public class JsonAnySetterSerialization {

    static class Test {
        private String field0;
        private Map<String, Object> map;

        public String getField0() { return field0; }
        public void setField0(String field0) { this.field0 = field0; }
        public void setMap(Map<String, Object> map) { this.map = map; }
        public Map<String, Object> getMap() { return map; }
    }

    public static void main(String[] args) throws Exception {
        ObjectMapper mapper = new ObjectMapper();
        // 美化输出
        mapper.enable(SerializationFeature.INDENT_OUTPUT);

        // 新增一个HashMap,里面放入两个元素
        Map<String, Object> map = new HashMap<>();
        map.put("aaa", "value_aaa");
        map.put("bbb", "value_bbb");

        Test test = new Test();
        test.setField0("000");

        // map赋值给test.map
        test.setMap(map);

        System.out.println(mapper.writeValueAsString(test));
    }
}
  1. 上述代码的执行结果如下,其实很好理解,就是field0和map两个字段而已:
{
  "field0" : "000",
  "map" : {
    "aaa" : "value_aaa",
    "bbb" : "value_bbb"
  }
}
  1. 接下来,对上述代码做一处改动,如下图红框所示,给getMap方法增加JsonAnyGetter注解:

在这里插入图片描述
5. 修改后的执行结果如下,原来的map字段没有了,map内部的所有键值对都成了json的字段:

{
  "field0" : "000",
  "aaa" : "value_aaa",
  "bbb" : "value_bbb"
}
  1. 至此,可以品味出JsonAnyGetter的作用了:序列化时,将Map中的键值对全部作为JSON的字段输出

JsonAnySetter

  1. 弄懂了前面的JsonAnyGetter,对于JsonAnySetter的作用想必您也能大致猜到:反序列化时,对json中不认识的字段,统统调用JsonAnySetter注解修饰的方法去处理;
  2. 测试的代码如下,Test类的setValue方法被JsonAnySetter注解,在反序列化时,json中的aaabbb字段,都会交给setValue方法处理,也就是放入map中:
package com.bolingcavalry.jacksondemo.annotation.methodannotation;

import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.util.HashMap;
import java.util.Map;

public class JsonAnySetterDeserialization {

    static class Test {

        private String field0;
        
        private Map<String, Object> map = new HashMap<>();

        @JsonAnySetter
        public void setValue(String key, Object value) {
            map.put(key, value);
        }

        @Override
        public String toString() {
            return "Test{" +
                    "field0='" + field0 + '\'' +
                    ", map=" + map +
                    '}';
        }
    }

    public static void main(String[] args) throws Exception {
        String jsonStr = "{\n" +
                "  \"field0\" : \"000\",\n" +
                "  \"aaa\" : \"value_aaa\",\n" +
                "  \"bbb\" : \"value_bbb\"\n" +
                "}";

        System.out.println(new ObjectMapper().readValue(jsonStr, Test.class));
    }
}
  1. 执行结果如下,可见aaa、bbb都被放入了map中:
Test{field0='null', map={aaa=value_aaa, field0=000, bbb=value_bbb}}
  1. 另外JsonAnySetter还可以作用在成员变量上,上面的代码中,去掉setValue方法,在成员变量map上增加JsonAnySetter注解,修改后如下,执行结果也是一模一样的:
    static class Test {

        private String field0;

        @JsonAnySetter
        private Map<String, Object> map = new HashMap<>();

        @Override
        public String toString() {
            return "Test{" +
                    "field0='" + field0 + '\'' +
                    ", map=" + map +
                    '}';
        }
    }
  1. 注意,JsonAnySetter作用在成员变量上时,该成员变量必须是java.util.Map的实现类

你不孤单,欣宸原创一路相伴

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 数据库+中间件系列
  6. DevOps系列

欢迎关注公众号:程序员欣宸

微信搜索「程序员欣宸」,我是欣宸,期待与您一同畅游Java世界...
https://github.com/zq2599/blog_demos

标签:map,jackson,String,之八,field0,注解,序列化
来源: https://www.cnblogs.com/bolingcavalry/p/14375821.html