Spring Cloud OpenFeign 中文手册 菜鸡翻译

}

Spring Cloud OpenFeign默认为假装提供以下bean（BeanTypebeanName ：）ClassName：

• DecoderfeignDecoder ：（ResponseEntityDecoder包含SpringDecoder）

• Encoder feignEncoder： SpringEncoder

• Logger feignLogger： Slf4jLogger

• Contract feignContract： SpringMvcContract

• Feign.Builder feignBuilder： HystrixFeign.Builder

• ClientfeignClient：如果Ribbon在类路径中且已启用，则为LoadBalancerFeignClient，否则，如果Spring Cloud LoadBalancer在类路径中，FeignBlockingLoadBalancerClient则使用。如果它们都不在类路径中，则使用默认的客户端。

spring-cloud-starter-openfeign同时支持spring-cloud-starter-netflix-ribbon和spring-cloud-starter-loadbalancer。但是，由于它们是可选的依赖项，因此需要确保将要使用的依赖项添加到项目中。

OkHttpClient和ApacheHttpClient客户端可以通过设置一起使用feign.okhttp.enabled或feign.httpclient.enabled以true分别，以及具有它们的类路径上。您可以通过org.apache.http.impl.client.CloseableHttpClient在使用Apache或okhttp3.OkHttpClient使用OK HTTP时提供Bean来定制所使用的HTTP客户端。

默认情况下，Spring Cloud OpenFeign_不会_为Feign提供以下bean，但仍会从应用程序上下文中查找这些类型的bean以创建Feign客户端：

• Logger.Level

• Retryer

• ErrorDecoder

• Request.Options

• Collection<RequestInterceptor>

• SetterFactory

• QueryMapEncoder

默认情况下会创建Retryer.NEVER_RETRY具有类型的Bean Retryer，这将禁用重试。请注意，此重试行为不同于Feign的默认行为，在Feign默认行为中，它将自动重试IOException，将它们视为与网络临时相关的异常，以及从ErrorDecoder抛出的任何RetryableException。

创建这些类型之一的bean并将其放置在@FeignClient配置中（例如FooConfiguration上述配置），您可以覆盖所描述的每个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

requestInterceptors:

• com.example.FooRequestInterceptor

• com.example.BarRequestInterceptor

decode404: false

encoder: com.example.SimpleEncoder

decoder: com.example.SimpleDecoder

contract: com.example.SimpleContract

可以按照与上述类似的方式在@EnableFeignClients属性defaultConfiguration中指定默认配置。不同之处在于此配置将适用于_所有_客户端。

如果您希望使用配置属性来配置所有 @FeignClient，则可以使用default假名创建配置属性。

application.yml

feign:

client:

config:

default:

connectTimeout: 5000

readTimeout: 5000

loggerLevel: basic

如果我们同时创建@Configurationbean和配置属性，则配置属性将获胜。它将覆盖@Configuration值。但是，如果要将优先级更改为@Configuration，则可以更改feign.client.default-to-properties为false。

如果需要ThreadLocal在您的系统中使用绑定变量，RequestInterceptors you will need to either set the thread isolation strategy for Hystrix to SEMAPHORE或者在Feign中禁用Hystrix。

application.yml

To disable Hystrix in Feign

feign:

hystrix:

enabled: false

To set thread isolation to SEMAPHORE

hystrix:

command:

default:

execution:

isolation:

strategy: SEMAPHORE

如果我们要创建多个具有相同名称或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 bean来回报false：

@Configuration

public class CustomConfiguration{

@Bean

public FeignClientConfigurer feignClientConfigurer() {

return new FeignClientConfigurer() {

@Override

public boolean inheritParentConfiguration() {

return false;

}

};

}

}

1.3 手动创建Feign

在某些情况下，可能有必要使用上述方法无法实现的方式自定义Feign客户。在这种情况下，您可以使用Feign Builder API创建客户端 。下面是一个示例，该示例创建具有相同接口的两个Feign Client，但为每个Feign Client配置一个单独的请求拦截器。

@Import(FeignClientsConfiguration.class)

