1.基本介绍
相信使用过Spring的同学都用过@RequestBody、@ResponseBody注解。当一个Http报文到达服务器,我们看到的是在Controller中直接得到了对应的对象,意味着浏览器和服务器通过交换原始文本进行通信,而这里其实就是HttpMessageConverter发挥着作用。
本文简单剖析该组件的原理,并且结合业务实际演示在开发中如何自定义完成特殊的操作
2.作用原理
如果一句话来描述HttpMessageConvert是什么,便是将Java对象与HttpInput/Output流做转换。
![37b960cd3a361d6e447034f12aa5239a.png](https://i-blog.csdnimg.cn/blog_migrate/ad787e61f633ba2ed7cb883715376d04.jpeg)
3.基本接口
public interface HttpMessageConverter { /** * 该方法指定转换器可以读取的对象类型,即转换器可将请求信息转换为clazz类型的对象, * 同时指定支持的MIME类型(text/html、application/json等)。 */ boolean canRead(Class> clazz, MediaType mediaType); /** * 该方法指定转换器可以讲clazz类型的对象写到响应流当中,响应流支持的媒体类型在mediaType中定义 * */ boolean canWrite(Class> clazz, MediaType mediaType); /** * 该方法返回当前转换器支持的媒体类型 */ List getSupportedMediaTypes(); /** * 该方法将请求信息转换为T类型的对象 */ T read(Class extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException; /** * 该方法将T类型的对象写到响应流当中,同事指定响应的媒体类型为contentType * */ void write(T t, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;}
4.Spring内部封装
在四个主要接口的基础上,Spring还封装了一个抽象基类 AbstractHttpMessageConverter
其中主要增加了在何种情况下应该使用该HttpMessageConverter,包括编码、ContentType等等。
同时还有返回结果转换时候的ContentType,针对不同Converter会给前端不同的返回结果。
Spring为我们提供了一些通用的实现方法:
- StringHttpMessageConverter
- ByteArrayHttpMessageConverter
- SourceHttpMessageConverter
这也就是为什么在Controller中直接返回一个String对象前端可以直接得到一个plain/text的返回内容。
5.选择策略
每个工程一定会有多个HttpMessageConverter,对于不同的注解将会用不同的MessageConverter去转换:
- @RequestBody注解时: 根据Request对象header部分的Content-Type类型,逐一匹配合适的HttpMessageConverter来读取数据
- @ResponseBody注解时: 根据Request对象header部分的Accept属性(逗号分隔),逐一按accept中的类型,去遍历找到能处理的HttpMessageConverter
在Spring内部有一个HttpMessageConverterList,上述过程中每次会去顺序遍历这个List,一旦找到匹配项,将不再向后查找
6.实际应用
在我们的业务工程中其实已经有对该部分的使用。
1) 第三方HttpMessageConverter
比如我们用的Json转换:MappingJackson2HttpMessageConverter
同理还有FastjsonHttpMessageConverter
2) 添加MessageConverter
@Configurationpublic class WebMvcConfigurer extends WebMvcConfigurerAdapter { private static final String UTF8 = "UTF-8"; private final SessionInterceptor sessionInterceptor; public WebMvcConfigurer( final SessionInterceptor sessionInterceptor) { this.sessionInterceptor = sessionInterceptor; } @Override public void addInterceptors(final InterceptorRegistry registry) { registry.addInterceptor(sessionInterceptor); } @Override public void configureMessageConverters(List> converters) { super.configureMessageConverters(converters); final Charset utf8Charset = Charset.forName(UTF8); converters.add(new StringHttpMessageConverter(utf8Charset)); final MappingJackson2HttpMessageConverter jackson2Converter = new MappingJackson2HttpMessageConverter(); jackson2Converter.setDefaultCharset(utf8Charset); jackson2Converter.getObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL); SimpleModule module = new SimpleModule(); module.addSerializer(String.class, new UpgradeInsecureRequestsStringSerializer()); jackson2Converter.getObjectMapper().registerModule(module); converters.add(jackson2Converter); }}
通过继承WebMvcConfigurerAdapter可以添加自定义的转换类型
注意自己自定义的转换会在系统自带转换之后
比如jackson中可以进一步自定义对objectMapper的详细设置
7.问题排查
如果以后在业务中会遇到转换json不对,或者string转换有问题的情况,那么可以尝试从HttpMessageConverter入手排查。