使用HttpMessageConverter实现HTTP的序列化和反序列化

SpringBoot 同时被 2 个专栏收录
13 篇文章 2 订阅
94 篇文章 0 订阅

对象的序列化/反序列化大家应该都比较熟悉:序列化就是将object转化为可以传输的二进制,反序列化就是将二进制转化为程序内部的对象。序列化/反序列化主要体现在程序I/O这个过程中,包括网络I/O和磁盘I/O。

那么什么是http序列化和反序列化呢?

在使用springmvc/SpringBoot时,我们经常会这样写:

@RequestMapping("/test")
@ResponseBodypublic String test(@RequestBody String param) {
    return "param '" + param + "'";
}

@RestController中有@ResponseBody,可以帮我们把User序列化到resp.body中。@RequestBody可以帮我们把req.body的内容转化为User对象。如果是开发Web应用,一般这两个注解对应的就是Json序列化和反序列化的操作。这里实际上已经体现了Http序列化/反序列化这个过程,只不过和普通的对象序列化有些不一样,Http序列化/反序列化的层次更高,属于一种Object2Object之间的转换。

有过Netty使用经验的对这个应该比较了解,Netty中的Decoder和Encoder就有两种基本层次,层次低的一种是Byte <—> Message,二进制与程序内部消息对象之间的转换,就是常见的序列化/反序列化;另外一种是 Message <—> Message,程序内部对象之间的转换,比较高层次的序列化/反序列化。

Http协议的处理过程,TCP字节流 <—> HttpRequest/HttpResponse <—> 内部对象,就涉及这两种序列化。在springmvc中第一步已经由Servlet容器(tomcat等等)帮我们处理了,第二步则主要由框架帮我们处理。上面所说的Http序列化/反序列化就是指的这第二个步骤,它是controller层框架的核心功能之一,有了这个功能,就能大大减少代码量,让controller的逻辑更简洁清晰,就像上面示意的代码那样,方法中只有一行代码。spirngmvc进行第二步操作,也就是Http序列化和反序列化的核心是HttpMessageConverter。

HttpMessageConverter

Http请求响应报文其实都是字符串,当请求报文到java程序会被封装为一个ServletInputStream流,开发人员再读取报文,响应报文则通过ServletOutputStream流,来输出响应报文。

从流中只能读取到原始的字符串报文,同样输出流也是。那么在报文到达SpringMVC / SpringBoot和从SpringMVC / SpringBoot出去,都存在一个字符串到java对象的转化问题。这一过程,在SpringMVC / SpringBoot中,是通过HttpMessageConverter来解决的。HttpMessageConverter接口源码:
在这里插入图片描述
以上面的代码为例子来说明一下:在请求进入test方法前,会根据@RequestBody注解选择对应的HttpMessageConverter实现类来将请求参数解析到param变量中,因为这里的参数是String类型的,所以这里是使用了StringHttpMessageConverter类,它的canRead()方法返回true,然后read()方法会从请求中读出请求参数,绑定到test()方法的param变量中。

同理当执行test方法后,由于返回值标识了@ResponseBody,SpringMVC / SpringBoot将使用StringHttpMessageConverter的write()方法,将结果作为String值写入响应报文,当然,此时canWrite()方法返回true。

借用下图简单描述整个过程:
在这里插入图片描述
在Spring的处理过程中,一次请求报文和一次响应报文,分别被抽象为一个请求消息HttpInputMessage和一个响应消息HttpOutputMessage。处理请求时,由合适的消息转换器将请求报文绑定为方法中的形参对象,在这里同一个对象就有可能出现多种不同的消息形式,如json、xml。同样响应请求也是同样道理。在Spring中,针对不同的消息形式,有不同的HttpMessageConverter实现类来处理各种消息形式,至于各种消息解析实现的不同,则在不同的HttpMessageConverter实现类中。

替换@ResponseBody默认的HttpMessageConverter

1、springboot框架默认的使用jackson进行json转化

public class User {

    private String username;
    private Integer age;
    private Integer phone;
    private String email;

    public User(String username, Integer age) {
    super();
    this.username = username;
    this.age = age;
    }
}
@Controller
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/testt")
    @ResponseBody
    public User testt() {
        User user = new User("name", 18);
        return user;
    }
}

