Jackson中@JsonIgnore，@JsonValue，@JsonCreator注解作用

最新推荐文章于 2024-08-12 07:44:30 发布
最新推荐文章于 2024-08-12 07:44:30 发布
阅读量3.9k 收藏 13
点赞数 3
分类专栏： Java基础 文章标签： java jackson 注解 spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/numbbe/article/details/119110754
版权

@JsonIgnore，@JsonValue，@JsonCreator

通过具体的代码测试，来说明三者的作用。

两个名词：

序列化：实体转为Json格式，比如Controller层，返回给前端。

反序列化：Json格式数据转为实体，比如前端传递Json数据给Controller。

@JsonIgnore

注解在哪个字段上，则这个字段不会参与序列化和反序列化。

	// @JsonIgnore
	@Test
	public void test01() throws Exception {

		Student student = new Student();
		student.setId(1L);
		student.setEmail("xiaolaoben@233.com");
		student.setTelphone("12312311122");
		student.setUserName("小老犇");

		// 不加注解，效果
		String json = JacksonUtils.obj2json(student);
		System.out.println("不加注解，效果：all you(都有)" + json); // {"id":1,"userName":"小老犇","telphone":"12312311122","email":"xiaolaoben@233.com"}

//		// 加注解，序列化时，@JsonIgnore效果
		String pojotojson = JacksonUtils.obj2json(student);
		System.out.println("序列化时，效果：忽略电话字段值" + pojotojson); // {"id":1,"userName":"小老犇","email":"xiaolaoben@233.com"}

//		// 加注解，反序列化时，@JsonIgnore效果
		String jsonToPojo = "{\"id\":1,\"userName\":\"小老犇\",\"telphone\":\"12312311122\",\"email\":\"xiaolaoben@233.com\"}";
		Student pojo = JacksonUtils.json2pojo(jsonToPojo, Student.class);
		System.out.println("反序列化时，效果：忽略电话字段值" + pojo); // Student(id=1, userName=小老犇, telphone=null, email=xiaolaoben@233.com)

	}

@JsonValue

序列化时，指定将枚举字段，反序列化为什么值。

常用于枚举类中，注解在getCode()方法上，返回给前端code，数字。

	@Test
	public void test02() throws Exception {

		// 不使用注解
//		String no = JacksonUtils.obj2json(StudentEnum.FEMALE);
//		System.out.println("不使用注解，效果：同英文名" + no); // "FEMALE"

		// 使用注解
		String have = JacksonUtils.obj2json(StudentEnum.FEMALE);
		System.out.println("使用注解，效果：对应字段的值" + have);// 1002

	}

	// 开发过程中，Controller层序列化实体类，即后端to前端的过程。
	@Test
	public void test03() throws Exception {

		Student student = new Student();
		student.setId(1L);
		student.setEmail("xiaolaoben@233.com");
		student.setTelphone("12312311122");
		student.setUserName("小老犇");
		student.setSex(StudentEnum.FEMALE);

		// 不使用注解
		String no = JacksonUtils.obj2json(student);
		System.out.println("不使用注解，效果：同英文名" + no); // {"id":1,"userName":"小老犇","telphone":"12312311122","email":"xiaolaoben@233.com","sex":"FEMALE"}

		// 使用注解
		String have = JacksonUtils.obj2json(student);
		System.out.println("使用注解，效果：对应字段的值" + have);// {"id":1,"userName":"小老犇","telphone":"12312311122","email":"xiaolaoben@233.com","sex":1002}

	}

@JsonCreator

用于反序列化时，指定构造方法，可以在构造方法内部，进行业务处理，常用于枚举类中。

比如：

我们自定义的枚举类，往往是有自己的code，比如FEMALE(1002, “女性”)中的1002，相对应的前端传过来的，和数据库中存的也都是1002。

如果我们不使用JsonCreator，那么我们的1002，就会没有作用，前端传过来的数据，直接报错，反序列化失败。

不使用注解

	@Test
	public void test04() throws Exception {
	
		String no = "{\"id\":1,\"userName\":\"小老犇\",\"telphone\":\"12312311122\",\"email\":\"xiaolaoben@233.com\",\"sex\":0}";
		Student pojo = JacksonUtils.json2pojo(no, Student.class);
		System.out.println(pojo);
	}

此时，枚举中自定义的code无效，使用枚举类内置下标ordinal，从0开始排序，可以反序列化成功。

若传入code不在枚举类中默认code，则报错：

 com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type `com.huwei.system.StudentEnum` from number -1: index value outside legal index range [0..2] at [Source: (String)"{"id":1,"userName":"小老犇","telphone":"12312311122","email":"xiaolaoben@233.com","sex":-1}"; line: 1, column: 86] (through reference chain: com.huwei.system.Student["sex"])

