SpringBoot自定义MessageConvert详细讲解

更新时间：2023年01月11日 15:38:37 作者：zoeil

正在学习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<Person> {
    @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<MediaType> getSupportedMediaTypes() {
        return MediaType.parseMediaTypes("application/x-person");
    }
    @Override
    public Person read(Class<? extends Person> 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<HttpMessageConverter<?>> 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<String, MediaType> 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<HttpMessageConverter<?>> converters) {
                converters.add(new PersonMessageConvert());
            }
        };
    }

测试

注意：有可能我们添加的自定义的功能会覆盖默认很多功能，导致一些默认的功能失效。比如上面的ContentNegotiationConfigurer 就会覆盖原来的默认ContentNegotiationConfigurer

到此这篇关于SpringBoot自定义MessageConvert详细讲解的文章就介绍到这了,更多相关SpringBoot MessageConvert内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java this关键字的使用详解
this 关键字是 Java 常用的关键字，可用于任何实例方法内指向当前对象，也可指向对其调用当前方法的对象，或者在需要当前类型对象引用时使用
2021-11-11
修改及反编译可运行Jar包实现过程详解
这篇文章主要介绍了如何修改及反编译可运行Jar包,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-09-09
详解SpringBoot中添加@ResponseBody注解会发生什么
这篇文章主要介绍了详解SpringBoot中添加@ResponseBody注解会发生什么，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-11-11
Skywalking改成适配阿里云等带Http Basic的Elasticsearch服务
这篇文章主要介绍了改造Skywalking支持阿里云等带Http Basic的Elasticsearch服务
2022-02-02
Java设计模式之java命令模式详解
这篇文章主要介绍了Java设计模式编程中命令模式的使用,在一些处理请求响应的场合经常可以用到命令模式的编程思路,需要的朋友可以参考下
2021-09-09
Java同步锁Synchronized底层源码和原理剖析(推荐)
这篇文章主要介绍了Java同步锁Synchronized底层源码和原理剖析,释放后，进入减减操作、直到为0然后唤醒队列，让他们去争夺锁，循环前面步骤，对Java同步锁Synchronized相关知识感兴趣的朋友一起看看吧
2022-05-05
SpringBoot的@Value给静态变量注入application.properties属性值
这篇文章主要介绍了SpringBoot的@Value给静态变量注入application.properties属性值,Spring是一个开源的框架，主要是用来简化开发流程,通过IOC，依赖注入（DI）和面向接口实现松耦合,需要的朋友可以参考下
2023-05-05
字节二面SpringBoot可以同时处理多少请求
这篇文章主要为大家介绍了字节二面之SpringBoot可以同时处理多少请求面试分析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-07-07
Java编程接口调用的作用及代码分享
这篇文章主要介绍了Java编程接口调用的作用及代码分享，具有一定参考价值，需要的朋友可以了解下。
2017-11-11
java之Object类用法实例
这篇文章主要介绍了java之Object类用法实例,是Java程序设计中比较重要的概念,以实例的形式对其定义及用法做了较为深入的讲解,需要的朋友可以参考下
2014-10-10

SpringBoot自定义MessageConvert详细讲解

目录

前言

原理

实现

拓展

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具