Spring Cloud Gateway的動態路由實現

1.前言

網關中有兩個重要的概念，那就是路由配置和路由規則，路由配置是指配置某請求路徑路由到指定的目的地址。而路由規則是指匹配到路由配置之后，再根據路由規則進行轉發處理。
Spring Cloud Gateway作為所有請求流量的入口，在實際生產環境中為了保證高可靠和高可用，盡量避免重啟,需要實現Spring Cloud Gateway動態路由配置。前面章節介紹了Spring Cloud Gateway提供的兩種方法去配置路由規則，但都是在Spring Cloud Gateway啟動時候，就將路由配置和規則加載到內存里，無法做到不重啟網關就可以動態的對應路由的配置和規則進行增加，修改和刪除。本篇文章簡單介紹如何實現Spring Cloud Gateway的動態路由。

2. Spring Cloud Gateway簡單的動態路由實現

Spring Cloud Gateway的官方文檔並沒有講如何動態配置，查看 Spring Cloud Gateway的源碼，發現在org.springframework.cloud.gateway.actuate.GatewayControllerEndpoint類中提供了動態配置的Rest接口，但是需要開啟Gateway的端點，而且提供的功能不是很強大。通過參考和GatewayControllerEndpoint相關的代碼，可以自己編碼實際動態路由配置。
下面通過案例的方式去講解怎么實現Gateway的動態路由配置。案例工程如ch18-7-gateway所示。

代碼地址:https://github.com/SpringCloud/spring-cloud-code/blob/master/ch18-7/ch18-7-gateway

3. 簡單動態路由的實現

3.1 新建Maven工程ch18-7-gateway

配置主要的核心依賴如代碼清單18-33所示：
代碼清單: ch18-7/ch18-7-gateway/pom.xml

1. <dependencies>
2. <dependency>
3. <groupId>org.springframework.cloud</groupId>
4. <artifactId>spring-cloud-starter-gateway</artifactId>
5. </dependency>
6. <dependency>
7. <groupId>org.springframework.boot</groupId>
8. <artifactId>spring-boot-starter-webflux</artifactId>
9. </dependency>
10. <dependency>
11. <groupId>org.springframework.boot</groupId>
12. <artifactId>spring-boot-starter-actuator</artifactId>
13. </dependency>
14. </dependencies>

3.2 根據Spring Cloud Gateway的路由模型定義數據傳輸模型

分別創建GatewayRouteDefinition.java, GatewayPredicateDefinition.java, GatewayFilterDefinition.java這三個類。
(1) 創建路由定義模型如下代碼清單18-34所示：
代碼清單 18-34: ch18-7/ch18-7-gateway/src/main/java/cn/springcloud/book/gateway/model/GatewayRouteDefinition.java

1. public class GatewayRouteDefinition {
2. //路由的Id
3. private String id;
4. //路由斷言集合配置
5. private List<GatewayPredicateDefinition> predicates = new ArrayList<>();
6. //路由過濾器集合配置
7. private List<GatewayFilterDefinition> filters = new ArrayList<>();
8. //路由規則轉發的目標uri
9. private String uri;
10. //路由執行的順序
11. private int order = 0;
12. //此處省略get和set方法
13. }

(2)創建過濾器定義模型,代碼如代碼清單18-35所示：
代碼清單18-35: ch18-7/ch18-7-gateway/src/main/java/cn/springcloud/book/gateway/model/GatewayFilterDefinition.java

1. public class GatewayFilterDefinition {
2. //Filter Name
3. private String name;
4. //對應的路由規則
5. private Map<String, String> args = new LinkedHashMap<>();
6. //此處省略Get和Set方法
7. }

(3)路由斷言定義模型，代碼如代碼清單18-36所示:
代碼清單18-36: ch18-7/ch18-7-gateway/src/main/java/cn/springcloud/book/gateway/model/GatewayPredicateDefinition.java

1. public class GatewayPredicateDefinition {
2. //斷言對應的Name
3. private String name;
4. //配置的斷言規則
5. private Map<String, String> args = new LinkedHashMap<>();
6. //此處省略Get和Set方法
7. }

3.3 編寫動態路由實現類

編寫DynamicRouteServiceImpl並實現ApplicationEventPublisherAware接口，代碼如代碼清單18-37所示: ch18-37/ch18-7-gateway/src/main/java/cn/springcloud/book/gateway/route/DynamicRouteServiceImpl.java

