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