【SpringCloud笔记】（6）服务调用之OpenFeign

OpenFeign

概述

官网地址：https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign
GitHub地址：https://github.com/spring-cloud/spring-cloud-openfeign

是一个声明式的Web服务客户端，让编写Web服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可
Feign也支持可拔插式的编码器和解码器。
Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。
Feign可以与Eureka和Ribbon组合使用以支持负载均衡

能干嘛？

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

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

Feign与OpenFeign区别？

OpenFeign服务调用

新建cloud-consumer-feign-order80模块

pom文件

<artifactId>cloud-consumer-feign-order80</artifactId>

    <dependencies>
        <!--openfeign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <!--eureka client-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
        <dependency>
            <groupId>com.mzr.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>

yml文件

 server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

主启动类添加@EnableFeignClients注解

@SpringBootApplication
@EnableFeignClients//激活并开启feign
public class OrderFeignMain80
{
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class, args);
    }
}

新建Service+@FeignClient

@FeignClient(value = "cloud-provider-payment")//告知去找哪个微服务
public interface PaymentFeignService {
    @GetMapping(value = "/payment/get/{id}")//调用这个微服务中的这个地址
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}

controller层

@RestController
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);
    }
}

启动测试

多次刷新可以发现8001与8002交替出现

小总结：
消费者controller层调用PaymentFeignService层getPaymentById接口，从PaymentFeignService中@FeignClient(value = “cloud-provider-payment”)、@GetMapping(value = “/payment/get/{id}”)可得知调用服务提供者微服务中暴漏出的具有相同注解的方法，其实就是调用的服务提供者service层getPaymentById接口

OpenFeign超时控制

超时设置，故意设置超时演示出错情况：
1、服务提供方8001故意写暂停程序
2、服务消费方80添加超时方法PaymentFeignService
3、服务消费方80添加超时方法OrderFeignControIIer
4、测试访问http://localhost/consumer/payment/feign/timeout地址查看结果

8001 controller层

@GetMapping(value = "/payment/feign/timeout")
    public String paymentFeignTimeout()
    {
        // 业务逻辑处理正确，但是需要耗费3秒钟
        try { TimeUnit.SECONDS.sleep(3); } catch (InterruptedException e) { e.printStackTrace(); }
        return serverPort;
    }

消费者80 PaymentFeignService

@FeignClient(value = "cloud-provider-payment")//告知去找哪个微服务
public interface PaymentFeignService {
    @GetMapping(value = "/payment/get/{id}")//调用这个微服务中的这个地址
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);

    @GetMapping(value = "/payment/feign/timeout")
    public String paymentFeignTimeout();
}

消费者80 OrderFeignControIIer层

@GetMapping(value = "/consumer/payment/feign/timeout")
    public String paymentFeignTimeout()
    {
        // OpenFeign客户端一般默认等待1秒钟,就是要比服务提供端时间短，得不到响应便报错
        return paymentFeignService.paymentFeignTimeout();
    }

测试：提示超时，因为我们服务端接口响应要3秒，但是OpenFeign默认超时等待1秒，超过后报错

为了避免这种超时报错，有时候我们需要设置Feign客户端的超时控制

修改yml文件

server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/
#设置feign客户端超时时间(OpenFeign默认支持ribbon)
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文件

server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/
#设置feign客户端超时时间(OpenFeign默认支持ribbon)
ribbon:
#指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
  ReadTimeout: 5000
#指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

logging:
  level:
    # feign日志以什么级别监控哪个接口(接口使用全路径)
    com.atguigu.springcloud.service.PaymentFeignService: debug

启动测试

可以看到日志已经打印的非常详细了