Spring注入的成员属性HttpServletRequest是线程安全的吗?【享学Spring MVC】(下)

简介: Spring注入的成员属性HttpServletRequest是线程安全的吗?【享学Spring MVC】(下)

RequestObjectFactory


至于为何使用的是这个Factory来处理,请参考web容器初始化时的这块代码:


WebApplicationContextUtils:
  public static void registerWebApplicationScopes(ConfigurableListableBeanFactory beanFactory, @Nullable ServletContext sc) {
    // web容器下新增支持了三种scope
    // 非web容器(默认)只有单例和多例两种嘛
    beanFactory.registerScope(WebApplicationContext.SCOPE_REQUEST, new RequestScope());
    beanFactory.registerScope(WebApplicationContext.SCOPE_SESSION, new SessionScope());
    if (sc != null) {
      ServletContextScope appScope = new ServletContextScope(sc);
      beanFactory.registerScope(WebApplicationContext.SCOPE_APPLICATION, appScope);
      sc.setAttribute(ServletContextScope.class.getName(), appScope);
      // ==================依赖注入=================
      // 这里决定了,若你依赖注入ServletRequest的话,就使用RequestObjectFactory来处理你
      beanFactory.registerResolvableDependency(ServletRequest.class, new RequestObjectFactory());
      beanFactory.registerResolvableDependency(ServletResponse.class, new ResponseObjectFactory());
      beanFactory.registerResolvableDependency(HttpSession.class, new SessionObjectFactory());
      beanFactory.registerResolvableDependency(WebRequest.class, new WebRequestObjectFactory());
    }
  }


RequestObjectFactory自己的代码非常非常简单:


WebApplicationContextUtils:
  private static class RequestObjectFactory implements ObjectFactory<ServletRequest>, Serializable {
    // 从当前请求上下文里找到Request对象
    @Override
    public ServletRequest getObject() {
      return currentRequestAttributes().getRequest();
    }
    ...
  }
  // 从当前请求上下文:RequestContextHolder里找到请求属性,进而就可以拿到请求对象、响应对象等等了
  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;
  }


到这个节点可以知道,关键点就在于:RequestContextHolder.currentRequestAttributes()的值哪儿来的,或者说是什么时候放进去的,放了什么进去?


Spring何时把Request信息放进RequestContextHolder?



首先必须清楚:RequestContextHolder它代表着请求上下文,内部使用ThreadLocal来维护着,用于在线程间传递RequestAttributes数据。


// 它是个工具类:用抽象类表示而已  所有方法均静态
public abstract class RequestContextHolder {
  private static final ThreadLocal<RequestAttributes> requestAttributesHolder = new NamedThreadLocal<>("Request attributes");
  private static final ThreadLocal<RequestAttributes> inheritableRequestAttributesHolder = new NamedInheritableThreadLocal<>("Request context");
  ... // 省略set、get、reset等方法 
}


说明:关于ThreadLocal的使用,以及误区什么的,请务必参阅此文:ThreadLocal能解决线程安全问题?胡扯!本文教你正确的使用姿势


需要说明的是:Spring此处使用了InheritableThreadLocal用于传递,所以即使你在子线程里也是可以通过上下文RequestContextHolder获取到RequestAttributes数据的。


要想找到何时向RequestContextHolder里放值的,仅需知道何时调用的set方法便可(它有两个set方法,其中一个set方法仅在RequestContextListener里被调用,可忽略):


image.png


RequestContextFilter


该过滤器RequestContextFilter主要是用于第三方serlvet比如JSF FacesServlet。在Spring自己的Web应用中,如果一个请求最终被DispatcherServlet处理,它自己完成请求上下文的维护(比如对RequestContextHolder的维护)。


但是,并不是所有的请求都最终会被DispatcherServlet处理,比如匿名用户访问一个登录用户才能访问的资源,此时请求只会被安全过滤器(如TokenFilter)处理,而不会到达DispatcherServlet,在这种情况下,该过滤器RequestContextFilter就起了担当了相应的职责。


RequestContextFilter负责LocaleContextHolder和RequestContextHolder,而在过滤器内部很轻松的可以拿到HttpServletRequest,所以在不继承第三方Servlet技术的情况下,此Filter几乎用不着~


FrameworkServlet

“排除”上面一种设置的机会,只剩下FrameworkServlet了。它的initContextHolders()方法和resetContextHolders()方法均会维护请求上下文:


