Spring MVC处理响应的 header

我们经常需要在HttpResponse中设置一些headers，我们使用Spring MVC框架的时候我们如何给Response设置Header呢？

So easy，看下面的代码：

@RequestMapping(value = "/rulelist", method = RequestMethod.GET)

@ResponseBody

public String getRuleList(HttpServletRequest request,

        HttpServletResponse response) {

    response.addHeader("test", "test");

    return service.getRuleList();

}

通过验证，我们可以看到test项已经被成功添加到response的头部信息

Content-Length: 2 kilobytes

Content-Type:   text/plain;charset=ISO-8859-1

Server: Apache-Coyote/1.1

test: test

接下来，我们希望修改Content-Type，从而统一服务器端和客户端的内容编码。我们继续修改代码，

@RequestMapping(value = "/rulelist", method = RequestMethod.GET)

@ResponseBody

public String getRuleList(HttpServletRequest request,

        HttpServletResponse response) {

    response.addHeader("Content-Type", "application/json;charset=UTF-8");

    return service.getRuleList();

}

接下来，我们验证一下结果：

Content-Length: 2 kilobytes

Content-Type:   text/plain;charset=ISO-8859-1

Server: Apache-Coyote/1.1

和我们预想的并一样，response的content-type header没有被设置成"application/json;charset=UTF-8"，很令人困惑。

那么，接下来让我们来探索下Spring MVC内部是如何处理这一过程的。首先我们先要对Spring MVC框架处理Http请求的流程有一个整体的了解。

下图清晰地向大家展示了Spring MVC处理HTTP请求的流程，（图片来自网络）

具体流程如下：

1. DispatcherServlet接收到Request请求

2. HandlerMapping选择一个合适的Handler处理Request请求

3-4. 选择合适的HandlerAdapter，调用用户编写的Controller处理业务逻辑。（HandlerAdapter主要是帮助Spring MVC支持多种类型的Controller）

5. Controller将返回结果放置到Model中并且返回view名称给Handler Adapter

6. DispatcherServlet选择合适的ViewResolver来生成View对象

7-8. View对象利用Model中的数据进行渲染并返回数据

相信大家对于上面的处理流程并不陌生，上面的流程图向我们展示了SpringMVC生成ModelAndView并返回response的大体流程。

下面我们来看看我们上面代码片段的处理流程是如何进行的？

从上面的流程图我们可以看到，content-type header是单独被处理的，具体过程可以参考下面的源码(AbstractMessageConverterMethodProcessor)：

protected <T> void writeWithMessageConverters(T returnValue, MethodParameter returnType,

        ServletServerHttpRequest inputMessage, ServletServerHttpResponse outputMessage)

        throws IOException, HttpMediaTypeNotAcceptableException {

    Class<?> returnValueClass = getReturnValueType(returnValue, returnType);

    HttpServletRequest servletRequest = inputMessage.getServletRequest();

    List<MediaType> requestedMediaTypes = getAcceptableMediaTypes(servletRequest); //适合的兼容media types类型实际上，我们可以使用produces = {}来指定我们需要的mediatype

    List<MediaType> producibleMediaTypes = getProducibleMediaTypes(servletRequest, returnValueClass);

    Set<MediaType> compatibleMediaTypes = new LinkedHashSet<MediaType>();

    for (MediaType requestedType : requestedMediaTypes) {

        for (MediaType producibleType : producibleMediaTypes) {

            if (requestedType.isCompatibleWith(producibleType)) {

                compatibleMediaTypes.add(getMostSpecificMediaType(requestedType, producibleType));

            }

        }

    }

    if (compatibleMediaTypes.isEmpty()) {

        if (returnValue != null) {

            throw new HttpMediaTypeNotAcceptableException(producibleMediaTypes);

        }

        return;

    }

    List<MediaType> mediaTypes = new ArrayList<MediaType>(compatibleMediaTypes);

    MediaType.sortBySpecificityAndQuality(mediaTypes);

    MediaType selectedMediaType = null;　　　//选择最匹配的mediaType

    for (MediaType mediaType : mediaTypes) {

        if (mediaType.isConcrete()) {

            selectedMediaType = mediaType;

            break;

        }

        else if (mediaType.equals(MediaType.ALL) || mediaType.equals(MEDIA_TYPE_APPLICATION)) {

            selectedMediaType = MediaType.APPLICATION_OCTET_STREAM;

            break;

        }

    }

    if (selectedMediaType != null) {

        selectedMediaType = selectedMediaType.removeQualityValue();

        for (HttpMessageConverter<?> messageConverter : this.messageConverters) {         //遍历messageConvertors, 寻找可以处理相应返回类型和mediatype的HttpMessageConvertor

            if (messageConverter.canWrite(returnValueClass, selectedMediaType)) {

                returnValue = this.adviceChain.invoke(returnValue, returnType, selectedMediaType,

                        (Class<HttpMessageConverter<?>>) messageConverter.getClass(), inputMessage, outputMessage);

                if (returnValue != null) {         //这里将会填充mediatype到header，并将httpmessage发送给请求者

                    ((HttpMessageConverter<T>) messageConverter).write(returnValue, selectedMediaType, outputMessage);

                    if (logger.isDebugEnabled()) {

                        logger.debug("Written [" + returnValue + "] as \"" + selectedMediaType + "\" using [" +

                                messageConverter + "]");

                    }

                }

                return;

            }

        }

    }

    if (returnValue != null) {

        throw new HttpMediaTypeNotAcceptableException(this.allSupportedMediaTypes);

    }

}

