Spring Cloud GateWay动态路由配置

目录

• GateWay配置
• 在mysql定义表gateway_define, 表结构如下面的GatewayDefine实体类：
• 定义repository和service,采用JPA实现
• 定义MysqlRouteDefinitionRepository类，实现RouteDefinitionRepository接口的getRouteDefinitions方法，获取从数据库里面装载的路由配置，当然还有save和delete其他方法。
• 在启动类GatewayServiceApplication中添加两个Bean。 添加ApplicationStartup类，在Spring Boot启动时装载路由配置信息, 说明看注释:
• 其他
• 最后

• 后记

Spring Cloud Gateway是由spring官方基于Spring5.0,Spring Boot2.0,Project Reactor等技术开发的网关，目的是代替原先版本中的Spring Cloud Netfilx Zuul。目前Netfilx已经开源了Zuul2.0,但Spring 没有考虑集成，而是推出了自己开发的Spring Cloud GateWay。

该项目提供了一个构建在Spring Ecosystem之上的API网关，旨在提供一种简单而有效的途径来发送API，并向他们提供交叉关注点：例如：安全性，监控/指标和弹性。在这里废话少说，直接把我实现动态自定义路由的方法托出，共大家参考。由于水平有限，难免有不当或者错误之处，请大家指正，谢谢。

GateWay配置

一般的，我们如果使用Spring Cloud GateWay进行配置，类似于下面的样子:

