【SpringBoot】获取HttpServletRequest的三种方式

一时失言乱红尘 2023-09-26 23:55 36阅读 0赞

## 方法一: Controller中增加request参数 ##

@RestController
    public class DemoController { 
     
        @RequestMapping("/demo")
        public void demo(HttpServletRequest request) {        
            System.out.println(request.getParameter("hello"));
        }
    }

*  线程安全
 *  缺点: 每个方法都需要写一遍

## 方法二: 自动注入 ##

@Slf4j
    @RequestMapping(path = "/request")
    @RestController
    public class DemoRequestController {
    
        @Resource
        private HttpServletRequest request1;
    
        @RequestMapping(path = "/demo")
        public String demo(HttpServletRequest request2) {
            log.info("request1: {}", request1.getClass());
            log.info("request2: {}", request2.getClass());
            return "Hello, world!";
        }
    }

*  线程安全
 *  在`Spring`中，`DemoRequestController`的`scope`是`singleton`(单例)，也就是说在整个`web`系统中，只有一个`DemoRequestController`；但是其中注入的`request`却是线程安全的，原因在于：使用这种方式，当`Bean`（本例的`DemoRequestController`）初始化时，`Spring`并没有注入一个`request`对象，而是注入了一个代理（`proxy`）；当`Bean`中需要使用`request`对象时，通过该代理获取`request`对象。
 *  代理对象中用到了 `ThreadLocal` ， 因此request对象也是线程局部变量；这就保证了`request`对象的线程安全性。
 *  不限于`Controller`中，可以在任何地方进行注入
 *  注入的对象不限于`request`：除了注入`request`对象，该方法还可以注入其他`scope`为`request`或`session`的对象，如`HttpServletResponse`对象、`HttpSession`对象等；并保证线程安全
 *  如果`Controller`有很多，那么我们需要在每个`Controller`里面进行注入

## 方法三: 基类中自动注入 ##

本质与方法二类似

public class BaseController {   
     
       @Autowired 
       protected HttpServletRequest request;
    }

*  线程安全
 *  与方法2相比，避免了在不同的Controller中重复注入request
 *  但是java只允许继承一个基类

## 方法四: 手动调用 ##

@Slf4j
    @RequestMapping(path = "/request")
    @RestController
    public class DemoRequestController {
    
        @Resource
        private HttpServletRequest request1;
    
        @RequestMapping(path = "/demo")
        public String demo(HttpServletRequest request2) {
            HttpServletRequest request3 = ((ServletRequestAttributes) (RequestContextHolder.currentRequestAttributes())).getRequest();
            log.info("request1: {}", request1.getClass());
            log.info("request2: {}", request2.getClass());
            log.info("request3: {}", request3.getClass());
            return "Hello, world!";
        }
    }

*  线程安全
 *  可以在非`Bean`中直接获得
 *  缺点与方法一类似

## 总结 ##

获取`HttpServletRequest`共有三种方式

*  `Controller`的方法增加`HttpServletRequest`参数
 *  自动注入

> 建议使用继承来减少代码冗余

*  通过`RequestContextHolder.currentRequestAttributes()`手动获取

> 适合在非Bean中获取