OpenFeign服务接口调用

1.概述

1.1 OpenFeign是什么
Feign是一个声明式的WebService客户端,使用Feign能让编写Web Servvice客户端更加简单。它的使用方法是定义一个服务接口,然后在上面添加注解。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行的封装,使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。
官网地址

1.2 能干嘛
Feign旨在使编写Java Http客户端变得更容易。

前面在使用Ribbon+ RestTemplate时,利用RestTemplate对http请求的封装处理,形成了一套模版化的调用方法。但是在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用, 所以通常都会针对每个微服务自行封装些客户端类来包装这些依赖服务的调用。所以,Feign在此基础上做了进一步封装, 由他来帮助我们定义和实现依赖服务接[的定义。在Feign的实现下,我们只需创建一 个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是一个微服务接口 上面标注一个Feign注解即可),即可完成对服务提供方的接]绑定,简化了使用Spring cloud Ribbon时,自动封装服务调用客户端的开发量。

Feign集成了Ribbon
利用Ribbon维护了Payment的服务列表信息,并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是,通过feign只需要定义服务绑定接口且以声明式的方法,优雅而简单的实现了服务调用。

1.3 Feign和OpenFeign两者区别
OpenFeign服务接口调用_第1张图片

2.OpenFeign使用步骤

2.1新建cloud-consumer-feign-order80

Feign在消费端使用

2.2修改pom.xml文件


        
            com.zhang.springcloud
            cloud-api-commons
            ${project.version}
        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-starter-actuator
        
        
            org.springframework.boot
            spring-boot-devtools
            runtime
            true
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
        
            org.springframework.cloud
            spring-cloud-starter-netflix-eureka-client
        
        
        
            org.springframework.cloud
            spring-cloud-starter-openfeign
        

        
            org.projectlombok
            lombok
            true
        
    

2.3 创建application.yml文件

server:
  port: 80


eureka:
  client:
    register-with-eureka: false   #是否将自己注册到注册中心,集群必须设置为true配合ribbon
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka
#设置feign客户端超时时间(OpenFeign默认支持Ribbon)
ribbon:
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ReadTimeout: 5000
  #指的是建立连接所用时间,适用于网络状况正常的情况下,两端连接所用的时间
  ConnectTimeout: 5000

2.4 创建主启动类

@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class,args);
    }
}

2.5 创建业务类
2.5.1 创建service接口

@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {

    @GetMapping("/payment/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id);

2.5.2 创建controller

@RestController
@Slf4j
public class OrderFeignController {

    @Resource
    private PaymentFeignService paymentFeignService;

    @GetMapping("/consumer/payment/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id){
        return paymentFeignService.getPaymentById(id);
    }

3. OpenFeign超时控制

3.1超时设置,故意设置超时演示出错情况
3.1.1 服务提供方8001故意写暂停程序

@GetMapping("/payment/feign/timeout")
    public String paymentFeignTimeOut(){
        //暂停几秒钟线程
        try {
            TimeUnit.SECONDS.sleep(3);
        }catch (InterruptedException e){
            e.printStackTrace();
        }
        return serverPort;
    }

3.1.2 服务消费方80添加超时方法paymentFeignService

 @GetMapping("/payment/feign/timeout")
    public String paymentFeignTimeOut();

3.1.3 服务消费方80添加超时方法OrderFeignController

@GetMapping("/consumer/payment/feign/timeout")
    public String paymentFeignTimeOut(){
        //openfeign-ribbon,客户端一般默认等待1秒钟
        return paymentFeignService.paymentFeignTimeOut();
    }

测试:测试地址

错误页面:OpenFeign服务接口调用_第2张图片

OpenFeign默认等待一秒钟,超过后报错!!!!
OpenFeign服务接口调用_第3张图片
3.1.4 YML文件里需要开启OpenFeign客户端超时控制

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

4. OpenFeign日志打印功能

Feign提供了日志打印功能,我们可以通过配置来调整日志级别,从而了解Feign中Http请求的细节。说白了就是对Feign接]的调用情况进行监控和输出。
OpenFeign服务接口调用_第4张图片

  1. 配置日志bean
@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLever(){
        return Logger.Level.FULL;
    }
}

2. YML文件里需要开启日志的Feign客户端

logging:
  level:
    #feign日志以什么级别监控那个接口
    com.zhang.springcloud.service.PaymentFeignService: debug

你可能感兴趣的