常用配置属性 (Common application properties)
你可以在 application.properties 文件、application.yml 文件中指定各种属性，或者作为命令行参数传入。本附录提供了常用的 Spring Cloud Gateway 属性列表以及使用它们的底层类的引用。
::: note 注意 属性贡献可能来自类路径上的其他 jar 文件，因此不应将此列表视为详尽无遗。此外，你也可以定义自己的属性。 :::
| 名称 | 默认值 | 描述 |
|---|---|---|
| spring.cloud.gateway.server.webflux.default-filters | 应用于每个路由的过滤器定义列表。 | |
| spring.cloud.gateway.server.webflux.discovery.locator.enabled | false | 是否启用 DiscoveryClient 网关集成。 |
| spring.cloud.gateway.server.webflux.discovery.locator.filters | ||
| spring.cloud.gateway.server.webflux.discovery.locator.include-expression | true | 用于评估是否将服务包含进入网关集成的 SpEL 表达式，默认为: true。 |
| spring.cloud.gateway.server.webflux.discovery.locator.lower-case-service-id | false | 是否在断言和过滤器中将 serviceId 转换为小写，默认为 false。在使用 Eureka 时非常有用，因为它会自动将 serviceId 大写（例如：MYSERIVCE 会匹配 /myservice/**）。 |
| spring.cloud.gateway.server.webflux.discovery.locator.predicates | ||
| spring.cloud.gateway.server.webflux.discovery.locator.route-id-prefix | routeId 的前缀，默认为 discoveryClient.getClass().getSimpleName() + "_"。Service Id 将被追加以创建 routeId。 | |
| spring.cloud.gateway.server.webflux.discovery.locator.url-expression | 'lb://'+serviceId | 用于为每个路由创建 URI 的 SpEL 表达式，默认为: 'lb://'+serviceId。 |
| spring.cloud.gateway.server.webflux.enabled | true | 是否启用网关功能。 |
| spring.cloud.gateway.server.webflux.fail-on-route-definition-error | true | 发生路由定义错误时是否抛出异常，默认为 true。否则，仅记录一条警告。 |
| spring.cloud.gateway.server.webflux.filter.add-request-header.enabled | true | 是否启用 add-request-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.add-request-parameter.enabled | true | 是否启用 add-request-parameter 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.add-response-header.enabled | true | 是否启用 add-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.circuit-breaker.enabled | true | 是否启用 circuit-breaker 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.dedupe-response-header.enabled | true | 是否启用 dedupe-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.fallback-headers.enabled | true | 是否启用 fallback-headers 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.json-to-grpc.enabled | true | 是否启用 JSON to gRPC 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.local-response-cache.enabled | false | 是否启用 local-response-cache 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.local-response-cache.request.no-cache-strategy | skip-update-cache-entry | |
| spring.cloud.gateway.server.webflux.filter.local-response-cache.size | 此路由驱逐缓存的最大大小（支持 KB, MB 和 GB）。 | |
| spring.cloud.gateway.server.webflux.filter.local-response-cache.time-to-live | 5m | 缓存条目的过期时间（s 为秒，m 为分钟，h 为小时）。 |
| spring.cloud.gateway.server.webflux.filter.map-request-header.enabled | true | 是否启用 map-request-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.modify-request-body.enabled | true | 是否启用 modify-request-body 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.modify-response-body.enabled | true | 是否启用 modify-response-body 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.prefix-path.enabled | true | 是否启用 prefix-path 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.preserve-host-header.enabled | true | 是否启用 preserve-host-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.redirect-to.enabled | true | 是否启用 redirect-to 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.remove-hop-by-hop.headers | ||
| spring.cloud.gateway.server.webflux.filter.remove-hop-by-hop.order | ||
| spring.cloud.gateway.server.webflux.filter.remove-request-header.enabled | true | 是否启用 remove-request-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.remove-request-parameter.enabled | true | 是否启用 remove-request-parameter 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.remove-response-header.enabled | true | 是否启用 remove-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.request-header-size.enabled | true | 是否启用 request-header-size 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.request-header-to-request-uri.enabled | true | 是否启用 request-header-to-request-uri 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.request-rate-limiter.default-key-resolver | ||
| spring.cloud.gateway.server.webflux.filter.request-rate-limiter.default-rate-limiter | ||
| spring.cloud.gateway.server.webflux.filter.request-rate-limiter.enabled | true | 是否启用 request-rate-limiter 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.request-size.enabled | true | 是否启用 request-size 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.retry.enabled | true | 是否启用 retry 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-location-response-header.enabled | true | 是否启用 rewrite-location-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-location.enabled | true | 是否启用 rewrite-location 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-path.enabled | true | 是否启用 rewrite-path 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-request-parameter.enabled | true | 是否启用 rewrite-request-parameter 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.rewrite-response-header.enabled | true | 是否启用 rewrite-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.save-session.enabled | true | 是否启用 save-session 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.secure-headers.content-security-policy | 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' | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.content-type-options | nosniff | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.default-headers | ||
| spring.cloud.gateway.server.webflux.filter.secure-headers.disable | ||
| spring.cloud.gateway.server.webflux.filter.secure-headers.disabled-headers | ||
| spring.cloud.gateway.server.webflux.filter.secure-headers.download-options | noopen | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.enabled | true | 是否启用 secure-headers 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.secure-headers.enabled-headers | ||
| spring.cloud.gateway.server.webflux.filter.secure-headers.frame-options | DENY | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.permissions-policy | accelerometer=(), ambient-light-sensor=(), autoplay=(), battery=(), camera=(), cross-origin-isolated=(), display-capture=(), document-domain=(), encrypted-media=(), execution-while-not-rendered=(), execution-while-out-of-viewport=(), fullscreen=(), geolocation=(), gyroscope=(), keyboard-map=(), microphone=(), midi=(), navigation-override=(), payment=(), picture-in-picture=(), publickey-credentials-get=(), screen-wake-lock=(), sync-xhr=(), usb=(), web-share=(), xr-spatial-tracking=() | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.permitted-cross-domain-policies | none | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.referrer-policy | no-referrer | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.strict-transport-security | max-age=631138519 | |
| spring.cloud.gateway.server.webflux.filter.secure-headers.xss-protection-header | 1 ; mode=block | |
| spring.cloud.gateway.server.webflux.filter.set-path.enabled | true | 是否启用 set-path 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.set-request-header.enabled | true | 是否启用 set-request-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.set-request-host-header.enabled | true | 是否启用 set-request-host-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.set-response-header.enabled | true | 是否启用 set-response-header 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.set-status.enabled | true | 是否启用 set-status 过滤器。 |
| spring.cloud.gateway.server.webflux.filter.strip-prefix.enabled | true | 是否启用 strip-prefix 过滤器。 |
| spring.cloud.gateway.server.webflux.forwarded.by.enabled | false | 是否启用 Forwarded: by 头部部分。 |
| spring.cloud.gateway.server.webflux.forwarded.enabled | true | 是否启用 ForwardedHeadersFilter。 |
| spring.cloud.gateway.server.webflux.global-filter.adapt-cached-body.enabled | true | 是否启用 adapt-cached-body 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.forward-path.enabled | true | 是否启用 forward-path 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.forward-routing.enabled | true | 是否启用 forward-routing 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.load-balancer-client.enabled | true | 是否启用 load-balancer-client 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.local-response-cache.enabled | true | 是否为所有路由启用 local-response-cache 过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.netty-routing.enabled | true | 是否启用 netty-routing 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.netty-write-response.enabled | true | 是否启用 netty-write-response 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.reactive-load-balancer-client.enabled | true | 是否启用 reactive-load-balancer-client 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.remove-cached-body.enabled | true | 是否启用 remove-cached-body 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.route-to-request-url.enabled | true | 是否启用 route-to-request-url 全局过滤器。 |
| spring.cloud.gateway.server.webflux.global-filter.websocket-routing.enabled | true | 是否启用 websocket-routing 全局过滤器。 |
| spring.cloud.gateway.server.webflux.globalcors.add-to-simple-url-handler-mapping | false | 全局 CORS 配置是否应添加到 URL 处理器。 |
| spring.cloud.gateway.server.webflux.globalcors.cors-configurations | ||
| spring.cloud.gateway.server.webflux.handler-mapping.order | 1 | RoutePredicateHandlerMapping 的顺序。 |
| spring.cloud.gateway.server.webflux.httpclient.compression | false | 是否为 Netty HttpClient 启用压缩。 |
| spring.cloud.gateway.server.webflux.httpclient.connect-timeout | 连接超时时间（毫秒），默认为 30 秒。 | |
| spring.cloud.gateway.server.webflux.httpclient.max-header-size | 最大响应头大小。 | |
| spring.cloud.gateway.server.webflux.httpclient.max-initial-line-length | 最大初始行长度。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.acquire-timeout | 仅适用于 FIXED 类型，等待获取连接的最大时间（毫秒）。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.eviction-interval | 0 | 在后台以指定间隔执行定期驱逐检查。默认禁用 (Duration#ZERO)。 |
| spring.cloud.gateway.server.webflux.httpclient.pool.leasing-strategy | fifo | 配置连接池的租赁策略（fifo 或 lifo），默认为 FIFO（Netty 的默认设置）。 |
| spring.cloud.gateway.server.webflux.httpclient.pool.max-connections | 仅适用于 FIXED 类型，在现有连接上开始挂起获取之前的最大连接数。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.max-idle-time | 通道关闭前的最大空闲时间（毫秒）。如果为 NULL，则没有最大空闲时间。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.max-life-time | 通道关闭前的持续时间。如果为 NULL，则没有最大生存时间。 | |
| spring.cloud.gateway.server.webflux.httpclient.pool.metrics | false | 是否启用通道池指标并注册到 Micrometer。默认禁用。 |
| spring.cloud.gateway.server.webflux.httpclient.pool.name | proxy | 通道池名称，默认为 proxy。 |
| spring.cloud.gateway.server.webflux.httpclient.pool.type | elastic | HttpClient 使用的连接池类型（elastic, fixed 或 disabled）。 |
| spring.cloud.gateway.server.webflux.httpclient.proxy.host | Netty HttpClient 代理配置的主机名。 | |
| spring.cloud.gateway.server.webflux.httpclient.proxy.non-proxy-hosts-pattern | 主机的正则表达式（Java），这些主机应直接访问，绕过代理。 | |
| spring.cloud.gateway.server.webflux.httpclient.proxy.password | Netty HttpClient 代理配置的密码。 | |
| spring.cloud.gateway.server.webflux.httpclient.proxy.port | Netty HttpClient 代理配置的端口。 | |
| spring.cloud.gateway.server.webflux.httpclient.proxy.type | http | Netty HttpClient 代理配置的类型（http, socks4 或 socks5）。 |
| spring.cloud.gateway.server.webflux.httpclient.proxy.username | Netty HttpClient 代理配置的用户名。 | |
| spring.cloud.gateway.server.webflux.httpclient.response-timeout | 响应超时时间。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.close-notify-flush-timeout | 3000ms | SSL close_notify 刷新超时。默认为 3000 毫秒。 |
| spring.cloud.gateway.server.webflux.httpclient.ssl.close-notify-read-timeout | 0 | SSL close_notify 读取超时。默认为 0 毫秒。 |
| spring.cloud.gateway.server.webflux.httpclient.ssl.handshake-timeout | 10000ms | SSL 握手超时。默认为 10000 毫秒。 |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-password | 密钥密码，默认与 keyStorePassword 相同。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-store | Netty HttpClient 的密钥库路径。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-store-password | 密钥库密码。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-store-provider | Netty HttpClient 的密钥库提供者，可选字段。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.key-store-type | JKS | Netty HttpClient 的密钥库类型，默认为 JKS。 |
| spring.cloud.gateway.server.webflux.httpclient.ssl.ssl-bundle | 要使用的 SSL bundle 名称。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.trusted-x509-certificates | 用于验证远程端点证书的可信证书。 | |
| spring.cloud.gateway.server.webflux.httpclient.ssl.use-insecure-trust-manager | false | 安装 Netty 的 InsecureTrustManagerFactory。这是不安全的，不适用于生产环境。 |
| spring.cloud.gateway.server.webflux.httpclient.websocket.max-frame-payload-length | 最大帧有效载荷长度。 | |
| spring.cloud.gateway.server.webflux.httpclient.websocket.proxy-ping | true | 将 ping 帧代理到下游服务，默认为 true。 |
| spring.cloud.gateway.server.webflux.httpclient.wiretap | false | 为 Netty HttpClient 启用流量窃听调试。 |
| spring.cloud.gateway.server.webflux.httpserver.wiretap | false | 为 Netty HttpServer 启用流量窃听调试。 |
| spring.cloud.gateway.server.webflux.loadbalancer.use404 | false | |
| spring.cloud.gateway.server.webflux.metrics.enabled | false | 是否启用指标数据收集。 |
| spring.cloud.gateway.server.webflux.metrics.prefix | spring.cloud.gateway | 网关发出的所有指标的前缀。 |
| spring.cloud.gateway.server.webflux.metrics.tags | 添加到指标中的标签映射。 | |
| spring.cloud.gateway.server.webflux.observability.enabled | true | 是否开启 Micrometer 可观测性支持。 |
| spring.cloud.gateway.server.webflux.predicate.after.enabled | true | 是否启用 after 断言。 |
| spring.cloud.gateway.server.webflux.predicate.before.enabled | true | 是否启用 before 断言。 |
| spring.cloud.gateway.server.webflux.predicate.between.enabled | true | 是否启用 between 断言。 |
| spring.cloud.gateway.server.webflux.predicate.cloud-foundry-route-service.enabled | true | 是否启用 cloud-foundry-route-service 断言。 |
| spring.cloud.gateway.server.webflux.predicate.cookie.enabled | true | 是否启用 cookie 断言。 |
| spring.cloud.gateway.server.webflux.predicate.header.enabled | true | 是否启用 header 断言。 |
| spring.cloud.gateway.server.webflux.predicate.host.enabled | true | 是否启用 host 断言。 |
| spring.cloud.gateway.server.webflux.predicate.host.include-port | true | 匹配主机名时是否包含端口。 |
| spring.cloud.gateway.server.webflux.predicate.method.enabled | true | 是否启用 method 断言。 |
| spring.cloud.gateway.server.webflux.predicate.path.enabled | true | 是否启用 path 断言。 |
| spring.cloud.gateway.server.webflux.predicate.query.enabled | true | 是否启用 query 断言。 |
| spring.cloud.gateway.server.webflux.predicate.read-body.enabled | true | 是否启用 read-body 断言。 |
| spring.cloud.gateway.server.webflux.predicate.remote-addr.enabled | true | 是否启用 remote-addr 断言。 |
| spring.cloud.gateway.server.webflux.predicate.weight.enabled | true | 是否启用 weight 断言。 |
| spring.cloud.gateway.server.webflux.predicate.xforwarded-remote-addr.enabled | true | 是否启用 xforwarded-remote-addr 断言。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.burst-capacity-header | X-RateLimit-Burst-Capacity | 返回令牌桶容量配置的头部名称。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.config | ||
| spring.cloud.gateway.server.webflux.redis-rate-limiter.include-headers | true | 是否包含包含限流信息的头部，默认为 true。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.remaining-header | X-RateLimit-Remaining | 返回当前秒内剩余请求数的头部名称。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.replenish-rate-header | X-RateLimit-Replenish-Rate | 返回填充速率配置的头部名称。 |
| spring.cloud.gateway.server.webflux.redis-rate-limiter.requested-tokens-header | X-RateLimit-Requested-Tokens | 返回请求令牌配置的头部名称。 |
| spring.cloud.gateway.server.webflux.redis-route-definition-repository.enabled | true | 是否启用 RedisRouteDefinitionRepository。 |
| spring.cloud.gateway.server.webflux.restrictive-property-accessor.enabled | true | 在 SpEL 中限制方法和属性访问。 |
| spring.cloud.gateway.server.webflux.route-filter-cache-enabled | false | 是否启用路由过滤器缓存，默认为 false。 |
| spring.cloud.gateway.server.webflux.route-refresh-listener.enabled | true | 是否开启 RouteRefreshListener。 |
| spring.cloud.gateway.server.webflux.routes | 路由列表。 | |
| spring.cloud.gateway.server.webflux.set-status.original-status-header-name | 包含代理请求生成的 http 代码的头部名称。 | |
| spring.cloud.gateway.server.webflux.streaming-media-types | ||
| spring.cloud.gateway.server.webflux.trusted-proxies | 定义在 Forwarded 或 X-Forwarded 头部出现时受信任的代理的正则表达式。 | |
| spring.cloud.gateway.server.webflux.version.default-version | 默认 API 版本。 | |
| spring.cloud.gateway.server.webflux.version.detect-supported-versions | true | 是否使用出现在映射中的 API 版本进行支持的版本验证 (true)，或者仅使用显式配置的版本 (false)。默认为 true。 |
| spring.cloud.gateway.server.webflux.version.header-name | 用于提取 API 版本的头部名称。 | |
| spring.cloud.gateway.server.webflux.version.media-type | 用于提取 API 版本的媒体类型名称。 | |
| spring.cloud.gateway.server.webflux.version.media-type-param-name | 用于提取 API 版本的媒体类型参数名称。 | |
| spring.cloud.gateway.server.webflux.version.path-segment | 用于提取 API 版本的路径分段索引。 | |
| spring.cloud.gateway.server.webflux.version.request-param-name | 用于提取 API 版本的请求参数名称。 | |
| spring.cloud.gateway.server.webflux.version.required | false | |
| spring.cloud.gateway.server.webflux.version.supported-versions | ||
| spring.cloud.gateway.server.webflux.x-forwarded.enabled | true | 是否启用 XForwardedHeadersFilter。 |
| spring.cloud.gateway.server.webflux.x-forwarded.for-append | true | 是否启用以列表形式追加 X-Forwarded-For。 |
| spring.cloud.gateway.server.webflux.x-forwarded.for-enabled | true | 是否启用 X-Forwarded-For。 |
| spring.cloud.gateway.server.webflux.x-forwarded.host-append | true | 是否启用以列表形式追加 X-Forwarded-Host。 |
| spring.cloud.gateway.server.webflux.x-forwarded.host-enabled | true | 是否启用 X-Forwarded-Host。 |
| spring.cloud.gateway.server.webflux.x-forwarded.order | 0 | XForwardedHeadersFilter 的顺序。 |
| spring.cloud.gateway.server.webflux.x-forwarded.port-append | true | 是否启用以列表形式追加 X-Forwarded-Port。 |
| spring.cloud.gateway.server.webflux.x-forwarded.port-enabled | true | 是否启用 X-Forwarded-Port。 |
| spring.cloud.gateway.server.webflux.x-forwarded.prefix-append | true | 是否启用以列表形式追加 X-Forwarded-Prefix。 |
| spring.cloud.gateway.server.webflux.x-forwarded.prefix-enabled | true | 是否启用 X-Forwarded-Prefix。 |
| spring.cloud.gateway.server.webflux.x-forwarded.proto-append | true | 是否启用以列表形式追加 X-Forwarded-Proto。 |
| spring.cloud.gateway.server.webflux.x-forwarded.proto-enabled | true | 是否启用 X-Forwarded-Proto。 |
| spring.cloud.gateway.server.webmvc.form-filter.enabled | true | 是否启用 form-filter。 |
| spring.cloud.gateway.server.webmvc.forwarded-request-headers-filter.enabled | true | 是否启用 forwarded-request-headers-filter。 |
| spring.cloud.gateway.server.webmvc.remove-content-length-request-headers-filter.enabled | true | 是否启用 remove-content-length-request-headers-filter。 |
| spring.cloud.gateway.server.webmvc.remove-hop-by-hop-request-headers-filter.enabled | true | 是否启用 remove-hop-by-hop-request-headers-filter。 |
| spring.cloud.gateway.server.webmvc.remove-hop-by-hop-response-headers-filter.enabled | true | 是否启用 remove-hop-by-hop-response-headers-filter。 |
| spring.cloud.gateway.server.webmvc.remove-http2-status-response-headers-filter.enabled | true | 是否启用 remove-http2-status-response-headers-filter。 |
| spring.cloud.gateway.server.webmvc.routes | 路由列表。 | |
| spring.cloud.gateway.server.webmvc.routes-map | 路由映射。 | |
| spring.cloud.gateway.server.webmvc.streaming-buffer-size | 16384 | 用于流式媒体 mime-types 的缓冲区大小。 |
| spring.cloud.gateway.server.webmvc.streaming-media-types | 流式 Mime-types。 | |
| spring.cloud.gateway.server.webmvc.transfer-encoding-normalization-request-headers-filter.enabled | true | 是否启用 transfer-encoding-normalization-request-headers-filter。 |
| spring.cloud.gateway.server.webmvc.trusted-proxies | 定义在 Forwarded 或 X-Forwarded 头部出现时受信任的代理的正则表达式。 | |
| spring.cloud.gateway.server.webmvc.use-framework-retry-filter | false | 在类路径上有 Spring Retry 却仍想使用 Spring Framework retry 作为重试过滤器的情况下，将此属性设置为 true。 |
| spring.cloud.gateway.server.webmvc.weight-calculator-filter.enabled | true | 是否启用 weight-calculator-filter。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.enabled | true | 是否启用 XForwardedHeadersFilter。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.for-append | true | 是否启用以列表形式追加 X-Forwarded-For。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.for-enabled | true | 是否启用 X-Forwarded-For。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.host-append | true | 是否启用以列表形式追加 X-Forwarded-Host。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.host-enabled | true | 是否启用 X-Forwarded-Host。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.order | 0 | XForwardedHeadersFilter 的顺序。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.port-append | true | 是否启用以列表形式追加 X-Forwarded-Port。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.port-enabled | true | 是否启用 X-Forwarded-Port。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.prefix-append | true | 是否启用以列表形式追加 X-Forwarded-Prefix。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.prefix-enabled | true | 是否启用 X-Forwarded-Prefix。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.proto-append | true | 是否启用以列表形式追加 X-Forwarded-Proto。 |
| spring.cloud.gateway.server.webmvc.x-forwarded-request-headers-filter.proto-enabled | true | 是否启用 X-Forwarded-Proto。 |
可观测性元数据 (Observability metadata)
可观测性 - 指标 (Metrics)
下面你可以找到本项目声明的所有指标列表。
Gateway Http Client Observation (网关 HTTP 客户端观测)
当通过网关发送请求时创建的观测。
指标名称 http.client.requests (由规范类 org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention 定义)。类型 timer。
指标名称 http.client.requests.active (由规范类 org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention 定义)。类型 long task timer。
::: important 重要 在启动观测后添加的 KeyValues 可能会在 *.active 指标中缺失。 :::
::: important 重要 Micrometer 内部使用“纳秒”作为基础单位。但是，具体的基础单位由每个后端决定（例如 Prometheus 使用秒）。 :::
封闭类的全限定名称 org.springframework.cloud.gateway.filter.headers.observation.GatewayDocumentedObservation。
低基数 Keys (Low cardinality Keys)
| 名称 | 描述 |
|---|---|
http.method (必须) | HTTP 方法。 |
http.status_code (必须) | HTTP 状态码。 |
spring.cloud.gateway.route.id (必须) | 路由 ID。 |
spring.cloud.gateway.route.uri (必须) | 从路由中获取的 HTTP URI。 |
高基数 Keys (High cardinality Keys)
| 名称 | 描述 |
|---|---|
http.uri (必须) | 完整的 HTTP URI。 |
可观测性 - Spans (跨度)
下面你可以找到本项目声明的所有 span 列表。
Gateway Http Client Observation Span
当通过网关发送请求时创建的观测。
Span 名称 http.client.requests (由规范类 org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention 定义)。
封闭类的全限定名称 org.springframework.cloud.gateway.filter.headers.observation.GatewayDocumentedObservation。
Tag Keys
| 名称 | 描述 |
|---|---|
http.method (必须) | HTTP 方法。 |
http.status_code (必须) | HTTP 状态码。 |
http.uri (必须) | 完整的 HTTP URI。 |
spring.cloud.gateway.route.id (必须) | 路由 ID。 |
spring.cloud.gateway.route.uri (必须) | 从路由中获取的 HTTP URI。 |
可观测性 - 规范 (Conventions)
下面你可以找到本项目声明的所有 GlobalObservationConvention 和 ObservationConvention 列表。
| ObservationConvention 类名 | 适用的 ObservationContext 类名 |
|---|---|
org.springframework.cloud.gateway.filter.headers.observation.DefaultGatewayObservationConvention | GatewayContext |
org.springframework.cloud.gateway.filter.headers.observation.GatewayObservationConvention | GatewayContext |