spring cloud 学习之网关 Gateway

---

一、官方文档

官方文档

二、工作原理

GatewayFilter工厂

GatewayFilter工厂

这里简单将Spring Cloud Gateway内置的所有过滤器工厂整理成了一张表格。如下

过滤器工厂	作用	参数
AddRequestHeader	为原始请求添加Header	Header的名称及值
AddRequestParameter	为原始请求添加请求参数	参数名称及值
AddResponseHeader	为原始响应添加Header	Header的名称及值
DedupeResponseHeader	剔除响应头中重复的值	需要去重的Header名称及去重策略
Hystrix	为路由引入Hystrix的断路器保护	HystrixCommand的名称
FallbackHeaders	为fallbackUri的请求头中添加具体的异常信息	Header的名称
PrefixPath	为原始请求路径添加前缀	前缀路径
PreserveHostHeader	为请求添加一个preserveHostHeader=true的属性，路由过滤器会检查该属性以决定是否要发送原始的Host	无
RequestRateLimiter	用于对请求限流，限流算法为令牌桶	keyResolver、rateLimiter、statusCode、denyEmptyKey、emptyKeyStatus
RedirectTo	将原始请求重定向到指定的URL	http状态码及重定向的url
RemoveHopByHopHeadersFilter	为原始请求删除IETF组织规定的一系列Header	默认就会启用，可以通过配置指定仅删除哪些Header
RemoveRequestHeader	为原始请求删除某个Header	Header名称
RemoveResponseHeader	为原始响应删除某个Header	Header名称
RewritePath	重写原始的请求路径	原始路径正则表达式以及重写后路径的正则表达式
RewriteResponseHeader	重写原始响应中的某个Header	Header名称，值的正则表达式，重写后的值
SaveSession	在转发请求之前，强制执行WebSession::save操作	无
secureHeaders	为原始响应添加一系列起安全作用的响应头	无，支持修改这些安全响应头的值
SetPath	修改原始的请求路径	修改后的路径
SetResponseHeader	修改原始响应中某个Header的值	Header名称，修改后的值
SetStatus	修改原始响应的状态码	HTTP 状态码，可以是数字，也可以是字符串
StripPrefix	用于截断原始请求的路径	使用数字表示要截断的路径的数量
Retry	针对不同的响应进行重试	retries、statuses、methods、series
RequestSize	设置允许接收最大请求包的大小。如果请求包大小超过设置的值，则返回 413 Payload Too Large	请求包大小，单位为字节，默认值为5M
ModifyRequestBody	在转发请求之前修改原始请求体内容	修改后的请求体内容
ModifyResponseBody	修改原始响应体的内容	修改后的响应体内容
Default	为所有路由添加过滤器	过滤器工厂名称及值

**Tips：**每个过滤器工厂都对应一个实现类，并且这些类的名称必须以GatewayFilterFactory结尾，这是Spring Cloud Gateway的一个约定，例如AddRequestHeader对应的实现类为AddRequestHeaderGatewayFilterFactory。

全局过滤器

当请求与路由匹配时，过滤Web处理程序会将GlobalFilter的所有实例和所有特定GatewayFilter于路由的实例添加到过滤器链中。该组合的过滤器链按org.springframework.core.Ordered接口排序，您可以通过实现该getOrder()方法进行设置。

由于Spring Cloud Gateway区分了执行过滤器逻辑的“前”阶段和“后”阶段，因此优先级最高的过滤器是“前”阶段的第一个，而“后”阶段的最后一个-相。

下表列出了Spring Cloud Gateway执行器端点（请注意，每个端点都/actuator/gateway作为基本路径）：

ID	HTTP方法	描述
globalfilters	GET	显示应用于路由的全局过滤器列表。
routefilters	GET	显示GatewayFilter应用于特定路线的工厂列表。
refresh	POST	清除路由缓存。
routes	GET	显示网关中定义的路由列表。
routes/{id}	GET	显示有关特定路线的信息。
routes/{id}	POST	将新路由添加到网关。
routes/{id}	DELETE	从网关中删除现有路由。

开发

1.自定义断言

您需要实现RoutePredicateFactory。有一个AbstractRoutePredicateFactory可以扩展的抽象类。

MyRoutePredicateFactory.java

public class MyRoutePredicateFactory extends AbstractRoutePredicateFactory<HeaderRoutePredicateFactory.Config> {public MyRoutePredicateFactory() {super(Config.class);}@Overridepublic Predicate<ServerWebExchange> apply(Config config) {// grab configuration from Config objectreturn exchange -> {//grab the requestServerHttpRequest request = exchange.getRequest();//take information from the request to see if it//matches configuration.return matches(config, request);};}public static class Config {//Put the configuration properties for your filter here}}

2.自定义配置过滤器

您必须实现GatewayFilterFactory。您可以扩展名为的抽象类AbstractGatewayFilterFactory。以下示例显示了如何执行此操作：

自定义过滤器类名称应以结尾GatewayFilterFactory。

例如，要引用Something配置文件中命名的过滤器，该过滤器必须位于名为的类中SomethingGatewayFilterFactory。

PreGatewayFilterFactory.java

public class PreGatewayFilterFactory extends AbstractGatewayFilterFactory<PreGatewayFilterFactory.Config> {public PreGatewayFilterFactory() {super(Config.class);}@Overridepublic GatewayFilter apply(Config config) {// grab configuration from Config objectreturn (exchange, chain) -> {//If you want to build a "pre" filter you need to manipulate the//request before calling chain.filterServerHttpRequest.Builder builder = exchange.getRequest().mutate();//use builder to manipulate the requestreturn chain.filter(exchange.mutate().request(builder.build()).build());};}public static class Config {//Put the configuration properties for your filter here}}

PostGatewayFilterFactory.java

public class PostGatewayFilterFactory extends AbstractGatewayFilterFactory<PostGatewayFilterFactory.Config> {public PostGatewayFilterFactory() {super(Config.class);}@Overridepublic GatewayFilter apply(Config config) {// grab configuration from Config objectreturn (exchange, chain) -> {return chain.filter(exchange).then(Mono.fromRunnable(() -> {ServerHttpResponse response = exchange.getResponse();//Manipulate the response in some way}));};}public static class Config {//Put the configuration properties for your filter here}}

3.自定义全局顾虑器

必须实现GlobalFilter接口。这会将过滤器应用于所有请求。

以下示例说明如何分别设置全局前置和后置过滤器：

@Bean
public GlobalFilter customGlobalFilter() {return (exchange, chain) -> exchange.getPrincipal().map(Principal::getName).defaultIfEmpty("Default User").map(userName -> {//adds header to proxied requestexchange.getRequest().mutate().header("CUSTOM-REQUEST-HEADER", userName).build();return exchange;}).flatMap(chain::filter);
}@Bean
public GlobalFilter customGlobalPostFilter() {return (exchange, chain) -> chain.filter(exchange).then(Mono.just(exchange)).map(serverWebExchange -> {//adds header to responseserverWebExchange.getResponse().getHeaders().set("CUSTOM-RESPONSE-HEADER",HttpStatus.OK.equals(serverWebExchange.getResponse().getStatusCode()) ? "It worked": "It did not work");return serverWebExchange;}).then();
}

gateWay所有配置

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/appendix.html

---

springcloud 脚手架（wx-cloud）

• spring boot 2.3.3.RELEASE
• nacos
• geteway
• oauth2
• cache(spring+caffeine)
• mybaits

---