Jackson API 详细汇总与使用介绍

素颜马尾好姑娘i 2022-03-07 07:58 451阅读 0赞

**目录**

Jackson 概述 与 依赖

Jackson 使用前情提要

ObjectMapper 序列化对象

JsonNode 树模型 Json 节点

Jsonson 注解设置 POJO 属性

--------------------

# Jackson 概述 与 依赖 #

1、市面上用于在 Java 中解析 Json 的第三方库，随便一搜不下几十种，其中的佼佼者有 [Google 的 Gson][Google _ Gson]，[ Alibaba 的 Fastjson ][Alibaba _ Fastjson]以及本文的 jackson。

2、三者不相伯仲，随着掌握一个都能满足项目中的 json 解析操作，因为 Spring Boot Web 组件默认使用的是  jackson，所以掌握 Jackjson 是非常有必要的。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70][]

3、gson 和 fastjson 使用时只需要导入一个 jar 包(或者一个依赖)即可，而 jackson 却不是全部集成在一个 jar (一个应用)内，而是分为不同的功能模块，需要使用哪些功能，则导入对应的 jar 包(或依赖)。

<table> 
 <tbody> 
 <tr> 
 <td> FasterXml Github 地址：<a href="https://github.com/FasterXML" rel="nofollow">https://github.com/FasterXML</a>，jackson 所有的功能模块都在其中 比如 jackson-core 模块：<a href="https://github.com/FasterXML/jackson-core" rel="nofollow">https://github.com/FasterXML/jackson-core</a>，其中提供了 maven 依赖： </td> 
 </tr> 
 </tbody> 
</table>

<dependency>
 <groupId>com.fasterxml.jackson.core</groupId>
 <artifactId>jackson-core</artifactId>
 
 <version>${jackson.version.core}</version>
 </dependency>

<table> 
 <tbody> 
 <tr> 
 <td> jackson-core 二进制 jar 包下载地址：<a href="http://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-core/" rel="nofollow">http://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-core/</a> 其余的 jackson-xxx 模块也是同理，在其相应的项目主页中，都提供 maven 依赖与下载 jar 地址。 </td> 
 </tr> 
 </tbody> 
</table>

4、看了上面 Spring Boot Web 组件依赖 jackson 的情况就知道，使用 Jackson 导入以下 3 个主要模块基本满足开发：

<table> 
 <tbody> 
 <tr> 
 <td> jackson-core&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; #<a href="https://github.com/FasterXML/jackson-core" rel="nofollow">maven 依赖</a>、<a href="http://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-core/" rel="nofollow">二进制jar包</a> jackson-annotations&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; #<a href="https://github.com/FasterXML/jackson-annotations" rel="nofollow">maven依赖</a>、<a href="http://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-annotations/" rel="nofollow">二进制jar包</a> jackson-databind&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<a href="https://github.com/FasterXML/jackson-databind" rel="nofollow">#maven依赖</a>、<a href="http://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-databind/" rel="nofollow">二进制jar包</a> </td> 
 </tr> 
 </tbody> 
</table>

5、其中 jackson-databind 内部依赖了 jackson-annotations 与  jackson-core，所以 Maven 应用时，只要导入 databind 一个，则同时也导入了 annotations 与  core 依赖。

<dependency>
 <groupId>com.fasterxml.jackson.core</groupId>
 <artifactId>jackson-databind</artifactId>
 <version>2.11.0</version>
 </dependency>

# Jackson 使用前情提要 #

1、默认情况下，ObjectMapper 在序列化对象时，将实体所有的字段一 一序列化，无论这些字段是否有值，是否为 null。

2、如果实体的某个字段没有提供 getter 方法，则该字段不会被序列化。

3、Spring Boot Web 组件默认使用  jackson 进行对象的序列化与反序列化，即页面传入的参数，会自动反序列化为后台对象，后台传给前端的对象，也会序列化后输出。所以需要注意返回给页面的对象默认不能使用 Jackson 以外的 Json 库序列化，比如返回一个 Gson 的 JsonObject 给前端，则会报错，因为显然 Jackson 序列化时会失败。

4、Jackson 提供三种不同的方法来操作 JSON：

