Spring Cloud Gateway源码解析-10-自定义Predicate实现黑名单

---

系列文章

• 01-基本特性及核心概念
• 02-初始化解析之Route、Predicate、Filter的构建原理
• 03-RouteDefinitionLocator、RouteLocator解析
• 04-路由匹配RoutePredicateHandlerMapping
• 06-内置Predicate
• 07-过滤器解析之GlobalFilter
• 08-过滤器-GatewayFilter
• 09-结合注册中心实现动态路由
• 10-自定义Predicate实现黑名单
• 11-扩展RouteDefinitionRepository实现基于Redis的动态路由

创作不易，如果对您有帮助，麻烦辛苦下小手点个关注，有任何问题都可以私信交流哈。
祝您虎年虎虎生威。

---

自定义Predicate

思路

在SCG初始化解析中我们已经知道了Predicate是怎么根据我们的配置装配的。
以RemoteAddrRoutePredicateFactory为例。

public class RemoteAddrRoutePredicateFactory
		extends AbstractRoutePredicateFactory<RemoteAddrRoutePredicateFactory.Config> 

RemoteAddrRoutePredicateFactory继承了抽象类AbstractRoutePredicateFactory，泛型为内部类Config。

	@Override
	public ShortcutType shortcutType() {
		return GATHER_LIST;
	}

	@Override
	public List<String> shortcutFieldOrder() {
		return Collections.singletonList("sources");
	}

重写shortcutType和shortcutFieldOrder方法，这两个方法主要是用来定义Config的配置及生成方式，具体细节不再深叙，个人认为SCG的ShortcutType设计的很不好理解。

@Override
public Predicate<ServerWebExchange> apply(Config config) {

	return new GatewayPredicate() {
		@Override
		public boolean test(ServerWebExchange exchange) {
			return false;
		}
	};
}

实现apply方法，内部创建GatewayPredicate匿名内部类。

public static class Config {

		@NotEmpty
		private List<String> sources = new ArrayList<>();

		@NotNull
		private RemoteAddressResolver remoteAddressResolver = new RemoteAddressResolver() {
		};

		public List<String> getSources() {
			return sources;
		}

		public Config setSources(List<String> sources) {
			this.sources = sources;
			return this;
		}

		public Config setSources(String... sources) {
			this.sources = Arrays.asList(sources);
			return this;
		}

		public Config setRemoteAddressResolver(
				RemoteAddressResolver remoteAddressResolver) {
			this.remoteAddressResolver = remoteAddressResolver;
			return this;
		}

	}

根据Predicate功能定义内部类Config。


综上所述总结自定义Predicate要做的事情有如下几点：

1. 类名称，以XXX开头，RoutePredicateFactory结尾。
2. 定义内部Config类，内部定义Predicate所需配置。
3. 继承了抽象类AbstractRoutePredicateFactory，泛型为内部类Config
4. 重写shortcutType和shortcutFieldOrder方法
5. 实现apply方法，内部创建GatewayPredicate匿名内部类。
   

自定义黑名单Predicate

实现

实现黑名单可以通过配置的IP或者IP段进行限制。当请求进入时，获取到当前请求的客户端的IP，判断是否与配置的黑名单匹配，匹配返回false即可。


具体的实现逻辑见下方代码即可，与SCG内置的RemoteAddrRoutePredicateFactory类似

/**
 * Description：黑名单Predicate
 * @author li.hongjian
 * @email [email protected]
 * @Date 2021/3/31
 */