FrameworkServlet:
  // 处理请求的方法
  protected final void processRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    ...
    ServletRequestAttributes requestAttributes = buildRequestAttributes(request, response, previousAttributes);
    ...
    initContextHolders(request, localeContext, requestAttributes);
    try {
      // 抽象方法:交给DispatcherServlet去实现
      doService(request, response);
    } catch { 
      ...
    } finally {
      resetContextHolders(request, previousLocaleContext, previousAttributes);
      ...
    }
  }
  private void initContextHolders(...) {
    ...
    RequestContextHolder.setRequestAttributes(requestAttributes, this.threadContextInheritable);
  }


说明:initContextHolders的另外一处调用处在RequestBindingInterceptor里,在Async异步支持时用于绑定的,略。


由此可见,只要请求交给了FrameworkServlet处理,那么请求上下文里就必然有Request/Response等实例,并且是和每个请求线程绑定的(独享)。而我们绝大多数情况下都是在Controller或者后续流程中希望得到HttpServletRequest,那时请求上下文就已经把其和当先线程绑定好啦~


依赖注入【确定安全】流程总结


经过这一波分析,通过@Autowired方式依赖注入得到HttpServletRequest是线程安全的结论是显而易见的了:通过JDK动态代理,每次方法调用实际调用的是实际请求对象HttpServletRequest。先对它的关键流程步骤总结如下:


  1. 在Spring解析HttpServletRequest类型的@Autowired依赖注入时,实际注入的是个JDK动态代理对象
  2. 该代理对象的处理器是:ObjectFactoryDelegatingInvocationHandler,内部实际实例由ObjectFactory动态提供,数据由RequestContextHolder请求上下文提供,请求上下文的数据在请求达到时被赋值,参照下面步骤
  3. 该ObjectFactory是一个RequestObjectFactory(这是由web上下文初始化时决定的)
  4. 请求进入时,单反只要经过了FrameworkServlet处理,便会在处理时(调用Controller目标方法前)把Request相关对象设置到RequestContextHolder的ThreadLocal中去
  5. 这样便完成了:调用Controller目标方法前完成了Request对象和线程的绑定,所以在目标方法里,自然就可以通过当前线程把它拿出来喽,这一切都拜托的是ThreadLocal去完成的~

值得注意的是:若有不经过FrameworkServlet的请求(比如被过滤器过滤了,Spring MVC拦截器不行的哦它还是会经过FrameworkServlet处理的),但却又想这么使用,那么请主动配置RequestContextFilter这个过滤器来达到目的吧。


谨防线程池里使用HttpServletRequest的坑


源码也已经分析了,Spring的RequestContextHolder使用的InheritableThreadLocal,所以最多支持到父线程向子线程的数据传递,因此若你这么使用:


@Autowired
HttpServletRequest requestAuto;
@GetMapping("/test/request")
public Object testRequest() {
    new Thread(() -> {
        String name = requestAuto.getParameter("name");
        System.out.println(name);
    }).start();
    return "success";
}

是可以正常work的,但若你放在线程池里面执行,形如这样:


private static final ExecutorService THREAD_POOL = Executors.newFixedThreadPool(10);
@Autowired
HttpServletRequest requestAuto;
@GetMapping("/test/request")
public Object testRequest() {
    THREAD_POOL.execute(() -> {
        String name = requestAuto.getParameter("name");
        System.out.println(name);
    });
    return "success";
}


那是会出问题的,不能正常work。究其原因是@Autowire注入进来的实际使用的Request对象获取使用的是RequestContextHolder,而它最多只支持向子线程传递数据,不支持线程池。


说明:只有@Autowired进来的,或者自己在线程池内手动通过RequestContextHolder获取才有问题哦,HttpServletRequest通过请求参数进来的是木有问题哒~


至于底层原因,请参考文章:ThreadLocal垮线程池传递数据解决方案:TransmittableThreadLocal


总结


该文讲述的内容虽然并不难,但我认为还是比较“时髦”的,相信能给到很多人予以帮助,那就足够了。


最后提示一小点:有人留言我说可以使用RequestContextListener这个监听器,它也能给RequestContext赋值完成绑定。答案是可以的,因为它是一个源生的Servlet请求监听器:javax.servlet.ServletRequestListener可以监听到每个请求,RequestContextListener是Spring给出的监听器实现,因此只要你在xml里配置上它/or @Bean的方式也是可行的,只是上面已经说了,绝大部分情况下并不需自己麻烦自己的这么做

