记录一个jackson使用@JsonTypeInfo实现多态反序列化问题

最新推荐文章于 2023-08-14 23:03:49 发布
最新推荐文章于 2023-08-14 23:03:49 发布
阅读量9.2k 收藏 3
点赞数 2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhouyecheng/article/details/106258279
版权

记录一个jackson使用@JsonTypeInfo实现多态反序列化问题：missing type id property '@Clazz'

异常信息

missing type id property ‘@Clazz’ (for POJO property ‘xxx’):

Caused by: com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id when trying to resolve subtype of [simple type, class com.clearofchina.uaa.model.SysUserDetail]: missing type id property '@Clazz' (for POJO property 'result')
 at [Source: (PushbackInputStream); line: 1, column: 388] (through reference chain: com.clearofchina.core.model.ResponseModel["result"])
	at com.fasterxml.jackson.databind.exc.InvalidTypeIdException.from(InvalidTypeIdException.java:43)
	at com.fasterxml.jackson.databind.DeserializationContext.missingTypeIdException(DeserializationContext.java:1771)
	at com.fasterxml.jackson.databind.DeserializationContext.handleMissingTypeId(DeserializationContext.java:1300)
	at com.fasterxml.jackson.databind.jsontype.impl.TypeDeserializerBase._handleMissingTypeId(TypeDeserializerBase.java:299)
	at com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer._deserializeTypedUsingDefaultImpl(AsPropertyTypeDeserializer.java:164)
	at com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer.deserializeTypedFromObject(AsPropertyTypeDeserializer.java:105)
	at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeWithType(BeanDeserializerBase.java:1178)
	at com.fasterxml.jackson.databind.deser.impl.MethodProperty.deserializeAndSet(MethodProperty.java:138)
	at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserializeFromObject(BeanDeserializer.java:369)
	at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:159)
	at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4218)
	at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3267)
	at org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.readJavaType(AbstractJackson2HttpMessageConverter.java:239)
	... 76 more

问题产生背景及模拟代码

在封装统一认证鉴权模块时，要给网关提供微服务调用接口，返回鉴权成功后的用户信息，用户分系统用户、渠道应用、机构用户等不同类型，最终统一封装成ResponseModel对象返回，由于不同的用户信息实现用户信息抽象出来的接口，所以用到多态。同时又有根据用户ID获取用户信息的微服务需要提供，也封装成ResponseModel对象返回。由于ResponseModel中泛型的原因，导致使用@JsonTypeInfo中的“@Class”属性丢失，产生了以上的异常。业务描述比较难懂，上代码。

  • 统一返回对象ResponseModel
package com.clearofchina.uaa.json;

import lombok.Data;

/**
 * 统一返回对象
 * 
 * @author Zhouych
 * @date 2020年5月21日 上午10:42:52
 * @since V1.0.0
 */
@Data
public class ResponseModel<T> {

	private int code;

	private String message;

	private T result;

}
  • 用户对象抽象IUserInfo，使用@JsonTypeInfo来实现反序列化时多态区分
package com.clearofchina.uaa.json;

/**
 * 用户信息抽象
 * 
 * @author Zhouych
 * @date 2020年5月21日 上午10:49:23
 * @since V1.0.0
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS,include = JsonTypeInfo.As.PROPERTY,property = "@Clazz")
public interface IUserInfo {

	/**
	 * 获取用户唯一主键
	 * 
	 * @return
	 */
	@JsonIgnore
	String getUserKey();
}
  • 系统用户信息SysUserInfo，实现IUserInfo 接口，继承了@JsonTypeInfo
package com.clearofchina.uaa.json;

import lombok.Data;

/**
 * 系统用户信息
 * 
 * @author   Zhouych
 * @date     2020年5月21日 上午10:52:15
 * @since    V1.0.0
 */
@Data
public class SysUserInfo implements IUserInfo {
	
	private Long userId;
	
	private String username;
	
	private int age;

	@Override
	public String getUserKey() {
		return String.valueOf(this.userId);
	}

}
  • 渠道应用信息：ChlAppInfo，实现IUserInfo 接口，继承了@JsonTypeInfo
package com.clearofchina.uaa.json;

import lombok.Data;

/**
 * 渠道应用信息
 * 
 * @author   Zhouych
 * @date     2020年5月21日 上午10:58:46
 * @since    V1.0.0
 */
@Data
public class ChlAppInfo implements IUserInfo {
	