public class BlackRemoteAddrRoutePredicateFactory
		extends AbstractRoutePredicateFactory<BlackRemoteAddrRoutePredicateFactory.Config> {

	public BlackRemoteAddrRoutePredicateFactory() {
		super(Config.class);
	}

	@NotNull
	private List<IpSubnetFilterRule> convert(List<String> values) {
		List<IpSubnetFilterRule> sources = new ArrayList<>();
		for (String arg : values) {
			addSource(sources, arg);
		}
		return sources;
	}

	/**
	 * 此方法需重写，用来创建Config使用
	 * @return
	 */
	@Override
	public ShortcutType shortcutType() {

		/**
		 * GATHER_LIST类型只能有一个shortcutField
		 * {@link this#shortcutFieldOrder()}
		 */
		return GATHER_LIST;
	}

	/**
	 * 配置中的value对应的字段
	 * 比如当前我们的Config中的字段就为sources
	 * @return
	 */
	@Override
	public List<String> shortcutFieldOrder() {
		return Collections.singletonList("sources");
	}


	@Override
	public Predicate<ServerWebExchange> apply(Config config) {
		/**
		 * IpSubnetFilterRule是Netty中定义的IP过滤规则
		 */
		//根据配置的sources生成对应规则
		List<IpSubnetFilterRule> sources = convert(config.sources);

		return new GatewayPredicate() {
			@Override
			public boolean test(ServerWebExchange exchange) {
				InetSocketAddress remoteAddress = config.remoteAddressResolver
						.resolve(exchange);
				if (remoteAddress != null && remoteAddress.getAddress() != null) {
					//只要符合任意一个规则就返回false，与RemoteAddrRoutePredicateFactory相反
					for (IpSubnetFilterRule source : sources) {
						if (source.matches(remoteAddress)) {
							return false;
						}
					}
				}
				//如果没有匹配所有规则，则通过
				return true;
			}
		};
	}

	private void addSource(List<IpSubnetFilterRule> sources, String source) {
		//判断是否配置了IP段，如果没有则默认为最大为32，如配置172.15.32.15，则被修改为172.15.32.15/32
		if (!source.contains("/")) { // no netmask, add default
			source = source + "/32";
		}
		//假设配置的为 172.15.32.15/18
		//根据'/'分割  [0]:172.15.32.15  [1]:18
		String[] ipAddressCidrPrefix = source.split("/", 2);
		String ipAddress = ipAddressCidrPrefix[0];
		int cidrPrefix = Integer.parseInt(ipAddressCidrPrefix[1]);

		//设置拒绝规则
		sources.add(
				new IpSubnetFilterRule(ipAddress, cidrPrefix, IpFilterRuleType.REJECT));
	}

	public static class Config{
		/**
		 * 可配置多个IP/IP段
		 */
		@NotEmpty
		private List<String> sources = new ArrayList<>();
		/**
		 * 用来解析客户端IP
		 */
		@NotNull
		private RemoteAddressResolver remoteAddressResolver = new RemoteAddressResolver() {
		};

		public List<String> getSources() {
			return sources;
		}

		public Config setSources(List<String> sources) {
			this.sources = sources;
			return this;
		}

		public Config setSources(String... sources) {
			this.sources = Arrays.asList(sources);
			return this;
		}

		public Config setRemoteAddressResolver(
				RemoteAddressResolver remoteAddressResolver) {
			this.remoteAddressResolver = remoteAddressResolver;
			return this;
		}
	}
}

使用

spring:
  cloud:
    gateway:
      routes:
      - id: hello_route
        uri: http://localhost:8088/api/hello
        predicates:
        - BlackRemoteAddr=169.254.183.1/18,172.17.31.1/18 #配置指定IP段限制
        - Path=/api/hello

验证

启动SCG和一个本地服务并暴露接口为/api/hello，返回结果为hello world。在自定义的BlackRemoteAddrRoutePredicateFactory#test中断点.


**环境：本机IP **169.254.183.16。配置限制IP为169.254.183.1/18。此时我们的请求应该是会被拒绝返回404状态码的。


可以看到Predicate获取到了我们的IP，并且匹配了我们配置的规则，因此返回false，表示不匹配该路由，因此返回404.


修改配置为其他IP段，比如169.254.183.18/32，此时我们的IP是不符合该规则的，因此会放行。
重启项目再次测试。


可以看到我们的IP并没有匹配配置的规则，返回true，表示可以走该路由。


上边我对“重启”重点标注了，每次修改规则都要重启项目才能生效，那么在实际用的时候，我们肯定想实现不重启就可以动态修改我们配置的规则，那么该怎么做呢？
我们可以通过将配置写到外部一个源中，比如DB中，通过类似Nacos一样定时发送一个刷新配置的事件去实现刷新Predicate配置。明天我们就来基于Redis来实现动态刷新配置的功能。