SpringMVC Json自定义序列化和反序列化的操作方法

需求背景

需求一:SpringMVC构建的微服务系统,数据库对日期的存储是Long类型的时间戳,前端之前是默认使用Long类型时间,现在前端框架改动,要求后端响应数据时,Long类型的时间自动变成标准时间格式(yyyy-MM-dd HH:mm:ss)。

涉及到这个转换的范围挺大,所有的实体表都有创建时间createTime和修改时间updateTime,目前的主要诉求也是针对这两个字段,并且在实体详情数据和列表数据都存在,需要一个统一的方法,对这两个字段进行处理。

需求二:前端请求上传的JSON报文,String类型的内容,可能会出现前后有空格的现象,如果前端框架未对此问题进行处理,后端收到的JSON请求反序列化为对象时,就会出现String类型的值,前后有空格,现需要一个统一的处理方法,对接收的String类型属性执行trim方法。

解决方案

SpringMVC默认的JSON框架为jackson,也可以使用fastjson。

jackson框架

自定义序列化

如果项目使用jackson框架做json序列化,推荐的方案是使用@JsonSerialize注解,示例代码如下:

@JsonSerialize(using = CustomDateSerializer.class)
private Long createTime;

@JsonSerialize(using = CustomDateSerializer.class)
private Long updateTime;

CustomDateSerializer类的实现示例如下:

public class CustomDateSerializer extends JsonSerializer<Long> {

 @Override
 public void serialize(Long aLong, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
  SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  Date date = new Date(aLong);
  jsonGenerator.writeString(sdf.format(date));
 }
}

这种方案的好处如下:

  • 自定义的实现类可以复用
  • 精准到需要转换处理的字段,不受限于createTime和updateTime,更贴近于需求

缺点就是需要转换的字段都需要使用注解,工作量有点大

当然有其他的统一处理方案,这里不赘述。

自定义反序列化

在jackson框架上实现自定义序列化,也是非常方便的,继承SimpleModule类即可:

@Component
public class StringTrimModule extends SimpleModule {

 public StringTrimModule() {
  addDeserializer(String.class, new StdScalarDeserializer<String>(String.class) {
   @Override
   public String deserialize(JsonParser jsonParser, DeserializationContext ctx) throws IOException {
    String value = jsonParser.getValueAsString();
    if (StringUtils.isEmpty(value)) {
      return value;
    }
    return value.trim();
   }
  });
 }
}

fastjson框架

如果工程里出现这个依赖:

<dependency>
 <groupId>com.alibaba</groupId>
 <artifactId>fastjson</artifactId>
 <version>1.2.62</version>
</dependency>

说明此工程使用的json框架为fastjson,那么jackson的@JsonSerialize就不会有触发入口了,我们来看看fastjson的处理方式。

自定义序列化

相应的,使用fastjson会有相应的配置类,示例如下:

/**
 * 统一输出是采用fastJson
 *
 * @return
 */
@Bean
public HttpMessageConverters fastJsonHttpMessageConverters() {
 //convert转换消息的对象
 FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();

 //处理中文乱码问题
 List<MediaType> fastMediaTypes = new ArrayList<>();
 fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
 fastConverter.setSupportedMediaTypes(fastMediaTypes);

 //是否要格式化返回的json数据
 FastJsonConfig fastJsonConfig = new FastJsonConfig();
 fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat);
 // 添加指定字段的值转换处理
 fastJsonConfig.setSerializeFilters(new CustomerDateFilter());
 // FastJson禁用autoTypeSupport
 fastJsonConfig.getParserConfig().setAutoTypeSupport(false);
 fastConverter.setFastJsonConfig(fastJsonConfig);

 return new HttpMessageConverters(fastConverter);
}

这里需要添加fastjson对字段值的处理(上述代码已添加这行代码),如

// 添加指定字段的值转换处理
fastJsonConfig.setSerializeFilters(new CustomerDateFilter());

CustomerDateFilter为自行实现的类,代码如下:

public class CustomerDateFilter implements ValueFilter {

 @Override
 public Object process(Object object, String name, Object value) {
  if (FieldConstants.CREATE_TIME.equalsIgnoreCase(name) || FieldConstants.UPDATE_TIME.equalsIgnoreCase(name)) {
   // 属性名为createTime, updateTime进行转换处理
   SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
   sdf.setTimeZone(TimeZone.getTimeZone("GMT+8"));

   if(value instanceof Long) {
    Long time = (Long) value;
    Date date = new Date(time);
    return sdf.format(date);
   } else {
    return value;
   }
  }
  return value;
 }
}

这样就可以把所有响应对象中出现的createTime和updateTime字段统一处理了,无论列表数据还是单个对象数据,非常方便。缺点就是除此之外的字段,如果还做不到全系统统一,就需要单独处理。

SerializeFilter定制序列化

