写点什么

Jackson:我是最牛掰的 Java JSON 解析器(有点虚,阿里、腾讯大厂 Java 面试必问知识点系统梳理

作者:MySQL神话
  • 2021 年 11 月 27 日
  • 本文字数:4845 字

    阅读完需:约 16 分钟

{


"name" : "沉默王二",


"age" : 18


}


不是所有的字段都支持序列化和反序列化,需要符合以下规则:


  • 如果字段的修饰符是 public,则该字段可序列化和反序列化(不是标准写法)。

  • 如果字段的修饰符不是 public,但是它的 getter 方法和 setter 方法是 public,则该字段可序列化和反序列化。getter 方法用于序列化,setter 方法用于反序列化。

  • 如果字段只有 public 的 setter 方法,而无 public 的 getter 方 法,则该字段只能用于反序列化。


如果想更改默认的序列化和反序列化规则,需要调用 ObjectMapper 的 setVisibility() 方法。否则将会抛出 InvalidDefinitionException 异常。


ObjectMapper 通过 readValue 的系列方法从不同的数据源将 JSON 反序列化为 Java 对象。


  • readValue(String content, Class<T> valueType) 方法,将字符串反序列化为 Java 对象

  • readValue(byte[] src, Class<T> valueType) 方法,将字节数组反序列化为 Java 对象

  • readValue(File src, Class<T> valueType) 方法,将文件反序列化为 Java 对象


来看一下将字符串反序列化为 Java 对象的代码示例:


import com.fasterxml.jackson.core.JsonProcessingException;


import com.fasterxml.jackson.databind.ObjectMapper;


/**


  • 微信搜索「沉默王二」,回复 Java

  • @author 沉默王二

  • @date 2020/11/26


*/


public class Demo {


public static void main(String[] args) throws JsonProcessingException {


ObjectMapper mapper = new ObjectMapper();


String jsonString = "{\n" +


" "name" : "沉默王二",\n" +


" "age" : 18\n" +


"}";


Writer deserializedWriter = mapper.readValue(jsonString, Writer.class);


System.out.println(deserializedWriter);


}


}


class Writer{


private String name;


private int age;


// getter/setter


@Override


public String toString() {


return "Writer{" +


"name='" + name + ''' +


", age=" + age +


'}';


}


}


程序输出结果如下所示:


Writer{name='沉默王二', age=18}


PS:如果反序列化的对象有带参的构造方法,它必须有一个空的默认构造方法,否则将会抛出 InvalidDefinitionException 一行。


Exception in thread "main" com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Cannot construct instance of com.itwanger.jackson.Writer (no Creators, like default construct, exist): cannot deserialize from Object value (no delegate- or property-based Creator)


at [Source: (String)"{


"name" : "沉默王二",


"age" : 18


}"; line: 2, column: 3]


at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:67)


at com.fasterxml.jackson.databind.DeserializationContext.reportBadDefinition(DeserializationContext.java:1589)


at com.fasterxml.jackson.databind.DeserializationContext.handleMissingInstantiator(DeserializationContext.java:1055)


at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeFromObjectUsingNonDefault(BeanDeserializerBase.java:1297)


at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserializeFromObject(BeanDeserializer.java:326)


at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:159)


at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4202)


at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3205)


at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3173)


at com.itwanger.jackson.Demo.main(Demo.java:19)


Jackson 最常用的 API 就是基于”对象绑定” 的 ObjectMapper,


ObjectMapper 也可以将 JSON 解析为基于“树模型”的 JsonNode 对象,来看下面的示例。


import com.fasterxml.jackson.core.JsonProcessingException;


import com.fasterxml.jackson.databind.JsonNode;


import com.fasterxml.jackson.databind.ObjectMapper;


/**


  • 微信搜索「沉默王二」,回复 Java

  • @author 沉默王二

  • @date 2020/11/26


*/


public class JsonNodeDemo {


public static void main(String[] args) throws JsonProcessingException {


ObjectMapper mapper = new ObjectMapper();


String json = "{ "name" : "沉默王二", "age" : 18 }";


JsonNode jsonNode = mapper.readTree(json);


String name = jsonNode.get("name").asText();


System.out.println(name); // 沉默王二


}


}


借助 TypeReference 可以将 JSON 字符串数组转成泛型 List,来看下面的示例:


import com.fasterxml.jackson.core.JsonProcessingException;


import com.fasterxml.jackson.core.type.TypeReference;


import com.fasterxml.jackson.databind.ObjectMapper;


import java.util.List;


/**


  • 微信搜索「沉默王二」,回复 Java

  • @author 沉默王二

  • @date 2020/11/26


*/


public class TypeReferenceDemo {


public static void main(String[] args) throws JsonProcessingException {


ObjectMapper mapper = new ObjectMapper();


String json = "[{ "name" : "沉默王三", "age" : 18 }, { "name" : "沉默王二", "age" : 19 }]";


List<Author> listAuthor = mapper.readValue(json, new TypeReference<List<Author>>(){});


System.out.println(listAuthor);


}


}


class Author{


private String name;


private int age;


// getter/setter


// toString


}

03、更高级的配置

Jackson 之所以牛掰的一个很重要的因素是可以实现高度灵活的自定义配置。


在实际的应用场景中,JSON 中常常会有一些 Java 对象中没有的字段,这时候,如果直接解析的话,会抛出 UnrecognizedPropertyException 异常。


下面是一串 JSON 字符串:


String jsonString = "{\n" +


" "name" : "沉默王二",\n" +


" "age" : 18\n" +


" "sex" : "男",\n" +


"}";


但 Java 对象 Writer 中没有定义 sex 字段:


class Writer{


private String name;


private int age;


// getter/setter


}


我们来尝试解析一下:


ObjectMapper mapper = new ObjectMapper();


Writer deserializedWriter = mapper.readValue(jsonString, Writer.class);


不出意外,抛出异常了,sex 无法识别。


Exception in thread "main" com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field "sex" (class com.itwanger.jackson.Writer), not marked as ignorable (2 known properties: "name", "age"])


at [Source: (String)"{


"name" : "沉默王二",


"age" : 18,


"sex" : "男"


}"; line: 4, column: 12] (through reference chain: com.itwanger.jackson.Writer["sex"])


怎么办呢?可以通过 configure() 方法忽略掉这些“无法识别”的字段。


mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);


除此之外,还有其他一些有用的配置信息,来了解一下:


// 在序列化时忽略值为 null 的属性


mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);


// 忽略值为默认值的属性


mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_DEFAULT);

04、处理日期格式

对于日期类型的字段,比如说 java.util.Date,如果不指定格式,序列化后将显示为 long 类型的数据,这种默认格式的可读性很差。


{


"age" : 18,


"birthday" : 1606358621209


}


怎么办呢?


第一种方案,在 getter 上使用 @JsonFormat 注解。


private Date birthday;


// GMT+8 是指格林尼治的标准时间,在加上八个小时表示你现在所在时区的时间


@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")


public Date getBirthday() {


return birthday;


}


public void setBirthday(Date birthday) {


this.birthday = birthday;


}


再来看一下结果:


{


"age" : 18,


"birthday" : "2020-11-26 03:02:30"


}


具体代码如下所示:


ObjectMapper mapper = new ObjectMapper();


Writer wanger = new Writer("沉默王二", 18);


wanger.setBirthday(new Date());


String jsonString = mapper.writerWithDefaultPrettyPrinter()


.writeValueAsString(wanger);


System.out.println(jsonString);


第二种方案,调用 ObjectMapper 的 setDateFormat() 方法。


ObjectMapper mapper = new ObjectMapper();


mapper.setDa


《一线大厂 Java 面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》

【docs.qq.com/doc/DSmxTbFJ1cmN1R2dB】 完整内容开源分享


teFormat(StdDateFormat.getDateTimeInstance());


Writer wanger = new Writer("沉默王二", 18);


wanger.setBirthday(new Date());


String jsonString = mapper.writerWithDefaultPrettyPrinter()


.writeValueAsString(wanger);


System.out.println(jsonString);


输出结果如下所示:


{


"name" : "沉默王二",


"age" : 18,


"birthday" : "2020 年 11 月 26 日 上午 11:09:51"


}

05、字段过滤

在将 Java 对象序列化为 JSON 时,可能有些字段需要过滤,不显示在 JSON 中,Jackson 有一种比较简单的实现方式。


@JsonIgnore 用于过滤单个字段。


@JsonIgnore


public String getName() {


return name;


}


@JsonIgnoreProperties 用于过滤多个字段。


@JsonIgnoreProperties(value = { "age","birthday" })


class Writer{


private String name;


private int age;


private Date birthday;


}

06、自定义序列化和反序列化

当 Jackson 默认序列化和反序列化不能满足实际的开发需要时,可以自定义新的序列化和反序列化类。


自定义的序列化类需要继承 StdSerializer,同时重写 serialize() 方法,利用 JsonGenerator 生成 JSON,示例如下:


/**


  • 微信搜索「沉默王二」,回复 Java

  • @author 沉默王二

  • @date 2020/11/26


*/


public class CustomSerializer extends StdSerializer<Man> {


protected CustomSerializer(Class<Man> t) {


super(t);


}


public CustomSerializer() {


this(null);


}


@Override


public void serialize(Man value, JsonGenerator gen, SerializerProvider provider) throws IOException {


gen.writeStartObject();


gen.writeStringField("name", value.getName());


gen.writeEndObject();


}


}


class Man{


private int age;


private String name;


public Man(int age, String name) {


this.age = age;


this.name = name;


}


public int getAge() {


return age;


}


public void setAge(int age) {


this.age = age;


}


public String getName() {


return name;


}


public void setName(String name) {


this.name = name;


}


}


定义好自定义序列化类后,要想在程序中调用它们,需要将其注册到 ObjectMapper 的 Module 中,示例如下所示:


ObjectMapper mapper = new ObjectMapper();


SimpleModule module =


new SimpleModule("CustomSerializer", new Version(1, 0, 0, null, null, null));


module.addSerializer(Man.class, new CustomSerializer());


mapper.registerModule(module);


Man man = new Man( 18,"沉默王二");


String json = mapper.writeValueAsString(man);


System.out.println(json);


程序输出结果如下所示:


{"name":"沉默王二"}


自定义序列化类 CustomSerializer 中没有添加 age 字段,所以只输出了 name 字段。


再来看一下自定义的反序列化类,继承 StdDeserializer,同时重写 deserialize() 方法,利用 JsonGenerator 读取 JSON,示例如下:


public class CustomDeserializer extends StdDeserializer<Woman> {


protected CustomDeserializer(Class<?> vc) {


super(vc);


}


public CustomDeserializer() {


this(null);

最后

经过日积月累, 以下是小编归纳整理的深入了解 Java 虚拟机文档,希望可以帮助大家过关斩将顺利通过面试。由于整个文档比较全面,内容比较多,篇幅不允许,下面以截图方式展示 。









由于篇幅限制,文档的详解资料太全面,细节内容太多,所以只把部分知识点截图出来粗略的介绍,每个小节点里面都有更细化的内容!


本文已被CODING开源项目:【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

用户头像

MySQL神话

关注

还未添加个人签名 2021.11.12 加入

还未添加个人简介

评论

发布
暂无评论
Jackson:我是最牛掰的 Java JSON 解析器(有点虚,阿里、腾讯大厂Java面试必问知识点系统梳理