20. 使用 Spring MVC 或 Webflux 构建简单的网关

下面介绍一种替代样式网关。先前的文档均不适用于以下内容。

Spring Cloud Gateway 提供了一个名为ProxyExchange. 您可以在常规的 Spring Web 处理程序中将其用作方法参数。 它通过镜像 HTTP 动词的方法支持基本的下游 HTTP 交换。 对于 MVC,它还支持通过forward()方法。 要使用ProxyExchange,在类路径中包含正确的模块(spring-cloud-gateway-mvcspring-cloud-gateway-webflux).spring-doc.cadn.net.cn

以下 MVC 示例将请求代理为/test远程服务器的下游:spring-doc.cadn.net.cn

@RestController
@SpringBootApplication
public class GatewaySampleApplication {

    @Value("${remote.home}")
    private URI home;

    @GetMapping("/test")
    public ResponseEntity<?> proxy(ProxyExchange<byte[]> proxy) throws Exception {
        return proxy.uri(home.toString() + "/image/png").get();
    }

}

以下示例对 Webflux 执行相同的作:spring-doc.cadn.net.cn

@RestController
@SpringBootApplication
public class GatewaySampleApplication {

    @Value("${remote.home}")
    private URI home;

    @GetMapping("/test")
    public Mono<ResponseEntity<?>> proxy(ProxyExchange<byte[]> proxy) throws Exception {
        return proxy.uri(home.toString() + "/image/png").get();
    }

}

方便的方法ProxyExchange启用处理程序方法以发现和增强传入请求的 URI 路径。 例如,您可能希望提取路径的尾随元素以将它们传递到下游:spring-doc.cadn.net.cn

@GetMapping("/proxy/path/**")
public ResponseEntity<?> proxyPath(ProxyExchange<byte[]> proxy) throws Exception {
  String path = proxy.path("/proxy/path/");
  return proxy.uri(home.toString() + "/foos/" + path).get();
}

Spring MVC 和 Webflux 的所有功能都可用于网关处理程序方法。 因此,例如,您可以注入请求标头和查询参数,并且可以使用映射注释中的声明来约束传入请求。 请参阅文档@RequestMapping在 Spring MVC 中获取这些功能的更多详细信息。spring-doc.cadn.net.cn

您可以使用header()方法ProxyExchange.spring-doc.cadn.net.cn

您还可以通过将映射器添加到get()方法(和其他方法)。 映射器是一个Function这需要传入的ResponseEntity并将其转换为传出的。spring-doc.cadn.net.cn

为“敏感”标头提供一流的支持(默认情况下,cookieauthorization),这些不会向下游传递,而对于“代理”(x-forwarded-*) 标头。spring-doc.cadn.net.cn