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 json序列化 首字母大写 第二个字母需小写
有这样一个类: @Setter @Getter @JsonNaming(value = PropertyNamingStrategy.UpperCamelCaseStrategy.class) pub ...
- JSON类库Jackson优雅序列化Java枚举类
1. 前言 在Java开发中我们为了避免过多的魔法值,使用枚举类来封装一些静态的状态代码.但是在将这些枚举的意思正确而全面的返回给前端却并不是那么顺利,我们通常会使用Jackson类库序列化对象为JS ...
- 【Springboot】FastJson与Jackson全局序列化方式的配置和相关工具类
springboot 版本: <parent> <groupId>org.springframework.boot</groupId> <artifactId ...
- 20151024_004_C#基础知识(C#中的访问修饰符,继承,new关键字,里氏转换,is 和 as,多态,序列化与反序列化)
1:C#中的访问修饰符 public: 公共成员,完全公开,没有访问限制. private: 私有的,只能在当前类的内部访问. protected: 受保护的,只能在当前类的内部以及该类的子类中访问. ...
- spring boot 是如何利用jackson进行序列化的?
接上一篇:spring boot 是如何利用jackson进行反序列化的? @RestController public class HelloController { @RequestMapping ...
- json多态序列化
https://blog.csdn.net/java_huashan/article/details/46428971 https://blog.csdn.net/bruce128/article/d ...
- jackson对多态or多子类序列化的处理配置
[TOC] Jackson Jackson可以轻松的将Java对象转换成json对象和xml文档,同样也可以将json.xml转换成Java对象. 多态类型的处理 jackson允许配置多态类型处理, ...
- Jackson对多态和多子类序列化的处理配置
目录 Jackson 多态类型的处理 Jackson Jackson可以轻松的将Java对象转换成json对象和xml文档,同样也可以将json.xml转换成Java对象. 多态类型的处理 jacks ...
- Jackson 序列化和反序列化
博客地址:https://www.moonxy.com 一.前言 Jackson 功能很强大,既能满足简单的序列化和反序列化操作,也能实现复杂的.个性化的序列化和反序列化操作.到目前为止,Jackso ...
随机推荐
- 【Android开发】【布局】各种TabLayout样式
Demo
- parseFloat的取值
<script type="text/javascript"> document.write(parseFloat("10")) document. ...
- 93. 复原 IP 地址
做题思路or感想 这种字符串切割的问题都可以用回溯法来解决 递归三部曲: 递归参数 因为要切割字符串,所以要用一个startIndex来控制子串的开头位置,即是会切割出一个范围是[startIndex ...
- 【代码大全2 学习笔记】ADT 抽象与封装
ADT abstract data type 抽象数据类型 要理解面向对象编程,就要先理解ADT这个概念.不懂ADT的程序员开发出来的类只是名义上的"类"而已--只是单纯的把一些相 ...
- flex布局 一行4个元素 后面不够4个元素对齐
html 父元素 .container { display: flex; flex-wrap: wrap;} 子元素.list { width: 24%; height: 100px; backgro ...
- 简单了解AndroidManifest.xml文件
AndroidManifest.xml:资源清单文件 <?xml version="1.0" encoding="utf-8"?> <mani ...
- Vue_transition动画
1 <!DOCTYPE html> 2 <html lang="en" xmlns:v-on="http://www.w3.org/1999/xhtml ...
- PostgreSQL与PostGIS安装使用时需要注意的坑
最近些许繁忙,没有时间系统整理PostgreSQL和PostGIS的安装和使用方法.所以就简单记录一下遇到的坑. 1.找不到 libintl-9.dll 我安装的PostgreSQL版本是11.7,P ...
- XCTF练习题---MISC---小小的PDF
XCTF练习题---MISC---小小的PDF flag:SYC{so_so_so_easy} 解题步骤: 1.观察题目,下载附件 2.下载完发现是一个PDF文件,经过转Word,查看属性,十六进制查 ...
- 【前端干货】别再羡慕别人的Excel啦,教你点击按钮直接打开侧边栏!
负责技术支持的葡萄又来啦. 三日不见,我们的客户又为我们发来新的问题. 这次我们需要实现的场景是在前端表格环境中,像模板按钮那样,点击之后弹出一个侧边栏,然后通过点击不同的单元格显示不同的内容. 挤接 ...