Spring Cloud Gateway系列【10】配置Gateway详解

朱雀 2023-10-09 13:43 148阅读 0赞

#### 文章目录 ####

*   *  前言
     *  application.yml 配置项
     *  其他配置
     *   *  Http超时配置
         *  使用 Java API配置路由
         *  Discovery Client路由 配置谓词和过滤器
         *  CORS 配置

### 前言 ###

在之前介绍了一些Spring Cloud Gateway配置项，接下来详细介绍下所有配置项。

[官方文档地址][Link 1]

### application.yml 配置项 ###

可以在application.properties、application.yml、代码、命令行开关中指定各种属性。

本附录提供了常见 Spring Cloud Gateway 属性的列表以及对使用它们的底层类的引用。

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>spring.cloud.gateway.default-filters</td> 
   <td></td> 
   <td>作用于每个路由的过滤器列表</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.discovery.locator.enabled</td> 
   <td>false</td> 
   <td>启用服务发现，动态路由</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.discovery.locator.filters</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.discovery.locator.include-expression</td> 
   <td>true</td> 
   <td>是否在网关集成中包含服务的 SpEL 表达式，默认为：true。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.discovery.locator.lower-case-service-id</td> 
   <td>false</td> 
   <td>在谓词和过滤器中小写 serviceId ，默认为 false。当 eureka 自动大写 serviceId 时很有用。所以 MYSERIVCE，会匹配 /myservice/**</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.discovery.locator.predicates</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.discovery.locator.route-id-prefix</td> 
   <td></td> 
   <td>routeId 的前缀，默认为 discoveryClient.getClass().getSimpleName() + “_”+服务 ID 。将以创建 routeId。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.discovery.locator.url-expression</td> 
   <td>‘lb://’+serviceId</td> 
   <td>为每个路由创建 uri 的 SpEL 表达式，默认为：‘lb://’+serviceId。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.enabled</td> 
   <td>true</td> 
   <td>启用网关功能。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.fail-on-route-definition-error</td> 
   <td>true</td> 
   <td>路由定义错误失败的选项，默认为 true。否则，将记录警告。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.add-request-header.enabled</td> 
   <td>true</td> 
   <td>启用 add-request-header 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.add-request-parameter.enabled</td> 
   <td>true</td> 
   <td>启用添加请求参数过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.add-response-header.enabled</td> 
   <td>true</td> 
   <td>启用添加响应头过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.circuit-breaker.enabled</td> 
   <td>true</td> 
   <td>启用断路器过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.dedupe-response-header.enabled</td> 
   <td>true</td> 
   <td>启用重复数据删除响应头过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.fallback-headers.enabled</td> 
   <td>true</td> 
   <td>启用回退标头过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.hystrix.enabled</td> 
   <td>true</td> 
   <td>启用 hystrix 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.map-request-header.enabled</td> 
   <td>true</td> 
   <td>启用 map-request-header 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.modify-request-body.enabled</td> 
   <td>true</td> 
   <td>启用修改请求正文过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.modify-response-body.enabled</td> 
   <td>true</td> 
   <td>启用修改响应正文过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.prefix-path.enabled</td> 
   <td>true</td> 
   <td>启用前缀路径过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.preserve-host-header.enabled</td> 
   <td>true</td> 
   <td>启用保留主机头过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.redirect-to.enabled</td> 
   <td>true</td> 
   <td>启用重定向过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.remove-hop-by-hop.headers</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.remove-hop-by-hop.order</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.remove-request-header.enabled</td> 
   <td>true</td> 
   <td>启用 remove-request-header 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.remove-request-parameter.enabled</td> 
   <td>true</td> 
   <td>启用删除请求参数过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.remove-response-header.enabled</td> 
   <td>true</td> 
   <td>启用 remove-response-header 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.request-header-size.enabled</td> 
   <td>true</td> 
   <td>启用请求头大小过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.request-header-to-request-uri.enabled</td> 
   <td>true</td> 
   <td>启用 request-header-to-request-uri 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.request-rate-limiter.deny-empty-key</td> 
   <td>true</td> 
   <td>如果密钥解析器返回空密钥，则切换到拒绝请求，默认为 true。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.request-rate-limiter.empty-key-status-code</td> 
   <td></td> 
   <td>当 denyEmptyKey 为 true 时返回的 HttpStatus，默认为 FORBIDDEN。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.request-rate-limiter.enabled</td> 
   <td>true</td> 
   <td>启用请求速率限制器过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.request-size.enabled</td> 
   <td>true</td> 
   <td>启用请求大小过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.retry.enabled</td> 
   <td>true</td> 
   <td>启用重试过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.rewrite-location-response-header.enabled</td> 
   <td>true</td> 
   <td>启用 rewrite-location-response-header 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.rewrite-location.enabled</td> 
   <td>true</td> 
   <td>启用重写位置过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.rewrite-path.enabled</td> 
   <td>true</td> 
   <td>启用重写路径过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.rewrite-response-header.enabled</td> 
   <td>true</td> 
   <td>启用重写响应头过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.save-session.enabled</td> 
   <td>true</td> 
   <td>启用保存会话过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.content-security-policy</td> 
   <td>default-src ‘self’ https:; font-src ‘self’ https: data:; img-src ‘self’ https: data:; object-src ‘none’; script-src https:; style-src ‘self’ https: ‘unsafe-inline’</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.content-type-options</td> 
   <td>nosniff</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.disable</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.download-options</td> 
   <td>noopen</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.enabled</td> 
   <td>true</td> 
   <td>启用安全标头过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.frame-options</td> 
   <td>DENY</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.permitted-cross-domain-policies</td> 
   <td>none</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.referrer-policy</td> 
   <td>no-referrer</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.strict-transport-security</td> 
   <td>max-age=631138519</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.secure-headers.xss-protection-header</td> 
   <td>1 ; mode=block</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.set-path.enabled</td> 
   <td>true</td> 
   <td>启用设置路径过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.set-request-header.enabled</td> 
   <td>true</td> 
   <td>启用 set-request-header 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.set-request-host-header.enabled</td> 
   <td>true</td> 
   <td>启用 set-request-host-header 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.set-response-header.enabled</td> 
   <td>true</td> 
   <td>启用 set-response-header 过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.set-status.enabled</td> 
   <td>true</td> 
   <td>启用设置状态过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.filter.strip-prefix.enabled</td> 
   <td>true</td> 
   <td>启用带前缀过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.forwarded.enabled</td> 
   <td>true</td> 
   <td>启用 ForwardedHeadersFilter。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.adapt-cached-body.enabled</td> 
   <td>true</td> 
   <td>启用adapt-cached-body 全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.forward-path.enabled</td> 
   <td>true</td> 
   <td>启用转发路径全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.forward-routing.enabled</td> 
   <td>true</td> 
   <td>启用转发路由全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.load-balancer-client.enabled</td> 
   <td>true</td> 
   <td>启用负载平衡器客户端全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.netty-routing.enabled</td> 
   <td>true</td> 
   <td>启用 netty-routing 全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.netty-write-response.enabled</td> 
   <td>true</td> 
   <td>启用 netty-write-response 全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.reactive-load-balancer-client.enabled</td> 
   <td>true</td> 
   <td>启用reactive-load-balancer-client 全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.remove-cached-body.enabled</td> 
   <td>true</td> 
   <td>启用 remove-cached-body 全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.route-to-request-url.enabled</td> 
   <td>true</td> 
   <td>启用 route-to-request-url 全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.global-filter.websocket-routing.enabled</td> 
   <td>true</td> 
   <td>启用 websocket-routing 全局过滤器。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.globalcors.add-to-simple-url-handler-mapping</td> 
   <td>false</td> 
   <td>如果应将全局 CORS 配置添加到 URL 处理程序。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.globalcors.cors-configurations</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.compression</td> 
   <td>false</td> 
   <td>为 Netty HttpClient 启用压缩。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.connect-timeout</td> 
   <td></td> 
   <td>以毫秒为单位的连接超时，默认为 45 秒。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.max-header-size</td> 
   <td></td> 
   <td>最大响应标头大小。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.max-initial-line-length</td> 
   <td></td> 
   <td>最大初始行长度。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.pool.acquire-timeout</td> 
   <td></td> 
   <td>仅针对 FIXED 类型，等待获取的最长时间（以毫秒为单位）。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.pool.eviction-interval</td> 
   <td>0</td> 
   <td>以指定的时间间隔在后台执行定期驱逐检查。默认禁用 ({@link Duration#ZERO})</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.pool.max-connections</td> 
   <td></td> 
   <td>仅适用于 FIXED 类型，即在现有连接上开始挂起获取之前的最大连接数。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.pool.max-idle-time</td> 
   <td></td> 
   <td>通道关闭之前的时间（以毫秒为单位）。如果为 NULL，则没有最大空闲时间。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.pool.max-life-time</td> 
   <td></td> 
   <td>通道将关闭的持续时间。如果为 NULL，则没有最大生命周期。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.pool.metrics</td> 
   <td>false</td> 
   <td>允许在 Micrometer 中收集和注册通道池指标。默认禁用。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.pool.name</td> 
   <td>proxy</td> 
   <td>通道池映射名称</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.pool.type</td> 
   <td></td> 
   <td>HttpClient 使用的池类型，默认为 ELASTIC。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.proxy.host</td> 
   <td></td> 
   <td>Netty HttpClient 代理配置的主机名。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.proxy.non-proxy-hosts-pattern</td> 
   <td></td> 
   <td>用于配置的主机列表的正则表达式 (Java)。应该直接到达，绕过代理</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.proxy.password</td> 
   <td></td> 
   <td>Netty HttpClient 代理配置密码。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.proxy.port</td> 
   <td></td> 
   <td>Netty HttpClient 的代理配置端口。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.proxy.type</td> 
   <td></td> 
   <td>proxyType 用于 Netty HttpClient 的代理配置。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.proxy.username</td> 
   <td></td> 
   <td>Netty HttpClient 代理配置的用户名。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.response-timeout</td> 
   <td></td> 
   <td>响应超时。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.close-notify-flush-timeout</td> 
   <td>3000ms</td> 
   <td>SSL close_notify 刷新超时。默认为 3000 毫秒。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.close-notify-read-timeout</td> 
   <td>0</td> 
   <td>SSL close_notify 读取超时。默认为 0 毫秒。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.default-configuration-type</td> 
   <td></td> 
   <td>默认的 ssl 配置类型。默认为 TCP。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.handshake-timeout</td> 
   <td>10000ms</td> 
   <td>SSL 握手超时。默认为 10000 毫秒</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.key-password</td> 
   <td></td> 
   <td>密钥密码，默认与keyStorePassword 相同。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.key-store</td> 
   <td></td> 
   <td>Netty HttpClient 的密钥库路径。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.key-store-password</td> 
   <td></td> 
   <td>密钥库密码。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.key-store-provider</td> 
   <td></td> 
   <td>Netty HttpClient 的密钥库提供程序，可选字段。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.key-store-type</td> 
   <td>JKS</td> 
   <td>Netty HttpClient 的密钥库类型，默认为 JKS。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.trusted-x509-certificates</td> 
   <td></td> 
   <td>用于验证远程端点证书的可信证书。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.ssl.use-insecure-trust-manager</td> 
   <td>false</td> 
   <td>安装 netty InsecureTrustManagerFactory。这是不安全的，不适合生产。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.websocket.max-frame-payload-length</td> 
   <td></td> 
   <td>最大帧有效载荷长度。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.websocket.proxy-ping</td> 
   <td>true</td> 
   <td>代理 ping 帧到下游服务，默认为 true。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpclient.wiretap</td> 
   <td>false</td> 
   <td>为 Netty HttpClient 启用窃听调试。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.httpserver.wiretap</td> 
   <td>false</td> 
   <td>为 Netty HttpServer 启用窃听调试。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.loadbalancer.use404</td> 
   <td>false</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.metrics.enabled</td> 
   <td>false</td> 
   <td>启用指标数据的收集。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.metrics.prefix</td> 
   <td>spring.cloud.gateway</td> 
   <td>网关发出的所有指标的前缀。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.metrics.tags</td> 
   <td></td> 
   <td>添加到指标的标签映射。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.after.enabled</td> 
   <td>true</td> 
   <td>启用 after 谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.before.enabled</td> 
   <td>true</td> 
   <td>启用 before 谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.between.enabled</td> 
   <td>true</td> 
   <td>启用 between 谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.cloud-foundry-route-service.enabled</td> 
   <td>true</td> 
   <td>启用 cloud-foundry-route-service 谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.cookie.enabled</td> 
   <td>true</td> 
   <td>启用 cookie 谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.header.enabled</td> 
   <td>true</td> 
   <td>启用标头谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.host.enabled</td> 
   <td>true</td> 
   <td>启用主机谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.method.enabled</td> 
   <td>true</td> 
   <td>启用方法谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.path.enabled</td> 
   <td>true</td> 
   <td>启用路径谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.query.enabled</td> 
   <td>true</td> 
   <td>启用查询谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.read-body.enabled</td> 
   <td>true</td> 
   <td>启用 read-body 谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.remote-addr.enabled</td> 
   <td>true</td> 
   <td>启用远程地址谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.predicate.weight.enabled</td> 
   <td>true</td> 
   <td>启用权重谓词。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.redis-rate-limiter.burst-capacity-header</td> 
   <td>X-RateLimit-Burst-Capacity</td> 
   <td>返回突发容量配置的标头名称。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.redis-rate-limiter.config</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.redis-rate-limiter.include-headers</td> 
   <td>true</td> 
   <td>是否包含包含速率限制器信息的标头，默认为 true。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.redis-rate-limiter.remaining-header</td> 
   <td>X-RateLimit-Remaining</td> 
   <td>返回当前秒内剩余请求数的标头名称。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.redis-rate-limiter.replenish-rate-header</td> 
   <td>X-RateLimit-Replenish-Rate</td> 
   <td>返回补货率配置的标题名称。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.redis-rate-limiter.requested-tokens-header</td> 
   <td>X-RateLimit-Requested-Tokens</td> 
   <td>返回请求的令牌配置的标头的名称。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.routes</td> 
   <td></td> 
   <td>route 路由集合。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.set-status.original-status-header-name</td> 
   <td></td> 
   <td>包含代理请求的 http 代码的标头名称。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.streaming-media-types</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.enabled</td> 
   <td>true</td> 
   <td>启用 XForwardedHeadersFilter。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.for-append</td> 
   <td>true</td> 
   <td>如果已启用将 X-Forwarded-For 作为列表附加。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.for-enabled</td> 
   <td>true</td> 
   <td>如果启用 X-Forwarded-For。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.host-append</td> 
   <td>true</td> 
   <td>如果启用将 X-Forwarded-Host 作为列表附加。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.host-enabled</td> 
   <td>true</td> 
   <td>X-Forwarded-Host 启用。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.order</td> 
   <td>0</td> 
   <td>XForwardedHeadersFilter 的顺序。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.port-append</td> 
   <td>true</td> 
   <td>如果启用将 X-Forwarded-Port 作为列表附加。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.port-enabled</td> 
   <td>true</td> 
   <td>如果启用 X-Forwarded-Port。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.prefix-append</td> 
   <td>true</td> 
   <td>如果将 X-Forwarded-Prefix 作为列表附加已启用。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.prefix-enabled</td> 
   <td>true</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.proto-append</td> 
   <td>true</td> 
   <td>如果启用将 X-Forwarded-Proto 作为列表附加。</td> 
  </tr> 
  <tr> 
   <td>spring.cloud.gateway.x-forwarded.proto-enabled</td> 
   <td>true</td> 
   <td>如果启用 X-Forwarded-Proto。</td> 
  </tr> 
 </tbody> 
</table>

### 其他配置 ###

#### Http超时配置 ####

可以为所有路由配置 Http 超时（响应和连接），并可以为每个路由特定配置。

**1. 全局超时**

配置全局 http 超时：

*  connect-timeout必须以毫秒为单位指定。
 *  response-timeout必须指定为 java.time.Duration

示例：

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

**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

**3. 使用 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();
          }

#### 使用 Java API配置路由 ####

为了允许在 Java 中进行简单配置，该RouteLocatorBuilderbean 包括一个流畅的 API。以下清单显示了它的工作原理：

// 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();
    }

这种风格还允许更多的自定义谓词断言。Route Definition Locator bean定义的谓词使用逻辑组合and。通过使用流利的Java API，你可以使用and()，or()以及negate()的Predicate类。

#### Discovery Client路由 配置谓词和过滤器 ####

默认情况下，网关使用DiscoveryClient.

默认谓词是使用模式定义的路径谓词/serviceId/\*\*，其中serviceId是DiscoveryClient.

默认过滤器是带有正则表达式/serviceId/?(?< remaining>.\*)和替换的重写路径过滤器/$\{ remaining\}。这会在向下游发送请求之前从路径中剥离服务 ID。

如果要自定义DiscoveryClient路由使用的谓词或过滤器，请设置`spring.cloud.gateway.discovery.locator.predicates[x]`和`spring.cloud.gateway.discovery.locator.filters[y]`。这样做时，如果您想保留该功能，您需要确保包含前面显示的默认谓词和过滤器。以下示例显示了它的样子：

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: CircuitBreaker
    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}'"

#### CORS 配置 ####

您可以配置网关以控制 CORS 行为。全局 CORS 配置是 URL 模式到Spring Framework Cors Configuration的映射。以下示例配置 CORS：

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

在前面的示例中，允许来自docs.spring.io所有 GET 请求路径的请求的 CORS 请求。

要为某些网关路由谓词未处理的请求提供相同的 CORS 配置，请将spring.cloud.gateway.globalcors.add-to-simple-url-handler-mapping属性设置为true。

[Link 1]: https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/appendix.html