jackson學習之三：常用API操作
- 2021 年 1 月 28 日
- 筆記
歡迎訪問我的GitHub
//github.com/zq2599/blog_demos
內容：所有原創文章分類匯總及配套源碼，涉及Java、Docker、Kubernetes、DevOPS等；
系列文章匯總
- jackson學習之一：基本資訊
- jackson學習之二：jackson-core
- jackson學習之三：常用API操作
- jackson學習之四：WRAP_ROOT_VALUE（root對象）
- jackson學習之五：JsonInclude註解
- jackson學習之六：常用類註解
- jackson學習之七：常用Field註解
- jackson學習之八：常用方法註解
- jackson學習之九：springboot整合(配置文件)
- jackson學習之十(終篇)：springboot整合(配置類)
源碼下載
- 如果您不想編碼，可以在GitHub下載所有源碼，地址和鏈接資訊如下表所示(//github.com/zq2599/blog_demos)：
| 名稱 | 鏈接 | 備註 |
|---|---|---|
| 項目主頁 | //github.com/zq2599/blog_demos | 該項目在GitHub上的主頁 |
| git倉庫地址(https) | //github.com/zq2599/blog_demos.git | 該項目源碼的倉庫地址，https協議 |
| git倉庫地址(ssh) | [email protected]:zq2599/blog_demos.git | 該項目源碼的倉庫地址，ssh協議 |
- 這個git項目中有多個文件夾，本章的應用在jacksondemo文件夾下，如下圖紅框所示：
本篇概覽
本文是《jackson學習》系列的第三篇，前面咱們學習了jackson的低階API，知道了底層原理，本篇開始學習平時最常用的基本功能，涉及內容如下：
- 體驗最常用的操作，內容如下圖所示：
- 介紹常用的可配置屬性，以便按需要來設置；
- 接下來進入快速瀏覽的環節，咱們一起先把各個API過一遍；
單個對象序列化
先看常用的序列化API：
- 對象轉字元串：
String jsonStr = mapper.writeValueAsString(twitterEntry);
- 對象轉文件：
mapper.writeValue(new File("twitter.json"), twitterEntry);
- 對象轉byte數組：
byte[] array = mapper.writeValueAsBytes(twitterEntry);
單個對象反序列化
- 字元串轉對象：
TwitterEntry tFromStr = mapper.readValue(objectJsonStr, TwitterEntry.class);
- 文件轉對象：
TwitterEntry tFromFile = mapper.readValue(new File("twitter.json"), TwitterEntry.class);
- byte數組轉對象：
TwitterEntry tFromBytes = mapper.readValue(array, TwitterEntry.class);
- 字元串網路地址轉對象：
String testJsonDataUrl = "//raw.githubusercontent.com/zq2599/blog_demos/master/files/twitteer_message.json";
TwitterEntry tFromUrl = mapper.readValue(new URL(testJsonDataUrl), TwitterEntry.class);
集合序列化
- HashMap轉字元串：
String mapJsonStr = mapper.writeValueAsString(map);
集合反序列化
- 字元串轉HashMap：
Map<String, Object> mapFromStr = mapper.readValue(mapJsonStr, new TypeReference<Map<String, Object>>() {});
JsonNode
- 如果您不想使用XXX.class來做反序列化，也能使用JsonNode來操作：
JsonNode jsonNode = mapper.readTree(mapJsonStr);
String name = jsonNode.get("name").asText();
int age = jsonNode.get("age").asInt();
String city = jsonNode.get("addr").get("city").asText();
String street = jsonNode.get("addr").get("street").asText();
時間欄位格式化
- 對於Date欄位，默認的反序列化是時間戳，可以修改配置：
mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss"));
dateMapStr = mapper.writeValueAsString(dateMap);
JSON數組的反序列化
假設jsonArrayStr是個json數組格式的字元串：
- JSON數組轉對象數組：
TwitterEntry[] twitterEntryArray = mapper.readValue(jsonArrayStr, TwitterEntry[].class);
- JSON數組轉對象集合(ArrayList)：
List<TwitterEntry> twitterEntryList = mapper.readValue(jsonArrayStr, new TypeReference<List<TwitterEntry>>() {});
完整程式碼
- 上述所有常用API用法的完整程式碼如下：
package com.bolingcavalry.jacksondemo.databind;
import com.bolingcavalry.jacksondemo.beans.TwitterEntry;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.*;
public class SimpleDemo {
private static final Logger logger = LoggerFactory.getLogger(SimpleDemo.class);
public static void main(String[] args) throws Exception {
ObjectMapper mapper = new ObjectMapper();
logger.info("以下是序列化操作");
// 對象 -> 字元串
TwitterEntry twitterEntry = new TwitterEntry();
twitterEntry.setId(123456L);
twitterEntry.setFromUserId(101);
twitterEntry.setToUserId(102);
twitterEntry.setText("this is a message for serializer test");
twitterEntry.setLanguageCode("zh");
String jsonStr = mapper.writeValueAsString(twitterEntry);
logger.info("序列化的字元串：{}", jsonStr);
// 對象 -> 文件
mapper.writeValue(new File("twitter.json"), twitterEntry);
// 對象 -> byte數組
byte[] array = mapper.writeValueAsBytes(twitterEntry);
logger.info("\n\n以下是反序列化操作");
// 字元串 -> 對象
String objectJsonStr = "{\n" +
" \"id\":1125687077,\n" +
" \"text\":\"@stroughtonsmith You need to add a \\\"Favourites\\\" tab to TC/iPhone. Like what TwitterFon did. I can't WAIT for your Twitter App!! :) Any ETA?\",\n" +
" \"fromUserId\":855523, \n" +
" \"toUserId\":815309,\n" +
" \"languageCode\":\"en\"\n" +
"}";
TwitterEntry tFromStr = mapper.readValue(objectJsonStr, TwitterEntry.class);
logger.info("從字元串反序列化的對象：{}", tFromStr);
// 文件 -> 對象
TwitterEntry tFromFile = mapper.readValue(new File("twitter.json"), TwitterEntry.class);
logger.info("從文件反序列化的對象：{}", tFromStr);
// byte數組 -> 對象
TwitterEntry tFromBytes = mapper.readValue(array, TwitterEntry.class);
logger.info("從byte數組反序列化的對象：{}", tFromBytes);
// 字元串網路地址 -> 對象
String testJsonDataUrl = "//raw.githubusercontent.com/zq2599/blog_demos/master/files/twitteer_message.json";
TwitterEntry tFromUrl = mapper.readValue(new URL(testJsonDataUrl), TwitterEntry.class);
logger.info("從網路地址反序列化的對象：{}", tFromUrl);
logger.info("\n\n以下是集合序列化操作");
Map<String, Object> map = new HashMap<>();
map.put("name", "tom");
map.put("age", 11);
Map<String, String> addr = new HashMap<>();
addr.put("city","深圳");
addr.put("street", "粵海");
map.put("addr", addr);
String mapJsonStr = mapper.writeValueAsString(map);
logger.info("HashMap序列化的字元串：{}", mapJsonStr);
logger.info("\n\n以下是集合反序列化操作");
Map<String, Object> mapFromStr = mapper.readValue(mapJsonStr, new TypeReference<Map<String, Object>>() {});
logger.info("從字元串反序列化的HashMap對象：{}", mapFromStr);
// JsonNode類型操作
JsonNode jsonNode = mapper.readTree(mapJsonStr);
String name = jsonNode.get("name").asText();
int age = jsonNode.get("age").asInt();
String city = jsonNode.get("addr").get("city").asText();
String street = jsonNode.get("addr").get("street").asText();
logger.info("用JsonNode對象和API反序列化得到的數：name[{}]、age[{}]、city[{}]、street[{}]", name, age, city, street);
// 時間類型格式
Map<String, Object> dateMap = new HashMap<>();
dateMap.put("today", new Date());
String dateMapStr = mapper.writeValueAsString(dateMap);
logger.info("默認的時間序列化：{}", dateMapStr);
// 設置時間格式
mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss"));
dateMapStr = mapper.writeValueAsString(dateMap);
logger.info("自定義的時間序列化：{}", dateMapStr);
System.out.println(objectJsonStr);
// json數組
String jsonArrayStr = "[{\n" +
" \"id\":1,\n" +
" \"text\":\"text1\",\n" +
" \"fromUserId\":11, \n" +
" \"toUserId\":111,\n" +
" \"languageCode\":\"en\"\n" +
"},\n" +
"{\n" +
" \"id\":2,\n" +
" \"text\":\"text2\",\n" +
" \"fromUserId\":22, \n" +
" \"toUserId\":222,\n" +
" \"languageCode\":\"zh\"\n" +
"},\n" +
"{\n" +
" \"id\":3,\n" +
" \"text\":\"text3\",\n" +
" \"fromUserId\":33, \n" +
" \"toUserId\":333,\n" +
" \"languageCode\":\"en\"\n" +
"}]";
// json數組 -> 對象數組
TwitterEntry[] twitterEntryArray = mapper.readValue(jsonArrayStr, TwitterEntry[].class);
logger.info("json數組反序列化成對象數組：{}", Arrays.toString(twitterEntryArray));
// json數組 -> 對象集合
List<TwitterEntry> twitterEntryList = mapper.readValue(jsonArrayStr, new TypeReference<List<TwitterEntry>>() {});
logger.info("json數組反序列化成對象集合：{}", twitterEntryList);
}
}
- 執行結果如下：
C:\jdk\bin\java.exe -javaagent:C:\sofware\JetBrains\IntelliJIDEA\lib\idea_rt.jar=64570:C:\sofware\JetBrains\IntelliJIDEA\bin -Dfile.encoding=UTF-8 -classpath C:\jdk\jre\lib\charsets.jar;C:\jdk\jre\lib\deploy.jar;C:\jdk\jre\lib\ext\access-bridge-64.jar;C:\jdk\jre\lib\ext\cldrdata.jar;C:\jdk\jre\lib\ext\dnsns.jar;C:\jdk\jre\lib\ext\jaccess.jar;C:\jdk\jre\lib\ext\jfxrt.jar;C:\jdk\jre\lib\ext\localedata.jar;C:\jdk\jre\lib\ext\nashorn.jar;C:\jdk\jre\lib\ext\sunec.jar;C:\jdk\jre\lib\ext\sunjce_provider.jar;C:\jdk\jre\lib\ext\sunmscapi.jar;C:\jdk\jre\lib\ext\sunpkcs11.jar;C:\jdk\jre\lib\ext\zipfs.jar;C:\jdk\jre\lib\javaws.jar;C:\jdk\jre\lib\jce.jar;C:\jdk\jre\lib\jfr.jar;C:\jdk\jre\lib\jfxswt.jar;C:\jdk\jre\lib\jsse.jar;C:\jdk\jre\lib\management-agent.jar;C:\jdk\jre\lib\plugin.jar;C:\jdk\jre\lib\resources.jar;C:\jdk\jre\lib\rt.jar;D:\github\blog_demos\jacksondemo\databind\target\classes;C:\Users\12167\.m2\repository\com\fasterxml\jackson\core\jackson-databind\2.11.0\jackson-databind-2.11.0.jar;C:\Users\12167\.m2\repository\com\fasterxml\jackson\core\jackson-annotations\2.11.0\jackson-annotations-2.11.0.jar;C:\Users\12167\.m2\repository\com\fasterxml\jackson\core\jackson-core\2.11.0\jackson-core-2.11.0.jar;C:\Users\12167\.m2\repository\org\slf4j\slf4j-log4j12\1.7.25\slf4j-log4j12-1.7.25.jar;C:\Users\12167\.m2\repository\org\slf4j\slf4j-api\1.7.25\slf4j-api-1.7.25.jar;C:\Users\12167\.m2\repository\log4j\log4j\1.2.17\log4j-1.2.17.jar;C:\Users\12167\.m2\repository\commons-io\commons-io\2.7\commons-io-2.7.jar;C:\Users\12167\.m2\repository\org\apache\commons\commons-lang3\3.10\commons-lang3-3.10.jar;D:\github\blog_demos\jacksondemo\beans\target\classes com.bolingcavalry.jacksondemo.databind.SimpleDemo
2020-08-28 07:53:01 INFO SimpleDemo:27 - 以下是序列化操作
2020-08-28 07:53:01 INFO SimpleDemo:38 - 序列化的字元串：{"id":123456,"text":"this is a message for serializer test","fromUserId":101,"toUserId":102,"languageCode":"zh"}
2020-08-28 07:53:01 INFO SimpleDemo:47 -
以下是反序列化操作
2020-08-28 07:53:01 INFO SimpleDemo:60 - 從字元串反序列化的對象：[Tweet, id: 1125687077, text='@stroughtonsmith You need to add a "Favourites" tab to TC/iPhone. Like what TwitterFon did. I can't WAIT for your Twitter App!! :) Any ETA?', from: 855523, to: 815309, lang: en]
2020-08-28 07:53:01 INFO SimpleDemo:64 - 從文件反序列化的對象：[Tweet, id: 1125687077, text='@stroughtonsmith You need to add a "Favourites" tab to TC/iPhone. Like what TwitterFon did. I can't WAIT for your Twitter App!! :) Any ETA?', from: 855523, to: 815309, lang: en]
2020-08-28 07:53:01 INFO SimpleDemo:68 - 從byte數組反序列化的對象：[Tweet, id: 123456, text='this is a message for serializer test', from: 101, to: 102, lang: zh]
2020-08-28 07:53:04 INFO SimpleDemo:74 - 從網路地址反序列化的對象：[Tweet, id: 112233445566, text='this is a message from zq2599's github', from: 201, to: 202, lang: en]
2020-08-28 07:53:04 INFO SimpleDemo:77 -
以下是集合序列化操作
2020-08-28 07:53:04 INFO SimpleDemo:90 - HashMap序列化的字元串：{"name":"tom","addr":{"city":"深圳","street":"粵海"},"age":11}
2020-08-28 07:53:04 INFO SimpleDemo:92 -
以下是集合反序列化操作
2020-08-28 07:53:04 INFO SimpleDemo:94 - 從字元串反序列化的HashMap對象：{name=tom, addr={city=深圳, street=粵海}, age=11}
2020-08-28 07:53:04 INFO SimpleDemo:103 - 用JsonNode對象和API反序列化得到的數：name[tom]、age[11]、city[深圳]、street[粵海]
2020-08-28 07:53:04 INFO SimpleDemo:111 - 默認的時間序列化：{"today":1598572384838}
2020-08-28 07:53:04 INFO SimpleDemo:116 - 自定義的時間序列化：{"today":"2020-08-28 07:53:04"}
{
"id":1125687077,
"text":"@stroughtonsmith You need to add a \"Favourites\" tab to TC/iPhone. Like what TwitterFon did. I can't WAIT for your Twitter App!! :) Any ETA?",
"fromUserId":855523,
"toUserId":815309,
"languageCode":"en"
}
2020-08-28 07:53:04 INFO SimpleDemo:145 - json數組反序列化成對象數組：[[Tweet, id: 1, text='text1', from: 11, to: 111, lang: en], [Tweet, id: 2, text='text2', from: 22, to: 222, lang: zh], [Tweet, id: 3, text='text3', from: 33, to: 333, lang: en]]
2020-08-28 07:53:04 INFO SimpleDemo:149 - json數組反序列化成對象集合：[[Tweet, id: 1, text='text1', from: 11, to: 111, lang: en], [Tweet, id: 2, text='text2', from: 22, to: 222, lang: zh], [Tweet, id: 3, text='text3', from: 33, to: 333, lang: en]]
Process finished with exit code 0
- 還會產生名為twitter.json的文件，內容如下：
{"id":123456,"text":"this is a message for serializer test","fromUserId":101,"toUserId":102,"languageCode":"zh"}
常用配置
下面是平時可能用到的自定義配置項目：
- 序列化結果格式化：
mapper.enable(SerializationFeature.INDENT_OUTPUT);
- 空對象不要拋出異常：
mapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
- Date、Calendar等序列化為時間格式的字元串(如果不執行以下設置，就會序列化成時間戳格式)：
mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
- 反序列化時，遇到未知屬性不要拋出異常：
mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
- 反序列化時，空字元串對於的實例屬性為null：
mapper.enable(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT);
- 允許C和C++樣式注釋：
mapper.configure(JsonParser.Feature.ALLOW_COMMENTS, true);
- 允許欄位名沒有引號（可以進一步減小json體積）：
mapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true);
- 允許單引號：
mapper.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);
特殊配置：在json對象最外層再包裹一層
- 最後要說的是個特殊配置，先來看看正常情況一個普通的序列化結果：
{
"id" : 1,
"text" : "aabbcc",
"fromUserId" : 456,
"toUserId" : 0,
"languageCode" : "zh"
}
- 接下來咱們做兩件事，首先，是給上述json對應的實例類添加一個註解，如下圖紅框：
3. 其次，執行以下配置：
mapper.enable(SerializationFeature.WRAP_ROOT_VALUE);
- 然後再次執行TwitterEntry實例的序列化，得到的結果如下，可見和之前的序列化結果相比，之前的整個json都變成了一個value，此value對應的key就是註解JsonRootName的value屬性：
{
"aaa" : {
"id" : 1,
"text" : "aabbcc",
"fromUserId" : 456,
"toUserId" : 0,
"languageCode" : "zh"
}
}
- 至此，開發中常用的API和配置都已經介紹完成，希望能給您帶來一些參考，接下來的章節，咱們一起去了解另一個常用操作：jackson註解；
你不孤單，欣宸原創一路相伴
歡迎關注公眾號：程式設計師欣宸
微信搜索「程式設計師欣宸」，我是欣宸，期待與您一同暢遊Java世界…
//github.com/zq2599/blog_demos
