SpringBoot - @JsonIgnore和@JsonIgnoreProperties注解详解以及区别

写在前面

SpringBoot - @JsonFormat注解详解

在基于Spring Boot框架的项目中，只要添加了 Web 依赖（spring-boot-starter-web），就可以很方便地实现 JSON 转换。因为该Web 依赖默认加入了 jackson-databind 作为JSON处理器，不需要要添加额外的 JSON 处理器就可以返回一段 JSON。

@JsonIgnore的作用

@JsonIgnore：注解在属性上，JSON序列化时将JAVABEAN中的标注了该注解的属性忽略掉，即后端的方法返回JSON对象时，不生成其标注的属性。

@JsonIgnoreProperties的作用

（1）@JsonIgnoreProperties，注解在类上，JSON序列化时将JAVABEAN的指定的属性忽略掉，序列化和反序列化都受影响。
@JsonIgnoreProperties({“password”})
（2）@JsonIgnoreProperties(ignoreUnknown = true)，忽略掉JSON字符串中有，而在JAVABEAN中缺未定义的属性。

与@JSONField(serialize = false)的区别

@JsonIgnore 与 @JSONField(serialize = false)的目的和作用是一样的，都是用来JSON序列化时忽略字段。
@JsonIgnore：是jackson-databind中的注解。
@JSONField(serialize = false)：是阿里巴巴的FASTJSON的注解。

如何使用

方式一：使用@JsonIgnore注解，直接标注在属性上。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private String userName;

    @JsonIgnore
    private String password;
 
    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date birthday;
}
1
2
3
4
5
6
7
8
9
10
11
12

方式二：使用@JsonIgnoreProperties注解，标注在类上。

@Data
@AllArgsConstructor
@NoArgsConstructor
@JsonIgnoreProperties({"birthday", "password"})
public class User {
    private String userName;
    private String password;
    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date birthday;
}
1
2
3
4
5
6
7
8
9
10

方式三：使用@JsonIgnoreProperties注解，标注在类上，同时设置忽略POJO中不存在的属性。

@Data
@AllArgsConstructor
@NoArgsConstructor
@JsonIgnoreProperties(value = {"password"}, ignoreUnknown = true)
public class User {
    private String userName;
    private String password;
    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date birthday;
}
1
2
3
4
5
6
7
8
9
10

常见错误

com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field "phone" (class cn.hadoopx.User), not marked as ignorable (2 known properties: "birthday", "userName"])
 at [Source: (String)"{"userName":"ROCKY","password":"1234567A","birthday":"2022-09-02","phone":"13888888888"}"; line: 1, column: 76] (through reference chain: cn.hadoopx.User["phone"])
	at com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException.from(UnrecognizedPropertyException.java:61)
	at com.fasterxml.jackson.databind.DeserializationContext.handleUnknownProperty(DeserializationContext.java:987)
	at com.fasterxml.jackson.databind.deser.std.StdDeserializer.handleUnknownProperty(StdDeserializer.java:1974)
	at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.handleUnknownProperty(BeanDeserializerBase.java:1701)
	at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.handleUnknownVanilla(BeanDeserializerBase.java:1679)
	at com.fasterxml.jackson.databind.deser.BeanDeserializer.vanillaDeserialize(BeanDeserializer.java:330)
	at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:187)
	at com.fasterxml.jackson.databind.deser.DefaultDeserializationContext.readRootValue(DefaultDeserializationContext.java:322)
	at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4593)
	at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3548)
	at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3516)
	at cn.hadoopx.Hello.main(Hello.java:29)
1
2
3
4
5
6
7
8
9
10
11
12
13
14

由于在JSON字串中新增了phone属性，而USER中未定义phone属性，所以需要设置：ignoreUnknown = true。

源码、示例及DEMO

源码、示例及DEMO