浏览器访问/user/testt请求结果如下:
在这里插入图片描述
这就是使用Jackson解析的结果,没有传值的字段默认被解析成了null。现在来改成使用fastjson解析对象,这里就是替换默认的HttpMessageConverter,就是将其改成使用FastJsonHttpMessageConverter来处理Java对象与HttpInputMessage/HttpOutputMessage间的转化。

2、使用fastjson替代默认的jackson转化方式

增加Fastjson的maven依赖

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

Springboot配置FastJsonHttpMessageConverter有两种方法:

方法一:启动类继承extends WebMvcConfigurerAdapter,然后覆盖方法configureMessageConverters

import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.apache.log4j.Logger;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.web.HttpMessageConverters;
import org.springframework.context.annotation.Bean;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import java.util.ArrayList;
import java.util.List;

/** springboot以fastjon方式转化json数据 */
@SpringBootApplication
public class Application extends WebMvcConfigurerAdapter {
    private static Logger logger = Logger.getLogger(Application.class);

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        //1.需要定义一个convert转换消息的对象;
        FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
        //2.添加fastJson的配置信息,比如:是否要格式化返回的json数据;
        FastJsonConfig fastJsonConfig = new FastJsonConfig();

	SerializerFeature[] serializerFeatures = new SerializerFeature[]{
                //    输出key是包含双引号
//                SerializerFeature.QuoteFieldNames,
                //    是否输出为null的字段,若为null 则显示该字段
//                SerializerFeature.WriteMapNullValue,
                //    数值字段如果为null,则输出为0
                SerializerFeature.WriteNullNumberAsZero,
                //     List字段如果为null,输出为[],而非null
                SerializerFeature.WriteNullListAsEmpty,
                //    字符类型字段如果为null,输出为"",而非null
                SerializerFeature.WriteNullStringAsEmpty,
                //    Boolean字段如果为null,输出为false,而非null
                SerializerFeature.WriteNullBooleanAsFalse,
                //    Date的日期转换器
                SerializerFeature.WriteDateUseDateFormat,
                //    循环引用
                SerializerFeature.DisableCircularReferenceDetect,
        };

        fastJsonConfig.setSerializerFeatures(serializerFeatures);
        //3处理中文乱码问题
        List<MediaType> fastMediaTypes = new ArrayList<>();
        fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
        //4.在convert中添加配置信息.
        fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);
        fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
        //5.将convert添加到converters当中.
        converters.add(fastJsonHttpMessageConverter);
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
        logger.info("=====spring boot start success====");
    }
}

方法二:添加配置类来注入Bean:HttpMessageConverters

import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.boot.autoconfigure.web.HttpMessageConverters;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;

import java.nio.charset.Charset;

@Configuration
public class HttpMessageConverterConfig {

    //引入Fastjson解析json,不使用默认的jackson
    //必须在pom.xml引入fastjson的jar包,并且版必须大于1.2.10
    @Bean
    public HttpMessageConverters fastJsonHttpMessageConverters() {
        //1、定义一个convert转换消息的对象
        FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();

        //2、添加fastjson的配置信息
        FastJsonConfig fastJsonConfig = new FastJsonConfig();

        SerializerFeature[] serializerFeatures = new SerializerFeature[]{
                //    输出key是包含双引号
//                SerializerFeature.QuoteFieldNames,
                //    是否输出为null的字段,若为null 则显示该字段
//                SerializerFeature.WriteMapNullValue,
                //    数值字段如果为null,则输出为0
                SerializerFeature.WriteNullNumberAsZero,
                //     List字段如果为null,输出为[],而非null
                SerializerFeature.WriteNullListAsEmpty,
                //    字符类型字段如果为null,输出为"",而非null
                SerializerFeature.WriteNullStringAsEmpty,
                //    Boolean字段如果为null,输出为false,而非null
                SerializerFeature.WriteNullBooleanAsFalse,
                //    Date的日期转换器
                SerializerFeature.WriteDateUseDateFormat,
                //    循环引用
                SerializerFeature.DisableCircularReferenceDetect,
        };

        fastJsonConfig.setSerializerFeatures(serializerFeatures);
        fastJsonConfig.setCharset(Charset.forName("UTF-8"));

        //3、在convert中添加配置信息
        fastConverter.setFastJsonConfig(fastJsonConfig);

        //4、将convert添加到converters中
        HttpMessageConverter<?> converter = fastConverter;

        return new HttpMessageConverters(converter);
    }
}

浏览器发起请求,得到的结果如下:
在这里插入图片描述
未传值的字符串类型的属性被解析为””,未传值的数值类型的属性被解析为0。

