Spring Cloud Gateway使用说明（6）-- 其它配置

短命女 2022-11-27 15:55 301阅读 0赞

# 10 配置 #

Spring Cloud Gateway的配置由RouteDefinitionLocator的集合驱动。

**Example 65. RouteDefinitionLocator.java**

public interface RouteDefinitionLocator { 
        Flux<RouteDefinition> getRouteDefinitions();
    }

默认情况下，PropertiesRouteDefinitionLocator使用Spring Boot的@ConfigurationProperties机制加载属性。

以下两个示例是等效的：

spring:
      cloud:
        gateway:
          routes:
          - id: setstatus_route
            uri: https://example.org
            filters:
            - name: SetStatus
              args:
                status: 401
          - id: setstatusshortcut_route
            uri: https://example.org
            filters:
            - SetStatus=401

对于网关的大部分用法，配置文件方式是够用的，但一些生产用例更建议从外部源（如数据库）加载配置。未来的里程碑版本将有基于Spring Data Repositories （如Redis、MongoDB和Cassandra）的RouteDefinitionLocator实现。

# 11. 路由metadata #

通过metadata你可以为每个路由配置附加的数据：

**Example 67. application.yml**

spring:
      cloud:
        gateway:
          routes:
          - id: route_with_metadata
            uri: https://example.org
            metadata:
              optionName: "OptionValue"
              compositeObject:
                name: "value"
              iAmNumber: 1

可以从exchange中获取到所有的metadata属性：

Route route = exchange.getAttribute(GATEWAY_ROUTE_ATTR);
    // get all metadata properties
    route.getMetadata();
    // get a single metadata property
    route.getMetadata(someKey);

# 12. http超时配置 #

可以配置全局的http超时（连接和响应）时间，也可为每个路由单独覆盖配置。

## 12.1. 全局超时 ##

配置全局http超时时间：  
connect-timeout： 连接超时（毫秒）  
response-timeout：响应超时，为java.time.Duration

**global http timeouts example**

spring:
      cloud:
        gateway:
          httpclient:
            connect-timeout: 1000
            response-timeout: 5s

## 12.2. 路由单独超时 ##

为每个路由单独配置超时：  
connect-timeout：单位为毫秒  
response-timeout：单位为毫秒

**通过配置文件配置**

- id: per_route_timeouts
            uri: https://example.org
            predicates:
              - name: Path
                args:
                  pattern: /delay/{ timeout}
            metadata:
              response-timeout: 200
              connect-timeout: 200

**通过java配置**

import static org.springframework.cloud.gateway.support.RouteMetadataUtils.CONNECT_TIMEOUT_ATTR;
    import static org.springframework.cloud.gateway.support.RouteMetadataUtils.RESPONSE_TIMEOUT_ATTR;
    
          @Bean
          public RouteLocator customRouteLocator(RouteLocatorBuilder routeBuilder){ 
             return routeBuilder.routes()
                   .route("test1", r -> { 
                      return r.host("*.somehost.org").and().path("/somepath")
                            .filters(f -> f.addRequestHeader("header1", "header-value-1"))
                            .uri("http://someuri")
                            .metadata(RESPONSE_TIMEOUT_ATTR, 200)
                            .metadata(CONNECT_TIMEOUT_ATTR, 200);
                   })
                   .build();
          }

## 12.3. java路由配置API ##

为了可以更简单在Java中配置，在RouteLocatorBuilder bean中定义了一个fluent API。

**Example 68. GatewaySampleApplication.java**

// static imports from GatewayFilters and RoutePredicates
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder, ThrottleGatewayFilterFactory throttle) { 
        return builder.routes()
                .route(r -> r.host("**.abc.org").and().path("/image/png")
                    .filters(f ->
                            f.addResponseHeader("X-TestHeader", "foobar"))
                    .uri("http://httpbin.org:80")
                )
                .route(r -> r.path("/image/webp")
                    .filters(f ->
                            f.addResponseHeader("X-AnotherHeader", "baz"))
                    .uri("http://httpbin.org:80")
                    .metadata("key", "value")
                )
                .route(r -> r.order(-1)
                    .host("**.throttle.org").and().path("/get")
                    .filters(f -> f.filter(throttle.apply(1,
                            1,
                            10,
                            TimeUnit.SECONDS)))
                    .uri("http://httpbin.org:80")
                    .metadata("key", "value")
                )
                .build();
    }

## 12.4. 服务发现路由定义 ##

可以将网关配置为基于使用DiscoveryClient注册中心注册的服务发现路由。

要启用此功能，请设置spring.cloud.gateway.discovery.locator.enabled=true，并确保DiscoveryClient实现位于classpath上并已启用（如netflix eureka、consul或zookeeper）。

### 12.4.1. 为注册中心路由配置断言和过滤器 ###

默认情况下，网关为通过DiscoveryClient创建的路由定义单个断言和过滤器。  
默认断言是使用/serviceId/\*\*定义的path断言，其中serviceId是DiscoveryClient中服务的ID。  
默认过滤器是使用正则表达式 /serviceId/(?.\*)和替换的/$\{remaining\}进行重写。这只是在请求被发送到下游之前从路径中截取掉 service id 。

