网关 Spring Cloud Gateway 内置网关过滤器工厂总结

最新推荐文章于 2024-09-14 15:27:04 发布

2401_84007015

最新推荐文章于 2024-09-14 15:27:04 发布

阅读量1k

点赞数 17

CC 4.0 BY-SA版权

分类专栏：程序员文章标签： microsoft

本文链接：https://blog.csdn.net/2401_84007015/article/details/138434749

程序员专栏收录该内容

195 篇文章

订阅专栏

网页过滤（或_GatewayFilter_）工厂允许修改所述入站HTTP请求和出站HTTP响应。从这个意义上讲，它提供了一组有趣的功能，可以在与下游服务交互之前和之后应用。

处理程序映射管理客户端的请求。它检查它是否与某些已配置的路由匹配。然后，它将请求发送到Web处理程序以执行此路由的特定筛选器链。虚线在前置和后置滤波器逻辑之间划分逻辑。收入过滤器在代理请求之前运行。输出过滤器收到代理响应后便开始起作用。筛选器提供了在两者之间修改过程的机制。

3.实施WebFilter工厂

让我们回顾一下Spring Cloud Gateway项目中包含的最重要的_WebFilter_工厂。有两种方法可以实现它们，即使用YAML或Java DSL。我们将展示如何实现这两个示例。

3.1 HTTP请求

内置的WebFilter工厂允许与HTTP请求的标头和参数进行交互。我们可以添加 （AddRequestHeader）， 映射 （MapRequestHeader），设置或替换 （SetRequestHeader）， 以及删除 *（RemoveRequestHeader）*标头值并将其发送到代理服务。原始主机标头也可以保留（PreserveHostHeader）。

同样，我们可以添加 *（AddRequestParameter）*和删除 *（RemoveRequestParameter）*参数，以供下游服务处理。让我们看看如何做到这一点：

id: add_request_header_route

uri: https://httpbin.org

predicates:

Path=/get/**

filters:

AddRequestHeader=My-Header-Good,Good
AddRequestHeader=My-Header-Remove,Remove
AddRequestParameter=var, good
AddRequestParameter=var2, remove
MapRequestHeader=My-Header-Good, My-Header-Bad
MapRequestHeader=My-Header-Set, My-Header-Bad
SetRequestHeader=My-Header-Set, Set
RemoveRequestHeader=My-Header-Remove
RemoveRequestParameter=var2

让我们检查一切是否按预期进行。为此，我们将使用curl和公开可用的httpbin.org：

$ curl http://localhost:8080/get

{

“args”: {

“var”: “good”

“headers”: {

“Host”: “localhost”,

“My-Header-Bad”: “Good”,

“My-Header-Good”: “Good”,

“My-Header-Set”: “Set”,

“origin”: “127.0.0.1, 90.171.125.86”,

“url”: “https://localhost:8080/get?var=good”

}

我们可以看到卷曲响应是配置请求过滤器的结果。他们补充_我的报头-好_与价值_良好_，并映射其内容以_我的报头-坏。他们删除_My-Header-Remove 并将新值设置为_My-Header-Set_。在_args_和_url_部分，我们可以看到添加了一个新参数_var_。此外，最后一个过滤器将删除_var2_参数。

另外，我们可以在到达代理服务之前修改请求正文。只能使用Java DSL表示法配置此过滤器。下面的代码段仅将响应正文的内容大写：

@Bean

public RouteLocator routes(RouteLocatorBuilder builder) {

return builder.routes()

.route(“modify_request_body”, r -> r.path(“/post/**”)

.filters(f -> f.modifyRequestBody(

String.class, Hello.class, MediaType.APPLICATION_JSON_VALUE,

(exchange, s) -> Mono.just(new Hello(s.toUpperCase()))))

.uri(“https://httpbin.org”))

.build();

}

要测试代码段，让我们使用*-d_选项执行curl以包括主体_“ Content”*：

$ curl -X POST “http://localhost:8080/post” -i -d “Content”

“data”: “{“message”:“CONTENT”}”,

“json”: {

“message”: “CONTENT”

}

我们可以看到，由于过滤器的原因，主体内容现在大写为_CONTENT_。

3.2 HTTP响应

同样，我们可以通过使用add（AddResponseHeader），设置或替换（SetResponseHeader），删除（RemoveResponseHeader）和重写（RewriteResponseHeader）来修改响应头。响应上的另一个功能是重复数据删除（DedupeResponseHeader）可以覆盖策略并避免重复。通过使用另一个内置工厂（RemoveLocationResponseHeader），我们可以摆脱有关版本，位置和主机的特定于后端的详细信息。

让我们看一个完整的例子：

id: response_header_route

uri: https://httpbin.org

predicates:

Path=/header/post/**

filters:

AddResponseHeader=My-Header-Good,Good
AddResponseHeader=My-Header-Set,Good
AddResponseHeader=My-Header-Rewrite, password=12345678
DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin
AddResponseHeader=My-Header-Remove,Remove
SetResponseHeader=My-Header-Set, Set
RemoveResponseHeader=My-Header-Remove
RewriteResponseHeader=My-Header-Rewrite, password=[^&]+, password=***
RewriteLocationResponseHeader=AS_IN_REQUEST, Location, ,

让我们使用curl显示响应头：

$ curl -X POST “http://localhost:8080/header/post” -s -o /dev/null -D -

HTTP/1.1 200 OK

My-Header-Good: Good

Access-Control-Allow-Origin: *

Access-Control-Allow-Credentials: true

My-Header-Rewrite: password=***

My-Header-Set: Set

与HTTP请求类似，我们可以修改响应正文。在此示例中，我们覆盖了PUT响应的主体：

@Bean

public RouteLocator responseRoutes(RouteLocatorBuilder builder) {

return builder.routes()

.route(“modify_response_body”, r -> r.path(“/put/**”)

.filters(f -> f.modifyResponseBody(

String.class, Hello.class, MediaType.APPLICATION_JSON_VALUE,

(exchange, s) -> Mono.just(new Hello(“New Body”))))

.uri(“https://httpbin.org”))

.build();

}

让我们使用PUT端点来测试功能：

$ curl -X PUT “http://localhost:8080/put” -i -d “CONTENT”

{“message”:“New Body”}

3.3 路径

内置_WebFilter_工厂提供的功能之一是与客户端配置的路径进行交互。可以设置其他路径（SetPath），重写（RewritePath），添加前缀（PrefixPath）和剥离（StripPrefix）以仅提取其中的一部分。请记住，过滤器是根据其在YAML文件中的位置顺序执行的。让我们看看如何配置路由：