Spring-Cloud-Feign-组成和配置

jiezi

5 年前

接口	作用	默认值
`Feign.Builder`	Feign 的入口	`Feign.Builder`
`Client`	Feign 底层用什么去请求	和 Ribbon 配合时：`LoadBalancerFeignClient` 不和 Ribbon 配合时：`Fgien.Client.Default`
`Contract`	契约，注解支持	`SpringMVCContract`
`Encoder`	解码器，用于将独享转换成 HTTP 请求消息体	`SpringEncoder`
`Decoder`	编码器，将相应消息体转成对象	`ResponseEntityDecoder`
`Logger`	日志管理器	`Slf4jLogger`
`RequestInterceptor`	用于为每个请求添加通用逻辑（拦截器，例子：比如想给每个请求都带上 heared）	无

日志级别	打印内容
NONE（默认）	不记录任何日志
BASIC	仅记录请求方法，URL，响应状态代码以及执行时间（适合生产环境）
HEADERS	记录 BASIC 级别的基础上，记录请求和响应的 header
FULL	记录请求和弦 ineader，body 和元数据

遵循 SpringBoot 的三板斧
第一步：加依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

第二步：写注解

@EnableFeignClients // 在启动类上加

第三步：写配置

方式一：代码实现
第一步：添加 Feign 配置类，可以添加在主类下，但是不用添加 @Configuration。如果添加了@Configuration 而且又放在了主类之下，那么就会所有 Feign 客户端实例共享，同 Ribbon 配置类一样父子上下文加载冲突；如果一定添加@Configuration，就放在主类加载之外的包。建议还是不用加@Configuration。

public class FeignConfig {
    @Bean
    public Logger.Level Logger() {return Logger.Level.FULL;}
}

第二步：给 @FeignClient 添加配置类

//@FeignClient configuration = GoodsFeignConfig.class 细粒度配置，指定配置类
@FeignClient(name = "goods", configuration = FeignConfig.class)

第四步：写配置

logging:
  level:
    com.xxx.xxx.FeignAPI: DEBUG #需要将 FeignClient 接口全路径写上# 开启日志 格式为 logging.level.+Feign 客户端路径

方式二：配置属性实现

feign:
  client:
    config:
      #想要调用的微服务名称
      server-1:
        loggerLevel: FULL

方式一：代码实现
添加了 @Configuration 放在了主类之下，那么就会所有 Feign 客户端实例共享，同 Ribbon 配置类一样父子上下文加载冲突；让父子上下文 ComponentScan 重叠（强烈不建议）
唯一正确方式

// 在启动类上为 @EnableFeignClients 注解添加 defaultConfiguration 配置
@EnableFeignClients(defaultConfiguration = FeignConfig.class)

方式二：配置属性实现

feign:
  client:
    config:
      #将调用的微服务名称改成 default 就配置成全局的了
      default:
        loggerLevel: FULL

配置项	作用
`Logger.Level`	指定日志级别
`Retryer`	指定重试策略
`ErrorDecoder`	指定错误解码器
`Request.Options`	超时时间
`Collection<RequestInterceptor>`	拦截器
`SetterFactory`	用于设置 Hystrix 的配置属性，Fgien 整合 Hystrix 才会用

feign:
  client:
    config:
      feignName:
        connectTimeout: 5000  # 相当于 Request.Optionsn 连接超时时间
        readTimeout: 5000     # 相当于 Request.Options 读取超时时间
        loggerLevel: full     # 配置 Feign 的日志级别，相当于代码配置方式中的 Logger
        errorDecoder: com.example.SimpleErrorDecoder  # Feign 的错误解码器，相当于代码配置方式中的 ErrorDecoder
        retryer: com.example.SimpleRetryer  # 配置重试，相当于代码配置方式中的 Retryer
        requestInterceptors: # 配置拦截器，相当于代码配置方式中的 RequestInterceptor
          - com.example.FooRequestInterceptor
          - com.example.BarRequestInterceptor
        # 是否对 404 错误解码
        decode404: false
        encode: com.example.SimpleEncoder
        decoder: com.example.SimpleDecoder
        contract: com.example.SimpleContract

Feign 还支持对请求和响应进行 GZIP 压缩，以提高通信效率，配置方式如下：

# 配置请求 GZIP 压缩
feign.compression.request.enabled=true
# 配置响应 GZIP 压缩
feign.compression.response.enabled=true
# 配置压缩支持的 MIME TYPE
feign.compression.request.mime-types=text/xml,application/xml,application/json
# 配置压缩数据大小的下限
feign.compression.request.min-request-size=2048

粒度	Ribbon	Feign
代码局部	`@RibbonClient(configuration=RibbonConfig.class)`，`RibbonConfig`类必须加`@Configuration`, 且必须放在父上下文无法扫到的包下	`@FeignClient(configuration=FeignConfig.class)`，`FeignConfig`类的 `@Configuration` 可以不加（可选），如果有，必须放在父上下文无法扫到的包下
代码全局	`@RibbonClients(defaultConfigurtion=RibbonConfig.class)`	`@EnableFeignClients(defaultConfiguration = FeignConfig.class)` …
配置属性局部	<clientName(服务名称)>.ribbon.NFLoadBalancerClassName …	feign.client.config.<clientName(服务名称)>.loggerLevel …
配置属性全局	无	feign.client.config.default.loggerLevel

配置方式	有点	缺点
代码配置	基于代码，更加灵活	如果 Feign 的配置类加了 `@Configuration` 注解，需注意父子上下文，线上修改需要重打包，发布
属性配置	易上手配置更加直观线上修改无需重新打包，发布优先级更高	极端场景下没有代码配置更加灵活

优先级：细粒度属性配置 > 细粒度代码配置 > 全局属性配置 > 全局代码配置

赵小胖个人博客

Spring-Cloud-Feign-组成和配置

Feign 的组成

Feign 的日记级别

首先如何整合 Feign

如何给 Feign 添加日志级别

细粒度

全局配置

Feign 支持的配置项

代码方式

配置属性

Ribbon 配置 VS Feign 配置

Feign 代码方式 VS 配置属性方式