日本综合一区二区|亚洲中文天堂综合|日韩欧美自拍一区|男女精品天堂一区|欧美自拍第6页亚洲成人精品一区|亚洲黄色天堂一区二区成人|超碰91偷拍第一页|日韩av夜夜嗨中文字幕|久久蜜综合视频官网|精美人妻一区二区三区

RELATEED CONSULTING
相關(guān)咨詢
選擇下列產(chǎn)品馬上在線溝通
服務(wù)時(shí)間:8:30-17:00
你可能遇到了下面的問題
關(guān)閉右側(cè)工具欄

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
Jackson之JavaJSON解析器

在當(dāng)今的編程世界里,JSON 已經(jīng)成為將信息從客戶端傳輸?shù)椒?wù)器端的選擇協(xié)議,可以好不夸張的說,XML 就是那個(gè)被拍死在沙灘上的前浪。

很不幸的是,JDK 沒有 JSON 庫,不知道為什么不搞一下。Log4j 的時(shí)候,為了競(jìng)爭(zhēng),還推出了 java.util.logging,雖然最后也沒多少人用。

Java 之所以牛逼,很大的功勞在于它的生態(tài)非常完備,JDK 沒有 JSON 庫,第三方類庫有啊,還挺不錯(cuò),比如說本篇的豬腳——Jackson,GitHub 上標(biāo)星 6.1k,Spring Boot 的默認(rèn) JSON 解析器。

怎么證明這一點(diǎn)呢?

當(dāng)我們通過 starter 新建一個(gè) Spring Boot 的 Web 項(xiàng)目后,就可以在 Maven 的依賴項(xiàng)中看到 Jackson 的身影。

Jackson 有很多優(yōu)點(diǎn):

  • 解析大文件的速度比較快;
  • 運(yùn)行時(shí)占用的內(nèi)存比較少,性能更佳;
  • API 很靈活,容易進(jìn)行擴(kuò)展和定制。

Jackson 的核心模塊由三部分組成:

  • jackson-core,核心包,提供基于“流模式”解析的相關(guān) API,包括 JsonPaser 和 JsonGenerator。
  • jackson-annotations,注解包,提供標(biāo)準(zhǔn)的注解功能;
  • jackson-databind ,數(shù)據(jù)綁定包,提供基于“對(duì)象綁定”解析的相關(guān) API ( ObjectMapper ) 和基于“樹模型”解析的相關(guān) API (JsonNode)。

01、引入 Jackson 依賴

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

 
 
 
 
  1.     com.fasterxml.jackson.core
  2.     jackson-databind
  3.     2.10.1

jackson-databind 依賴于 jackson-core 和 jackson-annotations,所以添加完 jackson-databind 之后,Maven 會(huì)自動(dòng)將 jackson-core 和 jackson-annotations 引入到項(xiàng)目當(dāng)中。

Maven 之所以討人喜歡的一點(diǎn)就在這,能偷偷摸摸地幫我們把該做的做了。

02、使用 ObjectMapper

Jackson 最常用的 API 就是基于”對(duì)象綁定” 的 ObjectMapper,它通過 writeValue 的系列方法將 Java 對(duì)象序列化為 JSON,并且可以存儲(chǔ)成不同的格式。

  • writeValueAsString(Object value) 方法,將對(duì)象存儲(chǔ)成字符串
  • writeValueAsBytes(Object value) 方法,將對(duì)象存儲(chǔ)成字節(jié)數(shù)組
  • writeValue(File resultFile, Object value) 方法,將對(duì)象存儲(chǔ)成文件

