OpenFeign是一种声明式、模板化的HTTP客户端。在Spring Cloud中使用Feign, 我们可以做到使用HTTP请求远程服务时能与调用本地方法一样的编码体验。
OpenFeign的前身是Feign,OpenFeign是SpringCloud在Feign的基础上支持了Spring MVC的注解,并通过动态代理的方式产生实现类来做负载均衡并进行调用其他服务。
使用 Ribbon+RestTemplate 时,利用了RestTemplate对http请求的封装处理,形成了一套模版化的调用方法。在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用, 所以通常都会针对每个微服务自行封装成客户端类来包装这些依赖服务的调用。所以,Feign在此基础上做了进一步封装, 由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下,我们只需创建一个接口并使用注解的方式来配置它,简化了使用Spring Cloud Ribbon时,自动封装服务调用客户端的开发量。
Spring Cloud应用在启动时,Feign会扫描标有@FeignClient注解的接口,生成代理,并注册到Spring容器中。生成代理时Feign会为每个接口方法创建一个RequetTemplate对象,该对象封装了HTTP请求需要的全部信息,请求参数名、请求方法等信息都是在这个过程中确定的,Feign的模板化就体现在这里。
Feign
Feign是SpringCloud组件中的一个轻量级RESTFul
的HTTP服务客户端
,内置了Ribbon来做客户端负载均衡去调注册中心的服务,它的使用就是使用Feign的注解定义接口,然后调用这个接口就可以调用注册中心的服务。
Feign使用的是自己的一套注解,不支持Spring MVC的注解。
OpenFeign
OpenFeign是Spring Cloud在Feign的基础上支持了Spring MVC的注解,列如@RequestMapping
等,OpenFeign的@FeignClient
可以解析SpringMVC的@RequestMapping
注解下的接口,并通过动态代理的方式产生实现类,实现类中做负载均衡并调用其他服务。
Ribbon
Ribbon是Netflix开源的基于HTTP和TCP等协议负载均衡组件,是一个客户端负载均衡器,运行在客户端上。Ribbon的使用需要代码里面手动调用所需服务。Feign已经默认使用了Ribbon。
OpenFeign 的两个重要标注@FeignClient和@EnableFeignClients。
@FeignClient标注用于声明Feign客户端可访问的Web服务。
@EnableFeignClients标注用于修饰Spring Boot应用的入口类,以通知Spring Boot启动应用时,扫描应用中声明的Feign客户端可访问的Web服务。
@FeignClient标注的参数
- name, value (默认""),两者等价
- qualifier (默认"")
- url (默认"")
- decode404 (默认false)
- configuration (默认FeignClientsConfiguration.class)
- fallback (默认void.class)
- fallbackFactory (默认void.class)
- path (默认"")
- primary (默认true)
启用OpenFeign
pom添加依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
启动OpenFeign
需要启动类上添加
@EnableFeignClients
注解
@SpringBootApplication
@EnableFeignClients
public class TestOpenFeignApplication {
public static void main(String[] args) {
SpringApplication.run(TestOpenFeignApplication.class,args);
}
}
OpenFeign超时控制
默认Feign客户端只等待一秒钟,就是服务处理需要超过1秒,导致Feign客户端不想等待了,直接返回报错。为了避免这样的情况,有时候我们需要设置Feign客户端的超时控制。
# 设置 feign客户端超时时间 ( openFeign 默认支持 ribbon )
ribbon:
# 指的是建立连接所用的时间,适用于网络状况正常的情况下,俩端连接所用的时间 单位是秒
ReadTimeout: 6000
# 指的是建立连接后从服务器读取到可用资源的时间
ConnectTimeout: 5000
ribbon的可配置部分
ribbon.ReadTimeout=1000 //处理请求的超时时间,默认为1秒
ribbon.ConnectTimeout=1000 //连接建立的超时时长,默认1秒
ribbon.MaxAutoRetries=1 //同一台实例的最大重试次数,但是不包括首次调用,默认为1次
ribbon.MaxAutoRetriesNextServer=0 //重试负载均衡其他实例的最大重试次数,不包括首次调用,默认为0次
ribbon.OkToRetryOnAllOperations=false //是否对所有操作都重试,默认false