<table> 
 <tbody> 
 <tr> 
 <td> 1）<a href="https://www.yiibai.com/jackson/jackson_streaming_api.html" rel="nofollow">流式API</a> - 使用 Stream(流) 的方式对 Json 的每一个组成部分进行最细粒度的控制，JsonParser 读取数据，JsonGenerator 写入数据。 2）树模型 - 将 JSON 文件在内存里以树的形式表示，通过 JsonNode 处理单个Json节点，类似于 XML 的 DOM 解析器。(常用) 3）databind 模块 - ObjectMapper 读/写 JSON 是 POJO 序列化与反序列化 json 最方便的方式。（常用） </td> 
 </tr> 
 </tbody> 
</table>

# ObjectMapper 序列化对象 #

1、ObjectMapper 主要用于对 Java 对象（比如 POJO、List、Set、Map 等等）进行序列化与反序列化。

2、ObjectMapper 除了能在 json 字符串与 Java 对象之间进行转换，还能将 json 字符串与 JsonNode 进行转换。

<table> 
 <tbody> 
 <tr> 
 <td colspan="2" style="text-align:center;width:262px;">Java 对象与 Json 字符串的转换</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">String writeValueAsString(Object value)</td> 
 <td style="width:505px;"> 1、用于将任何 Java 对象（如 POJO、List、Set、Map等）序列化为 json 字符串，如果对象中某个属性的值为 null，则默认也会序列化为 null； 2、如果 value 为 null，返回序列化的结果也返回 null </td> 
 </tr> 
 <tr> 
 <td style="width:397px;"> byte[] writeValueAsBytes(Object value) </td> 
 <td style="width:505px;">将 java 对象序列化为 字节数组</td> 
 </tr> 
 <tr> 
 <td style="width:397px;"> writeValue(File resultFile, Object value) </td> 
 <td style="width:505px;">将 java 对象序列化并输出指定文件中</td> 
 </tr> 
 <tr> 
 <td style="width:397px;"> writeValue(OutputStream out, Object value) </td> 
 <td style="width:505px;">将 java 对象序列化并输出到指定字节输出流中</td> 
 </tr> 
 <tr> 
 <td style="width:397px;"> writeValue(Writer w, Object value) </td> 
 <td style="width:505px;">将 java 对象序列化并输出到指定字符输出流中</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">T readValue(String content, Class&lt;T&gt; valueType)</td> 
 <td style="width:505px;"> 1、从给定的 JSON 字符串反序列化为 Java 对象； 2、content 为空或者为 null，都会报错 3、valueType 表示反序列化的结果对象，可以是任何 java 对象，比如 POJO、List、Set、Map 等等. </td> 
 </tr> 
 <tr> 
 <td style="width:397px;">T readValue(byte[] src, Class&lt;T&gt; valueType)</td> 
 <td style="width:505px;">将 json 内容的字节数组反序列化为 java 对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">T readValue(File src, Class&lt;T&gt; valueType)</td> 
 <td style="width:505px;">将本地 json 内容的文件反序列化为 java 对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">T readValue(InputStream src, Class&lt;T&gt; valueType)</td> 
 <td style="width:505px;">将 json 内容的字节输入流反序列化为 java 对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">T readValue(Reader src, Class&lt;T&gt; valueType)</td> 
 <td style="width:505px;">将 json 内容的字符输入流反序列化为 java 对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;"> T readValue(URL src, Class&lt;T&gt; valueType)</td> 
 <td style="width:505px;">通过网络 url 地址将 json 内容反序列化为 java 对象</td> 
 </tr> 
 <tr> 
 <td colspan="2" style="text-align:center;width:397px;">Json 字符串内容反序列化为 Json 节点对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">JsonNode readTree(String content)</td> 
 <td style="width:505px;">将 JSON 字符串反序列化为 JsonNode 对象，即 json 节点对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">JsonNode readTree(URL source)</td> 
 <td style="width:505px;">对网络上的 json 文件进行反序列化为 json 节点对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">JsonNode readTree(InputStream in)</td> 
 <td style="width:505px;">对 json 文件输入流进行反序列化为 json 节点对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">JsonNode readTree(byte[] content)</td> 
 <td style="width:505px;">对 json 字节数组反序列化为 json 节点对象</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">JsonNode readTree(File file)</td> 
 <td style="width:505px;">将本地 json 文件反序列为为 json 节点对象</td> 
 </tr> 
 <tr> 
 <td colspan="2" style="text-align:center;width:397px;">Java 对象与 Json 节点对象的转换</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">T convertValue(Object fromValue, Class&lt;T&gt; toValueType)</td> 
 <td style="width:505px;">将 Java 对象（如 POJO、List、Map、Set 等）序列化为 Json 节点对象。</td> 
 </tr> 
 <tr> 
 <td style="width:397px;">T treeToValue(TreeNode n, Class&lt;T&gt; valueType)</td> 
 <td style="width:505px;"> json 树节点对象转 Java 对象（如 POJO、List、Set、Map 等等） TreeNode 树节点是整个 json 节点对象模型的根接口。 </td> 
 </tr> 
 </tbody> 
