OpenFeign服务接口调用
1. OpenFeign概述
openfeign主要用于客户端,作为服务调用,如同RestTempalte。Feign是一个声明式WebService客户端。使用Feign能让编写Web Service客户端更加简单。 它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装,使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。 官网:GitHub - spring-cloud/spring-cloud-openfeign: Support for using OpenFeign in Spring Cloud apps
Feign能干什么 Feign旨在使编写Java Http客户端变得更容易。 前面在使用Ribbon+RestTemplate时,利用RestTemplate对http请求的封装处理,形成了一套模版化的调用方去。但是在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用,所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以,Feign在此基础上做了进一步封装,由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下,我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是一个微服务接口上面标注一个Feign注解即可),即可完成对服务提供方的接口绑定,简化了使用Spring cloud Ribbon时,自动封装服务调用客户端的开发量。 Feign集成了Ribbon 利用Ribbon维护了Payment的服务列表信息,并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是,通过feign只需要定义服务绑定接口且以声明式的方法,优雅而简单的实现了服务调用。
Feign和OpenFeign的区别
Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端Feign内置了Ribbon,用来做客户端负载均衡,去调用服务注册中心的服务。Feign的使用方式是:使用Feign的注解定义接口,调用这个接口,就可以调用服务注册中心的服务。 OpenFeign是Spring Cloud在Feign的基础上支持了SpringMVC的注解,如@RequesMapping等等。OpenFeign的@Feignclient可以解析SpringMVc的@RequestMapping注解下的接口,并通过动态代理的方式产生实现类,实现类中做负载均衡并调用其他服务。
2. OpenFeign服务调用
使用OpenFeign就是服务接口+@FeignClient
-
新建cloud-consumer-fegin-order80
-
pom文件
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
-
aplication.yaml
server:
port: 80
eureka:
client:
#是否注册自己
register-with-eureka: false
service-url:
defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
# defaultZone: http://localhost:7001/eureka
-
主启动类
@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class OrderFeignMain80 {
public static void main(String[] args) {
SpringApplication.run(OrderFeignMain80.class,args);
}
}
-
业务逻辑层接口
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {
@GetMapping(value = "/payment/get/{id}")
CommonResult getPaymentById(@PathVariable("id") Long id);
}
-
controller层
@RestController
@Slf4j
public class OrderFeignController {
@Resource
private PaymentFeignService paymentFeignService;
@GetMapping(value = "/consumer/payment/get/{id}")
public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
return paymentFeignService.getPaymentById(id);
}
}
测试:
3. OpenFegin超时控制
超时程序演示:
-
修改clloud-provider-payment8001项目的controller
@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeOut(){
try{
TimeUnit.SECONDS.sleep(3);
}catch (InterruptedException e){
e.printStackTrace();
}
return serverPort;
}
-
添加入cloud-consumer-feign-order80的PaymentFeignService接口
@GetMapping(value = "/payment/feign/timeout")
String paymentFeignTimeOut();
-
修改cloud-consumer-feign-order80的controller层
@GetMapping(value = "/consumer/payment/feign/timeout")
public String paymentFeignTimeOut(){
return paymentFeignService.paymentFeignTimeOut();
}
测试:
openfeign默认等待1秒钟,而提供者需要3秒,所以出现报错;这里可以设置openfeign的超时实践或者进行服务降级。
#没置feign客户端超时时间(openFeign默认支持ribbon)ribbon: #指的是建立连接威用的时间,适用于网络状况正常的情况下,两端连接所用的时间 ribbon: ReadTimeout: 5000 #指的是建立连接后从服务器读取到可用资源所用的时间 ribbon: ConnectTimeout: 5000
配置超时时间后,继续测试:
4. OpenFeign日志打印功能
Feign提供了日志打和功能,我们可以通过配置来调整日志级别,从而了解Feign中 Http请求的细节。说白了就是对Feign接口的调用情况进行监控和输出。
日志级别:
NONE:默认的,不显示任何日志; BASIC:仅记录请求方法、URL、响应状态码及执行时间; HEADERS:除了BASIC中定义的信息之外,还有请求和响应的头信息; FULL:除了HEADERS中定义的信息之外,还有请求和响应的正文及元数据。
配置日志Bean
cloud-consumer-fegin-order80项目下创建config.FeignConfig类:
@Configuration
public class FeignConfig {
@Bean
Logger.Level feignLoggerLevel(){
return Logger.Level.FULL;
}
}
配置cloud-consumer-fegin-order80项目下yaml文件:
logging:
level:
#feign日志以什么级别监控哪个接口
com.yicai.springcloud.service.PaymentFeignService: debug
测试:(以后工作中需要fegin的详细信息,可以进行如上配置)