长沙网站建设商城,黑龙江做网站找谁,阳网站建设,网站建设方案功能描述1. 声明式 REST 客户端#xff1a; Feign
Feign 是一个声明式的 Web Service 客户端。它使编写 Web Service 客户端更容易。要使用 Feign#xff0c;需要创建一个接口并对其进行注解。它有可插拔的注解支持#xff0c;包括 Feign 注解和 JAX-RS 注解。Feign 还支持可插拔的…1. 声明式 REST 客户端 Feign
Feign 是一个声明式的 Web Service 客户端。它使编写 Web Service 客户端更容易。要使用 Feign需要创建一个接口并对其进行注解。它有可插拔的注解支持包括 Feign 注解和 JAX-RS 注解。Feign 还支持可插拔的编码器和解码器。Spring Cloud 增加了对 Spring MVC 注解的支持并支持使用 Spring Web 中默认使用的 HttpMessageConverters。Spring Cloud 集成了 Eureka、Spring Cloud CircuitBreaker以及Spring Cloud LoadBalancer以便在使用Feign时提供一个负载均衡的http客户端。
1.1. 如何“包含” Feign
要在你的项目中包含 Feign请使用 group 为 org.springframework.cloud 和 artifact id 为 spring-cloud-starter-openfeign 的 starter。请参阅 Spring Cloud 项目页面了解关于使用当前 Spring Cloud Release Train 设置构建系统的详细信息。
例子Spring Boot应用程序
SpringBootApplication
EnableFeignClients
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}}StoreClient.java
FeignClient(stores)
public interface StoreClient {RequestMapping(method RequestMethod.GET, value /stores)ListStore getStores();RequestMapping(method RequestMethod.GET, value /stores)PageStore 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 注解中字符串值上面的 stores是一个任意的客户端名称它被用来创建一个 Spring Cloud LoadBalancer client.。你也可以使用 url 属性指定一个 URL绝对值或只是一个hostname。application context 中的 bean 名称是接口的完全限定名称。要指定你自己的别名值你可以使用 FeignClient 注解的 qualifiers 值。
上面的负载均衡器客户端将想发现 stores service 的物理地址。如果你的应用程序是一个 Eureka 客户端那么它将在 Eureka 服务注册中心中解析该服务。如果你不想使用Eureka你可以使用 SimpleDiscoveryClient 在你的外部配置中配置一个服务列表。
Spring Cloud OpenFeign 支持 Spring Cloud LoadBalancer 阻塞模式的所有功能。你可以在 项目文档 中关于它们的信息。 要在 Configuration 注解的类上使用 EnableFeignClients 注解请确保指定客户端的位置例如 EnableFeignClients(basePackages com.example.clients) 或明确列出它们 EnableFeignClients(clients InventoryServiceFeignClient.class)
1.1.1. 属性解析模式
在创建 Feign 客户端 Bean 时我们通过 FeignClient 注解来解析传递的值。从 4.x 开始这些值被急切地解析。这对于大多数的使用情况来说是一个很好的解决方案而且它也允许对 AOT 的支持。
如果你需要延迟地解析属性请将 spring.cloud.openfeign.lazy-attributes-resolution 属性值设置为 true。 对于 Spring Cloud Contract 测试集成应该使用延迟的属性解析。
1.2. 覆盖 Feign 的默认值
Spring Cloud 的 Feign 支持中的一个核心概念是命名的客户端。每个feign客户端都是一个组件集合的一部分这些组件一起工作以按需联系远程服务器并且该集合有一个你作为应用开发者使用 FeignClient 注解给它的名字。Spring Cloud 使用 FeignClientsConfiguration 为每个命名的客户端按需创建一个新的组合作为 ApplicationContext。这包括除其他外一个 feign.Decoder、一个 feign.Encoder 和一个 feign.Contract。通过使用 FeignClient 注解的 contextId 属性可以重写该集合的名称。
Spring Cloud 让你通过使用 FeignClient 来声明额外的配置在 FeignClientsConfiguration 之上来完全控制 feign 客户端。例子
FeignClient(name stores, configuration FooConfiguration.class)
public interface StoreClient {//..
}在这种情况下client 由 FeignClientsConfiguration 中已有的组件和 FooConfiguration 中的任何组件组成后者将覆盖前者。 FooConfiguration 不需要用 Configuration 来注解。然而如果它是那么请注意将它从任何 ComponentScan 中排除否则会包括这个配置因为它将成为 feign.Decoder、feign.Encoder、feign.Contract 等的默认来源。这可以通过把它放在与任何 ComponentScan 或 SpringBootApplication 单独的、不重叠的包中来避免或者在 ComponentScan 中明确排除它。 使用 FeignClient 注解的 contextId 属性除了改变 ApplicationContext 集合的名称外它还将覆盖客户端名称的别名它将被用作为该客户端创建的配置Bean名称的一部分。 以前使用 url 属性不需要使用 name 属性。现在使用 name 是必须的。
在 name 和 url 属性中支持占位符。
FeignClient(name ${feign.name}, url ${feign.url})
public interface StoreClient {//..
}Spring Cloud OpenFeign 默认为 feign 提供了以下 bean 类BeanType beanName: ClassName
Decoder feignDecoder: ResponseEntityDecoder (它封装了一个 SpringDecoder)Encoder feignEncoder: SpringEncoderLogger feignLogger: Slf4jLoggerMicrometerObservationCapability micrometerObservationCapability: 如果 feign-micrometer 在 classpath 并且 ObservationRegistry 是可用的MicrometerCapability micrometerCapability: 如果 feign-micrometer 在 classpath MeterRegistry 可用并且 ObservationRegistry 不可用CachingCapability cachingCapability: 如果使用了 EnableCaching 注解可以通过 spring.cloud.openfeign.cache.enabled 来禁用。Contract feignContract: SpringMvcContractFeign.Builder feignBuilder: FeignCircuitBreaker.BuilderClient feignClient: 如果 Spring Cloud LoadBalancer 在 classpath 上就会使用 FeignBlockingLoadBalancerClient。如果它们都不在 classpath 上则使用默认的 feign 客户端。 spring-cloud-starter-openfeign 支持 spring-cloud-starter-loadbalancer。然而由于它是一个可选的依赖项如果你想使用它你需要确保它已经被添加到你的项目中。
通过将 spring.cloud.openfeign.okhttp.enabled 或 spring.cloud.openfeign.httpclient.hc5.enabled 分别设置为 true 并将其放在 classpath 上就可以使用 OkHttpClient 和 Apache HttpClient 5 Feign 客户端。当使用 Apache HC5 时你可以通过提供 org.apache.hc.client5.http.impl.classic.CloseableHttpClient 的 bean 来自定义使用的 HTTP 客户端。
你可以通过在 spring.cloud.openfeign.httpclient.xxx 属性中设置值进一步定制http客户端。仅以 httpclient 为前缀的属性将适用于所有客户端以 httpclient.hc5 为前缀的属性适用于 Apache HttpClient 5以 httpclient.okhttp 为前缀的属性适用于 OkHttpClient。你可以在附录中找到你可以定制的属性的完整列表。 从Spring Cloud OpenFeign 4开始Feign Apache HttpClient 4不再被支持。我们建议使用Apache HttpClient 5代替。
Spring Cloud OpenFeign 默认不为 feign 提供以下Bean但仍然从 application context 查找这些类型的 Bean 来创建 feign 客户端
Logger.LevelRetryerErrorDecoderRequest.OptionsCollectionRequestInterceptorSetterFactoryQueryMapEncoderCapability (MicrometerObservationCapability 和 CachingCapability 默认提供) 默认情况下会创建一个 Retryer.NEVER_RETRY 类型的 Retryer bean它将禁用重试。注意这个重试行为与 Feign 的默认行为不同它将自动重试 IOExceptions将其视为瞬时网络相关的异常以及从 ErrorDecoder 抛出的任何 RetryableException。
创建这些类型中的一个bean并将其放置在 FeignClient 配置中如上面的 FooConfiguration允许你覆盖所述的每一个 bean。例子
Configuration
public class FooConfiguration {Beanpublic Contract feignContract() {return new feign.Contract.Default();}Beanpublic BasicAuthRequestInterceptor basicAuthRequestInterceptor() {return new BasicAuthRequestInterceptor(user, password);}
}这就用 feign.Contract.Default 替换了 SpringMvcContract并在 RequestInterceptor 的集合中添加了一个 RequestInterceptor。
FeignClient 也可以使用配置属性进行配置。
application.yml
spring:cloud:openfeign:client:config:feignName:url: http://remote-service.comconnectTimeout: 5000readTimeout: 5000loggerLevel: fullerrorDecoder: com.example.SimpleErrorDecoderretryer: com.example.SimpleRetryerdefaultQueryParameters:query: queryValuedefaultRequestHeaders:header: headerValuerequestInterceptors:- com.example.FooRequestInterceptor- com.example.BarRequestInterceptorresponseInterceptor: com.example.BazResponseInterceptordismiss404: falseencoder: com.example.SimpleEncoderdecoder: com.example.SimpleDecodercontract: com.example.SimpleContractcapabilities:- com.example.FooCapability- com.example.BarCapabilityqueryMapEncoder: com.example.SimpleQueryMapEncodermicrometer.enabled: false
本例中的 feignName 指的是 FeignClient value它也被别名为 FeignClient name 和 FeignClient contextId。在负载均衡的情况下它也对应于将被用来检索实例的服务器应用程序的 serviceId。
默认配置可以在 EnableFeignClients 属性 defaultConfiguration 中指定其方式与上面描述的类似。不同的是这个配置将适用于所有 feign 客户端。
如果你喜欢用配置属性来配置所有的 FeignClient你可以用 default feign name 创建配置属性。
你可以使用 spring.cloud.openfeign.client.config.feignName.defaultQueryParameters 和 spring.cloud.openfeign.client.config.feignName.defaultRequestHeaders 来指定查询参数和 header 信息它们将与名为 feignName 的客户端的每个请求一起发送。
application.yml
spring:cloud:openfeign:client:config:default:connectTimeout: 5000readTimeout: 5000loggerLevel: basic
如果我们同时创建 Configuration bean和配置属性配置属性将获胜。它将覆盖 Configuration 的值。但如果你想改变 Configuration 的优先级你可以将 spring.cloud.openfeign.client.default-to-properties 改为 false。
如果我们想创建多个具有相同名称或网址的feign客户端使它们指向同一台服务器但每个都有不同的自定义配置那么我们必须使用 FeignClient 的 contextId 属性以避免这些配置 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。你可以通过重写 FeignClientConfigurer Bean中的 inheritParentConfiguration() 来做到这一点返回 false
Configuration
public class CustomConfiguration{Bean
public FeignClientConfigurer feignClientConfigurer() {return new FeignClientConfigurer() {Overridepublic boolean inheritParentConfiguration() {return false;}};}
}默认情况下Feign 客户端不对斜线 / 字符进行编码。你可以通过将 spring.cloud.openfeign.client.decodeSlash 的值设置为 false 来改变这种行为。
1.2.1.SpringEncoder配置
在我们提供的 SpringEncoder 中我们为二进制内容类型设置 null 字符集为所有其他类型设置 UTF-8。
你可以通过将 spring.cloud.openfeign.encoder.charset-from-content-type 的值设置为 true 来修改此行为以便从 Content-Type 头的字符推导出字符集。
1.3. 超时处理
我们可以在默认客户端和命名客户端上配置超时。OpenFeign 使用两个超时参数
connectTimeout 防止因服务器处理时间过长而阻塞调用者。readTimeout 从连接建立时开始应用当返回响应的时间过长时就会被触发。 如果服务器没有运行或可用则数据包会导致连接被拒绝。通信以错误信息或 fallback 的方式结束。如果 connectTimeout 设置得很低这可能在它之前发生。执行查找和接收这种数据包所需的时间导致了这一延迟的重要部分。它可能根据涉及DNS查询的远程主机而改变。
1.4. 手动创建 Feign Client
在某些情况下可能需要对你的 Feign 客户进行定制而使用上述方法是不可能的。在这种情况下你可以使用 Feign Builder API 来创建客户端。下面是一个例子它创建了两个具有相同接口的 Feign 客户端但每个客户端都配置了一个单独的请求拦截器request interceptor。
Import(FeignClientsConfiguration.class)
class FooController {private FooClient fooClient;private FooClient adminClient;Autowiredpublic FooController(Client client, Encoder encoder, Decoder decoder, Contract contract, MicrometerObservationCapability micrometerObservationCapability) {this.fooClient Feign.builder().client(client).encoder(encoder).decoder(decoder).contract(contract).addCapability(micrometerObservationCapability).requestInterceptor(new BasicAuthRequestInterceptor(user, user)).target(FooClient.class, https://PROD-SVC);this.adminClient Feign.builder().client(client).encoder(encoder).decoder(decoder).contract(contract).addCapability(micrometerObservationCapability).requestInterceptor(new BasicAuthRequestInterceptor(admin, admin)).target(FooClient.class, https://PROD-SVC);}
}在上面的例子中FeignClientsConfiguration.class 是由Spring Cloud OpenFeign 提供的默认配置。 PROD-SVC 是客户端将向其发出请求的服务的名称。 Feign Contract 对象定义了哪些注解和值对接口有效。自动注入的 Contract Bean 提供了对SpringMVC 注解的支持而不是默认的 Feign 原生注解。
你也可以使用 Builder 来配置 FeignClient使其不从父级上下文中继承bean。你可以通过覆盖调用 Builder 的 inheritParentContext(false) 来做到这一点。
1.5. Feign Spring Cloud CircuitBreaker 的支持
如果 Spring Cloud CircuitBreaker 在 classpath 上并且 spring.cloud.openfeign.circuitbreaker.enabledtrueFeign 将用 circuit breaker 来包装所有方法。
为了在每个客户端的基础上禁用 Spring Cloud CircuitBreaker 的支持创建一个具有 prototype scope 的 vanilla Feign.Builder例如
Configuration
public class FooConfiguration {BeanScope(prototype)public Feign.Builder feignBuilder() {return Feign.builder();}
}circuit breaker 的名称遵循这种模式 feignClientClassName#calledMethod(parameterTypes)。当调用一个带有 FooClient 接口的 FeignClient并且被调用的接口方法 bar 没有参数那么 circuit breaker 的名称将是 FooClient#bar()。 从2020.0.2开始circuit breaker 名称模式已经从 feignClientName_calledMethod 改变。使用2020.0.4中引入的 CircuitBreakerNameResolvercircuit breaker 名称可以保留旧模式。
提供一个 CircuitBreakerNameResolver 的bean你可以改变 circuit breaker 名称模式。
Configuration
public class FooConfiguration {Beanpublic CircuitBreakerNameResolver circuitBreakerNameResolver() {return (String feignClientName, Target? target, Method method) - feignClientName _ method.getName();}
}要启用 Spring Cloud CircuitBreaker group请将 spring.cloud.openfeign.circuitbreaker.group.enabled 属性设置为 true默认为 false。
1.6. 使用配置属性配置 CircuitBreaker
你可以通过配置属性来配置 CircuitBreaker。
例如如果你有这个 Feign 客户端
FeignClient(url http://localhost:8080)
public interface DemoClient {GetMapping(demo)String getDemo();
}你可以通过以下方式使用配置属性来配置它
spring:cloud:openfeign:circuitbreaker:enabled: truealphanumeric-ids:enabled: true
resilience4j:circuitbreaker:instances:DemoClientgetDemo:minimumNumberOfCalls: 69timelimiter:instances:DemoClientgetDemo:timeoutDuration: 10s 如果你想切换回 Spring Cloud 2022.0.0 之前使用的 circuit breaker name你可以将 spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled 设置为 false。
1.7. Feign Spring Cloud CircuitBreaker Fallback
Spring Cloud CircuitBreaker 支持 fallback 的概念一个默认的代码路径在 circuit 打开或出现错误时执行。要为一个给定的 FeignClient 启用 fallback将 fallback 属性设置为实现 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();}Componentstatic class Fallback implements TestClient {Overridepublic Hello getHello() {throw new NoFallbackAvailableException(Boom!, new RuntimeException());}Overridepublic String getException() {return Fixed response;}}如果需要访问使 fallback 触发的原因可以使用 FeignClient 里面的 fallbackFactory 属性。
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();}Componentstatic class TestFallbackFactory implements FallbackFactoryFallbackWithFactory {Overridepublic FallbackWithFactory create(Throwable cause) {return new FallbackWithFactory();}}static class FallbackWithFactory implements TestClientWithFactory {Overridepublic Hello getHello() {throw new NoFallbackAvailableException(Boom!, new RuntimeException());}Overridepublic String getException() {return Fixed response;}}1.8. Feign 和Primary
当使用 Feign 与 Spring Cloud CircuitBreaker fallback 时ApplicationContext 中存在多个相同类型的Bean。这将导致 Autowired 不起作用因为没有确切的一个 bean或一个被标记为 primary 的 bean。为了解决这个问题Spring Cloud OpenFeign 将所有Feign实例标记为 Primary因此 Spring Framework 将知道要注入哪个Bean。在某些情况下这可能是不可取的。要关闭这种行为请将 FeignClient 的 primary 属性设置为 false。
FeignClient(name hello, primary false)
public interface HelloClient {// methods here
}1.9. Feign 继承的支持
Feign 通过单继承接口支持模板式的api。这允许将常见的操作分组到方便的基础接口中。
UserService.java
public interface UserService {RequestMapping(method RequestMethod.GET, value /users/{id})User getUser(PathVariable(id) long id);
}UserResource.java
RestController
public class UserResource implements UserService {}UserClient.java
package project.user;FeignClient(users)
public interface UserClient extends UserService {}FeignClient 接口不应该在服务器和客户端之间共享并且不再支持在类级别上用 RequestMapping 注解 FeignClient 接口。
1.10. Feign request/response 压缩
你可以考虑为你的 Feign 请求启用请求或响应的GZIP压缩。你可以通过启用其中一个属性来做到这一点
spring.cloud.openfeign.compression.request.enabledtrue
spring.cloud.openfeign.compression.response.enabledtrueFeign 请求压缩给你的设置与你可能为你的Web服务器设置的类似
spring.cloud.openfeign.compression.request.enabledtrue
spring.cloud.openfeign.compression.request.mime-typestext/xml,application/xml,application/json
spring.cloud.openfeign.compression.request.min-request-size2048这些属性允许你对压缩媒体类型和最小请求阈值长度进行选择。 由于 OkHttpClient 使用 transparent透明 压缩即在存在 content-encoding 或 accept-encoding 头的情况下禁用所以当 feign.okhttp.OkHttpClient 出现在 classpath 上并且 spring.cloud.openfeign.okhttp.enabled 被设置为 true 时我们不会启用压缩。
1.11. Feign 日志
每个创建的 Feign 客户端都会创建一个logger。默认情况下logger 的名字是用于创建Feign客户端的接口的全类名称。Feign 的日志只响应 DEBUG 级别。
application.yml
logging.level.project.user.UserClient: DEBUG
你可以为每个客户端配置 Logger.Level 对象告诉 Feign 要记录多少内容。选择是
NONE, 没日志默认。BASIC, 只记录请求方法和URL以及响应状态代码和执行时间。HEADERS, 记录基本信息以及请求和响应头。FULL, 记录请求和响应的header、正文和元数据。
例如下面将设置 Logger.Level 为 FULL
Configuration
public class FooConfiguration {BeanLogger.Level feignLoggerLevel() {return Logger.Level.FULL;}
}1.12. Feign Capability 的支持
Feign Capability 暴露了Feign的核心组件因此这些组件可以被修改。例如这些功能可以接受客户端对其进行装饰并将装饰后的实例反馈给 Feign。对 Micrometer 的支持就是一个很好的现实生活中的例子。参见 [micrometer-support]。
创建一个或多个 Capability Bean并将其置于 FeignClient 配置中可以让你注册它们并修改相关客户端的行为。
Configuration
public class FooConfiguration {BeanCapability customCapability() {return new CustomCapability();}
}1.13. Micrometer 的支持
如果以下所有条件为 true就会创建并注册一个 MicrometerObservationCapability Bean这样你的 Feign 客户端就可以被 Micrometer 观察到
feign-micrometer 在 classpath 上。ObservationRegistry bean 可用。feign micrometer 属性设置为 true 默认 spring.cloud.openfeign.micrometer.enabledtrue (针对所有客户)spring.cloud.openfeign.client.config.feignName.micrometer.enabledtrue (针对单个客户端) 如果你的应用程序已经使用了 Micrometer启用这个功能就像把 feign-micrometer 放到你的classpath上一样简单。
你也可以通过以下两种方式禁用该功能
从你的 classpath 中排除 feign-micrometer。将 feign micrometer 一个属性设置为 false spring.cloud.openfeign.micrometer.enabledfalsespring.cloud.openfeign.client.config.feignName.micrometer.enabledfalse spring.cloud.openfeign.micrometer.enabledfalse 禁用所有 Feign 客户端的 Micrometer 支持而不考虑客户端级标志的值spring.cloud.openfeign.client.config.feignName.micrometer.enabled。如果你想启用或禁用每个客户端的 Micrometer 支持不要设置 spring.cloud.openfeign.micrometer.enabled 并使用 spring.cloud.openfeign.client.config.feignName.micrometer.enabled。
你也可以通过注册你自己的bean来自定义 MicrometerObservationCapability
Configuration
public class FooConfiguration {Beanpublic MicrometerObservationCapability micrometerObservationCapability(ObservationRegistry registry) {return new MicrometerObservationCapability(registry);}
}仍然可以在 Feign 中使用 MicrometerCapability仅支持指标你需要禁用 Micrometer 支持spring.cloud.openfeign.micrometer.enabledfalse并创建一个 MicrometerCapability Bean
Configuration
public class FooConfiguration {Beanpublic MicrometerCapability micrometerCapability(MeterRegistry meterRegistry) {return new MicrometerCapability(meterRegistry);}
}1.14. Feign 缓存
如果使用了 EnableCaching 注解就会创建并注册一个 CachingCapability Bean这样你的 Feign 客户端就能识别其接口上的 Cache* 注解
public interface DemoClient {GetMapping(/demo/{filterParam})Cacheable(cacheNames demo-cache, key #keyParam)String demoEndpoint(String keyParam, PathVariable String filterParam);
}你也可以通过属性 spring.cloud.openfeign.cache.enabledfalse 来禁用该功能。
1.15. Feign QueryMap 的支持
Spring Cloud OpenFeign 提供了一个等价的 SpringQueryMap 注解用于将POJO或Map参数注解为查询参数map。
例如Params 类定义了参数 param1 和 param2
// Params.java
public class Params {private String param1;private String param2;// [Getters and setters omitted for brevity]
}下面的 feign 客户端通过使用 SpringQueryMap 注解来使用 Params 类
FeignClient(demo)
public interface DemoTemplate {GetMapping(path /demo)String demoEndpoint(SpringQueryMap Params params);
}如果你需要对生成的查询参数 Map 有更多控制你可以实现一个自定义的 QueryMapEncoder Bean。
1.16. HATEOAS 的支持
Spring提供了一些API来创建遵循 HATEOAS 原则的REST表示 Spring Hateoas 和 Spring Data REST。
如果你的项目使用 org.springframework.boot:spring-boot-starter-hateoas starter 或 org.springframework.boot:spring-boot-starter-data-rest starterFeign HATEOAS 支持被默认启用。
当HATEOAS支持被启用时Feign 客户端被允许序列化和反序列化 HATEOAS 表示模型 EntityModel、 CollectionModel 和 PagedModel.。
FeignClient(demo)
public interface DemoTemplate {GetMapping(path /stores)CollectionModelStore getStores();
}1.17. Spring MatrixVariable 的支持
Spring Cloud OpenFeign提供对Spring MatrixVariable 注解的支持。
如果一个 map 被作为方法参数传递MatrixVariable path 段是通过用 连接 map 中的键值对而创建的。
如果传递了一个不同的对象那么在 MatrixVariable 注解中提供的 name如果定义了的话或者注解的变量名称将使用 与提供的方法参数结合起来。
IMPORTANT
尽管在服务器端Spring 并不要求用户将路径段占位符的名称与 matrix variable 的名称相同因为这在客户端太模糊了Spring Cloud OpenFeign要求你添加一个路径段占位符其名称要与 MatrixVariable 注解如果定义了中提供的 name 或注解的变量名称相符。
例如
GetMapping(/objects/links/{matrixVars})
MapString, ListString getObjects(MatrixVariable MapString, ListString matrixVars);注意变量名和 path 段占位符都被称为 matrixVars。
FeignClient(demo)
public interface DemoTemplate {GetMapping(path /stores)CollectionModelStore getStores();
}1.18. FeignCollectionFormat的支持
我们通过提供 CollectionFormat 注解来支持 feign.CollectionFormat。你可以通过传递所需的 feign.CollectionFormat 作为注解值用它来注解一个 Feign 客户端方法或整个类来影响所有方法。
在下面的例子中使用 CSV 格式而不是默认的 EXPLODED 来处理这个方法。
FeignClient(name demo)
protected interface DemoFeignClient {CollectionFormat(feign.CollectionFormat.CSV)GetMapping(path /test)ResponseEntity performRequest(String test);}1.19. 响应式的支持
由于 OpenFeign项目 目前不支持响应式客户端如 Spring WebClientSpring Cloud OpenFeign也不支持。一旦核心项目中可用我们将在这里添加对它的支持。
在这之前我们建议使用 feign-reactive 来支持 Spring WebClient。
1.19.1. 早期的初始化错误
根据你使用 Feign 客户端的方式你可能会在启动你的应用程序时看到初始化错误。为了解决这个问题你可以在自动连接客户端时使用一个 ObjectProvider。
Autowired
ObjectProviderTestFeignClient testFeignClient;1.20. Spring Data 的支持
如果 Jackson Databind 和 Spring Data Commons 在classpath上org.springframework.data.domain.Page 和 org.springframework.data.domain.Sort 的 converter 将被自动添加。
要禁用这种行为请设置
spring.cloud.openfeign.autoconfiguration.jackson.enabledfalse详见 org.springframework.cloud.openfeign.FeignAutoConfiguration.FeignJacksonConfiguration。
1.21. SpringRefreshScope的支持
如果启用了Feign客户端刷新每个Feign客户端的创建都有
feign.Request.Options 作为一个 refresh scope 的bean。这意味着诸如 connectTimeout 和 readTimeout 等属性可以针对任何Feign客户端实例进行刷新。在 org.springframework.cloud.openfeign.RefreshableUrl 下包装的url。这意味着如果用 spring.cloud.openfeign.client.config.{feignName}.url 属性定义 Feign 客户端的URL可以针对任何 Feign 客户端实例进行刷新。
你可以通过 POST /actuator/refresh 刷新这些属性。
默认情况下Feign 客户端的刷新行为是禁用的。使用以下属性来启用刷新行为
spring.cloud.openfeign.client.refresh-enabledtrue不要用 RefreshScope 注解来注解 FeignClient 接口。
1.22. OAuth2 的支持
可以通过设置以下标志启用OAuth2支持
spring.cloud.openfeign.oauth2.enabledtrue
当该标志被设置为 true且oauth2客户端 context resource detail 存在时就会创建一个 OAuth2AccessTokenInterceptor 类的 bean。在每次请求之前拦截器都会解析所需的访问令牌并将其作为一个header。OAuth2AccessTokenInterceptor 使用 OAuth2AuthorizedClientManager 来获取持有 OAuth2AccessToken 的 OAuth2AuthorizedClient。如果用户使用 spring.cloud.openfeign.oauth2.clientRegistrationId 属性指定了一个 OAuth2 clientRegistrationId它将被用来检索令牌。如果没有检索到令牌或没有指定 clientRegistrationId将使用从 url host 段检索的 serviceId。
TIP
使用 serviceId 作为 OAuth2 客户端的 registrationId 对于负载均衡的Feign客户端是很方便的。对于非负载均衡的客户端基于属性的 clientRegistrationId 是一个合适的方法。
TIP
如果你不想使用 OAuth2AuthorizedClientManager 的默认设置你可以直接在你的配置中实例化一个这种类型的bean。
1.23. 转换负载均衡的HTTP请求
你可以使用选定的 ServiceInstance 来转换负载均衡的HTTP请求。
对于 Request你需要实现和定义 LoadBalancerFeignRequestTransformer如下所示
Bean
public LoadBalancerFeignRequestTransformer transformer() {return new LoadBalancerFeignRequestTransformer() {Overridepublic Request transformRequest(Request request, ServiceInstance instance) {MapString, CollectionString headers new HashMap(request.headers());headers.put(X-ServiceId, Collections.singletonList(instance.getServiceId()));headers.put(X-InstanceId, Collections.singletonList(instance.getInstanceId()));return Request.create(request.httpMethod(), request.url(), headers, request.body(), request.charset(),request.requestTemplate());}};
}如果定义了多个转化器它们将按照 Bean 定义的顺序来应用。另外你可以使用 LoadBalancerFeignRequestTransformer.DEFAULT_ORDER 来指定这个顺序。
1.24. X-Forwarded Headers 的支持
X-Forwarded-Host 和 X-Forwarded-Proto 支持可以通过设置以下标志启用
spring.cloud.loadbalancer.x-forwarded.enabledtrue
1.25. 支持向 Feign 客户端提供URL的方法
你可以通过以下任何一种方式向Feign客户端提供一个URL 场景 例子 细节 URL是在 FeignClient 注解中提供的。 FeignClient(nametestClient, urlhttp://localhost:8081) URL是从注解的 url 属性中解析出来的没有负载均衡。 URL是在 FeignClient 注解和配置属性中提供的。 FeignClient(nametestClient, urlhttp://localhost:8081) 和定义在 application.yml 中的属性 spring.cloud.openfeign.client.config.testClient.urlhttp://localhost:8081 URL是从注解的 url 属性中解析出来的没有负载均衡。在配置属性中提供的URL仍未使用。 URL没有在 FeignClient 注解中提供而是在配置属性中提供。 FeignClient(nametestClient) 和定义在 application.yml 中的属性 spring.cloud.openfeign.client.config.testClient.urlhttp://localhost:8081 URL 从配置属性中解析没有负载均衡。如果 spring.cloud.openfeign.client.refresh-enabledtrue那么配置属性中定义的 URL 可以被刷新如 Spring RefreshScope 的支持 中所述。 在 FeignClient 注解中和配置属性中都没有提供这个URL。 FeignClient(nametestClient) URL是从注解的 name 属性中解析出来的具有负载均衡性。
1.26. AOT 和原生镜像的支持
Spring Cloud OpenFeign 支持 Spring AOT 转换和原生镜像但是只有在禁用刷新模式、禁用Feign客户端刷新默认设置和禁用 延迟的 FeignClient 属性解析默认设置的情况下才能支持。 如果你想在AOT或原生镜像模式下运行 Spring Cloud OpenFeign 客户端请确保将 spring.cloud.refresh.enabled 设置为 false。 如果你想在AOT或原生镜像模式下运行 Spring Cloud OpenFeign 客户端请确保 spring.cloud.openfeign.client.refresh-enabled 没有被设置为 true。 如果你想在AOT或原生镜像模式下运行Spring Cloud OpenFeign客户端请确保 spring.cloud.openfeign.lazy-attributes-resolution 没有被设置为 true。 然而如果你通过属性设置了 url 值那么通过运行带有 -Dspring.cloud.openfeign.client.config.[clientId].url[url] 标志的镜像就有可能覆盖 FeignClient 的 url 值。为了实现覆盖在构建时也必须通过属性而不是 FeignClient 属性来设置一个 url 值。
2. 配置属性
各种属性可以在 application.properties 文件、application.yml 文件中指定也可以作为命令行开关。本附录提供了一个常见的 Spring Cloud OpenFeign 属性列表以及对消费这些属性的底层类的引用。
属性贡献可以来自你classpath上的其他jar文件所以你不应该认为这是一个详尽的列表。另外你可以定义你自己的属性。
NameDefaultDescription spring.cloud.openfeign.autoconfiguration.jackson.enabled false If true, PageJacksonModule and SortJacksonModule bean will be provided for Jackson page decoding. spring.cloud.openfeign.circuitbreaker.enabled false If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker. spring.cloud.openfeign.circuitbreaker.group.enabled false If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker with with group. spring.cloud.openfeign.client.config spring.cloud.openfeign.client.decode-slash true Feign clients do not encode slash / characters by default. To change this behavior, set the decodeSlash to false. spring.cloud.openfeign.client.default-config default spring.cloud.openfeign.client.default-to-properties true spring.cloud.openfeign.client.refresh-enabled false Enables options value refresh capability for Feign. spring.cloud.openfeign.compression.request.enabled false Enables the request sent by Feign to be compressed. spring.cloud.openfeign.compression.request.mime-types [text/xml, application/xml, application/json] The list of supported mime types. spring.cloud.openfeign.compression.request.min-request-size 2048 The minimum threshold content size. spring.cloud.openfeign.compression.response.enabled false Enables the response from Feign to be compressed. spring.cloud.openfeign.encoder.charset-from-content-type false Indicates whether the charset should be derived from the {code Content-Type} header. 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 Enables the use of the Apache HTTP Client by Feign. spring.cloud.openfeign.httpclient.follow-redirects true spring.cloud.openfeign.httpclient.hc5.enabled false Enables the use of the Apache HTTP Client 5 by Feign. 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 Default value for socket timeout. spring.cloud.openfeign.httpclient.hc5.socket-timeout-unit Default value for socket timeout unit. spring.cloud.openfeign.httpclient.max-connections 200 spring.cloud.openfeign.httpclient.max-connections-per-route 50 spring.cloud.openfeign.httpclient.ok-http.read-timeout 60s {link OkHttpClient} read timeout; defaults to 60 seconds. spring.cloud.openfeign.httpclient.time-to-live 900 spring.cloud.openfeign.httpclient.time-to-live-unit spring.cloud.openfeign.micrometer.enabled true Enables Micrometer capabilities for Feign. spring.cloud.openfeign.oauth2.enabled false Enables feign interceptor for managing oauth2 access token. spring.cloud.openfeign.oauth2.load-balanced false Enables load balancing for oauth2 access token provider. spring.cloud.openfeign.okhttp.enabled false Enables the use of the OK HTTP Client by Feign.
