HttpServletRequest、ServerHttpRequest 和 ServerWebRequest作用详解

1、HttpServletRequest

• 所属框架：Java Servlet API（基于阻塞式 I/O）。

• 使用场景：传统的 Servlet 应用（如 Spring MVC的Tomcat、常用的容器等等）。

• 作用：表示客户端的 HTTP 请求。

• 常用方法：

  • getParameter(String name)：获取请求参数。

  • getHeader(String name)：根据名称获取单一的请求头

  • getMethod()：获取 HTTP 方法（如 GET、POST）。

  • getRequestURI()：获取请求的 URI。

  • getInputStream()：获取请求体的输入流。

  • getSession()：获取会话。

  • getAttribute(String name)：获取请求属性。
    示例：

@RestController
public class MyController {

    @GetMapping("/hello")
    public String hello(HttpServletRequest request) {
        String name = request.getParameter("name");
        return "Hello, " + name;
    }
}

2、ServerHttpRequest

• 所属框架：Spring WebFlux（基于响应式编程，非阻塞式 I/O）。

• 使用场景：响应式 Web 应用（如 Spring WebFlux）。

• 作用：提供了访问请求信息的方法，如请求头、请求参数、请求体、支持响应式流处理。

• 常用方法：

  • getHeaders()：获取请求头。

  • getMethod()：获取 HTTP 方法。

  • getURI()：获取请求的 URI。

  • getBody()：获取请求体的响应式流（Flux）。

示例：

@RestController
public class MyController {

    @GetMapping("/hello")
    public Mono<String> hello(ServerHttpRequest request) {
        String name = request.getQueryParams().getFirst("name");
        return Mono.just("Hello, " + name);
    }
}

3、ServerWebRequest

• 所属框架：Spring WebFlux（基于响应式编程，非阻塞式 I/O）。

• 使用场景：响应式 Web 应用（如 Spring WebFlux）。

• 作用：是对 ServerHttpRequest 和 ServerHttpResponse 的封装、提供了更高级的 API，用于访问请求和响应信息、支持响应式流处理。

• 常用方法：

  • getHeaders()：获取请求头。

  • getMethod()：获取 HTTP 方法。

  • getURI()：获取请求的 URI。

  • getBody()：获取请求体的响应式流（Flux）。

  • getAttribute(String name)：获取请求属性。

  • getSession()：获取会话。

示例：

@RestController
public class MyController {

    @GetMapping("/hello")
    public Mono<String> hello(ServerWebRequest request) {
        String name = request.getQueryParams().getFirst("name");
        return Mono.just("Hello, " + name);
    }
}

4、使用场景总结

4.1、HttpServletRequest：

适用于传统的 Servlet 应用（如 Spring MVC）。

适合阻塞式 I/O 的场景。

4.2、ServerHttpRequest：

适用于响应式 Web 应用（如 Spring WebFlux）。

适合非阻塞式 I/O 的场景。

4.3、ServerWebRequest：

适用于响应式 Web 应用（如 Spring WebFlux）。

提供了更高级的 API，封装了 ServerHttpRequest 和 ServerHttpResponse。

5、总结

如果你使用的是传统的 Spring MVC，选择 HttpServletRequest。

如果你使用的是响应式 Spring WebFlux，选择 ServerHttpRequest 或 ServerWebRequest。

ServerHttpRequest 更底层，适合直接操作请求和响应。

ServerWebRequest 更高级，封装了更多功能，适合复杂的业务场景。