使用注解

@Test
	public void test05() throws Exception {

		String have = "{\"id\":1,\"userName\":\"小老犇\",\"telphone\":\"12312311122\",\"email\":\"xiaolaoben@233.com\",\"sex\":1002}";
		Student student = JacksonUtils.json2pojo(have, Student.class);
		System.out.println(student);

	}

Jackson在反序列化的时候，会使用实体的默认无参构造函数来实例化一个对象，然后使用对象的setter方法来初始化属性值。

现在我们在反序列化Student类，查看控制台日志（如图）：
在这里插入图片描述
可以看出，现在@JsonCreator注解生效，反序列化Student类时，其中枚举字段的构造，走的是我们自定义的构造方法，通过处理，返回我们的枚举字段。此时，自定义的code生效。

测试代码：

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

import java.util.stream.Stream;

public enum StudentEnum {

	UNKNOWN(0, "未知"),

	MALE(1001, "男性"),

	FEMALE(1002, "女性"),

	NOMALE(1003, "妖怪");

	private String desc;

	private int code;

	StudentEnum(int code, String desc) {
		this.code = code;
		this.desc = desc;
	}

	public String getDesc() {
		return this.desc;
	}

	@JsonValue
	public Integer getCode() {
		return this.code;
	}

	@JsonCreator
	public static StudentEnum forValue(Integer value) {
		System.out.println("我在走枚举类型的自定义构造方法！");
		StudentEnum[] values = StudentEnum.values();
		return Stream.of(values).filter(it -> it.getCode().equals(value)).findAny().orElse(UNKNOWN);
	}

}

import io.swagger.annotations.ApiModelProperty;

/**
 * @author jjsai
 * @date 2021/7/11 19:05
 **/
public class Student {

	@ApiModelProperty(value = "主键")
	private Long id;

	@ApiModelProperty(value = "用户名")
	private String userName;

	@ApiModelProperty(value = "手机号")
	private String telphone;

	@ApiModelProperty(value = "邮箱")
	private String email;

	@ApiModelProperty(value = "性别")
	private StudentEnum sex;

	public Student() {
		System.out.println("我在走student的空参构造");
	}

	public Long getId() {
		return id;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public String getUserName() {
		return userName;
	}

	public void setUserName(String userName) {
		this.userName = userName;
	}

	public String getTelphone() {
		return telphone;
	}

	public void setTelphone(String telphone) {
		this.telphone = telphone;
	}

	public String getEmail() {
		return email;
	}

	public void setEmail(String email) {
		this.email = email;
	}

	public StudentEnum getSex() {
		return sex;
	}

	public void setSex(StudentEnum sex) {
		System.out.println("我在走Student类中的枚举字段sex的set方法");
		this.sex = sex;
	}

	@Override
	public String toString() {
		return "Student{" +
				"id=" + id +
				", userName='" + userName + '\'' +
				", telphone='" + telphone + '\'' +
				", email='" + email + '\'' +
				", sex=" + sex +
				'}';
	}

}

import org.junit.jupiter.api.Test;

/**
 * @author jjsai
 * @date 2021/7/11 19:01
 **/
public class JacksonTest {


	// @JsonIgnore
	@Test
	public void test01() throws Exception {
		Student student = new Student();
		student.setId(1L);
		student.setEmail("xiaolaoben@233.com");
		student.setTelphone("12312311122");
		student.setUserName("小老犇");

		// 不加注解，效果
		String json = JacksonUtils.obj2json(student);
		System.out.println("不加注解，效果：all you(都有)" + json); // {"id":1,"userName":"小老犇","telphone":"12312311122","email":"xiaolaoben@233.com"}

//		// 加注解，序列化时，@JsonIgnore效果
		String pojotojson = JacksonUtils.obj2json(student);
		System.out.println("序列化时，效果：忽略电话字段值" + pojotojson); // {"id":1,"userName":"小老犇","email":"xiaolaoben@233.com"}

//		// 加注解，反序列化时，@JsonIgnore效果
		String jsonToPojo = "{\"id\":1,\"userName\":\"小老犇\",\"telphone\":\"12312311122\",\"email\":\"xiaolaoben@233.com\"}";
		Student pojo = JacksonUtils.json2pojo(jsonToPojo, Student.class);
		System.out.println("反序列化时，效果：忽略电话字段值" + pojo); // Student(id=1, userName=小老犇, telphone=null, email=xiaolaoben@233.com)

	}