</table>

![2020071720573037.gif][]

API 演示源码：[/src/main/java/com/wmx/jackson/ObjectMapperTest.java][src_main_java_com_wmx_jackson_ObjectMapperTest.java]

# JsonNode 树模型 Json 节点 #

1、JsonNode 表示 json 节点，整个节点模型的根接口为 TreeNode，json 节点主要用于手动构建 json 对象。

2、JsonNode 有各种数据类型的实现类，其中最常用的就是 ObjectNode 与 ArrayNode，前者表示 json 对象，后者表示 json 对象数组。

3、json 节点对象可以通过 JsonNodeFactory 创建，如 JsonNodeFactory.instance.objectNode();

<table> 
 <tbody> 
 <tr> 
 <td colspan="2" style="text-align:center;">JsonNode json节点通用方法</td> 
 </tr> 
 <tr> 
 <td>JsonNode get(String fieldName)</td> 
 <td>用于访问对象节点的指定字段的值，如果此节点不是对象、或没有指定字段名的值，或没有这样名称的字段，则返回 null。</td> 
 </tr> 
 <tr> 
 <td>JsonNode get(int index)JsonNode get(int index)</td> 
 <td> 访问数组节点的指定索引位置上的值，对于其他节点，总是返回 null. 如果索引小于0，或等于、大于节点大小，则返回 null，对于任何索引都不会引发异常。 </td> 
 </tr> 
 <tr> 
 <td>boolean isArray()</td> 
 <td>判断此节点是否为 {@link ArrayNode} 数组节点</td> 
 </tr> 
 <tr> 
 <td>boolean isObject()</td> 
 <td>如果此节点是对象节点，则返回 true，否则返回 false</td> 
 </tr> 
 <tr> 
 <td>int size()</td> 
 <td>获取 json 节点的大小，比如 json 对象中有多少键值对，或者 json 数组中有多少元素。</td> 
 </tr> 
 <tr> 
 <td>ObjectNode deepCopy()</td> 
 <td>json 节点对象深度复制，相当于克隆</td> 
 </tr> 
 <tr> 
 <td>Iterator&lt;String&gt; fieldNames()</td> 
 <td>获取 json 对象中的所有 key</td> 
 </tr> 
 <tr> 
 <td>Iterator&lt;JsonNode&gt; elements()</td> 
 <td>如果该节点是JSON数组或对象节点，则访问此节点的所有值节点,对于对象节点，不包括字段名（键），只包括值，对于其他类型的节点，返回空迭代器。</td> 
 </tr> 
 <tr> 
 <td>boolean has(int index)</td> 
 <td>检查此节点是否为数组节点，并是否含有指定的索引。</td> 
 </tr> 
 <tr> 
 <td> boolean has(String fieldName) </td> 
 <td> 检查此节点是否为 JSON 对象节点并包含指定属性的值。 </td> 
 </tr> 
 <tr> 
 <td colspan="2" style="text-align:center;">将 json 属性的值转为 java 数据类型</td> 
 </tr> 
 <tr> 
 <td> int asInt() int asInt(int defaultValue) </td> 
 <td> asInt()：尝试将此节点的值转换为 int 类型，布尔值 false 转换为 0,true 转换为 1。如果不能转换为 int（比如值是对象或数组等结构化类型），则返回默认值 0 ，不会引发异常。 asInt(int defaultValue)：设置默认值 </td> 
 </tr> 
 <tr> 
 <td> boolean asBoolean() boolean asBoolean(boolean defaultValue) </td> 
 <td> 尝试将此节点的值转换为 Java 布尔值，0以外的整数映射为true，0映射为false，字符串“true”和“false”映射到相应的值。 如果无法转换为布尔值（包括对象和数组等结构化类型），则返回默认值 false，不会引发异常。 可以自己设置默认值。 </td> 
 </tr> 
 <tr> 
 <td> asText(String defaultValue) String asText() </td> 
 <td>如果节点是值节点（isValueNode 返回 true），则返回容器值的有效字符串表示形式，否则返回空字符串。</td> 
 </tr> 
 <tr> 
 <td> long asLong() long asLong(long defaultValue) </td> 
 <td>与 asInt 同理</td> 
 </tr> 
 <tr> 
 <td> double asDouble() double asDouble(double defaultValue) </td> 
 <td> 尝试将此节点的值转换为 double，布尔值转换为0.0（false）和1.0（true），字符串使用默认的Java 语言浮点数解析规则进行解析。 如果表示不能转换为 double（包括对象和数组等结构化类型），则返回默认值 0.0,不会引发异常。 </td> 
 </tr> 
 <tr> 
 <td>BigInteger bigIntegerValue()</td> 
 <td> 返回此节点的整数值（BigDecimal），当且仅当此节点为数字时（isNumber}返回true）。 对于其他类型，返回 BigInteger.ZERO。 </td> 
 </tr> 
 <tr> 
 <td>boolean booleanValue()</td> 
 <td>用于访问 JSON 布尔值（值文本“true”和“false”）的方法,对于其他类型，始终返回false</td> 
 </tr> 
 <tr> 
 <td>BigDecimal decimalValue()</td> 
 <td>返回此节点的浮点值 BigDecimal, 当且仅当此节点为数字时（isNumber 返回true）,对于其他类型，返回 BigDecimal.ZERO</td> 
 </tr> 
 <tr> 
 <td>double doubleValue()</td> 
 <td>返回此节点的64位浮点（双精度）值，当且仅当此节点为数字时（isNumber返回true），对于其他类型，返回0.0。</td> 
 </tr> 
 <tr> 
 <td>float floatValue()</td> 
 <td>返回此节点的32位浮点值，当且仅当此节点为数字时（isNumber返回true），对于其他类型，返回0.0。</td> 
 </tr> 
 <tr> 
 <td>int intValue() long longValue() Number numberValue() short shortValue() String textValue()</td> 
 <td>返回此节点的 int、long、Number、short、String 值。</td> 
 </tr> 
 <tr> 
 <td colspan="2" style="text-align:center;">ObjectNode 对象节点常用方法</td> 
 </tr> 
 <tr> 
 <td> ObjectNode put(String fieldName, String v) ObjectNode put(String fieldName, int v) </td> 
 <td> 1、将字段的值设置为指定的值，如果字段已经存在，则更新值，value 可以为 null. 2、其它 8&nbsp; 种基本数据类型以及 String、BigDecimal、BigInteger 都可以 put，但是没有 Date 类型 3、Date 日期类型只能通过 Long 长整型设置 </td> 
 </tr> 
 <tr> 
 <td>ArrayNode putArray(String fieldName)</td> 
 <td>构造新的 ArrayNode 子节点，并将其作为此 ObjectNode 的字段添加。</td> 
 </tr> 
 <tr> 
 <td>ObjectNode putNull(String fieldName):</td> 
 <td>为指定字段添加 null 值，put&nbsp;</td> 
 </tr> 
 <tr> 
 <td>ObjectNode putObject(String fieldName)</td> 
 <td>构造新的 ObjectNode 字节的，并将其作为此 ObjectNode 的字段添加。</td> 
 </tr> 
 <tr> 
 <td colspan="2" style="text-align:center;">替换与删除元素</td> 
 </tr> 
 <tr> 
 <td>JsonNode replace(String fieldName, JsonNode value)</td> 
 <td>将特定属性的值替换为传递的值，字段存在时更新，不存在时新增</td> 
 </tr> 
 <tr> 
 <td>JsonNode set(String fieldName, JsonNode value)</td> 
 <td>设置指定属性的值为 json 节点对象，字段存在时更新，不存在时新增，类似 replace 方法</td> 
 </tr> 
 <tr> 
 <td>JsonNode setAll(Map&lt;String,? extends JsonNode&gt; properties)</td> 
 <td>同时设置多个 json 节点</td> 
 </tr> 
 <tr> 
 <td>JsonNode setAll(ObjectNode other)</td> 
 <td>添加给定对象（other）的所有属性，重写这些属性的任何现有值.</td> 
 </tr> 
 <tr> 
 <td>ArrayNode withArray(String propertyName)</td> 
 <td>将 json 节点转为 json 数组对象</td> 
 </tr> 
 <tr> 
 <td>ObjectNode with(String propertyName)</td> 
 <td>将 json 节点转为 ObjectNode 对象</td> 
 </tr> 
 <tr> 
 <td>JsonNode remove(String fieldName)</td> 
 <td>删除指定的 key，返回被删除的节点</td> 
 </tr> 
 <tr> 
 <td>ObjectNode remove(Collection&lt;String&gt; fieldNames)</td> 
 <td>同时删除多个字段</td> 
 </tr> 
 <tr> 
 <td>ObjectNode removeAll()</td> 
 <td>删除所有字段属性</td> 
 </tr> 
 <tr> 
 <td>JsonNode without(String fieldName):</td> 
 <td>删除指定的 key，底层也是 remove</td> 
 </tr> 
 <tr> 
 <td>ObjectNode without(Collection&lt;String&gt; fieldNames)</td> 
 <td>同时删除多个字段，底层也是 removeAll</td> 
 </tr> 
 <tr> 
 <td colspan="2" style="text-align:center;">ArrayNode 数组节点常用方法</td> 
 </tr> 
 <tr> 
 <td>ArrayNode add(String v)</td> 
 <td> 将指定的字符串值添加到此 json 数组的末尾，其它数据类型也是同理。 除了可以添加 String 类型，还有 Java 的 8 种基本数据类型，以及 BigDecimal、BigInteger、JsonNode 类型。 </td> 
 </tr> 
 <tr> 
 <td>ArrayNode addAll(ArrayNode other)</td> 
 <td>用于添加给定数组的所有子节点</td> 
 </tr> 
 <tr> 
 <td>ArrayNode addNull()</td> 
 <td>该方法将在此数组节点的末尾添加 null 值。</td> 
 </tr> 
 <tr> 
 <td>ArrayNode addArray()</td> 
 <td>构造新的 ArrayNode 子节点，并将其添加到此数组节点的末尾</td> 
 </tr> 
 <tr> 
 <td>ObjectNode addObject()</td> 
 <td>构造一个新的 ObjectNode 字节的，并将其添加到此数组节点的末尾</td> 
 </tr> 
 </tbody> 