	private String appKey;
	
	private String appSecret;
	
	private String name;

	@Override
	public String getUserKey() {
		return this.appKey;
	}

}
  • 鉴权成功返回信息 AuthSuccessInfo
/**
 * 鉴权成功返回信息
 * 
 * @author   Zhouych
 * @date     2020年5月21日 下午1:48:27
 * @since    V1.0.0
 */
@Data
public class AuthSuccessInfo {
	
	private String sign;
	
	private IUserInfo userInfo;

}
  • 产生问题模拟类Main
package com.clearofchina.uaa.json;

import java.util.Random;
import java.util.UUID;

import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * 
 * @author Zhouych
 * @date 2020年5月21日 上午11:00:58
 * @since V1.0.0
 */
public class Main {

	public static void main(String[] args) throws Exception {
		// 模拟服务消费端
		Main main = new Main();
		// 请求并解析数据（真实场景为通过openfeign调用api接口）
		String userInfoResponse = main.authService("xxxx");
		ObjectMapper objectMapper = new ObjectMapper();
		ResponseModel<AuthSuccessInfo> response = objectMapper.readValue(userInfoResponse,
				objectMapper.getTypeFactory().constructParametricType(ResponseModel.class, AuthSuccessInfo.class));
		System.out.println(userInfoResponse);
		System.out.println(response);
		//输出正确，没什么问题
		// {"code":200,"message":"SUCCESS","result":{"sign":"e40dfabb-1c4c-41d8-af0a-ec1af884a0c2","userInfo":{"@Clazz":"com.clearofchina.uaa.json.ChlAppInfo","appKey":"123654","appSecret":"888888","name":"微信公众号"}}}
		// ResponseModel(code=200, message=SUCCESS, result=AuthSuccessInfo(sign=e40dfabb-1c4c-41d8-af0a-ec1af884a0c2, userInfo=ChlAppInfo(appKey=123654, appSecret=888888, name=微信公众号)))

		
		// 问题出在另外有微服务要提供根据ID获取用户信息
		String sysUserInfoString = main.getSysUserInfoById(1L);
		System.out.println(sysUserInfoString);
		// {"code":200,"message":"SUCCESS","result":{"userId":1,"username":"zhangsan","age":18}}
		ResponseModel<SysUserInfo> sysUserInfo = objectMapper.readValue(userInfoResponse,
				objectMapper.getTypeFactory().constructParametricType(ResponseModel.class, SysUserInfo.class));
		System.out.println(sysUserInfo);
		// 产生异常
		/*
		 * Exception in thread "main"
		 * com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id
		 * when trying to resolve subtype of [simple type, class
		 * com.clearofchina.uaa.json.SysUserInfo]: missing type id property '@Clazz'
		 * (for POJO property 'result') at [Source:
		 * (String)"{"code":200,"message":"SUCCESS","result":{"sign":"233d310b-0b4f-4131
		 * -91ed-0989a5525546","userInfo":{"@Clazz":"com.clearofchina.uaa.json.
		 * ChlAppInfo","appKey":"123654","appSecret":"888888","name":"微信公众号"}}}"; line:
		 * 1, column: 203] (through reference chain:
		 * com.clearofchina.uaa.json.ResponseModel["result"]) at
		 * com.fasterxml.jackson.databind.exc.InvalidTypeIdException.from(
		 * InvalidTypeIdException.java:43) at
		 * com.fasterxml.jackson.databind.DeserializationContext.missingTypeIdException(
		 * DeserializationContext.java:1771) at
		 * com.fasterxml.jackson.databind.DeserializationContext.handleMissingTypeId(
		 * DeserializationContext.java:1300) at
		 * com.fasterxml.jackson.databind.jsontype.impl.TypeDeserializerBase.
		 * _handleMissingTypeId(TypeDeserializerBase.java:299) at
		 * com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer.
		 * _deserializeTypedUsingDefaultImpl(AsPropertyTypeDeserializer.java:164) at
		 * com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer.
		 * deserializeTypedFromObject(AsPropertyTypeDeserializer.java:105) at
		 * com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeWithType
		 * (BeanDeserializerBase.java:1178) at
		 * com.fasterxml.jackson.databind.deser.impl.MethodProperty.deserializeAndSet(
		 * MethodProperty.java:138) at
		 * com.fasterxml.jackson.databind.deser.BeanDeserializer.vanillaDeserialize(
		 * BeanDeserializer.java:288) at
		 * com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(
		 * BeanDeserializer.java:151) at
		 * com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.
		 * java:4218) at
		 * com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3214)
		 * at com.clearofchina.uaa.json.Main.main(Main.java:38)
		 */
	}