class FooController {

private FooClient fooClient;

private FooClient adminClient;

@Autowired

public FooController(Decoder decoder, Encoder encoder, Client client, Contract contract) {

this.fooClient = Feign.builder().client(client)

.encoder(encoder)

.decoder(decoder)

.contract(contract)

.requestInterceptor(new BasicAuthRequestInterceptor(“user”, “user”))

.target(FooClient.class, “https://PROD-SVC”);

this.adminClient = Feign.builder().client(client)

.encoder(encoder)

.decoder(decoder)

.contract(contract)

.requestInterceptor(new BasicAuthRequestInterceptor(“admin”, “admin”))

.target(FooClient.class, “https://PROD-SVC”);

}

}

在上面的示例中，FeignClientsConfiguration.class是Spring Cloud OpenFeign提供的默认配置。

PROD-SVC 是客户将向其请求的服务的名称。

FeignContract对象定义在接口上有效的注释和值。自动装配的Contractbean提供对SpringMVC注释的支持，而不是默认的Feign本机注释。

您也可以在Builderto configure FeignClient not to inherit beans from the parent context. You can do this by overriding calling inheritParentContext(false)上使用Builder。

1.4 Feign Hystrix支持

如果Hystrix在classpath和上feign.hystrix.enabled=true，Feign将使用断路器包装所有方法。com.netflix.hystrix.HystrixCommand还可以返回 。这允许您使用反应模式（与以打电话.toObservable()或.observe()或异步使用（通过调用.queue()）。

要基于每个客户端禁用Hystrix支持，请创建Feign.Builder具有“原型”范围的香草，例如：

@Configuration

public class FooConfiguration {

@Bean

@Scope(“prototype”)

public Feign.Builder feignBuilder() {

return Feign.builder();

}

}

在Spring Cloud Dalston发行之前，如果Hystrix在类路径中，Feign默认会将所有方法包装在断路器中。Spring Cloud Dalston中更改了此默认行为，以支持选择加入方法。

1.5 Feign Hystrix Fallbacks

Hystrix支持回退的概念：当它们的电路断开或出现错误时执行的默认代码路径。要为给定@FeignClient集启用后备，该fallback属性应为实现后备的类名称。您还需要将实现声明为Spring bean。

@FeignClient(name = “hello”, fallback = HystrixClientFallback.class)

protected interface HystrixClient {

@RequestMapping(method = RequestMethod.GET, value = “/hello”)

Hello iFailSometimes();

}

static class HystrixClientFallback implements HystrixClient {

@Override

public Hello iFailSometimes() {

return new Hello(“fallback”);

}

}

如果需要访问引起后备触发器的原因，则可以使用fallbackFactory里面的属性@FeignClient。

@FeignClient(name = “hello”, fallbackFactory = HystrixClientFallbackFactory.class)

protected interface HystrixClient {

@RequestMapping(method = RequestMethod.GET, value = “/hello”)

Hello iFailSometimes();

}

@Component

static class HystrixClientFallbackFactory implements FallbackFactory {

@Override

public HystrixClient create(Throwable cause) {

return new HystrixClient() {

@Override

public Hello iFailSometimes() {

return new Hello("fallback; reason was: " + cause.getMessage());

}

};

}

}

Feign中的后备实现以及Hystrix后备如何工作存在局限性。返回com.netflix.hystrix.HystrixCommand和的方法目前不支持后备rx.Observable。

1.6 Feign @Primary

将Feign与Hystrix后备一起使用ApplicationContext时，同一类型的多个bean 。这将导致@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.7 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 {

}

通常不建议在服务器和客户端之间共享接口。它引入了紧密耦合，并且实际上也无法以当前形式与Spring MVC一起使用（方法参数映射不被继承）。

1.8 Feign请求/响应压缩

您可以考虑为您的Feign请求启用请求或响应GZIP压缩。您可以通过启用以下属性之一来做到这一点：

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以外的http客户端，可以启用默认的gzip解码器以UTF-8编码解码gzip响应：

feign.compression.response.enabled=true

feign.compression.response.useGzipDecoder=true

1.9 Feign日志

为每个创建的Feign客户端创建一个记录器。默认情况下，记录器的名称是用于创建Feign客户端的接口的全类名称。伪日志仅响应该DEBUG级别。

application.yml

logging.level.project.user.UserClient: DEBUG

Logger.Level您可以为每个客户端配置的对象告诉Feign要记录多少。选择是：

• NONE，不记录（DEFAULT）。

• BASIC，仅记录请求方法和URL以及响应状态代码和执行时间。

• HEADERS，记录基本信息以及请求和响应标头。

• FULL，记录请求和响应的标题，正文和元数据。

例如，以下将将设置Logger.Level为FULL：

@Configuration

public class FooConfiguration {

@Bean

Logger.Level feignLoggerLevel() {

return Logger.Level.FULL;

}

}

1.10 @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);

}

如果需要对生成的查询参数映射进行更多控制，则可以实现一个自定义QueryMapEncoderbean。

1.11 HATEOAS支持

跳过

1.12 Spring @MatrixVariable支持

Spring Cloud OpenFeign提供对Spring@MatrixVariable注释的支持。

如果将地图作为方法参数传递，则通过@MatrixVariable将地图中的键值对与相连来创建路径段=。

如果一个不同的对象被传递，无论是name在所提供的@MatrixVariable注释（如果定义）或注释的变量名接合用所提供的方法的参数使用=。

• 重要

即使在服务器端，Spring不需要用户将路径段占位符命名为与矩阵变量名称相同的名称，因为它在客户端上太含糊不清，Sprig Cloud OpenFeign要求您使用以下命令添加路径段占位符：name与@MatrixVariable注释（如果已定义）中提供的名称或带注释的变量名称匹配的名称。

例如：

@GetMapping(“/objects/links/{matrixVars}”)

Map<String, List> getObjects(@MatrixVariable Map<String, List> matrixVars);

请注意，变量名和路径段占位符都称为matrixVars。

@FeignClient(“demo”)

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以添加V获取：vip1024b （备注Java）

Java高频面试专题合集解析：

当然在这还有更多整理总结的Java进阶学习笔记和面试题未展示，其中囊括了Dubbo、Redis、Netty、zookeeper、Spring cloud、分布式、高并发等架构资料和完整的Java架构学习进阶导图！

更多Java架构进阶资料展示

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

…(img-Rg08680y-1712868732262)]
[外链图片转存中…(img-K81aCivE-1712868732262)]
[外链图片转存中…(img-nIg8nqSh-1712868732262)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以添加V获取：vip1024b （备注Java）
[外链图片转存中…(img-xDXTp1Na-1712868732263)]

Java高频面试专题合集解析：

[外链图片转存中…(img-XxZaCjtG-1712868732263)]

当然在这还有更多整理总结的Java进阶学习笔记和面试题未展示，其中囊括了Dubbo、Redis、Netty、zookeeper、Spring cloud、分布式、高并发等架构资料和完整的Java架构学习进阶导图！

[外链图片转存中…(img-3hqnlEo0-1712868732263)]

更多Java架构进阶资料展示

[外链图片转存中…(img-Ssrdu4yE-1712868732264)]

[外链图片转存中…(img-HS621Jpr-1712868732264)]

[外链图片转存中…(img-YdYMMiUF-1712868732266)]

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
[外链图片转存中…(img-VObrsW3h-1712868732266)]