來看一下存儲(chǔ)成字符串的代碼示例:

 
 
 
 
  1. import com.fasterxml.jackson.core.JsonProcessingException;
  2. import com.fasterxml.jackson.databind.ObjectMapper;
  3. /**
  4.  * 微信搜索「沉默王二」,回復(fù) Java
  5.  *
  6.  * @author 沉默王二
  7.  * @date 2020/11/26
  8.  */
  9. public class Demo {
  10.     public static void main(String[] args) throws JsonProcessingException {
  11.         Writer wanger = new Writer("沉默王二", 18);
  12.         ObjectMapper mapper = new ObjectMapper();
  13.         String jsonString = mapper.writerWithDefaultPrettyPrinter()
  14.                 .writeValueAsString(wanger);
  15.         System.out.println(jsonString);
  16.     }
  17. }
  18. class Writer {
  19.     private String name;
  20.     private int age;
  21.     public Writer(String name, int age) {
  22.         this.name = name;
  23.         this.age = age;
  24.     }
  25.     public String getName() {
  26.         return name;
  27.     }
  28.     public void setName(String name) {
  29.         this.name = name;
  30.     }
  31.     public int getAge() {
  32.         return age;
  33.     }
  34.     public void setAge(int age) {
  35.         this.age = age;
  36.     }
  37. }

程序輸出結(jié)果如下所示:

 
 
 
 
  1. {
  2.   "name" : "沉默王二",
  3.   "age" : 18
  4. }

不是所有的字段都支持序列化和反序列化,需要符合以下規(guī)則:

  • 如果字段的修飾符是 public,則該字段可序列化和反序列化(不是標(biāo)準(zhǔn)寫法)。
  • 如果字段的修飾符不是 public,但是它的 getter 方法和 setter 方法是 public,則該字段可序列化和反序列化。getter 方法用于序列化,setter 方法用于反序列化。
  • 如果字段只有 public 的 setter 方法,而無 public 的 getter 方 法,則該字段只能用于反序列化。

如果想更改默認(rèn)的序列化和反序列化規(guī)則,需要調(diào)用 ObjectMapper 的setVisibility() 方法。否則將會(huì)拋出 InvalidDefinitionException 異常。

ObjectMapper 通過 readValue 的系列方法從不同的數(shù)據(jù)源將 JSON 反序列化為 Java 對(duì)象。

  • readValue(String content, Class valueType) 方法,將字符串反序列化為 Java 對(duì)象
  • readValue(byte[] src, Class valueType) 方法,將字節(jié)數(shù)組反序列化為 Java 對(duì)象
  • readValue(File src, Class valueType) 方法,將文件反序列化為 Java 對(duì)象

來看一下將字符串反序列化為 Java 對(duì)象的代碼示例:

 
 
 
 
  1. import com.fasterxml.jackson.core.JsonProcessingException;
  2. import com.fasterxml.jackson.databind.ObjectMapper;
  3. public class Demo {
  4.     public static void main(String[] args) throws JsonProcessingException {
  5.         ObjectMapper mapper = new ObjectMapper();
  6.         String jsonString = "{\n" +
  7.                 "  \"name\" : \"沉默王二\",\n" +
  8.                 "  \"age\" : 18\n" +
  9.                 "}";
  10.         Writer deserializedWriter = mapper.readValue(jsonString, Writer.class);
  11.         System.out.println(deserializedWriter);
  12.     }
  13. }
  14. class Writer{
  15.     private String name;
  16.     private int age;
  17.     // getter/setter
  18.     @Override
  19.     public String toString() {
  20.         return "Writer{" +
  21.                 "name='" + name + '\'' +
  22.                 ", age=" + age +
  23.                 '}';
  24.     }
  25. }

程序輸出結(jié)果如下所示:

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

PS:如果反序列化的對(duì)象有帶參的構(gòu)造方法,它必須有一個(gè)空的默認(rèn)構(gòu)造方法,否則將會(huì)拋出 InvalidDefinitionException 一行。

 
 
 
 
  1. 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)
  2.  at [Source: (String)"{
  3.   "name" : "沉默王二",
  4.   "age" : 18
  5. }"; line: 2, column: 3]
  6.  at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:67)
  7.  at com.fasterxml.jackson.databind.DeserializationContext.reportBadDefinition(DeserializationContext.java:1589)
  8.  at com.fasterxml.jackson.databind.DeserializationContext.handleMissingInstantiator(DeserializationContext.java:1055)
  9.  at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeFromObjectUsingNonDefault(BeanDeserializerBase.java:1297)
  10.  at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserializeFromObject(BeanDeserializer.java:326)
  11.  at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:159)
  12.  at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4202)
  13.  at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3205)
  14.  at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3173)
  15.  at com.itwanger.jackson.Demo.main(Demo.java:19)

