SpringBoot 項目中獲取 Request 的四種方法

方法1、Controller中加參數(shù)來獲取request

注意：只能在Controller中加入request參數(shù)。

一般，我們在Controller中加參數(shù)獲取HttpServletRequest，如下所示：

@RestController
@RequestMapping("/gap")
public class PlantTraceController {
    @PostMapping("/plantTrace")
    public Result2 savePlantTraceInfo(@RequestBody JSONObject jsonObject, HttpServletRequest request) {
        String methodName = request.getHeader("methodName");
        ....
}

該方法實現(xiàn)的原理是，在Controller方法開始處理請求時，Spring會將request對象賦值到方法參數(shù)中。此時request對象是方法參數(shù)，相當于局部變量，毫無疑問是線程安全的。

Controller中獲取request對象后，如果要在其他方法中（如service方法、工具類方法等）使用request對象，需要在調用這些方法時將request對象作為參數(shù)傳入。

優(yōu)缺點

這種方法的主要缺點是request對象寫起來冗余太多，主要體現(xiàn)在兩點：

• 如果多個controller方法中都需要request對象，那么在每個方法中都需要添加一遍request參數(shù)
• request對象的獲取只能從controller開始，如果使用request對象的地方在函數(shù)調用層級比較深的地方，那么整個調用鏈上的所有方法都需要添加request參數(shù)

實際上，在整個請求處理的過程中，request對象是貫穿始終的；也就是說，除了定時器等特殊情況，request對象相當于線程內部的一個全局變量。而該方法，相當于將這個全局變量，傳來傳去。

方法2、自動注入來獲取request

注意：只能在Bean中注入request

@Controller
public class TestController{
    @Autowired
    private HttpServletRequest request; //自動注入request
    @RequestMapping("/test")
    public void test() throws InterruptedException{
        //模擬程序執(zhí)行了一段時間
        Thread.sleep(1000);
    }
}

優(yōu)缺點

該方法的主要優(yōu)點：

1. 注入不局限于Controller中：在方法1中，只能在Controller中加入request參數(shù)。而對于方法2，不僅可以在Controller中注入，還可以在任何Bean中注入，包括Service、Repository及普通的Bean。
2. 注入的對象不限于request：除了注入request對象，該方法還可以注入其他scope為request或session的對象，如response對象、session對象等；并保證線程安全。
3. 減少代碼冗余：只需要在需要request對象的Bean中注入request對象，便可以在該Bean的各個方法中使用，與方法1相比大大減少了代碼冗余。

但是，該方法也會存在代碼冗余。考慮這樣的場景：web系統(tǒng)中有很多controller，每個controller中都會使用request對象（這種場景實際上非常頻繁），這時就需要寫很多次注入request的代碼；如果還需要注入response，代碼就更繁瑣了。下面說明自動注入方法的改進方法，并分析其線程安全性及優(yōu)缺點。

方法3：基類中自動注入（推薦）

注意：只能在Bean中注入request

與方法2相比，將注入部分代碼放入到了基類中。

基類代碼：

public class BaseController {
    @Autowired
    protected HttpServletRequest request;     
}

優(yōu)缺點

與方法2相比，避免了在不同的Controller中重復注入request；但是考慮到java只允許繼承一個基類，所以如果Controller需要繼承其他類時，該方法便不再好用。

無論是方法2和方法3，都只能在Bean中注入request；如果其他方法（如工具類中static方法）需要使用request對象，則需要在調用這些方法時將request參數(shù)傳遞進去。下面介紹的方法4，則可以直接在諸如工具類中的static方法中使用request對象（當然在各種Bean中也可以使用）。

方法4：從RequestContextHolder中獲取request

代碼示例

@Controller
public class TestController {
    @RequestMapping("/test")
    public void test() throws InterruptedException {
        HttpServletRequest request = ((ServletRequestAttributes) (RequestContextHolder.currentRequestAttributes())).getRequest();
        // 模擬程序執(zhí)行了一段時間
        Thread.sleep(1000);
    }
}

優(yōu)缺點

優(yōu)點：可以在非Bean中直接獲取。缺點：如果使用的地方較多，代碼非常繁瑣；因此可以與其他方法配合使用。

以上就是在SpringBoot項目中獲取Request的四種方法的詳細內容，更多關于SpringBoot獲取Request的資料請關注腳本之家其它相關文章！

最新評論