支持SerializeFilter定制序列化的扩展编程接口有以下几个,可根据实际需要进行扩展:

  • PropertyPreFilter: 根据PropertyName判断是否序列化;
  • PropertyFilter: 根据PropertyName和PropertyValue来判断是否序列化;
  • NameFilter: 修改Key,如果需要修改Key,process返回值则可;
  • ValueFilter: 修改Value;
  • BeforeFilter: 序列化时在最前添加内容;
  • AfterFilter: 序列化时在最后添加内容;
  • 自定义反序列化

fastJson提供了序列化过滤器,来实现自定义序列化改造,但没有提供反序列化过滤器,来实现对应的功能。

方案:@JSONField注解

回到对JSON报文String类型的值执行trim操作,官网支持@JSONField注解的属性设置(要求fastJson版本1.2.36以上):

@JSONField(format="trim")
private String name;

在JSON报文反序列化时,该实体的name属性会自动执行trim方法进行处理。

此方案只有逐个添加注解,工作量较大。

方案:实现ObjectDeserializer接口

ObjectDeserializer接口为可以实现自定义反序列化实现接口,配合ParserConfig的全局设置,也可以达到预期的效果,合建StringTrimDeserializer类,对String进行处理:

/**
 * @title: StringTrimDeserializer
 * @description: 把String类型的内容统一做trim操作
 */
public class StringTrimDeserializer implements ObjectDeserializer {

 @Override
 public <T> T deserialze(DefaultJSONParser parser, Type type, Object fieldName) {
  // JSON String反序列化的逻辑比较复杂,在StringCodec的基础上,对其结果调用trim方法
  Object obj = StringCodec.instance.deserialze(parser, type, fieldName);
  if (obj instanceof String) {
   String str = (String) obj;
   return (T) str.trim();
  }
  return (T) obj;
 }

 @Override
 public int getFastMatchToken() {
  return JSONToken.LITERAL_STRING;
 }
}

相应在,在HttpMessageConverters类fastJsonHttpMessageConverters方法内中增加String类的反序列化设置:

// 设置String类的全局反序列化规则:自动完成trim操作
ParserConfig.getGlobalInstance().putDeserializer(String.class, new StringTrimDeserializer());

tips:

在StringTrimDeserializer类实现方法中为什么不直接parser.getLexer().stringVal()得到值后执行trim方法,而是调用StringCodec.instance的实现方法?

StringCodec是fastJson默认的String类型的反序列化逻辑类,里面要处理的类型有String、StringBuffer、StringBuilder等,还有各种的集合、数组结构,涉及的nextToken值都不相同,总之,对String文本的反序列化,实现逻辑和应对的场景都比较复杂,而此次的需求只是对String执行trim操作,复杂的逻辑还是交给StringCodec来处理,站在StringCodec的基础上,对其结果执行trim方法就可以达到预期目标。

小结

今天这篇是记录Json自定义序列化和反序列化的实践方案,开始实施前先确认工程里使用的框架是哪个,否则就会出现添加了@JsonSerialize注解,搞了大半天没有效果,回头一看框架是fastjson,没有触发入口,当然得不到预期效果,小小建议,希望对你有帮助。

