1. 概述

本文主要分享如何使用 Java 实现自定义 RouteLocator。

ps ：为什么这里强调 Java 呢？可以使用 Kotlin 实现自定义 RouteLocator ，在下一篇文章我们会详细分享。

首先我们来看一段示例程序，代码如下 ：

import static org.springframework.cloud.gateway.filter.factory.GatewayFilters.addResponseHeader;
import static org.springframework.cloud.gateway.handler.predicate.RoutePredicates.host;
import static org.springframework.cloud.gateway.handler.predicate.RoutePredicates.path;
import static org.springframework.tuple.TupleBuilder.tuple;

  1: @Bean
  2: public RouteLocator customRouteLocator(ThrottleGatewayFilterFactory throttle) {
  3: 	//@formatter:off
  4: 	return Routes.locator()
  5:            // Route
  6: 			.route("test")
  7: 				.predicate(host("**.abc.org").and(path("/image/png")))
  8: 				.addResponseHeader("X-TestHeader", "foobar")
  9: 				.uri("http://httpbin.org:80")
 10:            // Route
 11: 			.route("test2")
 12: 				.predicate(path("/image/webp"))
 13: 				.add(addResponseHeader("X-AnotherHeader", "baz"))
 14: 				.uri("http://httpbin.org:80")
 15:            // Route
 16: 			.route("test3")
 17: 				.order(-1)
 18: 				.predicate(host("**.throttle.org").and(path("/get")))
 19: 				.add(throttle.apply(tuple().of("capacity", 1,
 20: 						"refillTokens", 1,
 21: 						"refillPeriod", 10,
 22: 						"refillUnit", "SECONDS")))
 23: 				.uri("http://httpbin.org:80")
 24: 			.build();
 25: 	@formatter:on
 26: }

• 使用 Routes 创建了三个 Route 。
• 使用 RoutePredicates 创建每个 Route 的 Predicate 。
• 使用 GatewayFilters 创建每个 Route 的 GatewayFilter 。

2. Routes

rg.springframework.cloud.gateway.route.Routes ，Java 自定义 RouteLocator Builder 。

Routes 内置多个 Builder 类，用于创建 Route 相关的各个元素 ：

使用时，首先调用 Routes#locator() 方法，创建一个 LocatorBuilder 。代码如下 ：

public static LocatorBuilder locator() {
    return new LocatorBuilder();
}

LocatorBuilder ，代码如下 ： 

1: public static class LocatorBuilder {
 2: 
 3: 	private List<Route> routes = new ArrayList<>();
 4: 
 5: 	public PredicateSpec route(String id) {
 6: 		return new RouteSpec(this).id(id);
 7: 	}
 8: 
 9: 	private void add(Route route) {
10: 		this.routes.add(route);
11: 	}
12: 
13: 	LocatorBuilder uri(Route.Builder builder, String uri) {
14: 		Route route = builder.uri(uri).build();
15: 		routes.add(route);
16: 		return this;
17: 	}
18: 
19: 	LocatorBuilder uri(Route.Builder builder, URI uri) {
20: 		Route route = builder.uri(uri).build();
21: 		routes.add(route);
22: 		return this;
23: 	}
24: 
25: 	public RouteLocator build() {
26: 		return () -> Flux.fromIterable(this.routes);
27: 	}
28: 
29: }

• routes 属性，LocatorBuilder 已创建好的 Route 数组。
• #add() 方法，添加已创建好的 Route 。
• #uri() 方法，使用 Route.Builder 方法，创建 Route 并添加。
• #route() 方法，不同于上面两个方法，首先创建 RouteSpec 对象，后调用 RouteSpec#id(...) 方法，创建 PredicateSpec 对象。为什么是这样的呢？Routes 里创建 Route 是有序的链式过程，如下如 ：

• 绿线 ：创建一个 Route.Builder 。
• 红线 ：调用 LocatorBuilder#uri(uri) 方法，创建 Route 并添加。后面，可以继续【绿线】，创建下一个 Route.Builder 。
• #build() 方法，创建自定义 RouteLocator 类。

RouteSpec / PredicateSpec / GatewayFilterSpec 实现上就是常见的 Builder 类，点击链接直接查看代码 ：

• RouteSpec
• PredicateSpec
• GatewayFilterSpec

3. RoutePredicates

org.springframework.cloud.gateway.handler.predicate.RoutePredicates ，RoutePredicates 工厂，其调用 RoutePredicateFactory 接口的实现类，创建各种 Predicate 。代码比较易懂，点击 链接 查看实现。

4. GatewayFilters

org.springframework.cloud.gateway.filter.factory.GatewayFilters ，GatewayFilter 工厂，其调用 GatewayFilterFactory 接口的实现类，创建各种 GatewayFilter 。代码比较易懂，点击 链接 查看实现。