（五）OpenFeign服务接口调用

（五）OpenFeign服务接口调用

1、概述

1.1 是什么

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

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

1.2 功能

Feign能于什么

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

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

法。但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对

每个微服务自行封装一些客户端类来包装这些**依赖服务的调用。**所以，Feign在此基础上做了进一步封装，由他来

帮助我们定义和实现依赖服务接口的定义。

在Feign的实现下我们只需**创建一个接口并使用注解的方式来配置它(**以前是Dao接口上面标注Mapper注解,现在是一

个微服务接口上面标注一个 Feign注解即可)，即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon

时，自动封装服务调用客户端的开发量。

Feign集成了Ribbon

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

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

1.3 Ribbon、OpenFeign和Feign的关系

• Ribbon是使用是Ribbon+RestTemplate。

• Ribbon是对http请求做的除了，所以在每次调用的时候我们都需要拿到URI，然后去请求。

• OpenFeign的使用是定义接口加注解。

• 我们可以更好的维护接口与调用。

• Feign集成了Ribbon，OpenFeign升级了Feign。

2、OpenFeign使用步骤

2.1 新建模块

cloud-consumer-order80Feign

2.2 POM

<dependencies>
        <!--openfeign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>com.atguigu.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <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>

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

2.3 YML

server:
  port: 81
eureka:
  client:
    service-url:
      #集群版
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
    #表示是否将自己注册进EurekaServer
    register-with-eureka: true
    #是否从EurekaServer中去掉已有的注册信息，默认为true
    fetch-registry: true

2.4 主启动类

@EnableFeignClients//开启Feign功能

package com.lisa.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients//开启Feign功能
public class Order80Feign {
    public static void main(String[] args) {
        SpringApplication.run(Order80Feign.class,args);
    }
}

2.5 Service

业务逻辑接口+@FeignClient配置调用provider服务

新建PaymentFeignService接口并新增注解@FeignClient

@FeignClient("CLOUD-PAYMENT-SERVICE")

声明这是一个Feign客户端，类似@Mapper注解.同时通过value属性指定服务名称

package com.lisa.springcloud.service;

import com.atguibu.springcloud.entities.CommonResult;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@Component
@FeignClient("CLOUD-PAYMENT-SERVICE")//声明这是一个Feign客户端，类似@Mapper注解.同时通过value属性指定服务名称
public interface PaymentFeignService {

    //接口中的定义方法，完全采用SpringMVC的注解，Feign会根据注解帮我们生成URL，并访问获取结果
    @GetMapping("/payment/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id);
}

2.6 Controller

package com.lisa.springcloud.controller;

import com.atguibu.springcloud.entities.CommonResult;
import com.atguibu.springcloud.entities.Payment;
import com.lisa.springcloud.service.PaymentFeignService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@RestController
public class OrderFeignController {

    @Resource
    private PaymentFeignService paymentFeignService;

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

2.7 测试

http://localhost:81/consumer/payment/get/1

Feign自带负载均衡配置项

总结：

3、OpenFeign的超时控制

3.1 超时设置，故意设置超时演示出错情况

服务提供方8001、8002故意写暂停程序

cloud-provider-payment8001和cloud-provider-payment8002中的PaymentController.java添加：

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

服务消费方80:cloud-consumer-order80Feign添加超时方法PaymentFeignService:

@Component
@FeignClient("CLOUD-PAYMENT-SERVICE")//声明这是一个Feign客户端，类似@Mapper注解.同时通过value属性指定服务名称
public interface PaymentFeignService {
    ....

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

服务消费方80：cloud-consumer-order80Feign添加超时方法OrderFeignController:

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

测试：

http://localhost:81/consumer/payment/feign/timeout

OpenFeign默认等待一秒钟，超过后报错

默认Feign客户端只等待一秒钟，但是服务端处理需要超过1秒钟，导致Feign客户端不想等待了，直接返回报错。

为了避免这样的情况，有时候我们需要设置Feign客户端的超时控制。

3.2 yml文件中开启配置Feign客户端的超时控制

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

OpenFeign默认支持Ribbon

再次测试：

可以看出OpenFeign中支持Ribbon负载均衡

4、OpenFeign的日志打印功能

4.1 是什么

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

Feign接口的调用情况进行监控和输出

4.2 日志级别

NONE:默认的，不显示任何日志;

BASIC:仅记录请求方法、URL、响应状态码及执行时间;

HEADERS:除了BASIC中定义的信息之外，还有请求和响应的头信息;

FULL:除了HEADERS中定义的信息之外，还有请求和响应的正文及元数据。

4.3 配置日志bean

package com.lisa.springcloud.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class FeignConfig {

    @Bean
    Logger.Level feignLoggerLevel(){
        //FULL:除了HEADERS中定义的信息之外，还有请求和响应的正文及元数据。
        return Logger.Level.FULL;
    }
}

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

#YML文件里需要开启日志的Feign客户端
logging:
  level:
    com.lisa.springcloud.service.PaymentFeignService: debug

4.5 测试

http://localhost:81/consumer/payment/get/1

4.6 后台日志查看