Jackson 最常用的 API 就是基于”對(duì)象綁定” 的 ObjectMapper,

ObjectMapper 也可以將 JSON 解析為基于“樹模型”的 JsonNode 對(duì)象,來看下面的示例。

 
 
 
 
  1. import com.fasterxml.jackson.core.JsonProcessingException;
  2. import com.fasterxml.jackson.databind.JsonNode;
  3. import com.fasterxml.jackson.databind.ObjectMapper;
  4. public class JsonNodeDemo {
  5.     public static void main(String[] args) throws JsonProcessingException {
  6.         ObjectMapper mapper = new ObjectMapper();
  7.         String json = "{ \"name\" : \"沉默王二\", \"age\" : 18 }";
  8.         JsonNode jsonNode = mapper.readTree(json);
  9.         String name = jsonNode.get("name").asText();
  10.         System.out.println(name); // 沉默王二
  11.     }
  12. }

借助 TypeReference 可以將 JSON 字符串?dāng)?shù)組轉(zhuǎn)成泛型 List,來看下面的示例:

 
 
 
 
  1. import com.fasterxml.jackson.core.JsonProcessingException;
  2. import com.fasterxml.jackson.core.type.TypeReference;
  3. import com.fasterxml.jackson.databind.ObjectMapper;
  4. import java.util.List;
  5. public class TypeReferenceDemo {
  6.     public static void main(String[] args) throws JsonProcessingException {
  7.         ObjectMapper mapper = new ObjectMapper();
  8.         String json = "[{ \"name\" : \"沉默王三\", \"age\" : 18 }, { \"name\" : \"沉默王二\", \"age\" : 19 }]";
  9.         List listAuthor = mapper.readValue(json, new TypeReference>(){});
  10.         System.out.println(listAuthor);
  11.     }
  12. }
  13. class Author{
  14.     private String name;
  15.     private int age;
  16.     // getter/setter
  17.     // toString
  18. }

03、更高級(jí)的配置

Jackson 之所以牛掰的一個(gè)很重要的因素是可以實(shí)現(xiàn)高度靈活的自定義配置。

在實(shí)際的應(yīng)用場(chǎng)景中,JSON 中常常會(huì)有一些 Java 對(duì)象中沒有的字段,這時(shí)候,如果直接解析的話,會(huì)拋出 UnrecognizedPropertyException 異常。

下面是一串 JSON 字符串:

 
 
 
 
  1. String jsonString = "{\n" +
  2.                 "  \"name\" : \"沉默王二\",\n" +
  3.                 "  \"age\" : 18\n" +
  4.                 "  \"sex\" : \"男\(zhòng)",\n" +
  5.                 "}";

但 Java 對(duì)象 Writer 中沒有定義 sex 字段:

 
 
 
 
  1. class Writer{
  2.     private String name;
  3.     private int age;
  4.     // getter/setter
  5. }

我們來嘗試解析一下:

 
 
 
 
  1. ObjectMapper mapper = new ObjectMapper();
  2. Writer deserializedWriter = mapper.readValue(jsonString, Writer.class);

不出意外,拋出異常了,sex 無法識(shí)別。

 
 
 
 
  1. 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"])
  2.  at [Source: (String)"{
  3.   "name" : "沉默王二",
  4.   "age" : 18,
  5.   "sex" : "男"
  6. }"; line: 4, column: 12] (through reference chain: com.itwanger.jackson.Writer["sex"])

