SpringBoot自定义MessageConverter及其源码分析

本文介绍了在SpringBoot中自定义MessageConverter时遇到的响应数据格式错误和406异常问题。通过追踪源码,分析了内容协商的过程,发现canWrite方法只判断了返回值类型,未考虑mediaType。解决方案是在canWrite方法中增加对mediaType的判断,确保自定义Converter能正确处理请求。

SpringBoot自定义MessageConverter及其源码分析

正在学习SpringBoot,在自定义MessageConverter时发现:为同一个返回值类型配置多个MessageConverter时,可能会发生响应数据格式错误,或406异常(客户端无法接收相应数据)。在此记录一下解决问题以及追踪源码的过程。此处的讨论场景为:基于请求参数的内容协商,详见需求描述。

一 需求描述

  1. 前提条件:浏览器访问路径为http://localhost:8080/showPerson,服务器端对应的Controller如下:
@RestController
public class ParamController {
   
   
    @GetMapping("/showPerson")
    public Person showPerson(Person person){
   
   
        person.setUserName("lisi");
        person.setAge(35);
        return person;
    }
}
  1. 需求:建立两个自定义的MessageConverter,并利用URL请求路径中携带的format参数来控制使用哪个converter。举例来说:

    当发送请求 http://localhost:8080/showPerson?format=something时,需要的响应格式为:lisi - something - 35
    当发送请求 http://localhost:8080/showPerson?format=anything时,需要的响应格式为:lisi - anything - 35

  • PS:用 POST方式请求或许更合理,这里为了省事儿直接用 GET了。

二 最初的实现

  1. 根据上面的需求,我们首先创建了如下的配置类:
@Configuration(proxyBeanMethods = false)
public class WebConfig /*implements WebMvcConfigurer*/ {
   
   

    //1、WebMvcConfigurer定制化SpringMVC的功能
    @Bean
    public WebMvcConfigurer webMvcConfigurer(){
   
   
        return new WebMvcConfigurer() {
   
   
            @Override
            public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
   
   
				// 创建Map,用于收集MediaType信息
                Map<String, MediaType> mediaTypes = new HashMap<>();
                mediaTypes.put("json",MediaType.APPLICATION_JSON);
                mediaTypes.put("xml",MediaType.APPLICATION_XML);
                // 添加自定义的媒体类型
                mediaTypes.
### 解决Spring MVC中自定义MessageConverter出现的乱码问题 为了处理由自定义`MessageConverter`引发的乱码情况,可以采取多种措施来确保数据传输过程中字符集的一致性和准确性。 #### 方法一:通过配置`StringHttpMessageConverter` 在Spring MVC应用上下文中注册并配置`StringHttpMessageConverter`实例,指定支持媒体类型的字符编码为UTF-8。这可以通过XML方式完成: ```xml <bean id="messageConverter" class="org.springframework.http.converter.StringHttpMessageConverter"> <property name="supportedMediaTypes"> <list> <value>text/html;charset=UTF-8</value> <value>application/json;charset=UTF-8</value> <value>application/xml;charset=UTF-8</value> </list> </property> </bean> ``` 此设置能够有效防止因默认编码不匹配而导致的中文乱码现象[^1]。 #### 方法二:利用`@RequestMapping`注解中的produces属性 对于特定控制器方法,可以直接在其上的`@RequestMapping`或其他衍生注解(如`@GetMapping`, `@PostMapping`等)中声明期望产生的内容类型及其字符集: ```java @RequestMapping(value="/example", produces={"application/json;charset=UTF-8"}) @ResponseBody public String example() { return "测试字符串"; } ``` 这种方式使得每次响应都会携带正确的Content-Type头信息,从而避免浏览器或客户端解析错误引起乱码[^2]。 #### 方法三:调整Tomcat服务器端参数 当部署于Apache Tomcat容器内时,还可以考虑修改其连接器(`Connector`)部分的相关设定项,比如URIEncoding,默认情况下应设为UTF-8: ```properties server.tomcat.uri-encoding=UTF-8 ``` 或者编辑conf/server.xml文件内的相应节点添加如下属性: ```xml <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8"/> ``` 这样做有助于统一整个Web应用程序层面的数据交换所使用的字符编码标准[^4]。 以上三种途径均可用于缓解乃至彻底消除由于自定义消息转换器造成的汉字显示异常状况。实际操作时可根据具体场景灵活选用最适宜的方式。
评论 2
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值