【Java 问题 & 解决方法 · SpringBoot & Jackson】Enum类型 转JSON无法获取内部属性

一、问题描述

情景：现限制必须使用 Enum类型，协助在前后端间传递部分规范化信息，
且保证 enum 对象 内部属性可直接获取（可以使用lombok协助处理）：

@Getter
@AllArgsConstructor
enum RespCode{
	SEND_SUCCESS(200,"发送成功！"),
	SOMETHING_ERROR(400,"XXX出错！")
	;
	
	int code;
	String msg;
}

若如此简单操作，当需要将 enum 类型 转换为JSON对象时，我们只能获取到状态名称（如"SEND_SUCCESS"），无法直接找到对应的属性。

POM引入Jackson依赖（测试使用）：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.12.5</version>
</dependency>

测试代码如下：

ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(RespCode.SEND_SUCCESS);
System.out.println("JSON对象：" + json);

二、解决方法

为了能更加方便地获取属性，我们 构建方法toMap()，并加上@JsonValue注解，通过这种方法，改变JSON转化调用的方法：

@Getter
@AllArgsConstructor
enum RespCode{
	SEND_SUCCESS(200,"发送成功！"),
	SOMETHING_ERROR(400,"XXX出错！")
	;
	
	int code;
	String msg;

	@JsonValue
	public Map<String,Object> toMap(){
		Map<String,Object> map = new HashMap<>();
		map.put("code",getCode());
		map.put("msg ",getMsg());
		return map;
	}
}

再次测试，这次可直接获取到我们需要的信息：

这样可以保证前端对信息的直接使用，无需做任何处理，更加便捷。