怎么辦呢?可以通過 configure() 方法忽略掉這些“無法識(shí)別”的字段。

 
 
 
 
  1. mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

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

 
 
 
 
  1. // 在序列化時(shí)忽略值為 null 的屬性
  2. mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
  3. // 忽略值為默認(rèn)值的屬性
  4. mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_DEFAULT);

04、處理日期格式

對(duì)于日期類型的字段,比如說 java.util.Date,如果不指定格式,序列化后將顯示為 long 類型的數(shù)據(jù),這種默認(rèn)格式的可讀性很差。

 
 
 
 
  1. {
  2.   "age" : 18,
  3.   "birthday" : 1606358621209
  4. }

怎么辦呢?

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

 
 
 
 
  1. private Date birthday;
  2. // GMT+8 是指格林尼治的標(biāo)準(zhǔn)時(shí)間,在加上八個(gè)小時(shí)表示你現(xiàn)在所在時(shí)區(qū)的時(shí)間
  3. @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
  4. public Date getBirthday() {
  5.     return birthday;
  6. }
  7. public void setBirthday(Date birthday) {
  8.     this.birthday = birthday;
  9. }

再來看一下結(jié)果:

 
 
 
 
  1. {
  2.   "age" : 18,
  3.   "birthday" : "2020-11-26 03:02:30"
  4. }

具體代碼如下所示:

 
 
 
 
  1. ObjectMapper mapper = new ObjectMapper();
  2. Writer wanger = new Writer("沉默王二", 18);
  3. wanger.setBirthday(new Date());
  4. String jsonString = mapper.writerWithDefaultPrettyPrinter()
  5.                 .writeValueAsString(wanger);
  6. System.out.println(jsonString);

第二種方案,調(diào)用 ObjectMapper 的 setDateFormat() 方法。

 
 
 
 
  1. ObjectMapper mapper = new ObjectMapper();
  2. mapper.setDateFormat(StdDateFormat.getDateTimeInstance());
  3. Writer wanger = new Writer("沉默王二", 18);
  4. wanger.setBirthday(new Date());
  5. String jsonString = mapper.writerWithDefaultPrettyPrinter()
  6.                 .writeValueAsString(wanger);
  7. System.out.println(jsonString);

輸出結(jié)果如下所示:

 
 
 
 
  1. {
  2.   "name" : "沉默王二",
  3.   "age" : 18,
  4.   "birthday" : "2020年11月26日 上午11:09:51"
  5. }

05、字段過濾

在將 Java 對(duì)象序列化為 JSON 時(shí),可能有些字段需要過濾,不顯示在 JSON 中,Jackson 有一種比較簡單的實(shí)現(xiàn)方式。

@JsonIgnore 用于過濾單個(gè)字段。

 
 
 
 
  1. @JsonIgnore
  2. public String getName() {
  3.     return name;
  4. }

@JsonIgnoreProperties 用于過濾多個(gè)字段。

 
 
 
 
  1. @JsonIgnoreProperties(value = { "age","birthday" })
  2. class Writer{
  3.     private String name;
  4.     private int age;
  5.     private Date birthday;
  6. }

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

當(dāng) Jackson 默認(rèn)序列化和反序列化不能滿足實(shí)際的開發(fā)需要時(shí),可以自定義新的序列化和反序列化類。

自定義的序列化類需要繼承 StdSerializer,同時(shí)重寫 serialize() 方法,利用 JsonGenerator 生成 JSON,示例如下:

 
 
 
 
  1. public class CustomSerializer extends StdSerializer {
  2.     protected CustomSerializer(Class t) {
  3.         super(t);
  4.     }
  5.     public CustomSerializer() {
  6.         this(null);
  7.     }
  8.     @Override
  9.     public void serialize(Man value, JsonGenerator gen, SerializerProvider provider) throws IOException {
  10.         gen.writeStartObject();
  11.         gen.writeStringField("name", value.getName());
  12.         gen.writeEndObject();
  13.     }
  14. }
  15. class Man{
  16.     private int age;
  17.     private String name;
  18.     public Man(int age, String name) {
  19.         this.age = age;
  20.         this.name = name;
  21.     }
  22.     public int getAge() {
  23.         return age;
  24.     }
  25.     public void setAge(int age) {
  26.         this.age = age;
  27.     }
  28.     public String getName() {
  29.         return name;
  30.     }
  31.     public void setName(String name) {
  32.         this.name = name;
  33.     }
  34. }

