1. 声明式 REST 客户端:假装
Feign 是一个声明性 Web 服务客户端。它使编写 Web 服务客户端变得更加容易。要使用 Feign,请创建一个接口并对其进行注释。它具有可插拔注释支持,包括 Feign 注释和 JAX-RS 注释。Feign 还支持可插拔编码器和解码器。Spring Cloud 增加了对 Spring MVC 注释的支持,并使用相同的HttpMessageConverters在 Spring Web 中默认使用。Spring Cloud 集成了 Eureka、Spring Cloud CircuitBreaker 以及 Spring Cloud LoadBalancer,以在使用 Feign 时提供负载均衡的 http 客户端。
1.1. 如何包含 Feign
要将 Feign 包含在您的项目中,请使用带有组的Startersorg.springframework.cloud和工件 IDspring-cloud-starter-openfeign. 有关使用当前 Spring Cloud Release Train 设置构建系统的详细信息,请参阅 Spring Cloud 项目页面。
示例 spring boot 应用程序
@SpringBootApplication
@EnableFeignClients
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
@FeignClient("stores")
public interface StoreClient {
@RequestMapping(method = RequestMethod.GET, value = "/stores")
List<Store> getStores();
@RequestMapping(method = RequestMethod.GET, value = "/stores")
Page<Store> getStores(Pageable pageable);
@RequestMapping(method = RequestMethod.POST, value = "/stores/{storeId}", consumes = "application/json")
Store update(@PathVariable("storeId") Long storeId, Store store);
@RequestMapping(method = RequestMethod.DELETE, value = "/stores/{storeId:\\d+}")
void delete(@PathVariable Long storeId);
}
在@FeignClient注释String 值(上面的“stores”)是一个任意客户端名称,用于创建 Spring Cloud LoadBalancer 客户端。您还可以使用url属性 (绝对值或只是主机名)。中 bean 的名称application context 是接口的完全限定名称。要指定您自己的别名值,您可以使用qualifiers价值 的@FeignClient注解。
上面的负载均衡器客户端将希望发现物理地址用于“存储”服务。如果您的应用程序是 Eureka 客户端,那么它将解析 Eureka 服务注册表中的服务。如果你不想使用 Eureka,您可以配置服务器列表在您的外部配置中使用SimpleDiscoveryClient.
Spring Cloud OpenFeign 支持 Spring Cloud LoadBalancer 阻塞模式可用的所有功能。您可以在项目文档中阅读有关它们的更多信息。
使用@EnableFeignClients注释@Configuration-annotated-classes,请确保指定客户端所在的位置,例如:@EnableFeignClients(basePackages = "com.example.clients")或明确列出它们:@EnableFeignClients(clients = InventoryServiceFeignClient.class)
|
1.2. 覆盖假默认值
Spring Cloud 的 Feign 支持中的一个核心概念是命名客户端。每个伪装客户端都是组件集合的一部分,这些组件协同工作以按需联系远程服务器,并且该集合具有一个名称,您作为应用程序开发人员使用@FeignClient注解。 Spring Cloud 创建一个新的集成作为ApplicationContext按需为每个命名客户端使用FeignClientsConfiguration. 这包含(除其他外)一个feign.Decoder一个feign.Encoder和一个feign.Contract. 可以使用contextId属性的@FeignClient注解。
Spring Cloud 允许您通过声明其他配置(在FeignClientsConfiguration) 使用@FeignClient. 例:
@FeignClient(name = "stores", configuration = FooConfiguration.class)
public interface StoreClient {
//..
}
在这种情况下,客户端由已有的组件组成FeignClientsConfiguration与任何FooConfiguration(后者将覆盖前者)。
FooConfiguration不需要用@Configuration.但是,如果是,请注意将其从任何@ComponentScan否则将包括此配置,因为它将成为feign.Decoder,feign.Encoder,feign.Contract,等,如果指定。这可以通过将其放在一个单独的、不重叠的包中来避免@ComponentScan或@SpringBootApplication,或者可以在@ComponentScan. |
用contextId属性的@FeignClient注释,除了更改
这ApplicationContextensemble,它将覆盖客户端名称的别名
它将用作为该客户机创建的配置 Bean 名称的一部分。 |
以前,使用url属性,不需要name属性。用name现在是必需的。 |
占位符在name和url属性。
@FeignClient(name = "${feign.name}", url = "${feign.url}")
public interface StoreClient {
//..
}
Spring Cloud OpenFeign 默认为 feign (BeanTypebean名称:ClassName):
-
Decoder假装解码器:ResponseEntityDecoder(它将SpringDecoder) -
EncoderfeignEncoder:SpringEncoder -
LoggerfeignLogger:Slf4jLogger -
MicrometerCapability千分尺能力:如果feign-micrometer在类路径上,并且MeterRegistry可用 -
CachingCapability缓存能力:如果@EnableCaching注释。可以通过feign.cache.enabled. -
ContractfeignContract:SpringMvcContract -
Feign.BuilderfeignBuilder 的:FeignCircuitBreaker.Builder -
ClientfeignClient:如果 Spring Cloud LoadBalancer 在类路径上,FeignBlockingLoadBalancerClient被使用。 如果它们都不在类路径上,则使用默认的伪装客户端。
spring-cloud-starter-openfeign支持spring-cloud-starter-loadbalancer.但是,作为可选依赖项,如果要使用它,您需要确保将其添加到您的项目中。 |
OkHttpClient 和 ApacheHttpClient 以及 ApacheHC5 伪装客户端可以通过设置feign.okhttp.enabled或feign.httpclient.enabled或feign.httpclient.hc5.enabled自true,并将它们放在类路径上。
您可以通过提供 bean 来自定义使用的 HTTP 客户端org.apache.http.impl.client.CloseableHttpClient使用 Apache 或okhttp3.OkHttpClient使用 OK HTTP 或org.apache.hc.client5.http.impl.classic.CloseableHttpClient使用 Apache HC5 时。
默认情况下,Spring Cloud OpenFeign 不为 feign 提供以下 bean,但仍会从应用程序上下文中查找这些类型的 bean 以创建 feign 客户端:
-
Logger.Level -
Retryer -
ErrorDecoder -
Request.Options -
Collection<RequestInterceptor> -
SetterFactory -
QueryMapEncoder -
Capability(MicrometerCapability和CachingCapability默认提供)
一颗豆子Retryer.NEVER_RETRY与类型Retryer默认情况下创建,这将禁用重试。请注意,此重试行为与假装默认行为不同,后者将自动重试 IOExceptions,将它们视为与网络相关的暂时性异常,以及从 ErrorDecoder 抛出的任何 RetryableException。
创建其中一种类型的 bean 并将其放置在@FeignClient配置(例如FooConfigurationabove) 允许您覆盖所描述的每个 bean。 例:
@Configuration
public class FooConfiguration {
@Bean
public Contract feignContract() {
return new feign.Contract.Default();
}
@Bean
public BasicAuthRequestInterceptor basicAuthRequestInterceptor() {
return new BasicAuthRequestInterceptor("user", "password");
}
}
这将替换SpringMvcContract跟feign.Contract.Default并添加一个RequestInterceptor到收藏RequestInterceptor.
@FeignClient也可以使用配置属性进行配置。
application.yml
feign:
client:
config:
feignName:
connectTimeout: 5000
readTimeout: 5000
loggerLevel: full
errorDecoder: com.example.SimpleErrorDecoder
retryer: com.example.SimpleRetryer
defaultQueryParameters:
query: queryValue
defaultRequestHeaders:
header: headerValue
requestInterceptors:
- com.example.FooRequestInterceptor
- com.example.BarRequestInterceptor
decode404: false
encoder: com.example.SimpleEncoder
decoder: com.example.SimpleDecoder
contract: com.example.SimpleContract
capabilities:
- com.example.FooCapability
- com.example.BarCapability
queryMapEncoder: com.example.SimpleQueryMapEncoder
metrics.enabled: false
feignName在此示例中,引用@FeignClient value,也以@FeignClient name和@FeignClient contextId. 在负载平衡方案中,它还对应于serviceId将用于检索实例的服务器应用程序。解码器、重试器和其他类的指定类必须在 Spring 上下文中具有 bean 或具有默认构造函数。
默认配置可以在@EnableFeignClients属性defaultConfiguration以与上述类似的方式。不同之处在于,此配置将适用于所有伪装客户端。
如果您更喜欢使用配置属性来配置所有@FeignClient,您可以使用default假名。
您可以使用feign.client.config.feignName.defaultQueryParameters和feign.client.config.feignName.defaultRequestHeaders指定将与名为feignName.
application.yml
feign:
client:
config:
default:
connectTimeout: 5000
readTimeout: 5000
loggerLevel: basic
如果我们同时创建@Configurationbean 和配置属性,配置属性将获胜。
它将覆盖@Configuration值。但是,如果要将优先级更改为@Configuration,
您可以更改feign.client.default-to-properties自false.
如果我们想创建多个具有相同名称或 url 的伪装客户端
这样它们就会指向同一台服务器,但每个服务器都有不同的自定义配置
我们必须使用contextId属性的@FeignClient为了避免名字
这些配置 bean 的冲突。
@FeignClient(contextId = "fooClient", name = "stores", configuration = FooConfiguration.class)
public interface FooClient {
//..
}
@FeignClient(contextId = "barClient", name = "stores", configuration = BarConfiguration.class)
public interface BarClient {
//..
}
也可以将 FeignClient 配置为不从父上下文继承 bean。
您可以通过覆盖inheritParentConfiguration()在FeignClientConfigurer要返回的豆子false:
@Configuration
public class CustomConfiguration {
@Bean
public FeignClientConfigurer feignClientConfigurer() {
return new FeignClientConfigurer() {
@Override
public boolean inheritParentConfiguration() {
return false;
}
};
}
}
默认情况下,伪装客户端不对斜杠字符进行编码。您可以通过将/feign.client.decodeSlash自false. |
1.2.1.SpringEncoder配置
在SpringEncoder我们提供,我们设置null二进制内容类型的字符集和UTF-8对于所有其他的。
您可以修改此行为以从Content-Typeheader charset 而不是通过设置feign.encoder.charset-from-content-type自true.
1.3. 超时处理
我们可以在默认客户端和命名客户端上配置超时。OpenFeign 使用两个超时参数:
-
connectTimeout防止由于服务器处理时间过长而阻止调用方。 -
readTimeout从建立连接时开始应用,并在返回响应时间过长时触发。
如果服务器未运行或不可用,则数据包会导致连接被拒绝。通信以错误消息或回退结束。这可能发生在connectTimeout如果它设置得很低。执行查找和接收此类数据包所花费的时间会导致很大一部分延迟。它可能会根据涉及 DNS 查找的远程主机而更改。 |
1.4. 手动创建伪造客户端
在某些情况下,可能需要以一种不 可以使用上述方法。在这种情况下,您可以使用 Feign Builder API 创建客户端。下面是一个例子 它创建两个具有相同接口的 Feign 客户端,但每个客户端都配置为 一个单独的请求拦截器。
@Import(FeignClientsConfiguration.class)
class FooController {
private FooClient fooClient;
private FooClient adminClient;
@Autowired
public FooController(Client client, Encoder encoder, Decoder decoder, Contract contract, MicrometerCapability micrometerCapability) {
this.fooClient = Feign.builder().client(client)
.encoder(encoder)
.decoder(decoder)
.contract(contract)
.addCapability(micrometerCapability)
.requestInterceptor(new BasicAuthRequestInterceptor("user", "user"))
.target(FooClient.class, "https://PROD-SVC");
this.adminClient = Feign.builder().client(client)
.encoder(encoder)
.decoder(decoder)
.contract(contract)
.addCapability(micrometerCapability)
.requestInterceptor(new BasicAuthRequestInterceptor("admin", "admin"))
.target(FooClient.class, "https://PROD-SVC");
}
}
在上面的示例中FeignClientsConfiguration.class是默认配置
由 Spring Cloud OpenFeign 提供。 |
PROD-SVC是客户端将向其发出请求的服务的名称。 |
佯装Contractobject 定义了哪些注释和值在接口上有效。这
自动接线Contractbean 提供对 SpringMVC 注解的支持,而不是
默认的 Feign 原生注解。 |
您还可以使用Builder`to configure FeignClient not to inherit beans from the parent context.
You can do this by overriding calling `inheritParentContext(false)在Builder.
1.5. 假装 Spring Cloud CircuitBreaker 支持
如果 Spring Cloud CircuitBreaker 位于类路径上,并且feign.circuitbreaker.enabled=true,Feign 将用断路器包裹所有方法。
要在每个客户端的基础上禁用 Spring Cloud CircuitBreaker 支持,请创建一个 vanillaFeign.Builder使用“原型”范围,例如:
@Configuration
public class FooConfiguration {
@Bean
@Scope("prototype")
public Feign.Builder feignBuilder() {
return Feign.builder();
}
}
断路器名称遵循此模式<feignClientClassName>#<calledMethod>(<parameterTypes>).调用@FeignClient跟FooClient接口,并且没有参数的被调用接口方法是bar那么断路器名称将是FooClient#bar().
从 2020.0.2 开始,断路器名称模式已从<feignClientName>_<calledMethod>.
用CircuitBreakerNameResolver在 2020.0.4 中引入的断路器名称可以保留旧模式。 |
提供 beanCircuitBreakerNameResolver,您可以更改断路器名称模式。
@Configuration
public class FooConfiguration {
@Bean
public CircuitBreakerNameResolver circuitBreakerNameResolver() {
return (String feignClientName, Target<?> target, Method method) -> feignClientName + "_" + method.getName();
}
}
要启用 Spring Cloud CircuitBreaker 组,请将feign.circuitbreaker.group.enabled属性设置为true(默认情况下false).
1.6. 使用配置属性配置断路器
您可以通过配置属性配置断路器。待办事项集feign.circuitbreaker.alphanumeric-ids.enabled自true.因为
不能使用诸如 、 、 之类的字符#() ,在配置属性名称中,我们需要
更改 OpenFeign 生成的断路器 ID 的命名约定。以上
财产会为您做这件事。
例如,如果你有这个 Feign 客户端
@FeignClient(url = "http://localhost:8080")
public interface DemoClient {
@GetMapping("demo")
String getDemo();
}
您可以通过执行以下作使用配置属性来配置它
feign:
circuitbreaker:
enabled: true
alphanumeric-ids:
enabled: true
resilience4j:
circuitbreaker:
instances:
DemoClientgetDemo:
minimumNumberOfCalls: 69
timelimiter:
instances:
DemoClientgetDemo:
timeoutDuration: 10s
1.7. 假装 Spring Cloud CircuitBreaker 回退
Spring Cloud CircuitBreaker 支持回退的概念:当电路打开或出现错误时执行的默认代码路径。为给定的@FeignClient将fallback属性添加到实现回退的类名。您还需要将您的实现声明为 Spring bean。
@FeignClient(name = "test", url = "http://localhost:${server.port}/", fallback = Fallback.class)
protected interface TestClient {
@RequestMapping(method = RequestMethod.GET, value = "/hello")
Hello getHello();
@RequestMapping(method = RequestMethod.GET, value = "/hellonotfound")
String getException();
}
@Component
static class Fallback implements TestClient {
@Override
public Hello getHello() {
throw new NoFallbackAvailableException("Boom!", new RuntimeException());
}
@Override
public String getException() {
return "Fixed response";
}
}
如果需要访问触发回退的原因,可以使用fallbackFactory属性@FeignClient.
@FeignClient(name = "testClientWithFactory", url = "http://localhost:${server.port}/",
fallbackFactory = TestFallbackFactory.class)
protected interface TestClientWithFactory {
@RequestMapping(method = RequestMethod.GET, value = "/hello")
Hello getHello();
@RequestMapping(method = RequestMethod.GET, value = "/hellonotfound")
String getException();
}
@Component
static class TestFallbackFactory implements FallbackFactory<FallbackWithFactory> {
@Override
public FallbackWithFactory create(Throwable cause) {
return new FallbackWithFactory();
}
}
static class FallbackWithFactory implements TestClientWithFactory {
@Override
public Hello getHello() {
throw new NoFallbackAvailableException("Boom!", new RuntimeException());
}
@Override
public String getException() {
return "Fixed response";
}
}
1.8. 假装和@Primary
当将 Feign 与 Spring Cloud CircuitBreaker 回退一起使用时,在ApplicationContext相同类型的。这将导致@Autowired无法工作,因为没有一个 bean,或者一个标记为主 bean。为了解决这个问题,Spring Cloud OpenFeign 将所有 Feign 实例标记为@Primary,因此 Spring Framework 将知道要注入哪个 bean。在某些情况下,这可能是不可取的。要关闭此行为,请将primary属性@FeignClient设置为 false。
@FeignClient(name = "hello", primary = false)
public interface HelloClient {
// methods here
}
1.9. 假继承支持
Feign 通过单继承接口支持样板 API。 这允许将常见作分组到方便的基本接口中。
public interface UserService {
@RequestMapping(method = RequestMethod.GET, value ="/users/{id}")
User getUser(@PathVariable("id") long id);
}
@RestController
public class UserResource implements UserService {
}
package project.user;
@FeignClient("users")
public interface UserClient extends UserService {
}
@FeignClient接口不应在服务器和客户端之间共享,并注释@FeignClient接口@RequestMapping不再支持类级别。 |
1.10. 假请求/响应压缩
您可以考虑为您的 假装请求。您可以通过启用以下属性之一来执行此作:
feign.compression.request.enabled=true
feign.compression.response.enabled=true
伪造请求压缩为您提供的设置类似于您可能为 Web 服务器设置的设置:
feign.compression.request.enabled=true
feign.compression.request.mime-types=text/xml,application/xml,application/json
feign.compression.request.min-request-size=2048
这些属性允许您选择压缩媒体类型和最小请求阈值长度。
由于 OkHttpClient 使用“透明”压缩,因此如果content-encoding或accept-encoding标头存在,当feign.okhttp.OkHttpClient存在于类路径上,并且feign.okhttp.enabled设置为true. |
1.11. 假日志记录
为创建的每个 Feign 客户端创建一个记录器。默认情况下,记录器的名称是用于创建 Feign 客户端的接口的完整类名。伪造日志记录仅响应DEBUG水平。
logging.level.project.user.UserClient: DEBUG
这Logger.Level您可以为每个客户端配置的对象,告诉 Feign 要记录多少。选项包括:
-
NONE,无日志记录(默认)。 -
BASIC,仅记录请求方法和 URL 以及响应状态代码和执行时间。 -
HEADERS,记录基本信息以及请求和响应标头。 -
FULL,记录请求和响应的标头、正文和元数据。
例如,以下命令将设置Logger.Level自FULL:
@Configuration
public class FooConfiguration {
@Bean
Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
}
1.12. 假装能力支持
Feign 功能公开核心 Feign 组件,以便可以修改这些组件。例如,功能可以采用Client,装饰它,并将装饰后的实例还给 Feign。
对指标库的支持就是一个很好的现实例子。请参阅伪造指标。
创建一个或多个Capability豆子并将它们放在@FeignClient配置允许您注册它们并修改相关客户端的行为。
@Configuration
public class FooConfiguration {
@Bean
Capability customCapability() {
return new CustomCapability();
}
}
1.13. 伪造指标
如果满足以下所有条件,则MicrometerCapability创建并注册 bean,以便您的 Feign 客户端将指标发布到 Micrometer:
-
feign-micrometer在类路径上 -
一个
MeterRegistry豆子可用 -
feign 指标属性设置为
true(默认情况下)-
feign.metrics.enabled=true(适用于所有客户) -
feign.client.config.feignName.metrics.enabled=true(对于单个客户端)
-
如果您的应用程序已经使用 Micrometer,则启用指标就像将feign-micrometer到你的类路径上。 |
您还可以通过以下任一方式禁用该功能:
-
以外
feign-micrometer从您的类路径 -
将伪造指标属性之一设置为
false-
feign.metrics.enabled=false -
feign.client.config.feignName.metrics.enabled=false
-
feign.metrics.enabled=false禁用对所有 Feign 客户端的指标支持,而不管客户端级标志的值如何:feign.client.config.feignName.metrics.enabled.
如果要为每个客户端启用或禁用 merics,请不要将feign.metrics.enabled并使用feign.client.config.feignName.metrics.enabled. |
您还可以自定义MicrometerCapability通过注册您自己的 Bean:
@Configuration
public class FooConfiguration {
@Bean
public MicrometerCapability micrometerCapability(MeterRegistry meterRegistry) {
return new MicrometerCapability(meterRegistry);
}
}
1.14. 假装缓存
如果@EnableCaching注释,则CachingCapabilitybean 被创建和注册,以便您的 Feign 客户端识别@Cache*其界面上的注释:
public interface DemoClient {
@GetMapping("/demo/{filterParam}")
@Cacheable(cacheNames = "demo-cache", key = "#keyParam")
String demoEndpoint(String keyParam, @PathVariable String filterParam);
}
您还可以通过属性禁用该功能feign.cache.enabled=false.
1.15. 假装@QueryMap支持
OpenFeign 的@QueryMap注释支持 POJO 用作
GET 参数映射。不幸的是,默认的 OpenFeign QueryMap 注释是
与 Spring 不兼容,因为它缺少value财产。
Spring Cloud OpenFeign 提供了等效的@SpringQueryMap注释,其中
用于将 POJO 或 Map 参数作为查询参数映射进行注释。
例如,Params类定义参数param1和param2:
// Params.java
public class Params {
private String param1;
private String param2;
// [Getters and setters omitted for brevity]
}
以下伪装客户端使用Params类,使用@SpringQueryMap注解:
@FeignClient("demo")
public interface DemoTemplate {
@GetMapping(path = "/demo")
String demoEndpoint(@SpringQueryMap Params params);
}
如果您需要对生成的查询参数映射进行更多控制,您可以实现自定义QueryMapEncoder豆。
1.16. HATEOAS 支持
Spring提供了一些API来创建遵循HATEOAS原则的REST表示,Spring Hateoas和Spring Data REST。
如果您的项目使用org.springframework.boot:spring-boot-starter-hateoas起动机
或org.springframework.boot:spring-boot-starter-data-reststarter,默认启用假装 HATEOAS 支持。
启用 HATEOAS 支持后,允许 Feign 客户端序列化 并反序列化 HATEOAS 表示模型:EntityModel、CollectionModel 和 PagedModel。
@FeignClient("demo")
public interface DemoTemplate {
@GetMapping(path = "/stores")
CollectionModel<Store> getStores();
}
1.17. Spring @MatrixVariable支持
Spring Cloud OpenFeign 为 Spring 提供了支持@MatrixVariable注解。
如果将映射作为方法参数传递,则@MatrixVariable路径段是通过将映射中的键值对与 .=
如果传递了不同的对象,则name在@MatrixVariable注释(如果已定义)或注释的变量名称为
使用 与提供的方法参数连接。=
- 重要
-
尽管在服务器端,Spring 不要求用户将路径段占位符命名为与矩阵变量名称相同的名称,但由于在客户端会过于模糊,Spring Cloud OpenFeign 要求您添加一个路径段占位符,其名称与
name在@MatrixVariable注释(如果已定义)或带注释的变量名称。
例如:
@GetMapping("/objects/links/{matrixVars}")
Map<String, List<String>> getObjects(@MatrixVariable Map<String, List<String>> matrixVars);
请注意,变量名称和路径段占位符都调用matrixVars.
@FeignClient("demo")
public interface DemoTemplate {
@GetMapping(path = "/stores")
CollectionModel<Store> getStores();
}
1.18. 假装CollectionFormat支持
我们支持feign.CollectionFormat通过提供@CollectionFormat注解。
您可以通过传递所需的feign.CollectionFormat作为注释值。
在以下示例中,CSVformat 而不是默认的EXPLODED处理方法。
@FeignClient(name = "demo")
protected interface DemoFeignClient {
@CollectionFormat(feign.CollectionFormat.CSV)
@GetMapping(path = "/test")
ResponseEntity performRequest(String test);
}
1.19. 响应式支持
由于 OpenFeign 项目目前不支持响应式客户端,例如 Spring WebClient,因此 Spring Cloud OpenFeign 也不支持。一旦它在核心项目中可用,我们将在此处添加对它的支持。
在此之前,我们建议使用 feign-reactive 来支持 Spring WebClient。
1.19.1. 早期初始化错误
根据您使用 Feign 客户端的方式,您可能会在启动应用程序时看到初始化错误。
要解决此问题,您可以使用ObjectProvider自动接线客户端时。
@Autowired
ObjectProvider<TestFeignClient> testFeignClient;
1.20. Spring 数据支持
您可以考虑启用 Jackson 模块以获得支持org.springframework.data.domain.Page和org.springframework.data.domain.Sort译码。
feign.autoconfiguration.jackson.enabled=true
1.21. Spring@RefreshScope支持
如果启用了伪装客户端刷新,则每个伪装客户端都使用feign.Request.Options作为刷新作用域的 bean。这意味着connectTimeout和readTimeout可以通过POST /actuator/refresh.
默认情况下,伪装客户端中的刷新行为处于禁用状态。使用以下属性启用刷新行为:
feign.client.refresh-enabled=true
不要对@FeignClient接口与@RefreshScope注解。 |
1.22. OAuth2 支持
可以通过设置以下标志来启用 OAuth2 支持:
feign.oauth2.enabled=true
1.22.1. 已弃用的 OAuth2 支持
当标志设置为true和spring-security-oauth2-autoconfigure存在于类路径中,并且存在 OAuth2 客户端上下文资源详细信息,并且OAuth2ClientContext和OAuth2ProtectedResourceDetailsbean 存在,类的 beanOAuth2FeignRequestInterceptor被创建。在每次请求之前,拦截器都会解析所需的访问Tokens并将其作为标头包含在内。
有时,当为 Feign 客户端启用负载平衡时,您可能也希望使用负载平衡来获取访问Tokens。为此,您应该确保负载均衡器位于类路径(spring-cloud-starter-loadbalancer)上,并通过设置以下标志显式启用 OAuth2FeignRequestInterceptor 的负载均衡:
feign.oauth2.load-balanced=true
- 警告
-
上述 OAuth2 支持现已弃用,因为
spring-security-oauth2-autoconfigure已达到寿命的尽头。请改用下面描述的模式。
1.22.2. 当前的 OAuth2 支持
当feign.client.refresh-enabled标志设置为 true,并且spring-security-oauth2-client存在于类路径中,类的 beanOAuth2AccessTokenInterceptor被创建。在每次请求之前,拦截器都会解析所需的访问Tokens并将其作为标头包含在内。OAuth2AccessTokenInterceptor使用OAuth2AuthorizedClientManager获取OAuth2AuthorizedClient该OAuth2AccessToken.如果用户指定了 OAuth2clientRegistrationId使用feign.oauth2.clientRegistrationId属性,它将用于检索Tokens。如果未检索Tokens或clientRegistrationId尚未指定,则serviceId从url主机段。
- 提示
-
使用
serviceId由于 OAuth2 客户端 registrationId 对于负载均衡的 Feign 客户端来说很方便。对于非负载平衡的,基于属性的clientRegistrationId是一个合适的方法。 - 提示
-
如果您不想使用
OAuth2AuthorizedClientManager,您可以在配置中实例化这种类型的 bean。