Spring MVC 中RequestContextHolder获取request和response

主要参考@winner_0715的博客：spring MVC中几种获取request和response的方式

1.最简单方式：参数

例如：

@RequestMapping("/test")
@ResponseBody
public void saveTest(HttpServletRequest req, HttpServletResponse resp){
　　
}

2.加入监听器，然后在代码里面获取

在Spring API中提供了一个非常便捷的工具类RequestContextHolder，能够在Controller中获取request对象和response对象，使用方法如下

HttpServletRequest req = ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();
HttpServletResponse resp = ((ServletWebRequest)RequestContextHolder.getRequestAttributes()).getResponse();

需要注意的是如果直接使用这个工具类，则会抛出一个空指针异常。原因是需要先

a.在web.xml配置RequestContextListener监听器:

<listener>
      <listener-class>org.springframework.web.context.request.RequestContextListener</listener-class>
</listener>

原理

RequestContextListener实现了 ServletRequestListener ,在其覆盖的requestInitialized(ServletRequestEvent requestEvent)方法中,将request最终设置到了RequestContextHolder中.

public class RequestContextListener implements ServletRequestListener {

    private static final String REQUEST_ATTRIBUTES_ATTRIBUTE =
            RequestContextListener.class.getName() + ".REQUEST_ATTRIBUTES";


    @Override
    public void requestInitialized(ServletRequestEvent requestEvent) {
        if (!(requestEvent.getServletRequest() instanceof HttpServletRequest)) {
            throw new IllegalArgumentException(
                    "Request is not an HttpServletRequest: " + requestEvent.getServletRequest());
        }
        HttpServletRequest request = (HttpServletRequest) requestEvent.getServletRequest();//从事件对象中获取request对象
        ServletRequestAttributes attributes = new ServletRequestAttributes(request);//将request设置到servletRequestAttributes中
        request.setAttribute(REQUEST_ATTRIBUTES_ATTRIBUTE, attributes);//反过来将servletRequestAttributes设置到request中
        LocaleContextHolder.setLocale(request.getLocale());
        RequestContextHolder.setRequestAttributes(attributes);//再将servletRequestAttributes设置到requestContextHolder中
    }

 b.或者在web.xml配置RequestContextListener监听器:

	<listener>
		<listener-class>
			dragon.core.web.MultipartRequestContextListener
		</listener-class>
	</listener>

原理

MultipartRequestContextListener同样实现了 ServletRequestListener ,在其覆盖的requestInitialized(ServletRequestEvent requestEvent)方法中,将request最终设置到了MultipartRequestContextHolder中.

@Override
	public void requestInitialized(ServletRequestEvent requestEvent)
	{
		if (!(requestEvent.getServletRequest() instanceof HttpServletRequest))
		{
			throw new IllegalArgumentException("Request is not an HttpServletRequest: "
					+ requestEvent.getServletRequest());
		}
		HttpServletRequest request = (HttpServletRequest) requestEvent.getServletRequest();//从事件对象中获取request对象
                String requestURI = request.getRequestURI();
		if (requestURI.contains("bizObjectHandler/add") || requestURI.contains("bizObjectHandler/mod")
				|| requestURI.contains("fileHandler/kindEditorUpload") || requestURI.contains("apiService.hs")
				|| requestURI.contains("uploadFile.do") || requestURI.contains("uploadFiles.do")
				|| requestURI.contains("importDics.do"))
		{
			if (multipartResolver == null)
			{
				multipartResolver = (MultipartResolver) SpringUtil.getBean("multipartResolver");
			}
			if (multipartResolver.isMultipart(request))
			{
				MultipartHttpServletRequest multipartRequest = multipartResolver.resolveMultipart(request);//将request分解成multipartRequest
				MultipartRequestHolder.setMultipartHttpServletRequest(multipartRequest);//将multipartRequest设置到MultipartRequestHolder中
			}
		}
	}