Feign是一个声明式的Web服务客户端,让编写Web服务客户端变得非常容易,只需创建一个接口并在接口上添加注解即可;
OpenFeign基本知识
Feign是什么
Feign是一个声明式的Web服务客户端,让编写Web服务客户端变得非常容易,只需创建一个接口并在接口上添加注解即可;Feign旨在使编写JavaHTTP客户端变得更容易;
Feign的出现解决了什么问题
上篇《微服务架构|1基于Ribbon的负载均衡详解》在使用Ribbon+RestTemplate时,利用RestTemplate对http请求的封装处理,有一套模版化的调用方法;但是在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用,所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用;Feign在此基础上做了进一步封装,由他来帮助我们定义和实现依赖服务接口的定义;在Feign的实现下,我们只需创建一个接口并使用注解的方式来配置它,即可完成对服务提供方的接口绑定;简化了使用SpringcloudRibbon时,自动封装服务调用客户端的开发量;
Feign与OpenFeign的区别与对比
Feign 是 Spring Cloud 组件中的一个轻量级 RESTful 的 HTTP 服务客户端。Feign 内置了 Ribbon,用来做客户端负载均衡,去调用服务注册中心的服务。Feign 的使用方式是:使用 Feign 的注解定义接口,调用这个接口,就可以调用服务注册中心的服务; | OpenFeign 是 Spring Cloud 在 Feign 的基础上支持了 SpringMVC 的注解,如 @RequesMapping 等。OpenFeign 的 @FeignClient 可以解析 SpringMVC 的 @RequestMapping 注解下的接口,并通过动态代理的方式产生实现类,实现类中做负载均衡并调用其他服务; |
2018年以前的项目在使用feign | springcloud F 及 F 版本以上基本上使用 openfeign,openfeign 从框架结构上可以看做是2019年 feign 停更后出现版本,可以说大多数新项目在用 openfeign |
spring-cloud-starter-feign | spring-cloud-starter-openfeign |
Feign与OpenFeign最大的区别是:前者不支持对SpringMVC的注解,而后者支持;Feign默认支持Ribbon负载均衡,而OpenFeign又是在Feign的基础上发展而来的;详情可以参考下面:《3在业务接口上添加注解》与《3在业务接口上添加注解》;
在服务消费者端开启Feign支持
消费者对Feign客户端的支持示例同《微服务架构|1基于Ribbon的负载均衡详解》一篇中:4使用NetflixFeign客户端调用服务部分;
引入poxml依赖
org.springframework.cloud
spring-cloud-starter-feign
在主程序类上添加注解
@EnableFeignClients:表示开启并使用Feign客户端;
在业务接口上添加注解
@FeignClient('provider-instance-name') //标识服务为 feign 的客户端
public interface ProviderFeignClient {
//定义端点的路径和动作
@RequestMapping(
method= RequestMethod.GET,
value='/providers/{providerId}',
consumes='application/json')
//定义传入端点的参数,该方法可以由客户端调用以触发组织服务
Provider getProvider(@PathVariable('providerId') String providerId);
}
注意:Feign不支持对SpringMVC注解的支持;接下来完成对业务接口的实现,将接口自动注入Controller层并调用接口方法即可;
在controller层调用接口
@RestController
public class ConsumerFeignController{
@Resource
private ProviderFeignClient providerFeignClient;
@GetMapping(value = '/provider/get/{id}')
public Provider getProviderById(@PathVariable('id') Long id){
return providerFeignClient.getProviderById(id);
}
}
在服务消费者端开启OpenFeign支持
引入poxml依赖
org.springframework.cloud
spring-cloud-starter-openfeign
在主程序类上添加注解
@EnableFeignClients:表示开启并使用Feign客户端;
在业务接口上添加注解
@FeignClient:表示开启并使用Feign客户端;
@Component
@FeignClient(value = 'provider-instance-name')
public interface ProviderFeignClient {
@GetMapping(value = '/providers/{providerId}')
Provider getProvider(@PathVariable('providerId') String providerId);
}
注意:可以从这里看到OpenFeign对SpringMVC注解的支持;接下来的步骤同Feign,也是:完成对业务接口的实现,将接口自动注入Controller层并调用接口方法即可;同《4在controller层调用接口》;
OpenFeign的超时控制
当客户端请求超过1s是,会报如下错误:
这是因为Feign客户端默认只等待一秒钟,当请求时间超过1s时,Feign会给我们返回请求超时页面;只需修改yml文件即可修改默认超时控制;
#设置 feign/openFeign 客户端超时时间
ribbon:
#指的是建立连接所用的时间,适用于网络状况正常的情况下,两端连接所用的时间
ReadTimeout: 5000
#指的是建立连接后从服务器读取到可用资源所用的时间
ConnectTimeout: 5000
OpenFeign的日志打印功能
日志与日志级别
Feign提供了日志打印功能,可以通过配置来调整日志级别,从而了解Feign中Http请求的细节;也即:对Feign接口的调用情况进行监控和输出;
NONE | 默认的,不显示任何日志 |
BASIC | 仅记录请求方法、URL、响应状态码及执行时间 |
HEADERS | 除了 BASIC 中定义的信息之外,还有请求和响应的头信息 |
FULL | 除了 HEADERS 中定义的信息之外,还有请求和响应的正文及元数据 |
编写配置类设置日志级别
在config包下;
@Configuration
public class FeignConfig{
@Bean
Logger.Level feignLoggerLevel(){
return Logger.Level.FULL;
}
}
在yml文件里配置需要开启日志功能的提供者Feign客户端
logging:
level:
#feign日志以什么级别监控哪个接口
com.xxx.springcloud.service.ProviderFeignService: debug
在控制台上查看日志信息
最后
新人制作,如有错误,欢迎指出,感激不尽!
欢迎关注公众号,会分享一些更日常的东西!
文章为作者独立观点,不代表 股票程序化软件自动交易接口观点