本文探讨了在使用jackson反序列化json到包含特定子类列表的对象时，因超类定义`@jsontypeinfo`而导致的`invalidtypeidexception`。即使目标列表已明确指定子类型，jackson仍可能期望json中包含类型标识符。文章详细介绍了如何利用jackson mixin功能，通过外部注解配置来覆盖或修改超类的反序列化行为，从而在不修改原有类结构的情况下，成功将json数据反序列化到指定的显式子类列表。
在使用Jackson进行JSON反序列化时，开发者经常会遇到将多态类型数据映射到具体Java类的问题。Jackson提供了@JsonTypeInfo和@JsonSubTypes等注解来支持多态反序列化。然而，当父类定义了类型信息（@JsonTypeInfo），而JSON数据中却缺少相应的类型标识符，同时目标对象又明确指定了子类类型时，可能会触发com.fasterxml.jackson.databind.exc.InvalidTypeIdException。
问题场景分析
考虑以下JSON结构和Java类定义：
{ "users": [{ "name": "John" }]}
以及对应的Java类：
// 父类User定义了类型信息，期望JSON中包含"type"字段@JsonTypeInfo( use = JsonTypeInfo.Id.NAME, property = "type", defaultImpl = User.class // 默认实现)@JsonSubTypes({ @JsonSubTypes.Type(name = "myUser", value = MyUser.class), @JsonSubTypes.Type(name = "guestUser", value = GuestUser.class)})@JsonInclude(JsonInclude.Include.NON_NULL)@JsonIgnoreProperties(ignoreUnknown = true)public class User { public String name;}public class MyUser extends User { // MyUser特有的字段和方法}public class GuestUser extends User { // GuestUser特有的字段和方法}// 请求类，其users列表明确指定了MyUser类型public class Request { List users; // 关键：此处限定为List，且无法修改为List // 构造函数、getter/setter等}
当尝试使用ObjectMapper将上述JSON反序列化到Request.class时：
public static void main(String[] args) { ObjectMapper mapper = new ObjectMapper(); String json = "{"users": [{"name": "John"}]}"; try { Request request = mapper.readValue(json, Request.class); System.out.println(request); } catch (Exception e) { e.printStackTrace(); }}
程序会抛出InvalidTypeIdException：
Exception in thread "main" com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id when trying to resolve subtype of [simple type, class com.example.MyUser]: missing type id property 'type' (for POJO property 'users')
这个异常的原因在于，User类上的@JsonTypeInfo注解告诉Jackson在反序列化User或其子类时，需要从JSON中查找名为type的属性来确定具体类型。然而，提供的JSON中并没有”type”字段。尽管Request类中的users字段被声明为List，明确指出了目标子类，但Jackson在处理父类User的类型信息时，仍然会优先遵循@JsonTypeInfo的指示，导致在缺少type属性时抛出异常。特别是在无法修改Request类中List为List的情况下，这个问题显得尤为棘手。
解决方案：Jackson Mixin
Jackson Mixin是一个强大的功能，它允许我们为已有的类（包括来自第三方库的类）外部地添加、修改或覆盖Jackson注解，而无需修改其源代码。这正是解决上述问题的理想方案。我们可以利用Mixins来告诉Jackson，在反序列化User类时，忽略其原有的@JsonTypeInfo设置，并默认使用MyUser作为实现类。
1. 定义Mixin接口
首先，创建一个接口（通常推荐使用接口，因为它不会被实例化，仅用于承载注解），并用@JsonTypeInfo注解来覆盖User类上的原有设置。这里的关键是设置use = JsonTypeInfo.Id.NONE，表示不使用任何属性作为类型信息，并指定defaultImpl = MyUser.class，告诉Jackson在没有类型信息时默认使用MyUser。
九歌
九歌–人工智能诗歌写作系统
322 查看详情
import com.fasterxml.jackson.annotation.JsonTypeInfo;@JsonTypeInfo( use = JsonTypeInfo.Id.NONE, // 不使用任何属性作为类型信息 defaultImpl = MyUser.class // 默认使用MyUser作为反序列化目标)public interface UserMixin { // 此接口无需包含任何方法或字段}
2. 将Mixin绑定到ObjectMapper
接下来，在创建ObjectMapper实例时，将UserMixin绑定到User类。这会告诉Jackson，在处理User类及其子类的反序列化时，应优先考虑UserMixin中定义的注解。
import com.fasterxml.jackson.databind.ObjectMapper;// ...ObjectMapper mapper = new ObjectMapper() .addMixIn(User.class, UserMixin.class);// ...
当两个类（User和UserMixin）都包含相同的注解时，Mixin中的注解将覆盖目标类（User）中的注解。
完整示例代码
现在，我们将上述概念整合到一个完整的、可运行的示例中：
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;import com.fasterxml.jackson.annotation.JsonInclude;import com.fasterxml.jackson.annotation.JsonSubTypes;import com.fasterxml.jackson.annotation.JsonTypeInfo;import com.fasterxml.jackson.databind.ObjectMapper;import java.util.List;// --- 原始类定义 (通常无法修改) ---@JsonTypeInfo( use = JsonTypeInfo.Id.NAME, property = "type", defaultImpl = User.class)@JsonSubTypes({ @JsonSubTypes.Type(name = "myUser", value = MyUser.class), @JsonSubTypes.Type(name = "guestUser", value = GuestUser.class)})@JsonInclude(JsonInclude.Include.NON_NULL)@JsonIgnoreProperties(ignoreUnknown = true)public class User { public String name; @Override public String toString() { return "User{" + "name='" + name + ''' + '}'; }}public class MyUser extends User { // MyUser特有的字段和方法 // 例如：public String myUserSpecificField; @Override public String toString() { return "MyUser{" + "name='" + name + ''' + // (myUserSpecificField != null ? ", myUserSpecificField='" + myUserSpecificField + ''' : "") + '}'; }}public class GuestUser extends User { // GuestUser特有的字段和方法 // 例如：public String guestUserSpecificField; @Override public String toString() { return "GuestUser{" + "name='" + name + ''' + // (guestUserSpecificField != null ? ", guestUserSpecificField='" + guestUserSpecificField + ''' : "") + '}'; }}public class Request { public List users; // 明确指定为List // 默认构造函数 public Request() {} // Getter和Setter (Jackson反序列化需要) public List getUsers() { return users; } public void setUsers(List users) { this.users = users; } @Override public String toString() { return "Request{" + "users=" + users + '}'; }}// --- Mixin定义 ---@JsonTypeInfo( use = JsonTypeInfo.Id.NONE, // 不使用任何属性作为类型信息 defaultImpl = MyUser.class // 默认使用MyUser作为反序列化目标)public interface UserMixin {}// --- 主测试方法 ---public class JacksonDeserializationDemo { public static void main(String[] args) { String json = """ { "users": [{ "name": "John" }] } """; try { // 创建ObjectMapper并绑定Mixin ObjectMapper mapper = new ObjectMapper() .addMixIn(User.class, UserMixin.class); // 执行反序列化 Request request = mapper.readValue(json, Request.class); // 验证结果 if (request != null && request.getUsers() != null && !request.getUsers().isEmpty()) { System.out.println("Deserialization successful. User name: " + request.getUsers().get(0).name); System.out.println("Deserialized Request object: " + request); System.out.println("Type of first user in list: " + request.getUsers().get(0).getClass().getName()); } else { System.out.println("Deserialization resulted in empty or null data."); } } catch (Exception e) { e.printStackTrace(); } }}
运行上述代码，将得到以下预期输出：
Deserialization successful. User name: JohnDeserialized Request object: Request{users=[MyUser{name='John'}]}Type of first user in list: MyUser
这表明JSON数据已成功反序列化到Request对象中的List，并且列表中的元素确实是MyUser的实例，InvalidTypeIdException也得到了避免。
总结与注意事项
Jackson Mixin的强大之处： Mixin功能使得我们能够在不修改原有类定义（尤其是当这些类来自第三方库或不可修改时）的情况下，灵活地调整Jackson的反序列化行为。覆盖策略： 当目标类和Mixin类都包含相同的Jackson注解时，Mixin中的注解会优先被使用，从而实现对原有行为的覆盖。@JsonTypeInfo(use = JsonTypeInfo.Id.NONE)： 这个设置是解决InvalidTypeIdException的关键，它明确告诉Jackson在反序列化时忽略类型标识符的存在。defaultImpl的作用： 当use = JsonTypeInfo.Id.NONE时，defaultImpl指定了在没有显式类型信息时，Jackson应该默认实例化哪个具体的子类。在本例中，由于Request的users列表已明确指定为List，defaultImpl = MyUser.class与此意图一致。适用场景： 这种方法特别适用于以下情况：父类定义了多态类型信息，但JSON数据中不包含类型标识符。目标集合或字段明确期望一个特定的子类类型。无法修改父类或包含父类引用的类（如Request类）。
通过合理运用Jackson Mixin，我们可以优雅地解决复杂的JSON反序列化问题，提高代码的灵活性和可维护性。
以上就是如何使用Jackson Mixin解决JSON到显式类的反序列化问题的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1031975.html
微信扫一扫 
支付宝扫一扫 