接下来，将选择好的mediatype写入到HttpOutputMessage中

public final void write(final T t, MediaType contentType, HttpOutputMessage outputMessage)

        throws IOException, HttpMessageNotWritableException {

    final HttpHeaders headers = outputMessage.getHeaders();     //设置contenttype到HttpOutputMessage

    if (headers.getContentType() == null) {

        MediaType contentTypeToUse = contentType;

        if (contentType == null || contentType.isWildcardType() || contentType.isWildcardSubtype()) {

            contentTypeToUse = getDefaultContentType(t);

        }

        if (contentTypeToUse != null) {

            headers.setContentType(contentTypeToUse);

        }

    }

    if (headers.getContentLength() == -1) {

        Long contentLength = getContentLength(t, headers.getContentType());

        if (contentLength != null) {

            headers.setContentLength(contentLength);

        }

    }

　　　　　　/* 省略了不相干代码 */

}

最终的Headers设置在ServletServerHttpResponse类中完成，

private void writeHeaders() {

    if (!this.headersWritten) {

        for (Map.Entry<String, List<String>> entry : this.headers.entrySet()) {

            String headerName = entry.getKey();

            for (String headerValue : entry.getValue()) {         //将复合类中之前设置的header(content-type)内容补充到servletResponse

                this.servletResponse.addHeader(headerName, headerValue);

            }

        }

        // HttpServletResponse exposes some headers as properties: we should include those if not already present

        if (this.servletResponse.getContentType() == null && this.headers.getContentType() != null) {

            this.servletResponse.setContentType(this.headers.getContentType().toString());

        }

        if (this.servletResponse.getCharacterEncoding() == null && this.headers.getContentType() != null &&

                this.headers.getContentType().getCharSet() != null) {

            this.servletResponse.setCharacterEncoding(this.headers.getContentType().getCharSet().name());

        }

        this.headersWritten = true;

    }

}

从上述的代码中，我们可以看到在RequestResponseBodyMethodProcessor这个ReturnValueHandler中，media-type被单独的逻辑进行处理，因此直接在ServletResponse中设置content-type header并不能正常生效。

需要在@RequestMapping中添加produces = {} 进行设置才可以。

参考：https://www.cnblogs.com/kaiblog/p/7565231.html

我们经常需要在HttpResponse中设置一些headers，我们使用Spring MVC框架的时候我们如何给Response设置Header呢？

Sooooooooooooo easy，看下面的代码：

@RequestMapping(value = "/rulelist", method = RequestMethod.GET)

@ResponseBody

