网站注册地,云服务器怎么发布网站,互联网推广品牌,建行网站会员有什么用目录 一、概览
二、通过GatewayFilter实现
三、继承AbstractGatewayFilterFactory 一、概览 当使用Spring Cloud Gateway构建API网关时#xff0c;可以利用Spring Cloud Gateway提供的内置过滤器#xff08;filter#xff09;来实现对请求的处理和响应的处理。过滤器可以…目录 一、概览
二、通过GatewayFilter实现
三、继承AbstractGatewayFilterFactory 一、概览 当使用Spring Cloud Gateway构建API网关时可以利用Spring Cloud Gateway提供的内置过滤器filter来实现对请求的处理和响应的处理。过滤器可以在请求被路由之前或之后被执行它可以用于修改请求和响应内容、记录请求日志、校验请求参数、鉴权等等。如果内置的过滤器不能满足需求可以自定义过滤器。 之前博客已经介绍了Spring Cloud Gateway内置过滤器的使用方法和示例具体可以参考https://blog.csdn.net/qq_41061437/article/details/128069622 本篇博客将重点介绍如何编写自定义的过滤器并将其应用到Spring Cloud Gateway中。将使用Java编程语言以及Spring Boot和Spring Cloud Gateway框架。将通过一个示例来演示如何实现一个自定义过滤器讲解自定义过滤器的实现方法、配置方法和使用方法。
二、通过GatewayFilter实现 SpringCloudGateWay项目参考SpringCloudGateway--自动路由映射与手动路由映射_雨欲语的博客-CSDN博客 使用GatewayFilter实现需要implements GatewayFilter和Ordered首先在gateway项目中新建MyOneGatewayFilter类
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
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;import java.net.URI;Component
public class MyOneGatewayFilter implements GatewayFilter, Ordered {Overridepublic MonoVoid filter(ServerWebExchange exchange, GatewayFilterChain chain) {// 获取请求路径String path exchange.getRequest().getPath().toString();URI uri exchange.getRequest().getURI();System.err.println(String.format(获取到请求路径%s, uri.toString()));// 如果请求路径以“/v1”开头则截取掉第一个路径段if (path.startsWith(/v1)) {path path.substring(/v1.length());}// 创建新的请求对象并将新路径设置为请求路径ServerHttpRequest newRequest exchange.getRequest().mutate().path(path).build();// 使用新请求对象创建新的ServerWebExchange对象ServerWebExchange newExchange exchange.mutate().request(newRequest).build();System.err.println(String.format(获取到新的请求路径%s, newExchange.getRequest().getURI()));// 继续执行过滤器链return chain.filter(newExchange);}Overridepublic int getOrder() {return 0;}
}新建GatewayConfig类
import com.littledyf.filter.MyOneGatewayFilter;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;Configuration
public class GatewayConfig {Value(${server.port})private String port;Beanpublic RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {return builder.routes().route(r - r.path(/v1/**).filters(f - f.filter(new MyOneGatewayFilter())).uri(http://localhost: port)).build();}} yml文件使用之前的
server:port: 9999
spring:application:name: service-gatewaycloud: # 配置Spring Cloud相关属性gateway:discovery: # 配置网关发现机制locator: # 配置处理机制enabled: false # 开启网关自动映射处理逻辑lower-case-service-id: true # 开启小写转换filter:secure-headers:disable:- strict-transport-security- x-download-optionsroutes: # 配置网关中的一个完整路由包括命名地址谓词集合规则过滤器集合- id: service-one # 路由定义的命名唯一即可。命名规则符合Java中的变量符命名规则uri: lb://service-one # 当前路由定义对应的微服务转发地址,lb - 代表loadbalancepredicates: # 配置谓词集合- Path/service/**filters:- StripPrefix1nacos:username: nacospassword: nacosdiscovery:server-addr: 127.0.0.1group: devnamespace: devmetadata:version: v1.0.0 启动项目访问测试http://localhost:9999/v1/service/nacos/test 可以看到如果是以v1开头的会直接进入到我们自定义的MyOneGatewayFilter过滤器中如果直接service开头则直接走内置过滤器。
三、继承AbstractGatewayFilterFactory xxxxGatewayFilterFactory是符合内置过滤器原则的所有已经实现的内置过滤器都是按照这种方式进行的这里就是仿照内置过滤器编写编写MyTwoGatewayFilterFactory类
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.cloud.gateway.support.GatewayToStringStyler;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;import java.net.URI;
import java.util.Arrays;
import java.util.List;Component
public class MyTwoGatewayFilterFactory extends AbstractGatewayFilterFactoryMyTwoGatewayFilterFactory.Config {public MyTwoGatewayFilterFactory() {super(MyTwoGatewayFilterFactory.Config.class);}Overridepublic ListString shortcutFieldOrder() {return Arrays.asList(name);}Overridepublic GatewayFilter apply(MyTwoGatewayFilterFactory.Config config) {return new GatewayFilter() {Overridepublic MonoVoid filter(ServerWebExchange exchange, GatewayFilterChain chain) {// 获取请求路径URI uri exchange.getRequest().getURI();System.err.println(String.format(获取到请求路径%s, uri));//System.err.println(String.format(配置属性%s, config.getName()));String path exchange.getRequest().getPath().toString();// 如果请求路径以“/xxx”开头则截取掉第一个路径段,xxx是配置文件中的name属性if (path.startsWith(/ config.getName())) {path path.substring((/ config.getName()).length());}else {throw new IllegalStateException(CustomGatewayFilter is not enabled);}// 创建新的请求对象并将新路径设置为请求路径ServerHttpRequest newRequest exchange.getRequest().mutate().path(path).build();// 使用新请求对象创建新的ServerWebExchange对象ServerWebExchange newExchange exchange.mutate().request(newRequest).build();System.err.println(String.format(获取到新的请求路径%s, newExchange.getRequest().getURI()));return chain.filter(newExchange);}Overridepublic String toString() {return GatewayToStringStyler.filterToStringCreator(MyTwoGatewayFilterFactory.this).toString();}};}public static class Config {private String name;public Config() {}public String getName() {return this.name;}public void setName(String name) {this.name name;}}
}在配置文件中加上刚编写的自定义过滤器名
server:port: 9999
spring:application:name: service-gatewaycloud: # 配置Spring Cloud相关属性gateway:discovery: # 配置网关发现机制locator: # 配置处理机制enabled: false # 开启网关自动映射处理逻辑lower-case-service-id: true # 开启小写转换filter:secure-headers:disable:- strict-transport-security- x-download-optionsroutes: # 配置网关中的一个完整路由包括命名地址谓词集合规则过滤器集合- id: service-one # 路由定义的命名唯一即可。命名规则符合Java中的变量符命名规则uri: lb://service-one # 当前路由定义对应的微服务转发地址,lb - 代表loadbalancepredicates: # 配置谓词集合- Path/service/**filters:- StripPrefix1- MyTwoapinacos:username: nacospassword: nacosdiscovery:server-addr: 127.0.0.1group: devnamespace: devmetadata:version: v1.0.0 测试http://localhost:9999/service/api/nacos/test 如果不包含我们定义的api则直接报错 这只是简单展示了自定义过滤器的功能实际能实现很多复杂功能。比如进行鉴权、黑白名单过滤等等。