在SpringBoot项目中获取Request的四种方法
作者:IDIOT___IDIOT
SpringBoot 项目中获取 Request 的四种方法
方法1、Controller中加参数来获取request
注意:只能在Controller中加入request参数。
一般,我们在Controller中加参数获取HttpServletRequest,如下所示:
@RestController @RequestMapping("/gap") public class PlantTraceController { @PostMapping("/plantTrace") public Result2 savePlantTraceInfo(@RequestBody JSONObject jsonObject, HttpServletRequest request) { String methodName = request.getHeader("methodName"); .... }
该方法实现的原理是,在Controller方法开始处理请求时,Spring会将request对象赋值到方法参数中。此时request对象是方法参数,相当于局部变量,毫无疑问是线程安全的。
Controller中获取request对象后,如果要在其他方法中(如service方法、工具类方法等)使用request对象,需要在调用这些方法时将request对象作为参数传入。
优缺点
这种方法的主要缺点是request对象写起来冗余太多,主要体现在两点:
- 如果多个controller方法中都需要request对象,那么在每个方法中都需要添加一遍request参数
- request对象的获取只能从controller开始,如果使用request对象的地方在函数调用层级比较深的地方,那么整个调用链上的所有方法都需要添加request参数
实际上,在整个请求处理的过程中,request对象是贯穿始终的;也就是说,除了定时器等特殊情况,request对象相当于线程内部的一个全局变量。而该方法,相当于将这个全局变量,传来传去。
方法2、自动注入来获取request
注意:只能在Bean中注入request
@Controller public class TestController{ @Autowired private HttpServletRequest request; //自动注入request @RequestMapping("/test") public void test() throws InterruptedException{ //模拟程序执行了一段时间 Thread.sleep(1000); } }
优缺点
该方法的主要优点:
- 注入不局限于Controller中:在方法1中,只能在Controller中加入request参数。而对于方法2,不仅可以在Controller中注入,还可以在任何Bean中注入,包括Service、Repository及普通的Bean。
- 注入的对象不限于request:除了注入request对象,该方法还可以注入其他scope为request或session的对象,如response对象、session对象等;并保证线程安全。
- 减少代码冗余:只需要在需要request对象的Bean中注入request对象,便可以在该Bean的各个方法中使用,与方法1相比大大减少了代码冗余。
但是,该方法也会存在代码冗余。考虑这样的场景:web系统中有很多controller,每个controller中都会使用request对象(这种场景实际上非常频繁),这时就需要写很多次注入request的代码;如果还需要注入response,代码就更繁琐了。下面说明自动注入方法的改进方法,并分析其线程安全性及优缺点。
方法3:基类中自动注入(推荐)
注意:只能在Bean中注入request
与方法2相比,将注入部分代码放入到了基类中。
基类代码:
public class BaseController { @Autowired protected HttpServletRequest request; }
优缺点
与方法2相比,避免了在不同的Controller中重复注入request;但是考虑到java只允许继承一个基类,所以如果Controller需要继承其他类时,该方法便不再好用。
无论是方法2和方法3,都只能在Bean中注入request;如果其他方法(如工具类中static方法)需要使用request对象,则需要在调用这些方法时将request参数传递进去。下面介绍的方法4,则可以直接在诸如工具类中的static方法中使用request对象(当然在各种Bean中也可以使用)。
方法4:从RequestContextHolder中获取request
代码示例
@Controller public class TestController { @RequestMapping("/test") public void test() throws InterruptedException { HttpServletRequest request = ((ServletRequestAttributes) (RequestContextHolder.currentRequestAttributes())).getRequest(); // 模拟程序执行了一段时间 Thread.sleep(1000); } }
优缺点
优点:可以在非Bean中直接获取。缺点:如果使用的地方较多,代码非常繁琐;因此可以与其他方法配合使用。
以上就是在SpringBoot项目中获取Request的四种方法的详细内容,更多关于SpringBoot获取Request的资料请关注脚本之家其它相关文章!