public String getRuleList(HttpServletRequest request,

HttpServletResponse response) {

response.addHeader("test", "test");

return service.getRuleList();

}

通过验证，我们可以看到test项已经被成功添加到response的头部信息

Content-Length: 2 kilobytes

Content-Type: text/plain;charset=ISO-8859-1

Server: Apache-Coyote/1.1

test: test

接下来，我们希望修改Content-Type，从而统一服务器端和客户端的内容编码。我们继续修改代码，

@RequestMapping(value = "/rulelist", method = RequestMethod.GET)

@ResponseBody

public String getRuleList(HttpServletRequest request,

HttpServletResponse response) {

response.addHeader("Content-Type", "application/json;charset=UTF-8");

return service.getRuleList();

}

接下来，我们验证一下结果：

Content-Length: 2 kilobytes

Content-Type: text/plain;charset=ISO-8859-1

Server: Apache-Coyote/1.1

和我们预想的并一样，response的content-type header没有被设置成"application/json;charset=UTF-8"，很令人困惑。

那么，接下来让我们来探索下Spring MVC内部是如何处理这一过程的。首先我们先要对Spring MVC框架处理Http请求的流程有一个整体的了解。

下图清晰地向大家展示了Spring MVC处理HTTP请求的流程，（图片来自网络）

具体流程如下：

1. DispatcherServlet接收到Request请求

2. HandlerMapping选择一个合适的Handler处理Request请求

3-4. 选择合适的HandlerAdapter，调用用户编写的Controller处理业务逻辑。（HandlerAdapter主要是帮助Spring MVC支持多种类型的Controller）

5. Controller将返回结果放置到Model中并且返回view名称给Handler Adapter

6. DispatcherServlet选择合适的ViewResolver来生成View对象

7-8. View对象利用Model中的数据进行渲染并返回数据

相信大家对于上面的处理流程并不陌生，上面的流程图向我们展示了SpringMVC生成ModelAndView并返回response的大体流程。

下面我们来看看我们上面代码片段的处理流程是如何进行的？

从上面的流程图我们可以看到，content-type header是单独被处理的，具体过程可以参考下面的源码(AbstractMessageConverterMethodProcessor)：

protected <T> void writeWithMessageConverters(T returnValue, MethodParameter returnType,

ServletServerHttpRequest inputMessage, ServletServerHttpResponse outputMessage)

