SpringBoot自定义MessageConvert详细讲解

正在学习SpringBoot，在自定义MessageConverter时发现：为同一个返回值类型配置多个MessageConverter时，可能会发生响应数据格式错误，或406异常（客户端无法接收相应数据）。在此记录一下解决问题以及追踪源码的过程

前言

对于页面携带的请求头中的AcceptSpringBoot有对应的10种MessageConvert可以支持写出对应的媒体类型，比如application/xml、application/json……

我们还可以通过向容器放入一个WebMvcConfigurer

实现定制化SpingMVC，自定义一个MessageConvert处理特殊的协议比如application/x-person

实现多协议数据兼容。json、xml、x-person

原理

0、@ResponseBody 响应数据出去调用 RequestResponseBodyMethodProcessor 处理

1、Processor 处理方法返回值。通过 MessageConverter 处理

2、所有 MessageConverter 合起来可以支持各种媒体类型数据的操作（读、写）

3、内容协商找到最终的 messageConverter；

实现

/* 条件
*
* 1、浏览器发请求直接返回xml [application/xml] jacksonXmlConverter
* 2、如果是ajax请求返回json [application/json] jacksonJsonConverter
* 3、如果是app发请求，返回自定义协议数据 [application/x-person] xxxxConverter
*
* 步骤：
* 1、添加自定义的MessageConverter进系统底层
* 2、系统底层就会统计出所有MessageConverter能操作哪些类型
* 3、客户端内容协商 [person--->person]
*/

person类

@Data public class Person { public String username; public Integer age; public Pet pet; }

pet类

@Data public class Pet { public String name; public Integer age; }

PersonMessageConvert

/* * 自定义的Convert */ public class PersonMessageConvert implements HttpMessageConverter { @Override public boolean canRead(Class clazz, MediaType mediaType) { return false; } @Override public boolean canWrite(Class clazz, MediaType mediaType) { return clazz.isAssignableFrom(Person.class); } /* * @Description 服务器需要统计所有MessageConvert都能写出哪些类型，我们这里也要自定义 * @Param **/ @Override public List getSupportedMediaTypes() { return MediaType.parseMediaTypes("application/x-person"); } @Override public Person read(Class clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException { return null; } @Override public void write(Person person, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException { //自定义协会数据的写出 String data = person.getUsername() + ";" + person.getAge() + ";" +person.getPet() + ";"; //写出去 OutputStream body = outputMessage.getBody(); body.write(data.getBytes()); } }

方法

    @ResponseBody @GetMapping("/test/person") public Person getPeroson() { Person person = new Person(); person.setUsername("张三"); person.setAge(18); person.setPet(new Pet()); return person; }

WebMvcConfigurer

    @Bean public WebMvcConfigurer webMvcConfigurer() { return new WebMvcConfigurer() { @Override public void extendMessageConverters(List> converters) { converters.add(new PersonMessageConvert()); } } }

测试

拓展

如何实现访问路径携带format参数指明协商协议

比如：http://localhost:8080/test/person?format=x-person

记得先开启基于参数的内容协商

spring:
mvc:
contentnegotiation:
favor-parameter: true

@Bean public WebMvcConfigurer webMvcConfigurer() { return new WebMvcConfigurer() { /* * 自定义内容协商策略 */ @Override public void configureContentNegotiation(ContentNegotiationConfigurer configurer) { Map mediaTypeMap = new HashMap<>(); mediaTypeMap.put("json", MediaType.APPLICATION_JSON); mediaTypeMap.put("xml", MediaType.APPLICATION_XML); mediaTypeMap.put("x-person",MediaType.parseMediaType("application/x-person")); //指定支持解析那些参数的媒体类型 ParameterContentNegotiationStrategy parametertrategy = new ParameterContentNegotiationStrategy(mediaTypeMap); HeaderContentNegotiationStrategy headerStrategy = new HeaderContentNegotiationStrategy(); configurer.strategies(Arrays.asList(parametertrategy, headerStrategy)); } @Override public void extendMessageConverters(List> converters) { converters.add(new PersonMessageConvert()); } }; }

测试