詳解Spring Boot如何獲取Request

在Web應用程序的開發過程中，獲取請求(request)是常見的需求。而在Spring Boot中，獲取請求可以通過多種方式實現。本文將會從不同的角度深入探討Spring Boot如何獲取Request。

一、通過Controller接收Request

最常見的獲取請求的方式，就是在Controller方法的參數列表中添加HttpServletRequest參數，例如：

@RequestMapping("/example")
@ResponseBody
public String example(HttpServletRequest request) {
    // 處理請求
    return "Hello, World!";
}

這種方式可以獲取到完整的請求(request)信息，比如請求的URL、Header、Body等。但是，如果參數列表中添加的HttpServletRequest參數較多或者需要獲取的信息較多，這種方式就顯得有些負責。

二、通過@ModelAttribute註解獲取Request參數

另一種獲取請求參數(request parameter)的方式是使用@ModelAttribute註解，例如：

@RequestMapping("/example")
@ResponseBody
public String example(@ModelAttribute ExampleRequest request) {
    // 處理請求
    return "Hello, World!";
}

其中ExampleRequest是一個POJO類（Plain Old Java Object，純Java對象），用於封裝請求的參數。在這種方式中，Spring Boot會自動從請求中獲取到參數，並將其綁定到ExampleRequest對象中。

三、通過@RequestParam註解獲取Request參數

還有一種獲取請求參數的方式是使用@RequestParam註解，例如：

@RequestMapping("/example")
@ResponseBody
public String example(@RequestParam("name") String name) {
    // 處理請求
    return "Hello, " + name + "!";
}

其中@RequestParam註解可以指定參數的名稱，否則會默認使用方法參數的名稱。這種方式需要將每個參數都手動指定，並且無法處理多個請求參數的情況。

四、通過ServletRequestAttributes獲取Request

除了在Controller中直接獲取Request外，還可以通過ServletRequestAttributes獲取到當前線程的Request，例如：

@RequestMapping("/example")
@ResponseBody
public String example() {
    ServletRequestAttributes attrs = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = attrs.getRequest();
    // 處理請求
    return "Hello, World!";
}

在這種方式中，需要注意的是需要使用RequestContextHolder.getRequestAttributes()獲取到ServletRequestAttributes，再通過ServletRequestAttributes獲取HttpServletRequest。

五、通過Filter獲取Request

如果需要在整個Web應用程序中都能夠獲取到Request信息，可以考慮使用Filter。在Filter中，可以通過ServletRequest和ServletResponse獲取到當前請求和響應，例如：

@Component
public class ExampleFilter implements Filter {
    
    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) req;
        // 處理請求
        chain.doFilter(request, res);
    }
    
}

在這種方式中，可以通過註冊ExampleFilter實現全局的Request獲取。

六、通過自定義註解獲取Request

除了以上方式，還可以通過自定義註解來獲取Request信息。例如：

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CurrentUser {
}

其中CurrentUser是一個自定義註解，用於獲取當前用戶的信息。在Controller方法中，可以使用該註解獲取Request信息，例如：

@RequestMapping("/example")
@ResponseBody
public String example(@CurrentUser User user) {
    // 處理請求
    return "Hello, " + user.getName() + "!";
}

在這種方式中，可以通過AOP（Aspect Oriented Programming，面向切面編程）來實現註解的解析，從而獲取到Request信息。

七、通過Session獲取Request

最後一種獲取Request信息的方式是使用Session。在Spring Boot中，可以通過Session獲取當前用戶的信息和請求信息，例如：

@RequestMapping("/example")
@ResponseBody
public String example(HttpSession session) {
    User user = (User) session.getAttribute("user");
    // 處理請求
    return "Hello, " + user.getName() + "!";
}

在使用Session獲取Request信息時，需要注意的是，Session可能會帶來一些性能問題，因為需要將信息存儲在內存中。因此，需要謹慎使用。

總結

通過以上多種方式，我們可以在Spring Boot中獲取到請求的信息，並對請求進行處理。不同的方式各有優缺點，需要根據具體的場景來選擇合適的方法。