Spring Cloud Gateway：GlobalFilter和GatewayFilter的区别与联系

最新推荐文章于 2024-06-12 20:53:12 发布

BballChen

最新推荐文章于 2024-06-12 20:53:12 发布

阅读量3.6k

点赞数 3

分类专栏： Spring Cloud

本文链接：https://blog.csdn.net/Bballchen/article/details/115291695

版权

Spring Cloud 专栏收录该内容

11 篇文章 3 订阅

订阅专栏

通过前面的学习，我们知道SCG有两种filter用来拦截web请求，分别是GlobalFilter和GatewayFilter，作者为什么要定义两种filter呢，他们之间有哪些区别和联系，以下分析下我的看法。

1. global filter和gateway filter区别

1.1 接口定义不一样

global filter和gateway filter是分别定义了一个接口，他们的结构看起来很像，下面是
glogal filter的定义：

// GlobalFilter自己就是一个单独的接口，没有任何继承关系，里面就一个方法filter。简单理解英文：
//  GlobalFilter是一个拦截样式，链路方式处理web请求，用来实现横切面，以及一些安全，超时等需求
/**
 * Contract for interception-style, chained processing of Web requests that may be used to
 * implement cross-cutting, application-agnostic requirements such as security, timeouts,
 * and others.
*/
public interface GlobalFilter {
	Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

gateway filter的定义如下，可以看到他们的接口描述基本一致，说明其用途也是相类似的。不一样的地方是GatewayFilter多定义两个属性，暂时没看到它的用途是什么。还有其继承了ShortcutConfigurable，这个应该是方便GatewayFilter做配置化的，因为GatewayFilter没有具体的实现类定义，必须从配置中读取filter信息，然后动态创建GatewayFilter。

/**
 * Contract for interception-style, chained processing of Web requests that may be used to
 * implement cross-cutting, application-agnostic requirements such as security, timeouts,
 * and others. Specific to a Gateway
 * 
 * Copied from WebFilter
 */
public interface GatewayFilter extends ShortcutConfigurable {
	String NAME_KEY = "name";
	String VALUE_KEY = "value";
	Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

1.2 实现类定义不一样

global filter有具体的类定义，我们可以在spring-cloud-gateway-server项目中找到对应的类定义，10个glogal filter类路径如下：
在这里插入图片描述
比如NettyWriteResponseFilter的定义：

gateway filter没有类定义，它只有工厂类，比如AddRequestHeaderGatewayFilterFactory，它可以在apply方法中创建匿名GatewayFilter：

public class AddRequestHeaderGatewayFilterFactory
		extends AbstractNameValueGatewayFilterFactory {

	@Override
	// 这个方法会返回一个GatewayFilter，可以猜测动态创建GatewayFilter时会调用这个方法
	public GatewayFilter apply(NameValueConfig config) {
		return new GatewayFilter() {
			@Override
			// 内部类实现filter逻辑
			public Mono<Void> filter(ServerWebExchange exchange,
					GatewayFilterChain chain) {
				// 拿到head的值
				String value = ServerWebExchangeUtils.expand(exchange, config.getValue());
				// 设置head到请求里
				ServerHttpRequest request = exchange.getRequest().mutate()
						.header(config.getName(), value).build();
				// 处理filter链
				return chain.filter(exchange.mutate().request(request).build());
			}
		};
	}
}

1.3 bean的加载方式不一样

global filter有具体的实现类，可以直接实例化加载到容器中，拿NettyRoutingFilter的加载为例，可以在GatewayAutoConfiguration中看到它是直接new出来放到容器中的。gateway filter没有具体的实现类，只有对应的工厂类，它的加载方式肯定就是不一样的，它是动态加载，暂时没研究是如何加载的，后面补上。

		// 全局filter的加载
		@Bean
		@ConditionalOnEnabledGlobalFilter
		public NettyRoutingFilter routingFilter(HttpClient httpClient,
				ObjectProvider<List<HttpHeadersFilter>> headersFilters,
				HttpClientProperties properties) {
			return new NettyRoutingFilter(httpClient, headersFilters, properties);
		}

2.global filter和gateway filter的联系

要说到他们的联系，我们知道不管是global filter还是gateway filter，他们都能够组成一个filter链来做拦截，而这个filter链是由List< GatewayFilter > 集合组成的，这看起来是GatewayFilter的组合，跟GlobalFilter无关。其实SCG通过适配器的方式，把GlobalFilter适配为GatewayFilter了，我们可以在FilteringWebHandler的构造器中看到这个装换：

	private final List<GatewayFilter> globalFilters;
	
	// 这里会把所有的global filter注入进来
	public FilteringWebHandler(List<GlobalFilter> globalFilters) {
		this.globalFilters = loadFilters(globalFilters);
	}

	private static List<GatewayFilter> loadFilters(List<GlobalFilter> filters) {
		return filters.stream().map(filter -> {
			// 遍历所有的global filter，适配成gateway filter
			GatewayFilterAdapter gatewayFilter = new GatewayFilterAdapter(filter);
			if (filter instanceof Ordered) {
				int order = ((Ordered) filter).getOrder();
				// OrderedGatewayFilter的定义与GatewayFilterAdapter类似，就是增加了order属性用来做优先级的排序
				return new OrderedGatewayFilter(gatewayFilter, order);
			}
			return gatewayFilter;
		}).collect(Collectors.toList());
	}

我们可以看看GatewayFilterAdapter的定义：

private static class GatewayFilterAdapter implements GatewayFilter {
		private final GlobalFilter delegate;
		GatewayFilterAdapter(GlobalFilter delegate) {
			// GlobalFilter是执行者
			this.delegate = delegate;
		}

		@Override
		public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
			// 通过委派的方式驱动GlobalFilter工作
			return this.delegate.filter(exchange, chain);
		}
	}