1. @Service
2. public class DynamicRouteServiceImpl implements ApplicationEventPublisherAware {
3. @Autowired
4. private RouteDefinitionWriter routeDefinitionWriter;
5. private ApplicationEventPublisher publisher;
6. //增加路由
7. public String add(RouteDefinition definition) {
8. routeDefinitionWriter.save(Mono.just(definition)).subscribe();
9. this.publisher.publishEvent(new RefreshRoutesEvent(this));
10. return "success";
11. }
12. //更新路由
13. public String update(RouteDefinition definition) {
14. try {
15. this.routeDefinitionWriter.delete(Mono.just(definition.getId()));
16. } catch (Exception e) {
17. return "update fail,not find route routeId: "+definition.getId();
18. }
19. try {
20. routeDefinitionWriter.save(Mono.just(definition)).subscribe();
21. this.publisher.publishEvent(new RefreshRoutesEvent(this));
22. return "success";
23. } catch (Exception e) {
24. return "update route fail";
25. }
26. }
27. //刪除路由
28. public Mono<ResponseEntity<Object>> delete(String id) {
29. return this.routeDefinitionWriter.delete(Mono.just(id))
30. .then(Mono.defer(() -> Mono.just(ResponseEntity.ok().build())))
31. .onErrorResume(t -> t instanceof NotFoundException, t -> Mono.just(ResponseEntity.notFound().build()));
32. }
33. @Override
34. public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
35. this.publisher = applicationEventPublisher;
36. }
37. }

3.4 編寫Rest接口

編寫RouteController類的提供Rest接口，用於動態路由配置。代碼如代碼清單18-38所示:
代碼清單 18-38: ch18-7/ch18-7-gateway/src/main/java/cn/springcloud/book/gateway/controller/RouteController.java

1. @RestController
2. @RequestMapping("/route")
3. public class RouteController {
4. @Autowired
5. private DynamicRouteServiceImpl dynamicRouteService;
6. //增加路由
7. @PostMapping("/add")
8. public String add(@RequestBody GatewayRouteDefinition gwdefinition) {
9. try {
10. RouteDefinition definition = assembleRouteDefinition(gwdefinition);
11. return this.dynamicRouteService.add(definition);
12. } catch (Exception e) {
13. e.printStackTrace();
14. }
15. return "succss";
16. }
18. //刪除路由
19. @DeleteMapping("/routes/{id}")
20. public Mono<ResponseEntity<Object>> delete(@PathVariable String id) {
21. return this.dynamicRouteService.delete(id);
22. }
23. //更新路由
24. @PostMapping("/update")
25. public String update(@RequestBody GatewayRouteDefinition gwdefinition) {
26. RouteDefinition definition = assembleRouteDefinition(gwdefinition);
27. return this.dynamicRouteService.update(definition);
28. }
29. }

3.5 配置application.yml文件

在application.yml文件配置應用的配置信息，並開啟Spring Cloud Gateway對外提供的端點Rest接口。代碼如代碼清單18-39所示:
代碼清單 18-39: ch18-7/ch18-7-gateway/src/main/resources/application.yml
配置輸出日志如下所示:

1. # 配置輸出日志
2. logging:
3. level:
4. org.springframework.cloud.gateway: TRACE
5. org.springframework.http.server.reactive: DEBUG
6. org.springframework.web.reactive: DEBUG
7. reactor.ipc.netty: DEBUG
8. #開啟端點
9. management:
10. endpoints:
11. web:
12. exposure:
13. include: '*'
14. security:
15. enabled: false

3.6 啟動ch18-7-gateway應用測試

(1) 啟動ch18-7-gateway應用之后，由於開啟了端點，首先打開瀏覽器訪問端點URL:
http://localhost:8080/actuator/gateway/routes ,查看路由信息返回為空，如下圖所示:

(2)打開PostMan，訪問http://localhost:8080/route/add, 發起Post請求，如下圖所示,返回success說明向Gateway增加路由配置成功。

然后再打開PostMan訪問端點URL:http://localhost:8080/actuator/gateway/routes ,
查看路由信息返回如下圖所示，可以看到已經添加的路由配置。

(3) 打開瀏覽器訪問http://localhost:8080/jd, 可以正常轉發https://www.jd.com/對應的京東商城首頁。
(4) 通過訪問http://localhost:8080/route/update, 對id為jd_route的路由更新配置，如下圖所示：

然后再訪問路由端點URL,發現路由配置已經被更新，如下圖所示:

然后通過瀏覽器訪問http://localhost:8080/taobao ,可以成功轉發到淘寶網。
(5) 通過訪問http: //localhost:8080/route/delete/jd_route,其中的id為路由對應的id，刪除路由結果如下圖所示: