SpringMVC中Controller处理response.setContentType()及header为applicationjsoncharsetutf-8无效问题分析

SpringMVC中Controller处理response.setContentType()及header为"application/json;charset=utf-8"无效问题分析

一. 异常问题

我在SpringMVC中创建了一个处理器Controller，处理器方法内部利用response对象设置content-type，内容类型设置为“application/json;charset=UTF-8”,在该方法对外输出中文时，结果发现还是乱码。代码如下：

    @ResponseBody
    @RequestMapping(value = "/error",method = RequestMethod.GET)
    public String showError(HttpServletResponse response) throws IOException {
        //专门用来处理通过注解方式实现的处理器的!
        //RequestMappingHandlerMapping
        //RequestMappingHandlerAdapter--->invokeHandlerMethod()
        response.setContentType("application/json;charset=UTF-8");
       
        return "失败";
    }

结果在请求时，发现依然乱码：

二. 原因分析

后来经过追踪源码，发现是因为SpringMVC源码内部做了特殊处理，导致通过response.setContentType("application/json;charset=UTF-8")方法设置请求头编码无效。

SpringMVC中是通过RequestMappingHandlerAdapter来处理通过注解方式定义的请求处理器方法的，然后在该类中，有一个invokeHandlerMethod()方法，内部通过ServletInvocableHandlerMethod中的invokeAndHandle调用目标方法，并处理返回值。

如果return value ！= null，则通过returnvalueHandlers来处理，内部会调用MessageConverter转换成相应的报文格式。

HttpOutputMessage中的outputMessage，对应的实例是 org.springframework.http.server.ServletServerHttpResponse。在写入数据的同时，会设置response的header，包括content-type（根据RequestMapping 的 produces 属性 计算出来）。也就是说，当请求方法在带有返回值的情况下，在controller中设置content-type是无效的，会被消息转换器覆盖掉。

三.解决办法

1.解决方式一，利用produces属性

    @ResponseBody
    //@GetMapping("/show")
    @RequestMapping(value = "/show",method = RequestMethod.GET,produces = {"application/json;charset=UTF-8"})
    public String showCharacter(){

        return "成功";
    }

2. 解决方式二，请求方法不要带返回值

    @ResponseBody
    @RequestMapping(value = "/error",method = RequestMethod.GET)
    public void showError(HttpServletResponse response) throws IOException {
        //
        //专门用来处理通过注解方式实现的处理器的!
        //RequestMappingHandlerMapping
        //RequestMappingHandlerAdapter--->invokeHandlerMethod()
        //AbstractHttpMessageConverter

        response.setContentType("application/json;charset=UTF-8");
        ServletOutputStream out = response.getOutputStream();
        IOUtils.write("失败".getBytes("UTF-8"),out);
        //IOUtils.write("失败",out);
        out.flush();
        //return "失败";
    }