Jackson多态序列化图文详解
场景
做一个消息中心,专门负责发送消息。消息分为几种渠道,包括手机通知(Push)、短信(SMS)、邮件(Email),Websocket等渠道。
我定义了一个基类MessageRequest
用来接收请求参数,代码如下:
public class MessageRequest implements Serializable { protected MessageChannel channel; private MessageRequest(){} protected MessageRequest(MessageChannel channel){ this.channel = channel; } public MessageChannel getChannel() { return this.channel; } }
在MessageRequest
中有个属性channel
是枚举MessageChannel
,该枚举列举所有渠道,代码如下:
public enum MessageChanne { PUSH, EMAIL, WEBSOCKET, SMS, ; MessageChannel() {} }
MessageRequest
有各种渠道的子类实现,以Push为例:
public class PushMessageReuqest extends MessageRequest { public PushMessageRequest() { super(MessageChannel.PUSH); } private String title; // 省略其他字段以及getter、setter方法 ... }
我在接口入参使用MessageRequest
接收:
public class MessageController { @PostMapping("/sendMessage") public R<Object> sendMessage(MessageRequest request) { System.out.println(request); } }
使用postman发送push请求之后发现后端收到的类型还是基类,并且title字段丢失。
这与我预想的不符,因为客户端知道渠道,构建对应的渠道消息体给我就好了啊!为什么类型被擦除了呢?我的想法就是发送push请求啊。。。。。后来才知道序列化之后在反序列化的时候不知道给你反序列化成什么类型,序列化工具也没有聪明到能根据你的channel属性就知道是什么类型,但是我又想这样做。那么怎么办呢????
Jackson多态类型序列化/反序列化
经过查询资料以及咨询了一下领导,发现了@JsonTypeInfo
和@JsonSubTypes
两个注解。
@JsonTypeInfo
作用于类/接口,被用来开启多态类型处理,它有一些属性:
- use(必选):定义使用哪一种类型标识码,有以下几个可选项。
NONE
:不使用识别码CLASS
:使用完全限定类名做识别码MINIMAL_CLASS
:使用类名(忽略包名)做识别码,和基类在同一个包可用NAME
:指定名称CUSTOM
:自定义识别码,由@JsonTypeIdResolver
对应
- include(可选):指定识别码如何被包含进去,有以下几个可选项。
PROPERTY
:作为兄弟属性加入,默认值WRAPPER_OBJECT
:作为一个包装的对象WRAPPER_ARRAY
:作为包装的数组EXTERNAL_PROPERTY
:作为扩展属性EXISTING_PROPERTY
:作为已存在的属性(符合我的场景,用channel)
- property(可选):指定识别码的属性名称。该属性只有当
use
为CLASS(不指定默认为@class
)、MINIMAL_CLASS(不指定默认为@c
)、NAME(不指定默认为@type
,include
为PROPERTY、EXISTING_PROPERTY、EXTERNAL_PROPERTY时才有效。 - defaultImpl(可选):如果类型识别码不存在或者无效,可以使用该属性来指定反序列化时使用的默认类型。
- visible(可选,默认false):属性定义了类型标识符是否会成为反序列化器的一部分,默认为false,也就是说Jackson会从json内容中删除类型标识再传递给JsonDeserializer。
@JsonSubTypes
作用于类/接口,用来列出给定类/接口的子类。一般配合@JsonTypeInfo
使用
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "channel") @JsonSubTypes({ @JsonSubTypes.Type(value = PushMessageRequest.class, name = "PUSH"), @JsonSubTypes.Type(value = EmailMessageRequest.class, name = "EMAIL") })
JsonSubTypes
的值是一个@JsonSubTypes.Type[]
数组,参数value
表示类型,参数name
表示@JsonTypeInfo
注解中property
属性的值,对比以上代码即:channel = "PUSH"或channel = "EMAIL"。name
为可选值,不指定时需在子类提供JsonTypeName
注解并指定value
属性。
实战
改造上面提供的MessageReuqest
// include默认为PROPERTY,这里可以不加 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "channel") @JsonSubTypes({ @JsonSubTypes.Type(value = PushMessageRequest.class, name = "PUSH"), @JsonSubTypes.Type(value = EmailMessageRequest.class, name = "EMAIL") }) public class MessageRequest implements Serializable { protected MessageChannel channel; private MessageRequest(){} protected MessageRequest(MessageChannel channel){ this.channel = channel; } public MessageChannel getChannel() { return this.channel; } }
此时通过postman请求发现入参类型有了变化
include属性使用默认的PROPERTY时发现序列化之后的json会多出来一个属性,属性名对应的就是@JsonTypeInfo
的property
的值。虽然不影响使用,但是我看着很不舒服。基于我这种情况可以使用include=EXISTING_PROPERTY
。
总结
到此这篇关于Jackson多态序列化的文章就介绍到这了,更多相关Jackson多态序列化内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
原文出处:https://www.cnblogs.com/lvbok/p/16330663.html
相关文章
Jackson反序列化@JsonFormat 不生效的解决方案
这篇文章主要介绍了Jackson反序列化@JsonFormat 不生效的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-08-10- 这篇文章主要介绍了解决Golang json序列化字符串时多了\的情况,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-12-24
- 序列化是一种对象持久化的手段,普遍应用在网络传输、RMI等场景中,这篇文章主要给大家总结介绍了关于java序列化与反序列化的使用方法,文中通过示例代码介绍的非常详细,需要的朋友可以参考下...2021-07-29
- 这篇文章主要介绍了C#使用虚拟方法实现多态,涉及C#多态的实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25
- 下面小编就为大家带来一篇protobuf对象二进制序列化存储(详解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2020-06-25
- 经常看到一些配置文件里面存放的是一些类似带有格式的变量名称和值,其实就是一个序列化的过程,在需要用到这些数据库的时候会进行一个反序列化过程,就是将这个字符串再还原成他原来的数据结构。下面说说php 如何进行数据...2015-10-30
- 这篇文章主要介绍了C#实现的json序列化和反序列化代码实例,本文讲解了两种实现方法,并直接给出代码示例,需要的朋友可以参考下...2020-06-25
- 这篇文章主要介绍了C#实现的序列化通用类,实例分析了C#序列化与反序列化操作相关技巧,需要的朋友可以参考下...2020-06-25
- 这篇文章主要介绍了Springboot中如何使用Jackson,帮助大家更好的理解和使用springboot框架,感兴趣的朋友可以了解下...2020-11-07
jackson json序列化实现首字母大写,第二个字母需小写
这篇文章主要介绍了jackson json序列化实现首字母大写,第二个字母需小写方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-06-29- 这篇文章主要介绍了Jackson 反序列化时实现大小写不敏感设置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-06-29
- 在这篇文章中,我们将会学到如何使用C#,来序列化对象成为Json格式的数据,以及如何反序列化Json数据到对象。...2020-06-25
- 这篇文章主要介绍了C#中Serializable序列化,以实例形式详细讲述了系列化的技术及各种序列化方法,非常具有实用价值,需要的朋友可以参考下...2020-06-25
- 这篇文章主要介绍了C#实现复杂XML的序列化与反序列化的方法,是非常实用的一个技巧,需要的朋友可以参考下...2020-06-25
- 下面小编就为大家带来一篇用序列化实现List<T> 实例的深复制(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2020-06-25
- 这篇文章主要介绍了javascript中from 表单序列化提交的实现方法,代码简单易懂,非常不错,需要的朋友参考下吧...2017-01-23
深入分析XmlSerializer对象的Xml序列化与反序列化的示例详解
本篇文章是对XmlSerializer 对象的Xml序列化与反序列化的应用进行了详细的分析介绍,需要的朋友参考下...2021-09-22- 这篇文章主要介绍了Python实现序列化及csv文件读取,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-04-22
- 这篇文章主要介绍了.Net中的序列化和反序列化详解的相关资料,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了C# 三种序列化方法,需要的朋友可以参考下...2020-06-25