1. spring:
2.  cloud:
3.    gateway:
4.      discovery:
5.        locator:
6.          enabled: true
7.      routes:
8.      - id: sample-service-a
9.        uri: lb://SAMPLE-SERVICE-A-HA
10.        predicates:
11.        - Path=/customeradd/**
12.        filters:
13.        - RewritePath=/customeradd,/customer/add

当我们要新增或者改变一个网关路由时，我们不得不停止网关服务，修改配置文件，保存再重新启动网关服务，这样才能让我们新的设置生效。

设想一样，如果是在生产环境，为了一个小小的路由变更，这样的停止再重启恐怕谁也受不了吧。接下来，看看我们怎么能做到动态配置网关路由，让网关路由配置在服务不需要重启的情况生效。

在mysql定义表gateway_define, 表结构如下面的GatewayDefine实体类：

1. @Entity
2. @Table(name = "gateway_define")
3. public class GatewayDefine implements Serializable {
4.   @Id
5.   @GeneratedValue(strategy = GenerationType.AUTO)
6.   private String id;
7. 
   
8.   private String uri;
9. 
   
10.   private String predicates;
11. 
    
12.   private String filters;
13. 
    
14.   public String getId() {
15.       return id;
16.   }
17. 
    
18.   public void setId(String id) {
19.       this.id = id;
20.   }
21. 
    
22.   public String getUri() {
23.       return uri;
24.   }
25.   public void setUri(String uri) {
26.       this.uri = uri;
27.   }
28.   public String getPredicates() {
29.       return this.predicates;
30.   }
31. 
    
32.   public void setPredicates(String predicates) {
33.       this.predicates = predicates;
34.   }
35. 
    
36.   public List<PredicateDefinition> getPredicateDefinition() {
37.       if (this.predicates != null) {
38.           List<PredicateDefinition> predicateDefinitionList = JSON.parseArray(this.predicates, PredicateDefinition.class);
39.           return predicateDefinitionList;
40.       } else {
41.           return null;
42.       }
43.   }
44. 
    
45.   public String getFilters() {
46.       return filters;
47.   }
48.   public List<FilterDefinition> getFilterDefinition() {
49.       if (this.filters != null) {
50.           List<FilterDefinition> filterDefinitionList = JSON.parseArray(this.filters, FilterDefinition.class);
51.           return filterDefinitionList;
52.       } else {
53.           return null;
54.       }
55.   }
56. 
    
57.   public void setFilters(String filters) {
58.       this.filters = filters;
59.   }
60. 
    
61.   @Override
62.   public String toString() {
63.       return "GatewayDefine{" +
64.               "id='" + id + '\'' +
65.               ", uri='" + uri + '\'' +
66.               ", predicates='" + predicates + '\'' +
67.               ", filters='" + filters + '\'' +
68.               '}';
69.   }
70. }

其中：id为Eureka注册的服务名; uri、predicates、filters分别应上面配置文件片段中的predicates和filters(这两个保存的都是json)

定义repository和service,采用JPA实现

1. @Repository
2. public interface GatewayDefineRepository  extends JpaRepository<GatewayDefine, String> {
3. 
   
4.  @Override
5.  List<GatewayDefine> findAll();
6.  @Override
7.  GatewayDefine save(GatewayDefine gatewayDefine);
8.  @Override
9.  void deleteById(String id);
10.  @Override
11.  boolean existsById(String id);
12. }
13. 
    
14. public interface GatewayDefineService {
15.  List<GatewayDefine> findAll() throws Exception;
16.  String loadRouteDefinition() throws Exception;
17.  GatewayDefine save(GatewayDefine gatewayDefine) throws Exception;
18.  void deleteById(String id) throws Exception;
19.  boolean existsById(String id)throws Exception;
20. 
    
21. }
22. 
    
23. @Service
24. public class GatewayDefineServiceImpl implements GatewayDefineService {
25.  @Autowired
26.  GatewayDefineRepository gatewayDefineRepository;
27. 
    
28.  @Autowired
29.  private GatewayDefineService gatewayDefineService;
30. 
    
31.  @Autowired
32.  private RouteDefinitionWriter routeDefinitionWriter;
33. 
    
34.  private ApplicationEventPublisher publisher;
35. 
    
36.  @Override
37.  public List<GatewayDefine> findAll() throws Exception {
38.      return gatewayDefineRepository.findAll();
39.  }
40. 
    
41.  @Override
42.  public String loadRouteDefinition() {
43.      try {
44.          List<GatewayDefine> gatewayDefineServiceAll = gatewayDefineService.findAll();
45.          if (gatewayDefineServiceAll == null) {
46.              return "none route defined";
47.          }
48.          for (GatewayDefine gatewayDefine : gatewayDefineServiceAll) {
49.              RouteDefinition definition = new RouteDefinition();
50.              definition.setId(gatewayDefine.getId());
51.              definition.setUri(new URI(gatewayDefine.getUri()));
52.              List<PredicateDefinition> predicateDefinitions = gatewayDefine.getPredicateDefinition();
53.              if (predicateDefinitions != null) {
54.                  definition.setPredicates(predicateDefinitions);
55.              }
56.              List<FilterDefinition> filterDefinitions = gatewayDefine.getFilterDefinition();
57.              if (filterDefinitions != null) {
58.                  definition.setFilters(filterDefinitions);
59.              }
60.              routeDefinitionWriter.save(Mono.just(definition)).subscribe();
61.              this.publisher.publishEvent(new RefreshRoutesEvent(this));
62.          }
63.          return "success";
64.      } catch (Exception e) {
65.          e.printStackTrace();
66.          return "failure";
67.      }
68.  }
69. 
    
70.  @Override
71.  public GatewayDefine save(GatewayDefine gatewayDefine) throws Exception {
72.      gatewayDefineRepository.save(gatewayDefine);
73.      return gatewayDefine;
74.  }
75. 
    
76.  @Override
77.  public void deleteById(String id) throws Exception {
78.      gatewayDefineRepository.deleteById(id);
79.  }
80. 
    
81.  @Override
82.  public boolean existsById(String id) throws Exception {
83.      return gatewayDefineRepository.existsById(id);
84.  }
85. }

注:

loadRouteDefinition是重点，它从数据库里获取动态定义的路由，最后封装成RouteDefinition 类实例，调用RouteDefinitionWriter 的save方法保存。

RouteDefinitionWriter是个接口，真正实现的是InMemoryRouteDefinitionRepository类，在InMemoryRouteDefinitionRepository定义了一个SynchronizedMap 类，所有的设置都在这儿保存。

定义MysqlRouteDefinitionRepository类，实现RouteDefinitionRepository接口的getRouteDefinitions方法，获取从数据库里面装载的路由配置，当然还有save和delete其他方法。

1. public class MysqlRouteDefinitionRepository implements RouteDefinitionRepository {
2.  @Autowired
3.  private GatewayDefineService gatewayDefineService;
4.  @Override
5.  public Flux<RouteDefinition> getRouteDefinitions() {
6.      try {
7.          List<GatewayDefine> gatewayDefineList = gatewayDefineService.findAll();
8.          Map<String, RouteDefinition> routes = new LinkedHashMap<String, RouteDefinition>();
9.          for (GatewayDefine gatewayDefine: gatewayDefineList) {
10.              RouteDefinition definition = new RouteDefinition();
11.              definition.setId(gatewayDefine.getId());
12.              definition.setUri(new URI(gatewayDefine.getUri()));
13.              List<PredicateDefinition> predicateDefinitions = gatewayDefine.getPredicateDefinition();
14.              if (predicateDefinitions != null) {
15.                  definition.setPredicates(predicateDefinitions);
16.              }
17.              List<FilterDefinition> filterDefinitions = gatewayDefine.getFilterDefinition();
18.              if (filterDefinitions != null) {
19.                  definition.setFilters(filterDefinitions);
20.              }
21.              routes.put(definition.getId(), definition);
22. 
    
23.          }
24.          return Flux.fromIterable(routes.values());
25.      } catch (Exception e) {
26.          e.printStackTrace();
27.          return Flux.empty();
28.      }
29.  }
30. 
    
31.  @Override
32.  public Mono<Void> save(Mono<RouteDefinition> route) {
33.      return route.flatMap(r -> {
34.          try {
35.              GatewayDefine gatewayDefine = new GatewayDefine();
36.              gatewayDefine.setId(r.getId());
37.              gatewayDefine.setUri(r.getUri().toString());
38.              gatewayDefine.setPredicates(JSON.toJSONString(r.getPredicates()));
39.              gatewayDefine.setFilters(JSON.toJSONString(r.getFilters()));
40.              gatewayDefineService.save(gatewayDefine);
41.              return Mono.empty();
42. 
    
43.          } catch (Exception e) {
44.              e.printStackTrace();
45.              return Mono.defer(() -> Mono.error(new NotFoundException("RouteDefinition save error: "+ r.getId())));
46.          }
47. 
    
48.      });
49.  }
50. 
    
51.  @Override
52.  public Mono<Void> delete(Mono<String> routeId) {
53.      return routeId.flatMap(id -> {
54.          try {
55.              gatewayDefineService.deleteById(id);
56.              return Mono.empty();
57. 
    
58.          } catch (Exception e) {
59.              e.printStackTrace();
60.              return Mono.defer(() -> Mono.error(new NotFoundException("RouteDefinition delete error: " + routeId)));
61.          }            
62.      });
63.  }
64. }

在启动类GatewayServiceApplication中添加两个Bean。

1. @Bean
2. public RouteDefinitionWriter routeDefinitionWriter() {
3.     return new InMemoryRouteDefinitionRepository();
4. }
5. 
   
6. @Bean
7. public MysqlRouteDefinitionRepository mysqlRouteDefinitionRepository() {
8.     return new MysqlRouteDefinitionRepository();
9. }

添加ApplicationStartup类，在Spring Boot启动时装载路由配置信息, 说明看注释:

1. /**
2. * 在Spring Boot程序启动后会检测程序中是否有CommandLineRunner
3. * 和ApplicationRunner接口的实例，
4. * 如果存在，则会执行对应实现类中的run()方法，而且只执行一次
5. */
6. public class ApplicationStartup implements ApplicationRunner {
7. 
   
8.   @Autowired
9.   private GatewayDefineService gatewayDefineService;
10. 
    
11.   @Override
12.   public void run(ApplicationArguments args) throws Exception {
13.       gatewayDefineService.loadRouteDefinition();
14.   }
15. }

