如何再Java POJO转JSON时忽略掉一些属性

1. 前言

在Java开发中有时候某些敏感信息我们需要屏蔽掉，不能被消费这些数据的客户端知道。通常情况下我们会将其设置为或者空字符，其实还有其它办法，如果你使用了Jackson的话。接下来我将以一个实际场景来告诉你可以怎么做。

2. Jackson 如何忽略字段

这里都以 JSON 序列化为例。假如我们在业务中需要返回用户信息，已有的 POJO 是这样的：

业务场景：第三方通过用户的来获取用户的信息，但是密钥串显然不能让第三方知道，通常最容易想到的方法是将字段设置为或者。如果业务需要批量提供用户信息，即，我们总不能每次都要遍历一遍吧。Spring Boot内置的Jackson可以很方便的帮我们处理这个问题。

使用@JsonIgnore 注解

Jackson提供了一个注解，将它标记到需要被忽略的字段上或者对应的方法或者方法上就可以实现对该字段的屏蔽。就像下面这样标记：

无论是序列化(将POJO转为JSON)还是反序列化（(将JSON转为POJO），都会被忽略。

使用@JsonIgnoreProperties 注解

这个注解比更加强大一些，通常该注解标记到POJO之上，它有更多的能力：

忽略多个字段，配置属性即可。

忽略未知的属性，配置为，默认不忽略。

允许忽略字段被序列化，配置为，序列化的时候不会被忽略。

允许忽略字段被反序列化，配置为，反序列化的时候不会被忽略。

例如我们要忽略中的和，我们可以这样配置：

使用@JsonProperty 注解

需要 Jackson 版本不低于 2.6

这个注解出镜率还是非常高的，通常为了给JSON的字段起别名或者设置默认值使用。比如中的想对应JSON中的，我们可以：

在 2.6 版本以后，这个注解也能实现忽略字段的作用。它有个属性，用来指定在序列化（“读取”）和反序列化（“写”）期间访问权限（这里的读写是以属性为视角）。它由枚举定义：

从这个注解中我们可以知道，如果你想在POJO转JSON时忽略字段，就可以这么写：

使用@JsonIgnoreType 注解

这个注解是用来直接忽略类型的，如果上面的是另外一个 POJO 的属性，我们不希望它被序列化和反序列化，那么就可以：

3. 总结

目前大概可知的 Jackson 有这么四种的忽略属性的方式，它们有各自的使用场景，你可以根据自己的情况选择使用。好了今天的分享就到这里，多多关注：码农小胖哥，获取更多的编程干货。

100秒了解Session与Token

2021-01-30

Spring Security 实战干货：分布式对象SharedObject

2021-01-28