网关 Spring-Cloud-Gateway 源码解析 —— 路由（1.2）之 PropertiesRouteDefinitionLocator 配置文件

内容简介：网关 Spring-Cloud-Gateway 源码解析 —— 路由（1.2）之 PropertiesRouteDefinitionLocator 配置文件

摘要: 原创出处 http://www.iocoder.cn/Spring-Cloud-Gateway/route-definition-locator-properties/ 「芋道源码」欢迎转载，保留摘要，谢谢！

本文主要基于 Spring-Cloud-Gateway 2.0.X M4

• 1. 概述
• 2. PropertiesRouteDefinitionLocator
• 3. GatewayProperties
• 666. 彩蛋

1. 概述

本文主要对 PropertiesRouteDefinitionLocator 的源码实现 。

• 蓝色 部分 ：PropertiesRouteDefinitionLocator 。

推荐 Spring Cloud 书籍：

• 请支持正版。下载盗版， 等于主动编写低级 BUG 。
• 程序猿DD —— 《Spring Cloud微服务实战》
• 周立 —— 《Spring Cloud与 Docker 微服务架构实战》
• 两书齐买，京东包邮。

2. PropertiesRouteDefinitionLocator

org.springframework.cloud.gateway.config.PropertiesRouteDefinitionLocator ，从 配置文件 ( 例如，YML / Properties 等 ) 读取路由配置。代码如下 ：

public class PropertiesRouteDefinitionLocator implements RouteDefinitionLocator{

 private final GatewayProperties properties;

 public PropertiesRouteDefinitionLocator(GatewayProperties properties){
 this.properties = properties;
 }

 @Override
 public Flux<RouteDefinition> getRouteDefinitions(){
 return Flux.fromIterable(this.properties.getRoutes());
 }
}

• #getRouteDefinitions() 方法，从 GatewayProperties 获取路由配置数组。

3. GatewayProperties

org.springframework.cloud.gateway.config.GatewayProperties ，从配置文件 读取 ：

• 路由配置
• 默认 过滤器配置。当 RouteDefinition => Route 时，会将过滤器配置添加到 每个 Route 。

GatewayProperties 代码如下 ：

@ConfigurationProperties("spring.cloud.gateway")
@Validated
public class GatewayProperties{

 /**
* List of Routes
*/
 @NotNull
 @Valid
 private List<RouteDefinition> routes = new ArrayList<>();

 /**
* List of filter definitions that are applied to every route.
*/
 private List<FilterDefinition> defaultFilters = loadDefaults();

 private ArrayList<FilterDefinition> loadDefaults(){
 ArrayList<FilterDefinition> defaults = new ArrayList<>();
 FilterDefinition definition = new FilterDefinition();
 definition.setName(normalizeFilterName(RemoveNonProxyHeadersGatewayFilterFactory.class));
 defaults.add(definition);
 return defaults;
 }
}

• routes 属性，路由配置。通过 spring.cloud.gateway.routes 配置。以 YAML 配置文件举例子 ：

  spring:
  cloud:
  gateway:
  routes:
   # =====================================
  - host_example_to_httpbin=${test.uri}, Host=**.example.org
  
   # =====================================
  - id: host_foo_path_headers_to_httpbin
  uri: ${test.uri}
  predicates:
  - Host=**.foo.org
  - Path=/headers
  - Method=GET
  - Header=X-Request-Id, \d+
  - Query=foo, ba.
  - Query=baz
  - Cookie=chocolate, ch.p
  - After=1900-01-20T17:42:47.789-07:00[America/Denver]
  filters:
  - AddResponseHeader=X-Response-Foo, Bar
  
   # =====================================
  - id: add_request_header_test
  uri: ${test.uri}
  predicates:
  - Host=**.addrequestheader.org
  - Path=/headers
  filters:
  - AddRequestHeader=X-Request-Foo, Bar
  

  • 更多例子，点击 application.yml 查看。

• defaultFilters 属性， 默认 过滤器配置。通过 spring.cloud.gateway.default-filters 配置。以 YAML 配置文件举例子 ：

  spring:
  cloud:
  gateway:
  default-filters:
  - AddResponseHeader=X-Response-Default-Foo, Default-Bar
  - PrefixPath=/httpbin
  

  • 更多例子，点击 application.yml 查看。

666. 彩蛋

TODO 【3017】 与 Spring Cloud Config 结合

胖友，分享一波朋友圈可好！

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持 码农网

关注我们，获取更多IT资讯^_^

查看所有标签

• Spring cloud(5)-路由网关(Zuul)
• 网关 Spring-Cloud-Gateway 源码解析 —— 路由（2.2）之 RouteDefinitionRouteLocator 路由配置
• SpringCloud学习系列之六 ----- 路由网关Zuul使用教程
• 网关 Spring-Cloud-Gateway 源码解析 —— 路由（2.1）之 RouteLocator 一览
• 网关 Spring-Cloud-Gateway 源码解析 —— 路由（1.1）之 RouteDefinitionLocator 一览
• 网关 Spring-Cloud-Gateway 源码解析 —— 路由（1.4）之 DiscoveryClientRouteDefinitionLocator 注

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。