到此这篇关于SpringMVC Json自定义序列化和反序列化的文章就介绍到这了,更多相关SpringMVC 序列化和反序列化内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • Springmvc 4.x利用@ResponseBody返回Json数据的方法

    下面是官方文档对于@ResponseBody注解的解释: Mapping the response body with the @ResponseBody annotation The @ResponseBody annotation is similar to @RequestBody. This annotation can be put on a method and indicates that the return type should be written straight to

  • springmvc fastjson 反序列化时间格式化方法(推荐)

    第一种情况是从后台拿到数据,进行反序列化,反序列化格式时间:试了一下很多网上的方法,最后发现还是在实体类上面的日期字段加上如下注解,可以完成格式化操作,否则默认就都是时间戳的格式: @JSONField (format="yyyy-MM-dd HH:mm:ss")  public Date birthday; @JSONField (format="yyyy-MM-dd HH:mm:ss")  public Date birthday; 第二种情况是:respons

  • SpringMVC接收与响应json数据的几种方式

    前言 前后端的数据交互,除了通过form表单进行提交外,也可以通过ajax向后端传递和接收json格式数据(这种方式可以实现请求数据和页面分离).本文将总结一下在Spring MVC中接收和响应json数据的几种方式. 话不多说了,来一起看看详细的介绍吧 准备步骤: 1.导入json相关框架的依赖(比如jackson). 2.spring mvc的controller方法正常写,如果需要响应json,增加@responsebody注解. 3.在接受json对应的输入参数前,加上@RequestB

  • SpringMVC Json自定义序列化和反序列化的操作方法

    需求背景 需求一:SpringMVC构建的微服务系统,数据库对日期的存储是Long类型的时间戳,前端之前是默认使用Long类型时间,现在前端框架改动,要求后端响应数据时,Long类型的时间自动变成标准时间格式(yyyy-MM-dd HH:mm:ss). 涉及到这个转换的范围挺大,所有的实体表都有创建时间createTime和修改时间updateTime,目前的主要诉求也是针对这两个字段,并且在实体详情数据和列表数据都存在,需要一个统一的方法,对这两个字段进行处理. 需求二:前端请求上传的JSON

  • springboot jackson自定义序列化和反序列化实例

    目录 jackson自定义序列化和反序列 序列化JsonSerializer 最后请求http返回对象 反序列化JsonDeserializer 小结一下 springboot 自定义序列化器 jackson自定义序列化和反序列 spingmvc使用httpmessageconverter接口来转换http请求和响应. 如果需要添加和自定义转换器,则可以使用spring boot的HttpMessageConverters类:任何存在于上下文中的HttpMessageConverter的ben都

  • C#对Json进行序列化和反序列化

    一.Json简介 Json(JavaScript Object Notation) 是一种轻量级的数据交换格式.它基于JS的一个子集. Json采用完全独立于语言的文本格式.这使得Json成为理想的数据交换语言.易于人阅读和编写,同时也易于机器解析和生成. Json简单来说就是JS中的对象和数组,所以Json也存在两种结构:对象.数组. Json对象:Json对象定义在花括号“{}”内,以Key:value键值对的形式存放数据,多个数据使用分号“:”分割. 二.序列化 Object obj =

  • JS实现json的序列化和反序列化功能示例

    本文实例讲述了JS实现json的序列化和反序列化功能.分享给大家供大家参考,具体如下: 序列化: var s = new Object(); s.Name = "clientValue"; s.Id = 1; s.ClassId = 2; var data = JSON.stringify(s); console.log(data); 反序列化: eval将字符串反序列化成对象 var s = eval('(' + data+ ')'); console.log(s.Name); 完整

  • PHP中SERIALIZE和JSON的序列化与反序列化操作区别分析

    本文实例讲述了PHP中SERIALIZE和JSON的序列化与反序列化操作区别.分享给大家供大家参考,具体如下: PHP中SERIALIZE和JSON序列化与反序列化区别是什么呢,对于这个问题我们可以和小编一起来看看,具体的操作细节如下所示. 在PHP中,serialize和json两种方式对一个对象或数组进行序列化或反序列化有什么区别呢? 假设一个对象和一个数组: $web = new stdClass; $web->site = 'tantengvip'; $web->owner = 'tu

  • C#实现json的序列化和反序列化实例代码

    在做asp.net和unity进行http通信的时候,当unity客户端发出表单请求的时候,我要将他要请求的数据以json的格式返回给客户端,让客户端来解析.服务器端这一块就涉及到json的序列化和反序列化的问题. 两种方法都有例子,第一种是用泛型集合来存储的对象,然后将集合序列化一下:第二种是直接序列化的一个对象 复制代码 代码如下: using System;using System.Collections.Generic;using System.Web.Script.Serializat

  • ASP.NET中JSON的序列化和反序列化使用说明

    在网站应用中使用JSON的场景越来越多,本文介绍 ASP.NET中JSON的序列化和反序列化,主要对JSON的简单介绍,ASP.NET如何序列化和反序列化的处理,在序列化和反序列化对日期时间.集合.字典的处理. 一.JSON简介 JSON(JavaScript Object Notation,JavaScript对象表示法)是一种轻量级的数据交换格式. JSON是"名值对"的集合.结构由大括号'{}',中括号'[]',逗号',',冒号':',双引号'""'组成,包含

  • Golang中Json的序列化和反序列化的使用

    目录 JSON: 创建格式: 基本数据类型序列化: map序列化: 切片序列化: 反序列化为结构体: 反序列化为map: 反序列化为切片: JSON: JSON(JavaScript Object Notation):是一种轻量级的数据交换格式. 它是基于 ECMAScript 规范的一个子集,采用完全独立于编程语言的文本格式来存储和表示数据. 简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言.易于人阅读和编写,同时也易于计算机解析和生成,并有效的 提升网络传输效率. Json易于机器

  • SpringBoot之Json的序列化和反序列化问题

    目录 控制json序列化/反序列化 1. @JsonIgnoreProperties的用法 2. @JsonProperty 注解 3. @JsonCreator 注解 4. @JsonSetter 和 @JsonGetter 注解 5. @JsonAnySetter 注解 6. @JsonAnyGetter 注解 7. @JsonFormat 注解 8.@JsonSerialize 和 @JsonDeserialize 注解 SpringBoot序列化规则 1.全局设置 2.局部设置 3.自定

  • ASPNET中JSON的序列化和反序列化的方法

    一.JSON简介 JSON(JavaScript Object Notation,JavaScript对象表示法)是一种轻量级的数据交换格式. JSON是"名值对"的集合.结构由大括号'{}',中括号'[]',逗号',',冒号':',双引号'""'组成,包含的数据类型有Object,Number,Boolean,String,Array, NULL等. JSON具有以下的形式: 对象(Object)是一个无序的"名值对"集合,一个对象以"

随机推荐