Jackson之如何掌握JavaJSON解析器

本篇内容主要讲解“Jackson之如何掌握Java JSON解析器”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“Jackson之如何掌握Java JSON解析器”吧!

成都创新互联专业为企业提供大连网站建设、大连做网站、大连网站设计、大连网站制作等企业网站建设、网页设计与制作、大连企业网站模板建站服务,10多年大连做网站经验,不只是建网站,更提供有价值的思路和整体网络服务。

在当今的编程世界里,JSON 已经成为将信息从客户端传输到服务器端的首选协议,可以好不夸张的说,XML 就是那个被拍死在沙滩上的前浪。

很不幸的是,JDK 没有 JSON 库,不知道为什么不搞一下。Log4j 的时候,为了竞争,还推出了  java.util.logging,虽然最后也没多少人用。

Java 之所以牛逼,很大的功劳在于它的生态非常完备,JDK 没有 JSON  库,第三方类库有啊,还挺不错,比如说本篇的猪脚——Jackson,GitHub 上标星 6.1k,Spring Boot 的默认 JSON 解析器。

怎么证明这一点呢?

当我们通过 starter 新建一个 Spring Boot 的 Web 项目后,就可以在 Maven 的依赖项中看到 Jackson 的身影。

Jackson之如何掌握Java JSON解析器

Jackson 有很多优点:

  • 解析大文件的速度比较快;

  • 运行时占用的内存比较少,性能更佳;

  • API 很灵活,容易进行扩展和定制。

Jackson 的核心模块由三部分组成:

  • jackson-core,核心包,提供基于“流模式”解析的相关 API,包括 JsonPaser 和 JsonGenerator。

  • jackson-annotations,注解包,提供标准的注解功能;

  • jackson-databind ,数据绑定包,提供基于“对象绑定”解析的相关 API ( ObjectMapper ) 和基于“树模型”解析的相关  API (JsonNode)。

01、引入 Jackson 依赖

要想使用 Jackson,需要在 pom.xml 文件中添加 Jackson 的依赖。

     com.fasterxml.jackson.core     jackson-databind     2.10.1 

jackson-databind 依赖于 jackson-core 和 jackson-annotations,所以添加完  jackson-databind 之后,Maven 会自动将 jackson-core 和 jackson-annotations 引入到项目当中。

Jackson之如何掌握Java JSON解析器

Maven 之所以讨人喜欢的一点就在这,能偷偷摸摸地帮我们把该做的做了。

02、使用 ObjectMapper

Jackson 最常用的 API 就是基于”对象绑定” 的 ObjectMapper,它通过 writeValue 的系列方法将 Java 对象序列化为  JSON,并且可以存储成不同的格式。

  • writeValueAsString(Object value) 方法,将对象存储成字符串

  • writeValueAsBytes(Object value) 方法,将对象存储成字节数组

  • writeValue(File resultFile, Object value) 方法,将对象存储成文件

来看一下存储成字符串的代码示例:

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 {         Writer wanger = new Writer("沉默王二", 18);         ObjectMapper mapper = new ObjectMapper();         String jsonString = mapper.writerWithDefaultPrettyPrinter()                 .writeValueAsString(wanger);         System.out.println(jsonString);     } }  class Writer {     private String name;     private int age;      public Writer(String name, int age) {         this.name = name;         this.age = age;     }      public String getName() {         return name;     }      public void setName(String name) {         this.name = name;     }      public int getAge() {         return age;     }      public void setAge(int age) {         this.age = age;     } }

程序输出结果如下所示:

{   "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 valueType) 方法,将字符串反序列化为 Java 对象

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

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

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

import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper;  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;  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;  public class TypeReferenceDemo {     public static void main(String[] args) throws JsonProcessingException {         ObjectMapper mapper = new ObjectMapper();         String json = "[{ \"name\" : \"沉默王三\", \"age\" : 18 }, { \"name\" : \"沉默王二\", \"age\" : 19 }]";         List listAuthor = mapper.readValue(json, new TypeReference>(){});         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.setDateFormat(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,示例如下:

public class CustomSerializer extends StdSerializer {     protected CustomSerializer(Class 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 {     protected CustomDeserializer(Class vc) {         super(vc);     }      public CustomDeserializer() {         this(null);     }      @Override     public Woman deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {         JsonNode node = p.getCodec().readTree(p);         Woman woman = new Woman();         int age = (Integer) ((IntNode) node.get("age")).numberValue();         String name = node.get("name").asText();         woman.setAge(age);         woman.setName(name);         return woman;     } } class Woman{     private int age;     private String name;      public Woman() {     }      // getter/setter      @Override     public String toString() {         return "Woman{" +                 "age=" + age +                 ", name='" + name + '\'' +                 '}';     } }

通过 JsonNode 把 JSON 读取到一个树形结构中,然后通过 JsonNode 的 get 方法将对应字段读取出来,然后生成新的 Java  对象,并返回。

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

ObjectMapper mapper = new ObjectMapper(); SimpleModule module =         new SimpleModule("CustomDeserializer", new Version(1, 0, 0, null, null, null)); module.addDeserializer(Woman.class, new CustomDeserializer()); mapper.registerModule(module); String json = "{ \"name\" : \"三妹\", \"age\" : 18 }"; Woman woman = mapper.readValue(json, Woman.class); System.out.println(woman);

程序输出结果如下所示:

Woman{age=18, name='三妹'}

到此,相信大家对“Jackson之如何掌握Java JSON解析器”有了更深的了解,不妨来实际操作一番吧!这里是创新互联网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!


分享题目:Jackson之如何掌握JavaJSON解析器
文章地址:http://scyanting.com/article/gseocs.html