	/**
	 * 模拟服务提供方提供的鉴权服务：模拟http请求响应json数据
	 * 
	 * @param token
	 * @return
	 * @throws Exception
	 */
	public String authService(String token) throws Exception {
		Random random = new Random();
		ObjectMapper objectMapper = new ObjectMapper();
		AuthSuccessInfo result = new AuthSuccessInfo();
		if (random.nextBoolean()) {
			SysUserInfo userInfo = new SysUserInfo();
			userInfo.setAge(18);
			userInfo.setUsername("zhangsan");
			userInfo.setUserId(1L);
			result.setSign(UUID.randomUUID().toString());
			result.setUserInfo(userInfo);
		} else {
			ChlAppInfo userInfo = new ChlAppInfo();
			userInfo.setAppKey("123654");
			userInfo.setAppSecret("888888");
			userInfo.setName("微信公众号");
			result.setSign(UUID.randomUUID().toString());
			result.setUserInfo(userInfo);
		}
		ResponseModel<AuthSuccessInfo> response = new ResponseModel<>();
		response.setCode(200);
		response.setMessage("SUCCESS");
		response.setResult(result);
		return objectMapper.writeValueAsString(response);
	}
	
	/**
	 * 模拟服务提供方提供的查询用户信息服务：模拟http请求响应json数据
	 * 
	 * @param userId
	 * @return
	 * @throws Exception
	 */
	public String getSysUserInfoById(Long userId) throws Exception {
		SysUserInfo userInfo = new SysUserInfo();
		userInfo.setAge(18);
		userInfo.setUsername("zhangsan");
		userInfo.setUserId(userId);
		ObjectMapper objectMapper = new ObjectMapper();
		ResponseModel<SysUserInfo> response = new ResponseModel<>();
		response.setCode(200);
		response.setMessage("SUCCESS");
		response.setResult(userInfo);
		return objectMapper.writeValueAsString(response);
	}

}

解决方法

产生问题的原因是，由于反序列化多态的需要，添加了@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS,include = JsonTypeInfo.As.PROPERTY,property = “@Clazz”)这个注解，但由于ResponseModel里T result是泛型，序列化SysUserInfo为json字符串时，“@Clazz”属性丢失，导致反序列化时取@Clazz属性时无法找到。

  1. 解决方法一：既然是序列化时少了“@Clazz”属性，那就添上
    修改的IUserInfo类
package com.clearofchina.uaa.json;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonProperty.Access;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

/**
 * 用户信息抽象
 * 
 * @author Zhouych
 * @date 2020年5月21日 上午10:49:23
 * @since V1.0.0
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@Clazz")
public interface IUserInfo {

	/**
	 * 获取用户唯一主键
	 * 
	 * @return
	 */
	@JsonIgnore
	String getUserKey();

	/**
	 * 强行添加"@Clazz"属性
	 * 
	 * @return
	 */
	@JsonProperty(value = "@Clazz", access = Access.READ_ONLY)
	String getClazz();
}

对应的两个实现类SysUserInfo和ChlAppInfo实现该方法即可：

package com.clearofchina.uaa.json;

import lombok.Data;

/**
 * 渠道应用信息
 * 
 * @author   Zhouych
 * @date     2020年5月21日 上午10:58:46
 * @since    V1.0.0
 */
@Data
public class ChlAppInfo implements IUserInfo {
	
	private String appKey;
	
	private String appSecret;
	
	private String name;

	@Override
	public String getUserKey() {
		return this.appKey;
	}

	@Override
	public String getClazz() {
		return this.getClass().getName();
	}

}



package com.clearofchina.uaa.json;

import lombok.Data;

/**
 1. 系统用户信息
 2. 
 3. @author   Zhouych
 4. @date     2020年5月21日 上午10:52:15
 5. @since    V1.0.0
 */
@Data
public class SysUserInfo implements IUserInfo {
	
	private Long userId;
	
	private String username;
	
	private int age;

	@Override
	public String getUserKey() {
		return String.valueOf(this.userId);
	}

	@Override
	public String getClazz() {
		return this.getClass().getName();
	}
}

