Configuration Properties

以下内容列出了配置属性列表。

  • 兼容性验证

  • 配置管理

  • 服务发现

  • 特性管理

  • 负载均衡

  • OpenFeign 客户机

  • HTTP 客户端

  • 刷新机制

  • 服务注册

  • 实用程序 bean

Name Default Description

spring.cloud.compatibility-verifier.compatible-boot-versions

Spring Boot 依赖项的默认接受版本。如果您不想指定具体值,您可以为修订版本设置 {@code x}。示例:{@code 3.4.x}

spring.cloud.compatibility-verifier.enabled

false

启用创建 Spring Cloud 兼容性验证。

spring.cloud.config.allow-override

true

指示 {@link #isOverrideSystemProperties() systemPropertiesOverride} 可用的标记。将该值设为 false 以防止用户意外更改默认设置。默认值为 true。

spring.cloud.config.initialize-on-context-refresh

false

在上下文刷新事件中初始化引导配置的标记。默认值为 false。

spring.cloud.config.override-none

false

指示当 {@link #setAllowOverride(boolean) allowOverride} 为 true 时,外部属性应具有最低优先级,并且不应覆盖任何现有属性源(包括本地配置文件)。默认值为 false。这仅在使用 config first 引导时才有效。

spring.cloud.config.override-system-properties

true

指示外部属性应覆盖系统属性的标记。默认值为 true。

spring.cloud.decrypt-environment-post-processor.enabled

true

Enable the DecryptEnvironmentPostProcessor.

spring.cloud.discovery.client.composite-indicator.enabled

true

启用服务发现客户端复合健康指示器。

spring.cloud.discovery.client.health-indicator.enabled

true

spring.cloud.discovery.client.health-indicator.include-description

false

spring.cloud.discovery.client.health-indicator.use-services-query

true

指示指示器是否应使用 {@link DiscoveryClient#getServices} 来检查其运行状况。当设置为 {@code false} 时,指示器使用较轻的 {@link DiscoveryClient#probe() }。这有助于在大量部署中,返回的服务数量使该操作变得过重。

spring.cloud.discovery.client.simple.instances

spring.cloud.discovery.client.simple.local.host

spring.cloud.discovery.client.simple.local.instance-id

spring.cloud.discovery.client.simple.local.metadata

spring.cloud.discovery.client.simple.local.port

0

spring.cloud.discovery.client.simple.local.secure

false

spring.cloud.discovery.client.simple.local.service-id

spring.cloud.discovery.client.simple.local.uri

spring.cloud.discovery.client.simple.order

spring.cloud.discovery.enabled

true

启用服务发现客户端健康指示器。

spring.cloud.features.enabled

true

Enables the features endpoint.

spring.cloud.httpclientfactories.apache.enabled

true

启用创建 Apache Http 客户端工厂 bean。

spring.cloud.httpclientfactories.ok.enabled

true

启用创建 OK Http 客户端工厂 bean。

spring.cloud.hypermedia.refresh.fixed-delay

5000

spring.cloud.hypermedia.refresh.initial-delay

10000

spring.cloud.inetutils.default-hostname

localhost

错误时使用的默认主机名。

spring.cloud.inetutils.default-ip-address

127.0.0.1

错误时使用的默认 IP 地址。

spring.cloud.inetutils.ignored-interfaces

网络接口的 Java 正则表达式列表,这些表达式将被忽略。

spring.cloud.inetutils.preferred-networks

网络地址的 Java 正则表达式列表,这些地址将被优先使用。

spring.cloud.inetutils.timeout-seconds

1

计算主机名的超时时间(秒)。

spring.cloud.inetutils.use-only-site-local-interfaces

false

是否仅使用具有站点本地地址的接口。详情请参阅 {@link InetAddress#isSiteLocalAddress()}。

spring.cloud.loadbalancer.call-get-with-request-on-delegates

true

如果此标志设置为 {@code true},将实现 {@code ServiceInstanceListSupplier#get(Request request)} 方法在从 {@code DelegatingServiceInstanceListSupplier} 分配的类中调用 {@code delegate.get(request)},这些类尚未实现该方法,不包括 {@code CachingServiceInstanceListSupplier} 和 {@code HealthCheckServiceInstanceListSupplier},这些类应置于实例供应商层级中,此层级紧随在网络上执行实例检索的供应商之后,在执行任何基于请求的筛选之前,默认情况下为 {@code true}。

spring.cloud.loadbalancer.clients

spring.cloud.loadbalancer.eager-load.clients

spring.cloud.loadbalancer.health-check.initial-delay

0

HealthCheck 调度程序的初始延迟值。

spring.cloud.loadbalancer.health-check.interval

25s

运行 HealthCheck 调度器的间隔。

spring.cloud.loadbalancer.health-check.interval

25s

运行 HealthCheck 调度器的间隔。

spring.cloud.loadbalancer.health-check.path

应进行健康检查请求的路径。可以按 serviceId 设置。还可以设置 default 值。如果未设置,将使用 /actuator/health

spring.cloud.loadbalancer.health-check.port

应进行健康检查请求的路径。如果未设置,则为请求的服务在服务实例中可用的端口。

spring.cloud.loadbalancer.health-check.refetch-instances

false

指示实例是否应由 HealthCheckServiceInstanceListSupplier 重新获取。如果可以更新实例,并且基础委托不提供正在进行的流,则可以使用此方法。

spring.cloud.loadbalancer.health-check.refetch-instances-interval

25s

重新获取可用服务实例的间隔。

spring.cloud.loadbalancer.health-check.repeat-health-check

true

指示是否应持续重复健康检查。如果定期重新获取实例,则将其设置为 false 可能有用,因为每次重新获取也将触发健康检查。

spring.cloud.loadbalancer.health-check.update-results-list

true

指示 {@code healthCheckFlux} 是否应在检索到的每个活动 {@link ServiceInstance} 上发出。如果设置为 {@code false},则首先将整个存活实例序列收集到列表中,然后才发出。

spring.cloud.loadbalancer.hint

允许设置传递给 LoadBalancer 请求的 hint 值,随后可以在 {@link ReactiveLoadBalancer} 实现中使用。

spring.cloud.loadbalancer.hint-header-name

X-SC-LB-Hint

允许设置用于传递基于提示的服务实例过滤提示的标题名称。

spring.cloud.loadbalancer.retry.backoff.enabled

false

指示是否应用 Reactor Retry 退避。

spring.cloud.loadbalancer.retry.backoff.jitter

0.5

Used to set RetryBackoffSpec.jitter.

spring.cloud.loadbalancer.retry.backoff.max-backoff

Long.MAX ms

Used to set RetryBackoffSpec.maxBackoff.

spring.cloud.loadbalancer.retry.backoff.min-backoff

5 ms

Used to set RetryBackoffSpec#minBackoff.

spring.cloud.loadbalancer.retry.enabled

true

Enables LoadBalancer retries.

spring.cloud.loadbalancer.retry.max-retries-on-next-service-instance

1

在下一个 ServiceInstance 上执行的重试次数。在每次重试调用之前都会选择 ServiceInstance

spring.cloud.loadbalancer.retry.max-retries-on-same-service-instance

0

在同一个 ServiceInstance 上执行的重试次数。

spring.cloud.loadbalancer.retry.retry-on-all-exceptions

false

表示应该对所有异常尝试重试,而不仅仅是 retryableExceptions 中指定的异常。

spring.cloud.loadbalancer.retry.retry-on-all-operations

false

表示应该对 HttpMethod.GET 之外的操作尝试重试。

spring.cloud.loadbalancer.retry.retryable-exceptions

{}

应该触发重试的 Throwable 类的 Set

spring.cloud.loadbalancer.retry.retryable-status-codes

{}

应该触发重试的状态代码的 Set

spring.cloud.loadbalancer.stats.micrometer.enabled

false

对负载均衡请求启用微米指标。

spring.cloud.loadbalancer.sticky-session.add-service-instance-cookie

false

指示 LoadBalancer 是否应该添加包含新选实例的 Cookie。

spring.cloud.loadbalancer.sticky-session.instance-id-cookie-name

sc-lb-instance-id

保存首选实例 ID 的 Cookie 名称。

spring.cloud.loadbalancer.subset.instance-id

确定性子集化的实例 ID。如果未设置,将使用 {@link IdUtils#getDefaultInstanceId(PropertyResolver)}。

spring.cloud.loadbalancer.subset.size

100

确定性子集化的最大子集大小。

spring.cloud.loadbalancer.x-forwarded.enabled

false

To Enable X-Forwarded Headers.

spring.cloud.openfeign.autoconfiguration.jackson.enabled

true

如果为 true,将为 Jackson 页面解码提供 PageJacksonModule 和 SortJacksonModule bean。

spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled

false

如果为 true,断路器 id 将仅包含字母数字字符,以允许通过配置属性进行配置。

spring.cloud.openfeign.circuitbreaker.enabled

false

如果为 true,OpenFeign 客户端将封装在 Spring Cloud CircuitBreaker 断路器中。

spring.cloud.openfeign.circuitbreaker.group.enabled

false

如果为 true,OpenFeign 客户端将封装在带有组的 Spring Cloud CircuitBreaker 断路器中。

spring.cloud.openfeign.client.config

spring.cloud.openfeign.client.decode-slash

true

默认情况下,Feign 客户端不会对反斜杠 / 字符进行编码。若要更改此行为,请将 decodeSlash 设为 false

spring.cloud.openfeign.client.default-config

default

spring.cloud.openfeign.client.default-to-properties

true

spring.cloud.openfeign.client.refresh-enabled

false

为 Feign 启用选项值刷新功能。

spring.cloud.openfeign.compression.request.enabled

false

允许 Feign 发送的请求被压缩。

spring.cloud.openfeign.compression.request.mime-types

[text/xml, application/xml, application/json]

受支持 MIME 类型列表。

spring.cloud.openfeign.compression.request.min-request-size

2048

最小阈值内容大小。

spring.cloud.openfeign.compression.response.enabled

false

启用 Feign 响应的压缩。

spring.cloud.openfeign.encoder.charset-from-content-type

false

指示是否应从 {@code Content-Type} 标头导出字符集。

spring.cloud.openfeign.http2client.enabled

false

启用 Feign 使用 Java11 HTTP 2 客户端。

spring.cloud.openfeign.httpclient.connection-timeout

2000

spring.cloud.openfeign.httpclient.connection-timer-repeat

3000

spring.cloud.openfeign.httpclient.disable-ssl-validation

false

spring.cloud.openfeign.httpclient.enabled

true

启用 Feign 使用 Apache HTTP 客户端。

spring.cloud.openfeign.httpclient.follow-redirects

true

spring.cloud.openfeign.httpclient.hc5.connection-request-timeout

3

连接请求超时的默认值。

spring.cloud.openfeign.httpclient.hc5.connection-request-timeout-unit

连接请求超时单位的默认值。

spring.cloud.openfeign.httpclient.hc5.enabled

true

启用 Feign 使用 Apache HTTP 客户端 5。

spring.cloud.openfeign.httpclient.hc5.pool-concurrency-policy

Pool concurrency policies.

spring.cloud.openfeign.httpclient.hc5.pool-reuse-policy

Pool connection re-use policies.

spring.cloud.openfeign.httpclient.hc5.socket-timeout

5

套接字超时的默认值。

spring.cloud.openfeign.httpclient.hc5.socket-timeout-unit

套接字超时单位的默认值。

spring.cloud.openfeign.httpclient.http2.version

HTTP_2

配置此客户端与远程服务器通信时使用的协议。使用 {@link HttpClient.Version} 的 {@link String} 值。

spring.cloud.openfeign.httpclient.max-connections

200

spring.cloud.openfeign.httpclient.max-connections-per-route

50

spring.cloud.openfeign.httpclient.ok-http.protocols

配置此客户端与远程服务器通信时使用的协议。使用 {@link Protocol} 的 {@link String} 值。

spring.cloud.openfeign.httpclient.ok-http.read-timeout

60s

{@link OkHttpClient} 读取超时;默认为 60 秒。

spring.cloud.openfeign.httpclient.time-to-live

900

spring.cloud.openfeign.httpclient.time-to-live-unit

spring.cloud.openfeign.lazy-attributes-resolution

false

将 @FeignClient 属性解析模式切换为延迟加载。

spring.cloud.openfeign.micrometer.enabled

true

为 Feign 启用 Micrometer 功能。

spring.cloud.openfeign.oauth2.clientRegistrationId

提供了一个将与 OAuth2 一起使用的客户端 ID。

spring.cloud.openfeign.oauth2.enabled

false

启用用于管理 oauth2 访问令牌的 feign 拦截器。

spring.cloud.openfeign.okhttp.enabled

false

启用 Feign 使用 OK HTTP 客户端。

spring.cloud.refresh.additional-property-sources-to-retain

刷新期间要保留的其他属性源。通常只保留系统属性源。此属性还允许属性源(如 EnvironmentPostProcessors 创建的属性源)保留。

spring.cloud.refresh.enabled

true

启用刷新范围及其关联功能的自动配置。

spring.cloud.refresh.extra-refreshable

true

要后处理到刷新范围的 Bean 的其他类名。

spring.cloud.refresh.never-refreshable

true

永不刷新或重新绑定的 Bean 的类名分隔符列表。

spring.cloud.refresh.on-restart.enabled

true

在开始时启用刷新上下文。

spring.cloud.service-registry.auto-registration.enabled

true

是否启用服务自动注册。默认为 true。

spring.cloud.service-registry.auto-registration.fail-fast

false

如果没有 AutoServiceRegistration,是否导致启动失败。默认为 false。

spring.cloud.service-registry.auto-registration.register-management

true

是否将管理注册为服务。默认为 true。

spring.cloud.util.enabled

true

启用创建 Spring Cloud 实用程序 Bean。