Jackson忽略字段不序列化字段的3种方法

最新推荐文章于 2025-06-25 15:18:47 发布

老谭TYH

最新推荐文章于 2025-06-25 15:18:47 发布

阅读量1.3w

点赞数 4

CC 4.0 BY-SA版权

分类专栏： Spring Boot

原文链接：https://blog.youkuaiyun.com/zhanjia/article/details/108937875

Spring Boot 专栏收录该内容

18 篇文章

订阅专栏

本文详细介绍了Jackson库中用于忽略序列化和反序列化字段的两个注解：@JsonIgnore和@JsonIgnoreProperties。@JsonIgnore适用于单个字段，而@JsonIgnoreProperties则可以忽略类中的多个字段。此外，还讲解了@JsonIgnoreType及其动态应用，通过ObjectMapper的addMixIn方法可以忽略指定类型的字段。示例代码展示了如何在序列化过程中忽略特定字段。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、为字段添加@JsonIgnore注解，可以忽略该字段的序列化和反序列化。

@JsonIgnore
private String author;

2、使用JsonIgnoreProperties注解忽略多个字段

@JsonIgnoreProperties({ "summary", "author" })
public class ArticleIgnoreProperties {

	private String title;
	private String summary;
	private String content;
	private String author;

}

JsonIgnore作用于单个字段，JsonIgnoreProperties作用于类的多个字段，两者都是用来忽略指定的字段。

除此之外，还有另外一个以JsonIgnore开头的注解JsonIgnoreType，用于忽略指定类型（类、接口）的字段。

JsonIgnoreType注解

使用JsonIgnoreType注解忽略指定类型的字段

在指定的类型上，添加@JsonIgnoreType注解，可以忽略该类型的字段进行序列化。

public class AnimalIgnoreType {

	private String name;
	private Date date;
	private Address address;

	@JsonIgnoreType
	public static class Address {
		private String city;
	}
}

使用JsonIgnoreType注解动态忽略指定类型的字段

前面使用JsonIgnoreType注解，忽略的类型是固定的。

利用ObjectMapper的addMixIn方法，可以动态的将JsonIgnoreType注解应用于其他数据类型。

public class AnimalIgnoreType {

	private String name;
	private Date date;
	private Address address;

	public static class Address {
		private String city;
		
	}

}

首先，定义一个空的类，并添加JsonIgnoreType注解。

@JsonIgnoreType
public class IgnoreType {}

在序列化时，调用ObjectMapper的addMixIn方法，将JsonIgnoreType注解应用于目标类。

下面的例子，会将IgnoreType类的注解，添加到Date和Address上，因此序列化时这两个类对应的字段会被忽略。

/**
 * 调用ObjectMapper的addMixIn方法，将@JsonIgnoreType注解应用于任意目标类.
 * 
 * @throws JsonProcessingException
 */
@Test
public void mixIn() throws JsonProcessingException {
	AnimalIgnoreType animal = new AnimalIgnoreType();
	animal.setName("sam");
	animal.setDate(new Date());
	
	AnimalIgnoreType.Address address = new AnimalIgnoreType.Address();
	address.setCity("gz");
	animal.setAddress(address);
	
	ObjectMapper mapper = new ObjectMapper();
	mapper.addMixIn(Date.class, IgnoreType.class);
	mapper.addMixIn(Address.class, IgnoreType.class);
	System.out.println(mapper.writeValueAsString(animal));
}

结果：{"name":"sam"}

《轻松学习Jackson》教程