微服务架构 | 负载均衡 - [OpenFeign]

简介

Feign ≈ RestTemplate + Ribbon
OpenFeign ≈ Feign + MVC支持
OpenFeign 通过接口，而非协议访问服务提供方
类似 Dubbo/JNDI 的方式，通过接口和注解，生成远端服务的代理对象进行访问

快速入门

依赖

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

配置

序列化
因为 OpenFeign加入了对 SpringMvc 的集成，因此可以通过对 MVC 进行配置的方式影响 OpenFeign 的 RPC 结果，比如替换序列化组件

@Configuration
public class WebMvcConfig {
    @Bean
    GsonHttpMessageConverter gsonHttpMessageConverter(){
        GsonHttpMessageConverter converter = new GsonHttpMessageConverter();
        GsonBuilder gsonBuilder = new GsonBuilder();
        gsonBuilder.setDateFormat("yyyy-MM-dd HH:mm:ss");
        converter.setGson(gsonBuilder.serializeNulls().create());
        return converter;
    }
}

因为 OpenFeign 自动依赖 Ribbon，因此可以通过对 Ribbon 的配置设置超时
并且可以直接通过 yml 进行配置，注意这里的超时依然是消费者的超时控制

ribbon:
	# 建立连接后从服务器读取到可用资源所用的时间
	ReadTimeout: 5000
	# 建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
	ConnectTimeout: 5000

启动类
对 OpenFeign 接口的类扫描，是由 @EnableFeignClients 进行而不是 @SpringBootApplication
因此若项目变更了启动类默认位置，则 @EnableFeignClients 上也应该标注 basePackage 属性
如下面示例中的注释行：

//@SpringBootApplication(scanBasePackages = "com.fc.sprcloudlearning")
//@EnableFeignClients(basePackages = "com.fc.sprcloudlearning")
@SpringBootApplication
@EnableFeignClients
public class OrderComsummerApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderComsummerApplication.class,args);
    }
}

OpenFeign 接口
注意事项：

• 不需要 @Component 注解
• 接口上需要注明接口对应的服务名
• 接口方法上的 mvc 路径为服务提供方的 mvc 路径
• 接口方法上的 mvc 路径需要写全，注意带有类路径的情况

//@Component
@FeignClient(value = "PAYMENT-SERVICE")
public interface PaymentOpenfeignService {
    @RequestMapping(value = "/payment/{id}", method = RequestMethod.GET)
    CommonResult findById(@PathVariable("id") Long id);
}

OpenFeign 的（接口）日志

Feign 的接口日志级别

• NONE: 默认的，不显示任何日志
• BASIC：生成常用，仅记录请求方法、URL、响应状态码以及执行时间
• HEADERS：除了BASIC中定义的信息以外，还有请求和响应的头信息
• FULL：测试常用，除了HEADERS中定义的信息之外，还有请求和响应的正文及元数据

开启 OpenFeign 的接口日志需要两处配置
1 项目的日志需要可以输出相关类的日志
OpenFeign 的接口日志只是项目日志中的一部分，如果项目中日志的配置不支持，就无所谓接口日志记录成什么样
这里就是正常项目日志的配置，loombok / log4j 等等任意
这里的日志级别是 debug 的原因是 OpenFeign 的接口日志本身是 debug 级别的项目日志

logging:
  config: classpath:logback.cfg.dev.xml
  level:
    # 对服务类进行正常的接口配置，否则对应类根本不输出日志，就无所谓其中的接口日志记录到什么程度了
    com.fc.sprcloudlearning.order.service.PaymentOpenfeignService: debug

2 配置 OpenFeign 的接口日志级别
这里配置了如果项目需要服务相关的类输出日志，那其中接口日志输出的详细程度

@Configuration
public class OpenFeignConfig {
    @Bean
    Logger.Level openFeignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

日志输出效果如下图：
BASIC

HEADERS

FULL

OpenFeign 的负载均衡规则

OpenFeign 实际上是个 Rest 客户端，负载均衡操作依赖 Ribbon 负载均衡能力
因此，OpenFeign 下变更负载均衡规则的方式如 Ribbon

---

传送门：
微服务架构 | 组件目录