此次有个注意的点，就是添加“@Clazz”属性后，反序列化字符串中会把“@Clazz”带到反序列化器，所以要添加@JsonIgnoreProperties(ignoreUnknown = true)注解忽略掉位置属性。

  1. 解决方法二：在具体实现类使用@JsonTypeInfo覆盖掉接口类的@JsonTypeInfo，并添加默认实现属性，如下：
package com.clearofchina.uaa.json;

import com.fasterxml.jackson.annotation.JsonTypeInfo;

import lombok.Data;

/**
 * 系统用户信息
 * 
 * @author   Zhouych
 * @date     2020年5月21日 上午10:52:15
 * @since    V1.0.0
 */
@Data
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, defaultImpl = SysUserInfo.class)
public class SysUserInfo implements IUserInfo {
	
	private Long userId;
	
	private String username;
	
	private int age;

	@Override
	public String getUserKey() {
		return String.valueOf(this.userId);
	}

//	@Override
//	public String getClazz() {
//		return this.getClass().getName();
//	}
}
Zhouyecheng
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
PolymorphicJackson:Jackson 多态反序列化示例，适用于外部类类型
07-11
多态杰克逊 Jackson 多态反序列化示例，适用于外部类类型
redisson get()数据报错,missing type id property ‘@class’
了迹奇有没
11-29 1万+
redisson get()数据报错： com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id when trying to resolve subtype of [simple type, class java.lang.Object]: missing type id property ‘@class’ 详细报错信息如下： com.fasterxml.jackson.databind.exc.Invalid
Jackson里使用@JsonTypeInfo注解处理多态类型的序列化和反序列化
Jaemon
12-23 1万+
Jackson里使用@JsonTypeInfo注解处理多态类型的序列化和反序列化
@JsonTypeInfo 处理多态、序列化对象类型
赵丙双的博客
05-05 4702
@JsonTypeInfo 处理多态使用 @JsonTypeInfo@JsonTypeInfo 用于字段上include = WRAPPER_OBJECT、WRAPPER_ARRAYJsonTypeInfo.As.WRAPPER_OBJECTJsonTypeInfo.As.WRAPPER_ARRAY使用 ObjectMapper.activateDefaultTyping()原文链接 在 JSON 中存在多态类型的情况下，Jackson 无法在反序列化期间找出正确的类型。让我们通过一个例子来理解它。 pub
redis反序列化问题 missing type id property ‘@class‘
aayygg1234的专栏
03-06 4680
redis反序列化问题 com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id when trying to resolve subtype of [simple type, class java.lang.Object]: missing type id property '@class'
【工作中问题解决实践 九】使用@JsonTypeInfo实现请求数据对象多态
MaoLin Tian's Blog
08-14 1450
JsonTypeInfo注解的使用可以降低同一类数据处理接口的提供数量，调用方可以只调用一个接口，接口内部可以依据调用方组装的Model和内置参数确定处理逻辑，扩展性和易用性都很强，在数据同步的场景里挺值得一用的。
Jackson注解 @JsonTypeInfo 解决多态反序列化问题
徐海兴的专栏
10-11 1万+
@JsonTypeInfo 主要是用来解决反序列化时，多态的问题。 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS,include = JsonTypeInfo.As.PROPERTY,property = "@Clazz") //@JsonSubTypes({@JsonSubTypes.Type(value = Lion.class,name = "lio...
@JsonTypeInfo 逻辑名称 @JsonSubTypes、@JsonTypeName
赵丙双的博客
05-05 7201
@JsonTypeInfo 逻辑名称 @JsonSubTypes、@JsonTypeName@JsonTypeName@JsonSubTypeExampleJava ObjectsSerializing and deserializinginclude = JsonTypeInfo.As.WRAPPER_OBJECT原文链接 @JsonTypeInfo 的 use = JsonTypeInfo.Id.CLASS，会将完全限定类名序列化为类型标识符。当非 Java 客户端使用被序列化的 JSON 时，Java
@TypeDiscriminator注解实现多态对象的查询，jackson @JsonTypeInfo注解实现controller多态支持
12-07
用一个最最简单的例子，来讲解：使用Springboot @TypeDiscriminator注解实现多态对象的查询，jackson @JsonTypeInfo注解实现controller多态支持。
fastJSON：最小，最快的多态JSON序列化程序
02-03
最小，最快的多态JSON序列化器 请参阅此处的文章：[ ]（ ） 另请参阅 安全警告 HP Enterprise Security Group引起了我的注意，使用$type扩展名可能会导致不安全，因此，应将其与常识和已知的json来源一起使用，而...
serialisation:json-xml序列化-反序列化多态
05-17
对象的标识实现如下：*每个序列化的对象必须具有唯一的标识符（“ id”属性），并且在图形中是唯一的*如果对象是不具有此“ id”属性的类的实例， ，系统会自动为其分配一个UUID（创建“ id”伪属性）。 对于反序列...
Jackson多态序列化.doc
07-13
Jackson多态序列化.doc
Jackson控制多态的注解--JsonTypeInfo,JsonSubTypes,JsonTypeName
weixin_30263277的博客
07-25 1399
让我们看Jackson控制多态的注解： @JsonTypeInfo – indicates details of what type information to include in serialization 指出序列化包含的类型信息细节 @JsonSubTypes – indicates sub-types of the annotated type 指出被注解类型的子类 ...
Redis集成SpringCache获取缓存值报错：com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id
热门推荐
富强说
03-08 1万+
Redis集成获取缓存值报错： com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id when trying to resolve subtype of [simple type, class java.lang.Object]: missing type id property '@class' 这里...
Redis反序列化报错
qq_41063367的博客
07-06 1833
redis使用GenericJackson2JsonRedisSerializer反序列化报错： nested exception is org.springframework.data.redis.serializer.SerializationException: Could not read JSON: Missing type id when trying to resolve subtype of [simple type, class java.lang.Object]
SpringBoot使用redisTemplate时报错：Caused by: com.fasterxml.jackson.databind.exc.InvalidTypeIdException
baoliwan的博客
03-02 1597
在使用 redisTemplate.opsForHash().entries("key");获取键值对的时候报错的解决方法
Java Jackson @JsonTypeInfo 多态类型处理
weixin_51078837的博客
01-08 1858
jackson允许配置多态类型处理，当进行反序列话时，JSON数据匹配的对象可能有多个子类型，为了正确的读取对象的类型，我们需要添加一些类型信息。可以通过下面几个注解来实现： @JsonTypeInfo 作用于类/接口，被用来开启多态类型处理，对基类/接口和子类/实现类都有效 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME,include = JsonTypeInfo.As.PROPERTY,property = “name”) 这个注解有一些属性: use:定义使用哪一种
@class 的使用
CG-L 的技术博客
03-21 304
注意：@class 还可以解决头文件互相引用问题！
ASP.NET技术在网站开发设计中的研究与开发(论文+源代码+开题报告)【ASP】.zip
最新发布
06-06
ASP.NET技术在网站开发设计中的研究与开发(论文+源代码+开题报告)【ASP】
C++中用继承的方法创建一个类，初步实现多态操作
05-05
在 C 语言中，没有类的概念，也没有继承的语法。但是我们可以通过结构体和函数指针来模拟类和实现多态操作。下面是一个示例代码： ```c #include <stdio.h> typedef struct { const char* (*speak)(); } Animal; const char* animal_speak(Animal* animal) { return animal->speak(); } typedef struct { Animal base; const char* name; } Dog; const char* dog_speak() { return "Woof!"; } Dog* create_dog(const char* name) { Dog* dog = malloc(sizeof(Dog)); dog->base.speak = (const char* (*)())dog_speak; dog->name = name; return dog; } int main() { Animal* animal = (Animal*)create_dog("Fido"); printf("%s says %s\n", ((Dog*)animal)->name, animal_speak(animal)); return 0; } ``` 在这个例子中，使用了 `typedef` 关键字来定义了两个结构体 `Animal` 和 `Dog`。`Animal` 结构体包含了一个函数指针 `speak`，用于实现多态操作。`Dog` 结构体继承了 `Animal` 结构体，并添加了一个 `name` 字段。`create_dog` 函数用于创建一个 `Dog` 对象，并将其强制转换成 `Animal` 对象，以便于使用 `animal_speak` 函数进行多态调用。最后，在 `main` 函数中调用了 `animal_speak` 函数，实现了多态操作。 需要注意的是，这种方式虽然可以模拟类和实现多态操作，但是与真正的面向对象编程语言相比，还是有很大的差距，因为它缺乏了很多面向对象编程语言的特性，如封装、继承、多态等。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值