服务调用之OpenFeign-吉桂权的个人主

一、OpenFeign是什么？
1、基本概念

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

Feign是一个声明式WebService客户端，使用Feign能让编写WebService客户端更加简单；

它的使用方式是 定义一个服务接口然后在上面添加注解。

Feign也支持可插拔式的编码器和解码器；

SpringCloud对Feign进行了封装，使其支持了SpringMVC标准注解和HttpMessageConverters。

Feign可以与Eureka和Ribbon组合使用以支持负载均衡。

2、Feign能干什么？

Feign旨在是编写Java Http客户端变得更容易；

前面在使用Ribbon + RestTemplate时，利用RestTemplate对http请求的封装处理，形成了一套模板化的调用方法。

但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多次调用，所以通常会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。

所以，Feign在此基础上做了进一步封装，由它来帮助我们定义和实现依赖服务接口的定义。

借助于Feign，我们只需要创建一个接口，并使用注解的方式来配置它（以前是Dao接口上面标注Mapper注解，现在是一个微服务接口上面标注一个@Feign注解即可），即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

3、Feign集成了Ribbon

利用Ribbon维护了Payment的服务列表信息，并且通过轮询实现了客户端的负载均衡。

而与Ribbon不同的是，通过Feign只需要定义服务绑定接口且以声明式的方法，优雅而简单地实现了服务的调用；

4、Feign和OpenFeign的区别

Feign已经被OpenFeign所取代，

Feign	OpenFeign
Feign是Spring Cloud组件中的一个轻量级Restful的HTTP服务客户端；Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务；Feign的使用方式：使用@Feign注解定义接口，调用这个接口，就可以调用服务提供者的服务。	OpenFeign是Spring Cloud在Feign的基础上支持了SpringMVC的注解，如@RequestMapping等；OpenFeign的注解@FeignCLient可以解析SPringMVC的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务。
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-feign</artifactId> </dependency	<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency

二、实战-使用OpenFeign实现服务调用

1、新建 cloud-consumer-feign-order80 消费者服务：

pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>cloud2020</artifactId>
        <groupId>com.jiguiquan.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <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>
        <!--公共服务模块依赖-->
        <dependency>
            <groupId>com.jiguiquan.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!--springboot项目web和actuator最好一起走-->
        <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>

        <!--热部署devtools-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!--测试-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>
</project>

2、配置文件application.yml：

server:
  port: 80

spring:
  application:
    name: cloud-order-service

eureka:
  client:
    register-with-eureka: false #一个简单的消费者，可以不用向Eureka注册自己
    service-url:
      #      defaultZone: http://localhost:7001/eureka # 单机版 入驻的EurekaServer地址
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka  #集群版

3、创建主启动类 com.jiguiquan.springcloud.OrderFeignMain80.java

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

4、创建使用@FeignClient注解的service接口 service.PaymentFeignService：

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

    //与PaymentController中的API接口一模一样即可
    @GetMapping(value = "/payment/get/{id}")
    CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}

5、编写业务类 OrderController

@RestController
@Slf4j
public class OrderController {
    @Autowired
    private PaymentFeignService paymentFeignService;

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

6、启动服务，测试，访问 http://localhost/consumer/payment/get/6

多试几次，发现负载均衡功能也成功，且是Ribbon默认的轮询策略

三、OpenFeign的超时控制

1、超时设置，故意设置超时演示出错情况：

1.1、服务提供方8001故意写暂停程序（睡3秒钟）：

@RestController
@RequestMapping("/payment")
@Slf4j
public class PaymentController {

    @Value("${server.port}")
    private String serverPort;

    @GetMapping(value = "/feign/timeout")
    public String paymentFeignTimeout(){
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return serverPort;
    }
}

1.2、服务消费方80添加超时方法PaymentFeignService：

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

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

1.3、服务消费方80添加超时方法PaymentController：

@RestController
@Slf4j
public class OrderController {
    @Autowired
    private PaymentFeignService paymentFeignService;

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

1.4、测试：http://localhost/consumer/payment/feign/timeout

很明显，报错原因是访问超时：

2、在application.yml配置文件中开启OpenFeign客户端的超时控制：

OpenFeign的超时控制是由Ribbon实现的（默认为1秒钟）：

server:
  port: 80

spring:
  application:
    name: cloud-order-service

eureka:
  client:
    register-with-eureka: false #一个简单的消费者，可以不用向Eureka注册自己
    service-url:
      #      defaultZone: http://localhost:7001/eureka # 单机版 入驻的EurekaServer地址
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka  #集群版

#设置OpenFeign客户端超时时间（OpenFeign默认支持Ribbon）
ribbon:
  #指的是建立连接所用的时间，适用于网络状况正常的情况下，两端连接的时间
  ConnectTimeout: 5000
  #指的是建立连接后，从服务器读取到可用资源所用的时间
  ReadTimeout: 5000

3、此时，再次重启order80服务，测试

再次访问上面的url： http://localhost/consumer/payment/feign/timeout

在经过漫长的3秒钟后，最终没有报错，并访问正常

四、OpenFeign日志增强

1、什么是OpenFeign的日志打印功能？

Feign提供了日志打印功能，我们可以通过配置来调整日志级别，从而了解Feign中的Http请求的细节；

说白了，就是对Feign接口的调用情况进行监控和输出。

2、Feign的日志等级分为哪些等级？

NONE：默认的，不显示任何日志；
BASIC：仅记录请求方法、URL、响应状态码及执行时间；
HEADERS：除了BASIC中定义的信息之外，还增加了请求和响应的头信息；
FULL：除了HEADERS中定义的信息外，还有请求和响应的正文及元数据；

3、使用 FULL 等级做测试：增加一个配置Bean：config.FeignConfig.java

@Configuration
public class FeignConfig {
    //注意这里使用的Logger是 feign.Logger
    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

4、在配置文件 application.yml 中增加一个配置信息：

logging:
  level:
    #以debug的形式，打印对应的PaymentFeignService的FULL级别的全日志，可以列多个
    com.jiguiquan.springcloud.service.PaymentFeignService: debug

5、重启FeignOrder80服务，访问一次：http://localhost/consumer/payment/get/6

查看后台日志打印情况，可以看到，打印得非常的详细：

非常得实用！

个人此项目代码地址（持续更新）：

https://github.com/jiguiquan/cloud2020