</table>

API 演示源码：[/src/main/java/com/wmx/jackson/JsonNodeTest.java][src_main_java_com_wmx_jackson_JsonNodeTest.java]

# Jsonson 注解设置 POJO 属性 #

1、ObjectMapper  序列化 POJO 对象为 json 字符串时，Date 日期类型默认会转为 long 长整型，json 字符串反序列化为 POJO 时自动将长整型的日期转为 Date 类型。

2、Map 对象序列化为 json 字符串时，Map 中的日期值也会默认转为 long 长整型， ObjectMapper.readValue(String content, Class<T> valueType)：反序列化为 Map 对象时，长整型的日期仍旧是长整型，不会转回 Date。ObjectMapper.readTree(String content) 反序列化为 json 节点时，原来 Map 中的长整型的日期也会是长整型。

3、JsonNode 节点对象 put 数据时，有 8  种基本数据类型以及 String、BigDecimal、BigInteger，但是没有 Date 类型，所以日期类型只能通过 Long 长整型设置，但是转 POJO 对象时仍然会自动转为 Date 类型。

4、Google 的 gson 默认不会序列化对象中值为 null 的字段，而 jackson 则不管值是否为 null，都会序列化。

5、@JsonFormat 注解加到指定对象的属性上可以指定日期序列化的格式。

6、@JsonInclude(JsonInclude.Include.NON\_NULL) 添加到 POJO 对象上，表示对值为 null 的属性不进行序列化。

API 演示源码：

[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/jackson/Book.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_jackson_Book.java]  
[https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/jackson/AnnotationTest.java][https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_jackson_AnnotationTest.java]

[Google _ Gson]: https://blog.csdn.net/wangmx1993328/article/details/84385548
[Alibaba _ Fastjson]: https://blog.csdn.net/wangmx1993328/article/details/80882745
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70]: /images/20220307/423b3ff638234816953c40dfca4ce1e5.png
[2020071720573037.gif]: /images/20220307/1028fb2cc3fe4778b8129eb6f154530a.png
[src_main_java_com_wmx_jackson_ObjectMapperTest.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/jackson/ObjectMapperTest.java
[src_main_java_com_wmx_jackson_JsonNodeTest.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/jackson/JsonNodeTest.java
[https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_jackson_Book.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/jackson/Book.java
[https_github.com_wangmaoxiong_apache-study_blob_master_src_main_java_com_wmx_jackson_AnnotationTest.java]: https://github.com/wangmaoxiong/apache-study/blob/master/src/main/java/com/wmx/jackson/AnnotationTest.java