	// JsonValue
	@Test
	public void test02() throws Exception {

		// 不使用注解
		String no = JacksonUtils.obj2json(StudentEnum.FEMALE);
		System.out.println("不使用注解，效果：同英文名" + no); // "FEMALE"

		// 加上注解效果
		String have = JacksonUtils.obj2json(StudentEnum.FEMALE);
		System.out.println("使用注解，效果：对应字段的值" + have);// 1002

	}


	// 序列化实体类，即后端to前端的过程。
	@Test
	public void test03() throws Exception {
		Student student = new Student();
		student.setId(1L);
		student.setEmail("xiaolaoben@233.com");
		student.setTelphone("12312311122");
		student.setUserName("小老犇");
		student.setSex(StudentEnum.FEMALE);

		// 不使用注解
		String no = JacksonUtils.obj2json(student);
		System.out.println("不使用注解，效果：同英文名" + no); // {"id":1,"userName":"小老犇","telphone":"12312311122","email":"xiaolaoben@233.com","sex":"FEMALE"}

		// 使用注解
		String have = JacksonUtils.obj2json(student);
		System.out.println("使用注解，效果：对应字段的值" + have);// {"id":1,"userName":"小老犇","telphone":"12312311122","email":"xiaolaoben@233.com","sex":1002}

	}

	// @JsonCreator  不使用注解
	@Test
	public void test04() throws Exception {
		String no = "{\"id\":1,\"userName\":\"小老犇\",\"telphone\":\"12312311122\",\"email\":\"xiaolaoben@233.com\",\"sex\":0}";
		Student pojo = JacksonUtils.json2pojo(no, Student.class);
		System.out.println(pojo);
	}

