SpringBoot獲取Request的3種方法！
作者 | 磊哥
來源 | Java中文社群（ID：javacn666）
轉(zhuǎn)載請(qǐng)聯(lián)系授權(quán)（微信ID：GG_Stone）
HttpServletRequest 簡(jiǎn)稱 Request，它是一個(gè) Servlet API 提供的對(duì)象，用于獲取客戶端發(fā)起的 HTTP 請(qǐng)求信息。例如：獲取請(qǐng)求參數(shù)、獲取請(qǐng)求頭、獲取 Session 會(huì)話信息、獲取請(qǐng)求的 IP 地址等信息。
那么問題來了，在 Spring Boot 中，獲取 Request 對(duì)象的方法有哪些？
常見的獲取 Request 對(duì)象的方法有以下三種：
-
通過請(qǐng)求參數(shù)中獲取 Request 對(duì)象； -
通過 RequestContextHolder 獲取 Request 對(duì)象； -
通過自動(dòng)注入獲取 Request 對(duì)象。
具體實(shí)現(xiàn)如下。
1.通過請(qǐng)求參數(shù)獲取
實(shí)現(xiàn)代碼：
@RequestMapping("/index")
@ResponseBody
public void index(HttpServletRequest request){
// do something
}
該方法實(shí)現(xiàn)的原理是 Controller 開始處理請(qǐng)求時(shí)，Spring 會(huì)將 Request 對(duì)象賦值到方法參數(shù)中，我們直接設(shè)置到參數(shù)中即可得到 Request 對(duì)象。
2.通過 RequestContextHolder 獲取
在 Spring Boot 中，RequestContextHolder 是 Spring 框架提供的一個(gè)工具類，用于在多線程環(huán)境中存儲(chǔ)和訪問與當(dāng)前線程相關(guān)的請(qǐng)求上下文信息。它主要用于將當(dāng)前請(qǐng)求的信息存儲(chǔ)在線程范圍內(nèi)，以便在不同的組件中共享和訪問這些信息，特別是在沒有直接傳遞參數(shù)的情況下。RequestContextHolder 的主要作用有以下幾個(gè)：
-
訪問請(qǐng)求上下文信息：在 Web 應(yīng)用中，每個(gè)請(qǐng)求都會(huì)觸發(fā)一個(gè)新的線程來處理。RequestContextHolder 允許你在任何地方獲取當(dāng)前請(qǐng)求的上下文信息，比如 HttpServletRequest 對(duì)象、會(huì)話信息等。 -
跨層傳遞信息：在多層架構(gòu)中，比如控制器、服務(wù)層、數(shù)據(jù)訪問層，你可能需要在這些層之間傳遞一些與請(qǐng)求相關(guān)的信息，但不想在每個(gè)方法中顯式傳遞。通過 RequestContextHolder，你可以在一處設(shè)置請(qǐng)求信息，在其他地方獲取并使用。 -
線程安全的上下文共享：RequestContextHolder 使用線程局部變量來存儲(chǔ)請(qǐng)求上下文信息，確保在多線程環(huán)境下每個(gè)線程訪問的上下文信息都是獨(dú)立的，避免了線程安全問題。
因此我們可以使用 RequestContextHolde 獲取 Request 對(duì)象，實(shí)現(xiàn)代碼如下：
@RequestMapping("/index")
@ResponseBody
public void index(){
ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
HttpServletRequest request = servletRequestAttributes.getRequest();
// do something
}
3.通過自動(dòng)注入獲取
HttpServletRequest 對(duì)象也可以通過自動(dòng)注入，如屬性注入的方式獲取，如下代碼所示：
@Controller
public class HomeController{
@Autowired
private HttpServletRequest request; // 自動(dòng)注入 request 對(duì)象
// do something
}
小結(jié)
Request 對(duì)象是獲取客戶端 HTTP 請(qǐng)求的重要對(duì)象，也是 Spring Boot 的重要對(duì)象之一，獲取此對(duì)象的常用方法有：通過請(qǐng)求參數(shù)獲取、通過 RequestContextHolder 獲取，以及通過注入獲取。