相关文章
|
前端开发 Java 测试技术
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
本文介绍了 `@RequestParam` 注解的使用方法及其与 `@PathVariable` 的区别。`@RequestParam` 用于从请求中获取参数值(如 GET 请求的 URL 参数或 POST 请求的表单数据),而 `@PathVariable` 用于从 URL 模板中提取参数。文章通过示例代码详细说明了 `@RequestParam` 的常用属性,如 `required` 和 `defaultValue`,并展示了如何用实体类封装大量表单参数以简化处理流程。最后,结合 Postman 测试工具验证了接口的功能。
1121 0
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestBody
`@RequestBody` 是 Spring 框架中的注解,用于将 HTTP 请求体中的 JSON 数据自动映射为 Java 对象。例如,前端通过 POST 请求发送包含 `username` 和 `password` 的 JSON 数据,后端可通过带有 `@RequestBody` 注解的方法参数接收并处理。此注解适用于传递复杂对象的场景,简化了数据解析过程。与表单提交不同,它主要用于接收 JSON 格式的实体数据。
1765 0
|
前端开发 Java 微服务
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@PathVariable
`@PathVariable` 是 Spring Boot 中用于从 URL 中提取参数的注解,支持 RESTful 风格接口开发。例如,通过 `@GetMapping(&quot;/user/{id}&quot;)` 可以将 URL 中的 `{id}` 参数自动映射到方法参数中。若参数名不一致,可通过 `@PathVariable(&quot;自定义名&quot;)` 指定绑定关系。此外,还支持多参数占位符,如 `/user/{id}/{name}`,分别映射到方法中的多个参数。运行项目后,访问指定 URL 即可验证参数是否正确接收。
1151 0
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestMapping
@RequestMapping 是 Spring MVC 中用于请求地址映射的注解,可作用于类或方法上。类级别定义控制器父路径,方法级别进一步指定处理逻辑。常用属性包括 value(请求地址)、method(请求类型,如 GET/POST 等,默认 GET)和 produces(返回内容类型)。例如:`@RequestMapping(value = &quot;/test&quot;, produces = &quot;application/json; charset=UTF-8&quot;)`。此外,针对不同请求方式还有简化注解,如 @GetMapping、@PostMapping 等。
1203 0
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RestController
本文主要介绍 Spring Boot 中 MVC 开发常用的几个注解及其使用方式,包括 `@RestController`、`@RequestMapping`、`@PathVariable`、`@RequestParam` 和 `@RequestBody`。其中重点讲解了 `@RestController` 注解的构成与特点:它是 `@Controller` 和 `@ResponseBody` 的结合体,适用于返回 JSON 数据的场景。文章还指出,在需要模板渲染(如 Thymeleaf)而非前后端分离的情况下,应使用 `@Controller` 而非 `@RestController`
741 0
|
前端开发 Java 微服务
《深入理解Spring》:Spring、Spring MVC与Spring Boot的深度解析
Spring Framework是Java生态的基石,提供IoC、AOP等核心功能;Spring MVC基于其构建,实现Web层MVC架构;Spring Boot则通过自动配置和内嵌服务器,极大简化了开发与部署。三者层层演进,Spring Boot并非替代,而是对前者的高效封装与增强,适用于微服务与快速开发,而深入理解Spring Framework有助于更好驾驭整体技术栈。
|
前端开发 Java API
Spring Cloud Gateway Server Web MVC报错“Unsupported transfer encoding: chunked”解决
本文解析了Spring Cloud Gateway中出现“Unsupported transfer encoding: chunked”错误的原因,指出该问题源于Feign依赖的HTTP客户端与服务端的`chunked`传输编码不兼容,并提供了具体的解决方案。通过规范Feign客户端接口的返回类型,可有效避免该异常,提升系统兼容性与稳定性。
1029 0
|
SQL Java 数据库连接
Spring、SpringMVC 与 MyBatis 核心知识点解析
我梳理的这些内容,涵盖了 Spring、SpringMVC 和 MyBatis 的核心知识点。 在 Spring 中,我了解到 IOC 是控制反转,把对象控制权交容器;DI 是依赖注入,有三种实现方式。Bean 有五种作用域,单例 bean 的线程安全问题及自动装配方式也清晰了。事务基于数据库和 AOP,有失效场景和七种传播行为。AOP 是面向切面编程,动态代理有 JDK 和 CGLIB 两种。 SpringMVC 的 11 步执行流程我烂熟于心,还有那些常用注解的用法。 MyBatis 里,#{} 和 ${} 的区别很关键,获取主键、处理字段与属性名不匹配的方法也掌握了。多表查询、动态
496 0
|
JSON 前端开发 Java
第05课:Spring Boot中的MVC支持
第05课:Spring Boot中的MVC支持
542 0
|
Java 数据库 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
921 0