	// @JsonCreator  使用注解
	@Test
	public void test05() throws Exception {
		String have = "{\"id\":1,\"userName\":\"小老犇\",\"telphone\":\"12312311122\",\"email\":\"xiaolaoben@233.com\",\"sex\":1002}";
		Student student = JacksonUtils.json2pojo(have, Student.class);
		System.out.println(student);
	}

}

JacksonUtils工具类网上随便找一个就好。

比如：

https://www.cnblogs.com/f-society/p/12852563.html

完事！

小老犇
关注
专栏目录
[享学Jackson] 十三、jackson-annotation注解模块全解析及Jackson注解大全
架构师：通透，才能写出好代码！
01-20 4069
`Jackson`之所以流行得益于它强大的模块化设计，以及它提供的强大能力。而支撑它强大能力的很大一部分原因是得益于它完善的注解模块：**它提供了非常多的注解，可以让你在运行期“个性化控制”你的序列化/反序列化行为，从而具有非常高的弹性**。 前面花了好几篇文章大篇幅介绍`Jackson`的`Feature`特征以及原理，如果说Feature是全局设置，那么注解就是个性化配置，因此相比较起来面向应用、面向开发者的注解， 理解它的含义以及使用方式显得更加重要，是**程序员必备的基础知识之一**。
@JsonCreator和@JsonValue
llg___的博客
11-23 2192
此时，前端传个dto（json）过来，dto里有个参数的类型是枚举类型，反序列化json成dto对象时，枚举类型的属性也会反序列化，上面@JsonCreator定义的unSerializer方法执行，就会完成参数合法性校验，Service层省事了。比如一个枚举类的get方法上加上该注解，那么在序列化这个枚举类的对象时，返回的就是枚举对象的这个属性，而不是这个枚举对象的序列化json串。一个类只能用一个，加上这个注解时，该类的对象序列化时就会只返回这个字段的值做为序列化的结果。
Jackson注解 @JsonValue
徐海兴的专栏
10-10 1万+
@JsonValue 可以用在get方法或者属性字段上，一个类只能用一个，当加上@JsonValue注解是，序列化是只返回这一个字段的值。 例如，实体类中age属性加上注解 @JsonValue private Integer age; 序列化这个类是，只返回了age的值 ...
深入解析@JsonValue注解在Java序列化中的应用
最新发布
m0_62153576的博客
08-12 492
JsonValue注解用于标记一个无参方法，该方法的返回值将作为序列化时的单一值，而不是收集对象的所有属性。通常，该注解应用于返回简单标量类型的方法，如String或Number，但也可以使用任何可序列化的类型。此外，从2.9版本开始，@JsonValue注解也可以直接应用于字段。
@JsonIgnore注解作用
热门推荐
qq_43036466的博客
05-18 2万+
@JsonIgnore注解作用 此注解是类注解，作用是json序列化时将java bean中的一些属性忽略掉，序列化和反序列化都受影响。 此注解用于属性或者方法上（最好是属性上） 生成json 时不生成age 属性 public class user { private String name; @JsonIgnore private int age; } ...
@JsonValue注解和@JsonCreator注解的使用
【折翼天使不孤单】的博客
03-19 6500
Fastxml.jackson提供了JsonValue和JsonCreator注解用于序列化和反序列化时使用. @JsonValue注解用户get方法或者属性字段上,一个类只能用一个,加上这个注解时,序列化就会只返回这一个字段的值. 比如一个枚举类的get方法上加上该注解: 那么在序列化这个枚举类时,输出的对象就是:枚举类中的某个枚举的值,而不是这个枚举 如: 如果不加这个注解且没有使用@JsonFormat注解时,经过序列化之后,输出的是这个枚举,如图: 但是在枚举类上..
@JsonIgnore的注解作用
daLxiaom的博客
02-24 229
@JsonIgnore的注解作用
2.Spring Boot 中Json的使用，Jackson注解详解
妖怪的博客
08-07 3523
- 我们常在项目中使用的Json转换工具是`fastjson`，事实上spring本身集成了非常优秀的json工具，分别为`Jackson`，`Gson`，`JSON-B`，但是官方项目中默认推荐使用Jackson，所以本文着重介绍使用Jackson进行json的转换以及Jackson的注解使用
Jackson JSON jar包
06-09
例如，你可以用`@JsonProperty`注解来标记哪些字段应该在序列化和反序列化时考虑，`@JsonIgnore`注解来忽略某些字段，或者使用`@JsonCreator`和`@JsonValue`来定义对象的构造函数和表示方式。此外，Jackson还支持...
jackson(Java JSON工具库)(3 in 1)
06-21
例如，`@JsonProperty`用于指定字段与JSON属性的映射，`@JsonCreator`和`@JsonValue`用于自定义对象实例化和转换为JSON的方式，`@JsonIgnore`则可以忽略特定字段不参与序列化和反序列化。通过使用这些注解，开发者...
Spring Boot进阶(46)：解密Spring Boot和Jackson的完美结合：打造高效的JSON序列化方案
**My Coding Family**
06-15 1219
SpringBoot如何Jackson快速入门，一文教会你。
@JsonIgnore注解的作用
huqingxiang11的博客
07-13 590
要想了解一个包或者一个注解的作用，最直接有效的办法，就是ctrl+鼠标左键，点进去，你发现，国外大佬们跟我们不一样，人家是喜欢写注释的（手动滑稽），注释里面就会详细的介绍这个包或者这个注解是干什么用的，有哪些需要注意的地方 @JsonIgnore注解 里面的注释是这样的： /** * Marker annotation that indicates that the logical property that * the accessor (field, getter/setter method or
@JsonIgnore 注解的作用
weixin_43652507的博客
03-26 1371
@JsonIgnore 注解 指定属性不返回给前端
@JsonValue @JsonCreate用法
mmdsl083的博客
01-04 1016
JsonValue作用在某个get方法，或者某个枚举类实例上，表示序列化所用的构造方法的属性，如原来默认是0，1，2，当指定某个枚举属性之后就枚举实例化传参就是1，2，3，无法再通过枚举名实例化。一般可以@JsonValue可以完成序列化的工作，但是@JsonCreate可以指定序列化失败的时候抛出的异常。@JsonCreate 注解的作用是指定反序列化的方法，枚举类默认是枚举名和默认的序号作为枚举的构造方法，
Jackson的序列化及反序列化【@JsonValue及@JsonCreator注解】
ToBeMaybe_的博客
06-03 3288
Jackson的序列化 @JsonValue注解 @JsonValue 可以用在get方法或者属性字段上，一个类只能用一个，当加上@JsonValue注解时，序列化时只返回这一个字段的值，而不是这个类的属性键值对。 Teacher.class package org.zpli.springdemo.bean; import com.fasterxml.jackson.annotation.JsonValue; import lombok.Getter; import lombok.Setter; /**
Jackson的@JsonValue和@JsonCreator注解
weixin_30432007的博客
09-23 1351
@JsonValue 可以用在get方法或者属性字段上，一个类只能用一个，当加上@JsonValue注解时，该类的json化结果，只有这个get方法的返回值，而不是这个类的属性键值对. @JsonCreator 当json在反序列化时，默认选择类的无参构造函数创建类对象，没有无参构造函数时会报错， @JsonCreator作用就是指定一个有参构造函数供反序列化时调...
浅显易懂 @JsonIgnore 的作用
孤er尽悲欢绝的博客
12-12 883
在json序列化/反序列化时将java bean中使用了该注解的属性忽略掉
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值