完成。

其他

我这里面没有界面设置路由，我是在配置文件中配置我要的路由，然后通过 /actuator/gateway/routes 获取所有路由的json, 也可以通过 /actuator/gateway/routes/{id} 获取单独一个路由的json.然后手工往数据库里面插入数据，再把网关服务停止，删除配置文件中的路由设定，再重新启动网关功能，通过 /actuator/gateway/routes 能够获取同样的路由json, 通过curl访问设置的路由同样生效。

当然完全可以独立开发一个应用，有界面来读取数据库中的路由配置，可以增加和修改路由信息。再通过Spring Cloud Config的配置来刷新多个网关路由的信息，实现多个网关服务的路由信息实时更新。反正有各种方法可供选择。

最后

完全是记录自己前一段时间的研究心得。水平有限，有什么不对的地方请大家指正。还有，Spring Cloud GateWay还不支持OAuth2, 所以想统一集成授权、认证等功能的还是使用ZUUL吧。下一次有时间，我会写一下ZUUL的动态路由功能实现以及避免频繁刷新路由信息。反正和GateWay相似，但是还是有区别的。

实现参考了网上很多人的源码和文章，在此表示感谢！也阅读了Spring Cloud GateWay 部分源代码，对Spring Cloud GateWay有了一定的认识，聊以自慰。

后记

最新的Spring Cloud Greenwich.RELEASE中Gateway 过滤器新增支持OAuth2，我觉得可以抛弃ZUUL了。