可以通过设置spring.cloud.gateway.discovery.locator.predicates\[x\] and spring.cloud.gateway.discovery.locator.filters\[y\]来实现自定义DiscoveryClient路由使用的断言和过滤器。当你这样做时，如果你想要保留默认功能，你需要确保包括上面的默认断言和过滤器。下面是这样一个例子。

**Example 69. application.properties**

spring.cloud.gateway.discovery.locator.predicates[0].name: Path
    spring.cloud.gateway.discovery.locator.predicates[0].args[pattern]: "'/'+serviceId+'/**'"
    spring.cloud.gateway.discovery.locator.predicates[1].name: Host
    spring.cloud.gateway.discovery.locator.predicates[1].args[pattern]: "'**.foo.com'"
    spring.cloud.gateway.discovery.locator.filters[0].name: Hystrix
    spring.cloud.gateway.discovery.locator.filters[0].args[name]: serviceId
    spring.cloud.gateway.discovery.locator.filters[1].name: RewritePath
    spring.cloud.gateway.discovery.locator.filters[1].args[regexp]: "'/' + serviceId + '/(?<remaining>.*)'"
    spring.cloud.gateway.discovery.locator.filters[1].args[replacement]: "'/${remaining}'"

# 13. netty访问日志 #

设置 -Dreactor.netty.http.server.accessLogEnabled=true 来开启Reactor Netty access logs

> 注意  
> 必须是Java System Property而不是Spring Boot property。

logging 模块也可以通过配置单独输出一个access log文件，下面是logback的配置例子：  
**Example 70. logback.xml**

<appender name="accessLog" class="ch.qos.logback.core.FileAppender">
            <file>access_log.log</file>
            <encoder>
                <pattern>%msg%n</pattern>
            </encoder>
        </appender>
        <appender name="async" class="ch.qos.logback.classic.AsyncAppender">
            <appender-ref ref="accessLog" />
        </appender>
    
        <logger name="reactor.netty.http.server.AccessLog" level="INFO" additivity="false">
            <appender-ref ref="async"/>
        </logger>

# 14 跨域配置 #

我们可以通过配置网关来控制CORS行为，全局CORS配置是 Spring Framework CorsConfiguration模式的URL MAP。

**Example 71. application.yml**

spring:
      cloud:
        gateway:
          globalcors:
            cors-configurations:
              '[/**]':
                allowedOrigins: "https://docs.spring.io"
                allowedHeaders: "*"
                allowedMethods:
                - GET

[Spring Cloud Gateway 2.2.3 官方使用说明（1）–路由][Spring Cloud Gateway 2.2.3 _1]  
[Spring Cloud Gateway 2.2.3 官方使用说明（2）-- 路由filter（上）][Spring Cloud Gateway 2.2.3 _2_-- _filter]  
[Spring Cloud Gateway 2.2.3 官方使用说明（2）-- 路由filter（下）][Spring Cloud Gateway 2.2.3 _2_-- _filter 1]  
[Spring Cloud Gateway 2.2.3 官方使用说明（3）-- Global filter][Spring Cloud Gateway 2.2.3 _3_-- Global filter]  
[Spring Cloud Gateway 2.2.3 官方使用说明（4）-- HttpHeader Filters][Spring Cloud Gateway 2.2.3 _4_-- HttpHeader Filters]  
[Spring Cloud Gateway 2.2.3 使用说明（5）-- TLS 和 SSL][Spring Cloud Gateway 2.2.3 _5_-- TLS _ SSL]

> [Spring Cloud Gateway 2.2.3 使用说明（6）-- 其它配置][Spring Cloud Gateway 2.2.3 _6_--]

[Spring Cloud Gateway 2.2.3 使用说明（7）-- actuator][Spring Cloud Gateway 2.2.3 _7_-- actuator]  
[Spring Cloud Gateway 2.2.3 使用说明（8）-- 开发指导][Spring Cloud Gateway 2.2.3 _8_--]

[Spring Cloud Gateway 2.2.3 _1]: https://blog.csdn.net/xgw1010/article/details/107343712
[Spring Cloud Gateway 2.2.3 _2_-- _filter]: https://blog.csdn.net/xgw1010/article/details/107582426
[Spring Cloud Gateway 2.2.3 _2_-- _filter 1]: https://blog.csdn.net/xgw1010/article/details/107642291
[Spring Cloud Gateway 2.2.3 _3_-- Global filter]: https://blog.csdn.net/xgw1010/article/details/107670715
[Spring Cloud Gateway 2.2.3 _4_-- HttpHeader Filters]: https://blog.csdn.net/xgw1010/article/details/107768108
[Spring Cloud Gateway 2.2.3 _5_-- TLS _ SSL]: https://blog.csdn.net/xgw1010/article/details/107851355
[Spring Cloud Gateway 2.2.3 _6_--]: https://blog.csdn.net/xgw1010/article/details/108034791
[Spring Cloud Gateway 2.2.3 _7_-- actuator]: https://blog.csdn.net/xgw1010/article/details/108036731
[Spring Cloud Gateway 2.2.3 _8_--]: https://blog.csdn.net/xgw1010/article/details/108038009