Spring中获取request的几种方法

方法1：Controller中加参数

代码示例：

这种方法实现最简单，直接上Controller代码：

@Controller
public class TestController {
 @RequestMapping("/test")
 public void getXXX(HttpServletRequest request) throws InterruptedException {
 // 模拟程序执行了一段时间
 Thread.sleep(1000);
 }
}

该方法实现的原理是，在Controller方法开始处理请求时，Spring会将request对象赋值到方法参数中。除了request对象，可以通过这种方法获取的参数还有很多，具体可以参见：https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc-ann-methods

Controller中获取request对象后，如果要在其他方法中（如service方法、工具类方法等）使用request对象，需要在调用这些方法时将request对象作为参数传入。

线程安全：

测试结果：线程安全

分析：此时request对象是方法参数，相当于局部变量，毫无疑问是线程安全的。

优缺点：

这种方法的主要缺点是request对象写起来冗余太多，主要体现在两点：

1) 如果多个controller方法中都需要request对象，那么在每个方法中都需要添加一遍request参数

2) request对象的获取只能从controller开始，如果使用request对象的地方在函数调用层级比较深的地方，那么整个调用链上的所有方法都需要添加request参数

实际上，在整个请求处理的过程中，request对象是贯穿始终的；也就是说，除了定时器等特殊情况，request对象相当于线程内部的一个全局变量。而该方法，相当于将这个全局变量，传来传去。

方法2：自动注入

代码示例：

先上代码：

@Controller
public class TestController{
 
 @Autowired
 private HttpServletRequest request; //自动注入request
 
 @RequestMapping("/test")
 public void test() throws InterruptedException{
 //模拟程序执行了一段时间
 Thread.sleep(1000);
 }
}

线程安全：

测试结果：线程安全

分析：在Spring中，Controller的scope是singleton(单例)，也就是说在整个web系统中，只有一个TestController；但是其中注入的request却是线程安全的，原因在于：

使用这种方式，当Bean（本例的TestController）初始化时，Spring并没有注入一个request对象，而是注入了一个代理（proxy）；当Bean中需要使用request对象时，通过该代理获取request对象。

下面通过具体的代码对这一实现进行说明。

在上述代码中加入断点，查看request对象的属性，如下图所示：

在图中可以看出，request实际上是一个代理：代理的实现参见AutowireUtils的内部类ObjectFactoryDelegatingInvocationHandler：

/**
 * Reflective InvocationHandler for lazy access to the current target object.
 */
@SuppressWarnings("serial")
private static class ObjectFactoryDelegatingInvocationHandler implements InvocationHandler, Serializable {
 private final ObjectFactory> objectFactory;
 public ObjectFactoryDelegatingInvocationHandler(ObjectFactory> objectFactory) {
 this.objectFactory = objectFactory;
 }
 @Override
 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
 // ……省略无关代码
 try {
 return method.invoke(this.objectFactory.getObject(), args); // 代理实现核心代码
 }
 catch (InvocationTargetException ex) {
 throw ex.getTargetException();
 }
 }
}

也就是说，当我们调用request的方法method时，实际上是调用了由objectFactory.getObject()生成的对象的method方法；objectFactory.getObject()生成的对象才是真正的request对象。

继续观察上图，发现objectFactory的类型为WebApplicationContextUtils的内部类RequestObjectFactory；而RequestObjectFactory代码如下：

/**
 * Factory that exposes the current request object on demand.
 */
@SuppressWarnings("serial")
private static class RequestObjectFactory implements ObjectFactory<servletrequest>, Serializable {
 @Override
 public ServletRequest getObject() { 

 return currentRequestAttributes().getRequest();
 }
 @Override
 public String toString() {
 return "Current HttpServletRequest";
 }
}
/<servletrequest>

其中，要获得request对象需要先调用currentRequestAttributes()方法获得RequestAttributes对象，该方法的实现如下：

/**
 * Return the current RequestAttributes instance as ServletRequestAttributes.
 */
private static ServletRequestAttributes currentRequestAttributes() {
 RequestAttributes requestAttr = RequestContextHolder.currentRequestAttributes();
 if (!(requestAttr instanceof ServletRequestAttributes)) {
 throw new IllegalStateException("Current request is not a servlet request");
 }
 return (ServletRequestAttributes) requestAttr;
}

生成RequestAttributes对象的核心代码在类RequestContextHolder中，其中相关代码如下（省略了该类中的无关代码）：

public abstract class RequestContextHolder {
 public static RequestAttributes currentRequestAttributes() throws IllegalStateException {
 RequestAttributes attributes = getRequestAttributes();
 // 此处省略不相关逻辑…………
 return attributes;
 }
 public static RequestAttributes getRequestAttributes() {
 RequestAttributes attributes = requestAttributesHolder.get();
 if (attributes == null) {
 attributes = inheritableRequestAttributesHolder.get();
 }
 return attributes;
 }
 private static final ThreadLocal<requestattributes> requestAttributesHolder =
 new NamedThreadLocal<requestattributes>("Request attributes");
 private static final ThreadLocal<requestattributes> inheritableRequestAttributesHolder = 

 new NamedInheritableThreadLocal<requestattributes>("Request context");
}
/<requestattributes>/<requestattributes>/<requestattributes>/<requestattributes>

通过这段代码可以看出，生成的RequestAttributes对象是线程局部变量（ThreadLocal），因此request对象也是线程局部变量；这就保证了request对象的线程安全性。

优缺点：

该方法的主要优点：

1) 注入不局限于Controller中：在方法1中，只能在Controller中加入request参数。而对于方法2，不仅可以在Controller中注入，还可以在任何Bean中注入，包括Service、Repository及普通的Bean。

2) 注入的对象不限于request：除了注入request对象，该方法还可以注入其他scope为request或session的对象，如response对象、session对象等；并保证线程安全。

3) 减少代码冗余：只需要在需要request对象的Bean中注入request对象，便可以在该Bean的各个方法中使用，与方法1相比大大减少了代码冗余。

方法3：手动调用

代码示例：

@Controller
public class TestController {
 @RequestMapping("/test")
 public void test() throws InterruptedException {
 HttpServletRequest request = ((ServletRequestAttributes) (RequestContextHolder.currentRequestAttributes())).getRequest();
 // 模拟程序执行了一段时间 

 Thread.sleep(1000);
 }
}

线程安全：

测试结果：线程安全

分析：该方法与方法2（自动注入）类似，只不过方法2中通过自动注入实现，本方法通过手动方法调用实现。因此本方法也是线程安全的。

优缺点：

 优点：可以在非Bean中直接获取。