Jackson问题汇总

前言

常见的json框架有：Jackson，FasJson（阿里的，万年没更新，积累了大量issue），Gson（谷歌的）。其中Jackson效率最高，性能最好，最为常用。本文基于 2.11.3 版本的Jackson。

Jackson在1.x版本使用的包名是 codehaus ，后来升级到2.x版本时，为了和旧版本区分开来，采用了新的包名 fasterxml 。有这种类似操作的还有Log4j和Log4j2，在使用时需要注意引入的包名，避免混用版本或误用版本。

Jackson可以轻松的将Java对象转换成json对象和xml文档（即序列化），同样也可以将json、xml转换成Java对象（即反序列化）。

序列化日期字段的时区问题

在将日期转为字符串时会使用 @JsonFormat 注解，默认使用零时区，因此在使用时要注意时区问题。比如项目部署在中国境内的服务器（东八区时区），不注意时区问题可能会导致json中的时间和预期的差距8个小时。

实际开发中，假如存在多个不同时区的客户，通常是把客户所在的时区时间转换为零时区，然后存入到数据库中。这样项目从数据库读取到的时间就是零时区，再根据客户所在时区修改显示在前端页面的时间。这样比较灵活，不怕时间字段的值发生混乱，不易管理。

在格式化成json时注解如下：

另外， @DatetimeFormat 是spring提供的一个注解，用以将日期转为String，提供给前端使用。

序列化时重命名字段

可以使用 @JsonProperty 来重命名字段， @JsonProperty 能够在序列化和反序列化时给字段映射到指定的名字：

如上， updateUserName 在序列化为json时会被重命名为 updatedBy ，在反序列化时json中 updatedBy 的值会被映射到 updateUserName 。

将这个注解和MapStruct映射框架结合起来，可以通过定义 @JsonProperty 来避免额外定义MapStruct框架的不同名字段映射规则；比如： @Mapping(source = "updateUserName", target = "updatedBy")

还有个类似的注解 @JsonAlias ，其作用是给字段起别名，只在 反序列化 阶段有效，可以让字段接受更多的映射名称：

如上，在反序列化时，json中的 updatedBy 或者 updateUserName 都可以映射到pojo的 updateUserName 字段上。

序列化忽略指定的字段

按照字段进行忽略

可以使用 @JsonIgnore 或者 @JsonIgnoreProperties 来忽略字段， @JsonIgnoreProperties 比前者多了一个使用方式，那就是加在类上：

按照字段的值进行忽略

上述两个注解会直接忽略指定的字段，如果想忽略满足某个条件的字段，比如忽略值为null的字段，或者值为0的数值型字段等，可以用 @JsonInclude 注解。

@JsonInclude 用来指定序列化时需要包括哪些字段，本身提供了多种策略：ALWAYS、NON_NULL、NON_EMPTY等。如果需要自定义包括字段的策略，方式如下：

pojo的循环依赖导致序列化时无限递归

当多个pojo之间存在循环依赖时，在序列化时会无限递归，最终堆栈溢出 StackOverflowError 。pojo如下：

上述的pojo在序列化时会互相引用、无限递归，因此需要打断这个循环链。

经过本人测试，其他博客中提及的 @JsonManagedReference 和 @JsonBackReference 并无效果，至少在多对多的关联关系中不起效（一对多没有测试）。

使用 @JsonIgnore

直接在其中一方的字段上加上 @JsonIgnore ，这样在序列化时该字段就会被忽略，自然也就不会互相引用无限递归了。比如对于Vendor的序列化，可以将VendorFact里的vendor变量忽略：

不过这个方案有个缺点，就是序列化后的json中只有一方持有另一方，在另一方的json中无法持有对方，在一对多或者多对多的情况中并不便利。比如上面的方式，虽然Vendor可以正常序列化了，但是Fact依然不能正常序列化。而在序列化VendorFact时，也缺少了vendor的信息。

当然有个方案是，为每一方都单独创建一套对应的dto来进行序列化，这样的话虽然类的数量变多了，但是可以解决多对多关系中只有一方能序列化的问题。比如上面的例子，需要两个VendorFact的dto类，各自对应Vendor和Fact。不过在序列化VendorFact时，依然缺少另一方的信息。不过正常情况下不会单独去序列化作为中间表的VendorFact，因此不予考虑这个缺点。

此外，和 @JsonIgnore 效果类似的 @JsonIgnoreProperties ，也能起到一样的效果，但是这个注解如果添加在集合变量上是无效的，如下：

自定义对象的序列化和反序列化

有时候只靠默认的序列化方式，或者常规的json注解，难以实现某个对象的序列化要求。比如，现在需要对一个HashMap对象进行序列化，这个对象中的字段和类型是未知的，此时可以用 @JsonSerialize 和 @JsonDeserialize 来控制序列化和反序列化。