Spring Cloud Gateway 自带Filter的简单说明

该文详细介绍了APIGateway中的一系列过滤器功能,包括请求路径处理、请求和响应头的增删改、流量限制、请求重试策略以及错误处理等,旨在优化和控制微服务间的交互。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

// StripPrefix

// 该StripPrefix有一个参数,parts。该parts参数指示在将请求发送到下游之前要从请求中剥离的路径中的部分数。

// AddRequestHeader

// 给当前请求添加一个请求头,请求头值是一个数组,可以多个相同名称的,追加

// RemoveRequestHeader

// 移除请求中的一个请求头,追加到请求头列表中

// AddResponseHeader

// 给响应结果中添加一个响应头

// RemoveResponseHeader

// 从响应结果中移除有一个响应头

// RequestRateLimiter

// 限制请求的流量

// AddRequestParameter

// 添加请求参数

// SetRequestHeader 设置请求头,用值替换

// SetResponseHeader 设置请求头,用新值替换

// CacheRequestBody 缓存请求体

// DedupeResponseHeader 清除重复的返回头,RETAIN_FIRST 保留第一个 RETAIN_LAST 保留最后一个 RETAIN_UNIQUE 过滤重复的,返回头还有可能是个数组

//FallbackHeaders过滤器工厂的实现类是FallbackHeadersGatewayFilterFactory。当Hytrix触发fallback调用并且fallbackUri跳转的是另外一个服务的地址时,这个过滤器可以向跳转请求的Header中添加失败的详细信息。

// private String executionExceptionTypeHeaderName = EXECUTION_EXCEPTION_TYPE;

// private String executionExceptionMessageHeaderName = EXECUTION_EXCEPTION_MESSAGE;

// private String rootCauseExceptionTypeHeaderName = ROOT_CAUSE_EXCEPTION_TYPE;

// private String rootCauseExceptionMessageHeaderName = ROOT_CAUSE_EXCEPTION_MESSAGE;

// JsonToGrpc JSON转成GRPC

// MapRequestHeader 将From请求头,追加到To请求头中

// ModifyRequestBody 修改请求实体

// ModifyResponseBody 修改返回实体

// PrefixPath 追加前置path

// PreserveHostHeader 保留主机标头

// RedirectTo 重定向头 返回 头中加了 Location

// RemoveRequestHeader 移除指定请求头

// RemoveRequestParameter 移除指定请求参数

// RemoveResponseHeader 移除指定返回头

// RequestHeaderSize 单个请求头大小超限,默认16000L 追加错误信息放到返回头,返回431状态

// RequestRateLimiter 请求限流 RequestRateLimiter=10, 20, #{@principalNameKeyResolver} https://blog.youkuaiyun.com/weixin_42073629/article/details/106934827

// RequestSize 请求内容大小限制 默认大小5000000L 返回413 PAYLOAD_TOO_LARGE

// RetryGateway 请求重试

// retries,默认为3,用来标识重试次数

// series,用来指定哪些段的状态码需要重试,默认SERVER_ERROR即5xx

// statuses,用于指定哪些状态需要重试,默认为空,它跟series至少得指定一个

// methods,用于指定那些方法的请求需要重试,默认为GET

// exceptions,用于指定哪些异常需要重试,默认为java.io.IOException

// RewriteLocationResponse 重新返回跳转头

// RewritePath 重新Path地址,正则表达式

// RewriteResponseHeader 重新返回头,正则表达式

// SaveSessionGateway 保存请求Session

// SecureHeaders 追加安全返回头

// SetPathGateway 根据模版设置Path地址

// SetRequestHostHeader 重置请求头中的HOST

// SetStatusGateway 设置返回状态,同时可以设置实附返回状态originalStatusHeaderName

// TokenRelay 令牌中断,需要引入oauth2

// RequestHeaderToRequestUri 指定请求头字段设置成请求地址

### Spring Cloud Gateway 自定义过滤器实现 在 Spring Cloud Gateway 中,自定义过滤器可以通过继承 `GatewayFilter` 或者通过工厂模式创建来实现。以下是关于如何实现自定义过滤器的具体方法。 #### 创建全局过滤器 要创建一个全局过滤器,可以实现 `GlobalFilter` 接口并注册到 Spring 容器中。下面是一个简单的例子: ```java import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.core.Ordered; import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.stereotype.Component; import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono; @Component public class CustomGlobalFilter implements GlobalFilter, Ordered { @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { ServerHttpRequest request = exchange.getRequest(); System.out.println("Custom Filter: " + request.getMethod() + " " + request.getURI()); // 可在此处添加逻辑处理请求或响应 return chain.filter(exchange); } @Override public int getOrder() { return 0; // 设置优先级,数值越低优先级越高 } } ``` 此代码片段展示了如何创建一个打印日志的简单全局过滤器[^1]。 #### 使用 Factory 方法创建局部过滤器 如果需要针对特定路由应用过滤器,则应使用工厂类的方式。以下是如何创建和配置局部过滤器的一个实例: ```java import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory; import org.springframework.http.HttpHeaders; import org.springframework.stereotype.Component; @Component public class AddRequestHeaderGatewayFilterFactory extends AbstractGatewayFilterFactory<AddRequestHeaderGatewayFilterFactory.Config> { public static class Config { private String name; private String value; public void setName(String name) { this.name = name;} public String getName() {return this.name;} public void setValue(String value){this.value=value;} public String getValue(){return this.value;} } public AddRequestHeaderGatewayFilterFactory(){ super(Config.class); } @Override public org.springframework.cloud.gateway.filter.GatewayFilter apply(Config config){ return (exchange,chain)->{ exchange.getRequest().mutate() .header(config.getName(),config.getValue()) .build(); return chain.filter(exchange); }; } } ``` 上述代码展示了一个用于向请求头添加字段的局部过滤器工厂[^2]。 #### 配置文件中的设置 为了使这些过滤器生效,在 application.yml 文件中需做如下配置: ```yaml spring: cloud: gateway: routes: - id: add_request_header_route uri: http://example.org filters: - AddRequestHeader=foo, bar ``` 以上 YAML 片段说明了如何将前面定义好的局部过滤器应用于指定 URI 的路由上[^3]。 ### 注意事项 - **线程安全性**:由于网关可能运行于高并发环境之下,因此编写过滤器时需要注意其线程安全特性。 - **性能影响**:复杂的业务逻辑可能会增加延迟时间,故建议仅执行必要的操作。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值