throws IOException, HttpMediaTypeNotAcceptableException {

Class<?> returnValueClass = getReturnValueType(returnValue, returnType);

HttpServletRequest servletRequest = inputMessage.getServletRequest();

List<MediaType> requestedMediaTypes = getAcceptableMediaTypes(servletRequest); //适合的兼容media types类型实际上，我们可以使用produces = {}来指定我们需要的mediatype

List<MediaType> producibleMediaTypes = getProducibleMediaTypes(servletRequest, returnValueClass);

Set<MediaType> compatibleMediaTypes = new LinkedHashSet<MediaType>();

for (MediaType requestedType : requestedMediaTypes) {

for (MediaType producibleType : producibleMediaTypes) {

if (requestedType.isCompatibleWith(producibleType)) {

compatibleMediaTypes.add(getMostSpecificMediaType(requestedType, producibleType));

}

if (compatibleMediaTypes.isEmpty()) {

if (returnValue != null) {

throw new HttpMediaTypeNotAcceptableException(producibleMediaTypes);

}

return;

}

List<MediaType> mediaTypes = new ArrayList<MediaType>(compatibleMediaTypes);

MediaType.sortBySpecificityAndQuality(mediaTypes);

MediaType selectedMediaType = null;　　　//选择最匹配的mediaType

for (MediaType mediaType : mediaTypes) {

if (mediaType.isConcrete()) {

selectedMediaType = mediaType;

break;

}

else if (mediaType.equals(MediaType.ALL) || mediaType.equals(MEDIA_TYPE_APPLICATION)) {

selectedMediaType = MediaType.APPLICATION_OCTET_STREAM;

break;

}

if (selectedMediaType != null) {

selectedMediaType = selectedMediaType.removeQualityValue();

for (HttpMessageConverter<?> messageConverter : this.messageConverters) { //遍历messageConvertors, 寻找可以处理相应返回类型和mediatype的HttpMessageConvertor

if (messageConverter.canWrite(returnValueClass, selectedMediaType)) {

returnValue = this.adviceChain.invoke(returnValue, returnType, selectedMediaType,

(Class<HttpMessageConverter<?>>) messageConverter.getClass(), inputMessage, outputMessage);

if (returnValue != null) { //这里将会填充mediatype到header，并将httpmessage发送给请求者

((HttpMessageConverter<T>) messageConverter).write(returnValue, selectedMediaType, outputMessage);

if (logger.isDebugEnabled()) {

logger.debug("Written [" + returnValue + "] as \"" + selectedMediaType + "\" using [" +

messageConverter + "]");

}

return;

}

if (returnValue != null) {

throw new HttpMediaTypeNotAcceptableException(this.allSupportedMediaTypes);

}

接下来，将选择好的mediatype写入到HttpOutputMessage中

public final void write(final T t, MediaType contentType, HttpOutputMessage outputMessage)

throws IOException, HttpMessageNotWritableException {

final HttpHeaders headers = outputMessage.getHeaders(); //设置contenttype到HttpOutputMessage

if (headers.getContentType() == null) {

MediaType contentTypeToUse = contentType;

if (contentType == null || contentType.isWildcardType() || contentType.isWildcardSubtype()) {

contentTypeToUse = getDefaultContentType(t);

}

if (contentTypeToUse != null) {

headers.setContentType(contentTypeToUse);

}

if (headers.getContentLength() == -1) {

Long contentLength = getContentLength(t, headers.getContentType());

if (contentLength != null) {

headers.setContentLength(contentLength);

}

　　　　　　/* 省略了不相干代码 */

}

最终的Headers设置在ServletServerHttpResponse类中完成，

private void writeHeaders() {

if (!this.headersWritten) {

for (Map.Entry<String, List<String>> entry : this.headers.entrySet()) {

String headerName = entry.getKey();

for (String headerValue : entry.getValue()) { //将复合类中之前设置的header(content-type)内容补充到servletResponse

this.servletResponse.addHeader(headerName, headerValue);

}

// HttpServletResponse exposes some headers as properties: we should include those if not already present

if (this.servletResponse.getContentType() == null && this.headers.getContentType() != null) {

this.servletResponse.setContentType(this.headers.getContentType().toString());

}

if (this.servletResponse.getCharacterEncoding() == null && this.headers.getContentType() != null &&

this.headers.getContentType().getCharSet() != null) {

this.servletResponse.setCharacterEncoding(this.headers.getContentType().getCharSet().name());

}

this.headersWritten = true;

}

需要在@RequestMapping中添加produces = {} 进行设置才可以。

Spring MVC处理响应的 header的更多相关文章

Spring MVC能响应HTTP请求的原因？
很多Java面试官喜欢问这个问题: 一个Spring MVC的项目文件里,开发人员没有开发自己的Servlet,只通过注解@RequestMapping定义了方法home能响应发向 /mvc/test ...
Spring MVC @ResponseBody响应中文乱码
问题:在前端通过get请求服务端返回String类型的服务时,会出现中文乱码问题原因:由于spring默认对String类型的返回的编码采用的是 StringHttpMessageConverter ...
Spring MVC执行的流程
1.Spring MVC应用的开发步骤 a.在web.xml文件中定义前端控制器DispatcherServlet来拦截用户请求.由于Web应用是基于请求/响应架构的应用,所以不管哪个MVC Web ...
Spring MVC 简述：从MVC框架普遍关注的问题说起
任何一个完备的MVC框架都需要解决Web开发过程中的一些共性的问题,比如请求的收集与分发.数据前后台流转与转换,当前最流行的SpringMVC和Struts2也不例外.本文首先概述MVC模式的分层思想 ...
Spring MVC详细讲解
一:三层架构和MVC 1:三层架构我们的开发架构一般都是基于两种形式:一种是 C/S 架构,也就是客户端/服务器,另一种是 B/S 架构,也就是浏览器服务器.在 JavaEE 开发中,几乎全都是基于 ...
前端控制器是整个MVC框架中最为核心的一块，它主要用来拦截符合要求的外部请求，并把请求分发到不同的控制器去处理，根据控制器处理后的结果，生成相应的响应发送到客户端。前端控制器既可以使用Filter实现（Struts2采用这种方式），也可以使用Servlet来实现(spring MVC框架)。
本文转自http://www.cnblogs.com/davidwang456/p/4090058.html 感谢作者前端控制器是整个MVC框架中最为核心的一块,它主要用来拦截符合要求的外部请求,并 ...
从content-type设置看Spring MVC处理header的一个坑
我们经常需要在HttpResponse中设置一些headers,我们使用Spring MVC框架的时候我们如何给Response设置Header呢? Sooooooooooooo easy, 看下面的 ...
spring mvc 通过拦截器记录请求数据和响应数据
spring mvc 能过拦截器记录请求数据记录有很多种方式,主要有以下三种: 1:过滤器 2:HandlerInterceptor拦截器 3:Aspect接口控制器但是就我个人所知要记录返回的数据 ...
spring MVC 返回值信息和ResponseBody的响应json数据
spring mvc的界面返回: 如果我们定义的返回类型是String 那么我们返回的时候直接写入我们的界面的名字就可以了 springmvc会自动去找到我们的界面,如果是void类型的返回那么 ...

随机推荐

第一个spring冲刺总结
讨论成员:罗凯旋.罗林杰.吴伟锋.黎文衷第一阶段总体是做到了运算的功能,只是一些基本的功能实现,包括APP进入动画,以及界面的基本效果设计,还有核心算法已经实现(可以计算括号乘除法等等)“: 燃尽 ...
【动态规划】POJ-3616
一.题目 Description Bessie is such a hard-working cow. In fact, she is so focused on maximizing her pro ...
Java Head First & 多态
package com.cwcec.tag; class Fruit { } class Apple extends Fruit{} class Animal { public Fruit eat(F ...
Internet History, Technology and Security (Week 5-2)
Week 5 (续) Layer 2: Internet Protocol The InterNetwork (IP) 老师强调了一下不用去记住他介绍的人所说的每句话,而是记住要点,了解老师所做的PP ...
Python入门：类与类的继承
类,是一些有共同特征和行为事物的抽象概念的总和. 1. 定义一个类: 我们使用class来定义一个类,和之前说过的定义函数用def类似.在类里面给变量赋值时,专业术语称之为类的属性. 比如拿可口可乐来 ...
testdisk修复文件系统
故障修复步骤: 1. 检查磁盘分区级文件系统确实不在: 2. 云主机内部下载testdisk工具修复 yum install testdisk -y 3. 执行命令testdisk /dev/vdc进 ...
相见恨晚的 scala - 01 [ 基础 ]
简洁到不行,多一个分号都是不应该. 学习笔记: centOS 下安装 scala 和安装 jdk 一毛一样 . 1 . 不同于 Java 的变量声明 :( 但是和 js 很像 ) /** * Crea ...
ACdream1093
给你三种正多面体,正四面体,正六面体,正八面体.求从某一种正多面体中的某一点走到另一个点,且步数不超过k(1018)的方案数. 首先说明一下我交题的时候遇到的问题,起点和终点为同一点的时候,算不算走了 ...
UVAlive4287_Proving Equivalences
题意是告诉你有n个命题,m条递推关系,表示某个命题可以推出另外一个命题. 现在问你至少在增加多少个递推关系可以保证所有命题两两互推. 命题为点,关系为有向边,题目转化成为至少增加多少条有向边使得整个图 ...
牛客OI赛制测试赛3 解题报告
前话: 话说考试描述:普及难度. 于是想在这场比赛上涨点信心. 考出来的结果:Point:480 Rank:40 然而同机房的最好成绩是 510. 没考好啊!有点炸心态,D题一些细节没有注意, ...

Spring MVC处理响应的 header

Spring MVC处理响应的 header的更多相关文章

随机推荐

热门专题