参考资料:
1、【Spring】HttpMessageConverter的作用及替换
2、springboot学习(三)——使用HttpMessageConverter进行http序列化和反序列化
3、SpringBoot-扩展FastJsonHttpMessageConverter对返回的json对象进行扩展
4、fastjson SerializerFeature详解

  • 3
    点赞
  • 1
    评论
  • 22
    收藏
  • 一键三连
    一键三连
  • 扫一扫,分享海报

包含安装包及源码包 ----------------------------------技术背景介绍===================================' 本系统在一些大中型企业(跨多达24个区域)一直都在很好的服务过,主要在FTP 控制 UDP控制 HTTP控制 傁客户数据库 数据库 数据压缩加密方面进行了综合深入的应用 =====================================模块功能介绍==================================== OAEnterPrise.exe: 用户及权限的集成管理 ;报表种类及字段自动定义 sky.exe 报表录入及FTP自动传输系统,(多对一)初始密码为1 ReportServer.exe 报表自动接收系统,自动汇总导入数据库(DBF) SkyEditor.exe 文档录入及自动FTP发送系统 editorserver.exe 文档自动分类接收系统 SQL.exe 通用数据库查询系统 {支持各类数据库格式的查询,支持Undo 及 Redo 操作,可以保存任意中间结果 ,支持对任意结果的n次查询 支持查询结果导入excel表 支持多表查询操作} 需要 BDE skynet.exe 电子邮件系统(采用 HTTP DLL ) WebSearch.exe 文档及报表远程查询系统 webchat.exe 远程会议系统 {必须先在装有FTP SERVER 的服务器上 启动Install\Soft\New目录下ChatServer.exe} WinArchiver.exe :压缩解压系统 SkyImage.exe :图片编辑器 =====================================安装操作==================================== 在本机需要安装BDE(delphi BDE) 1: 在主机(服务器端口)上建立FTP服务(最好是微软的IIS_FTP) 设定用户名PASS 及密码USER (例如 : 用户名 :chj 密码: 1998 ),将设定的FTP用户名及密码设定为FTP的最高操作权限,注意如果用微软的IIS_FTP请在操作系统用户管理器也要设定此用户名及密码并设定为隶属于Administrator,否则刚才设定的用户名及密码将无法登陆FTP SERVER; 2: 手工在本用户FTP根目录下建立以下远程文件目录: 1. dat 2. dat\regse 3. dat\regre 4. dat\update 5. report 6. report\dat01 7. report\dat02 8. report\dat03 9. report\dat04 10. report\dat05 11. report\dat06 3: 获取加密用户名及密码: 在压缩文件中找到pass.exe文件 将用户名及密码输入EDIT编辑框,点按buttom1按钮,将得到加密的用户名及密码,例如用户名 :chj 密码: 1998,得到的用户名及密码分别是 用户名 :avu 密码: 2770 4:获取主机地址加密数据,上面一样,将运行FTP SERVER 主机地址 例如 202.87.09.91 输入EDIT编辑框点按buttom1按钮,将得到加密的主机地址 5: 执行install安装程序,系统对于普通用户及超级都用它来安装, 对于普通用户,不需要序列号,对于超级用户需要序列号,序列号为OA2000 ; 6 录入主机地址及用户密码,将加密的主机地址录入主机地址栏目中,上面的545.03.47.72,在主、副、次用户名中录入加密的FTP 用户名,例如上面的 avu 在主、副、次密码中录入加密的FTP 用户密码 例如2770 7. 填写安装区域部门选项(选择安装用户);如果选择总部各部门,比如"总经办",则密码为大写ZB+"总经办"每个字第一个大写的拼音,例如上面为ZBZJB ; 如果选择各分部,比如"安徽分部",则密码为大写 "安徽分部"每个字第一个大写的拼音,例如上面为AHFB; 如果选择各办事处,比如"安庆",则密码为大写 "安庆"每个字第一个大写的拼音,例如上面为AQ; 这些便是登陆用户信息,内容在\Install\Soft\New\NetSky\DAT 目录下,为bscid.cdx zbid.cdxfbid.cdx ;可以修改本初始文件; 可以用Delphi的ClientDataSet组件的LoadFromFile及SaveToFile方法打开本文件读写编辑,文件内容可
©️2021 CSDN 皮肤主题: 撸撸猫 设计师:马嘣嘣 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值