14.5 使用Jackson序列化为 JSON/XML/MessagePack

由于Java标准序列化机制的一些限制，实践中经常使用一些替代方 案，比如XML/JSON/MessagePack 。 Java SDK中对这些格式的支持有限，有很多第三方的类库提供了更为方便的支持，Jackson是其中一种， 它支持多种格式，包括XML/JSON/MessagePack等 ，本节就来介绍如何使用Jackson进行序列化。我们先来简单了解下这些格式以及Jackson。

我们还是通过Student类来演示Jackson的基本用法，格式包括 JSON、XML和Message-Pack。

序列化一个Student对象的基本代码为：

Jackson序列化的主要类是ObjectMapper，它是一个线程安全的类， 可以初始化并配置一次，被多个线程共享， SerializationFeature.INDENT_OUTPUT的目的是格式化输出，以便于阅 读。ObjectMapper的writeValueAsString方法就可以将对象序列化为字符串 ，输出为：

ObjectMapper还有其他方法，可以输出字节数组，写出到文件、 OutputStream、Writer等 ，方法声明如下：

比如，输出到文件"student.json"，代码为：

ObjectMapper怎么知道要保存哪些字段呢？与Java标准序列化机制 一样，它也使用反射，默认情况下，它会保存所有声明为public的字 段，或者有public getter方法的字段。

反序列化的代码如下所示：

使用readValue方法反序列化 ，有两个参数： 一个是输入源 ，这里是 文件student.json； 另一个是反序列化后的对象类型 ，这里是 Student.class，输出为：

说明反序列化的结果是正确的，除了接受文件，还可以是字节数组、字符串、Input-Stream、Reader等 ，如下所示：

在反序列化时，默认情况下，Jackson假定对象类型有一个无参的构 造方法，它会先调用该构造方法创建对象，然后解析输入源进行反序列化。

使用类似的代码，格式可以为XML， 唯一需要改变的是替换 ObjectMapper为Xml-Mapper。XmlMapper是ObjectMapepr的子类 ，序列 化代码为：

反序列化代码为：

类似的代码，格式可以为MessagePack， 同样使用ObjectMapper 类，但传递一个Mess-agePackFactory对象 。另外， MessagePack是二进 制格式，不能写出为String，可以写出为文件、OutpuStream或字节数组 。序列化代码为：

序列后的字节如图14-4所示。

反序列化代码为：

对于容器对象，Jackson也是可以自动处理的 ，但用法稍有不同，我 们来看下List和Map。

序列化一个学生列表的代码为：

这与序列化一个学生对象的代码是类似的，输出为：

反序列化代码不同，要新建一个TypeReference匿名内部类对象来指定类型 ，代码如下所示：

XML/MessagePack的代码是类似的 ，我们就不赘述了。

Map与List类似，序列化不需要特殊处理，但反序列化需要通过 TypeReference指定类型 ，我们看一个XML的例子。序列化一个学生Map 的代码为：

反序列化的代码为：

对于复杂一些的对象，Jackson也是可以自动处理的 ，我们让 Student类稍微复杂一些，改为如下定义：

分数改为一个Map，键为课程，ContactInfo表示联系信息，是一个 单独的类，定义如下：

构建一个ComplexStudent对象，代码为：

我们看JSON序列化，代码没有特殊的，如下所示：

XML格式的代码也是类似的，替换ObjectMapper为XmlMapper即可 ，输出为：

反序列化的代码也不需要特殊处理，指定类型为 ComplexStudent.class即可。

上面的例子中，我们没有做任何定制，默认的配置就是可以的。但 很多情况下，我们需要做一些配置， Jackson主要支持两种配置方法 。

1）注解，后续章节会详细介绍注解，这里主要是介绍Jackson一些 注解的用法。

2）配置ObjectMapper对象，ObjectMapper支持对序列化和反序列化 过程做一些配置，前面使用的SerializationFeature.INDENT_OUTPUT是 其中一种。

哪些情况需要配置呢？我们看一些典型的场景。

1）配置达到类似标准序列化中transient关键字的效果，忽略一些字段。

2）在标准序列化中，可以自动处理引用同一个对象、循环引用的 情况，反序列化时，可以自动忽略不认识的字段，可以自动处理继承多 态，但Jackson都不能自动处理，这些情况都需要进行配置。

3）标准序列化的结果是二进制、不可读的，但XML/JSON格式是 可读的，有时我们希望控制这个显示的格式。

4）默认情况下，反序列时，Jackson要求类有一个无参构造方法， 但有时类没有无参构造方法，Jackson支持配置其他构造方法。

针对这些场景，我们分别介绍。

在Java标准序列化中，如果字段标记为了transient，就会在序列化 中被忽略 ，在Jack-son中，可以使用以下两个注解之一。