定義好自定義序列化類后,要想在程序中調(diào)用它們,需要將其注冊(cè)到 ObjectMapper 的 Module 中,示例如下所示:

 
 
 
 
  1. ObjectMapper mapper = new ObjectMapper();
  2. SimpleModule module =
  3.         new SimpleModule("CustomSerializer", new Version(1, 0, 0, null, null, null));
  4. module.addSerializer(Man.class, new CustomSerializer());
  5. mapper.registerModule(module);
  6. Man man = new Man( 18,"沉默王二");
  7. String json = mapper.writeValueAsString(man);
  8. System.out.println(json);

程序輸出結(jié)果如下所示:

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

自定義序列化類 CustomSerializer 中沒有添加 age 字段,所以只輸出了 name 字段。

再來看一下自定義的反序列化類,繼承 StdDeserializer,同時(shí)重寫 deserialize() 方法,利用 JsonGenerator 讀取 JSON,示例如下:

 
 
 
 
  1. public class CustomDeserializer extends StdDeserializer {
  2.     protected CustomDeserializer(Class vc) {
  3.         super(vc);
  4.     }
  5.     public CustomDeserializer() {
  6.         this(null);
  7.     }
  8.     @Override
  9.     public Woman deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
  10.         JsonNode node = p.getCodec().readTree(p);
  11.         Woman woman = new Woman();
  12.         int age = (Integer) ((IntNode) node.get("age")).numberValue();
  13.         String name = node.get("name").asText();
  14.         woman.setAge(age);
  15.         woman.setName(name);
  16.         return woman;
  17.     }
  18. }
  19. class Woman{
  20.     private int age;
  21.     private String name;
  22.     public Woman() {
  23.     }
  24.     // getter/setter
  25.     @Override
  26.     public String toString() {
  27.         return "Woman{" +
  28.                 "age=" + age +
  29.                 ", name='" + name + '\'' +
  30.                 '}';
  31.     }
  32. }

通過 JsonNode 把 JSON 讀取到一個(gè)樹形結(jié)構(gòu)中,然后通過 JsonNode 的 get 方法將對(duì)應(yīng)字段讀取出來,然后生成新的 Java 對(duì)象,并返回。

定義好自定義反序列化類后,要想在程序中調(diào)用它們,同樣需要將其注冊(cè)到 ObjectMapper 的 Module 中,示例如下所示:

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

程序輸出結(jié)果如下所示:

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

07、結(jié)語

哎呀,好像不錯(cuò)哦,Jackson 絕對(duì)配得上“最牛掰”這三個(gè)字。如果只想簡單的序列化和反序列化,使用 ObjectMapper 的 write 和 read 方法即可。

如果還想更進(jìn)一步的話,就需要對(duì) ObjectMapper 進(jìn)行一些自定義配置,或者加一些注解,以及直接自定義序列化和反序列化類,更貼近一些 Java 對(duì)象。

需要注意的是,對(duì)日期格式的字段要多加小心,盡量不要使用默認(rèn)配置,可讀性很差。

好了,通過這篇文章的系統(tǒng)化介紹,相信讀者朋友們已經(jīng)完全摸透 Jackson 了,我們下篇文章見。

本文轉(zhuǎn)載自微信公眾號(hào)「沉默王二」,可以通過以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系沉默王二公眾號(hào)。


新聞標(biāo)題:Jackson之JavaJSON解析器
標(biāo)題網(wǎng)址:http://www.dlmjj.cn/article/ccsdhed.html