·@JsonIgnore：用于字段、getter或setter方法，任一地方的效果都一 样。

·@JsonIgnoreProperties：用于类声明，可指定忽略一个或多个字 段。

比如，上面的Student类，忽略分数字段，可以为：

也可以修饰getter方法，如：

也可以修饰Student类，如：

加了以上任一标记后，序列化后的结果中将不再包含score字段，在 反序列化时，即使输入源中包含score字段的内容，也不会给score字段赋值。

我们看个简单的例子，有两个类Common和A，A中有两个Common 对象，为便于演示，我们将所有属性定义为了public，它们的类定义如下：

有一个A对象，如下所示：

a对象的first和second都指向都一个c对象 ，不加额外配置，序列化a的代码为：

输出为：

在反序列化后，first和second将指向不同的对象 ，如下所示：

那怎样才能保持这种对同一个对象的引用关系呢？可以使用注解 @JsonIdentityInfo，对Common类做注解 ，如下所示：

@JsonIdentityInfo中指定了两个属性，property="id"表示在序列化输 出中新增一个属性"id"以表示对象的唯一标示，generator表示对象唯一 ID的产生方法，这里是使用整数顺序数产生器IntSequenceGenerator。

加了这个标记后，序列化输出会变为：

注意：“first"中加了一个属性"id”，而"second"的值只是1，表示引用 第一个对象，这个格式反序列化后，first和second会指向同一个对象。

我们看个循环引用的例子。有两个类Parent和Child，它们相互引 用，为便于演示，我们将所有属性定义为了public，类定义如下：

有一个对象，如下所示：

如果序列化parent这个对象，Jackson会进入无限循环，最终抛出异常 ，解决这个问题， 可以分别标记Parent类中的child和Child类中的 parent字段，将其中一个标记为主引用，而另一个标记为反向引用，主 引用使用@JsonManagedReference，反向引用使用 @JsonBackReference ，如下所示：

加了这个注解后，序列化就没有问题了 。我们看XML格式的序列 化代码：

在输出中，反向引用没有出现。不过，在反序列化时，Jackson会自 动设置Child对象中的parent字段的值 ，比如：

输出为：老马。 说明标记为反向引用的字段的值也被正确设置了 。

在Java标准序列化中，反序列化时，对于未知字段会自动忽略，但在Jackson中，默认情况下会抛出异常 。还是以Student类为例，如果 student.json文件的内容为：

其中，other属性是Student类没有的，如果使用标准的反序列化代码：

Jackson会抛出异常：

怎样才能忽略不认识的字段呢？可以配置ObjectMapper ，如下所 示：

这样就没问题了， 这个属性是配置在整个ObjectMapper上的，如果只是希望配置Student类，可以在Student类上使用如下注解 ：

Jackson也不能自动处理多态的情况 。我们看个例子，有4个类，定 义如下，我们忽略了构造方法和getter/setter方法：

ShapeManager中的Shape列表中的对象可能是Circle，也可能是 Square 。比如，有一个ShapeManager对象，如下所示：

使用JSON格式序列化，输出为：

这个输出看上去是没有问题的，但由于输出中没有类型信息，反序 列化时，Jackson不知道具体的Shape类型是什么，就会抛出异常 。

解决方法是在输出中包含类型信息，在基类Shape前使用如下注解 ：

这些注解看上去比较多， 含义是指在输出中增加属性"type"，表示 对象的实际类型，对Circle类，使用"circle"表示其类型，而对于Square 类，使用"square" 。加了注解后，序列化输出变为：

这样，反序列化时就可以正确解析了。

对于XML/JSON格式，有时，我们希望修改输出的名称，比如对 Student类，我们希望输出的字段名变为对应的中文，可以使用 @JsonProperty进行注解 ，如下所示：

加了这个注解后，输出的JSON格式变为：

对于XML格式，一个常用的修改是根元素的名称。默认情况下， 它是对象的类名，比如对Student对象，它是"Student"，如果希望修改， 比如改为小写"student"，可以使用 @JsonRootName修饰整个类 ，如下所 示：

默认情况下，日期的序列化格式为一个长整数，比如：

序列化代码：

输出如下所示：

这个格式是不可读的，怎样才能可读呢？ 使用@JsonFormat注解 ， 如下所示：

加注解后，输出变为如下所示：

前面的Student类， 如果没有定义默认构造方法，只有如下构造方法 ：

则反序列化时会抛异常，提示找不到合适的构造方法，可以使用 @JsonCreator和@Json-Property标记该构造方法 ，如下所示：

这样，反序列化就没有问题了。

需 要说明的是，对于XML格式，Jackson的支持不是太全面 。比如， 对于一个Map<String，List>对象，Jackson可以序列化，但不能反序列化 ，如下所示：