OpenFeign服务接口调用的使用方法

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

一、概述

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

2.能干嘛？
Feign旨在使编写Java Http客户端变得更容易。
在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以，Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是一个微服务接口上面标注一个Feign注解即可)，即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

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

3.Feign和OpenFeign两者区别
Feign
Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端
Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。Feign的使用方式是：使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务.
OpenFeign
OpenFeign是Spring Cloud 在Feign的基础上支持了SpringMVC的注解，如@RequesMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务。
OpenFeign提供了两个重要标注@FeignClient和@EnableFeignClients。
@FeignClient标注用于声明Feign客户端可访问的Web服务。
@EnableFeignClients标注用于修饰Spring Boot应用的入口类，以通知Spring Boot启动应用时，扫描应用中声明的Feign客户端可访问的Web服务。

二、OpenFeign的使用步骤

父工程以及Eureka7001,7002集群和服务端8001,8002的搭建请看Eureka的单机以及集群的使用详解
1.新建消费端cloud-openfeign80

2.写pom

<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>
    <!--web-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

3.在resources添加application.yml

server:
  port: 80

eureka:
  client:
    #false表示不向注册中心注册自己。
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/ 

4.主启动类

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

5.编写接口service并添加注解@FeignClient

@Component
//8001/8002配置文件中的的spring.application.name
@FeignClient(value = "CLOUD-CLIENT")
public interface OpenFeignService {
    //8001、8002的controller访问地址
    @GetMapping(value = "/client/get")
    String clientGet();
}

6.编写controller

@RestController
public class OpenFeignController {
    @Resource
    private OpenFeignService openFeignService;

    @GetMapping("/openFeign/client/get")
    public String openFeignString(){
        return openFeignService.clientGet();
    }
}

7.测试
先启动Eureka注册中心7001、7002
在启动提供者8001、8002
最后启动OpenFeign80

访问http://localhost/openFeign/client/get

Feign自带负载均衡配置项
访问成功，并且出现8001、 8002轮询

三、OpenFeign超时控制

设置超时演示出错
1.在服务提供者8001 Client8001Controller内编写

@GetMapping(value = "/openFeign/timeout")
    public String FeignTimeOut() {
        System.out.println("FeignTimeOut from port: " + serverPort);
        //暂停几秒钟线程
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return serverPort;
    }

2.服务消费方80添加超时方法OpenFeignService

@GetMapping(value = "/openFeign/timeout")
String FeignTimeOut();

3.服务消费方80添加超时方法OpenFeignController

    @GetMapping("payment/openFeign/timeout")
    public String paymentTimeout(){
        return openFeignService.FeignTimeOut();
    }

4.测试
访问 http://localhost/payment/openFeign/timeout

5.OpenFeign默认等待一秒钟，超时后会报错。所以需要设置Feign客户端的超时控制。
openFeign是默认支持Ribbon的

6.修改消费者cloud-openfeign80的application.yml

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

重新启动cloud-openfeign80
访问 http://localhost/payment/openFeign/timeout

访问成功！

四、OpenFeign日志打印功能

1.Feign 提供了日志打印功能，我们可以通过配置来调整日志级别，从而了解 Feign 中 Http 请求的细节。说白了就是对Feign接口的调用情况进行监控和输出

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

3.配置日志
在cloud-openfeign80新建类FeignConfig

@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

修改application.yml

logging:
  level:
    #feign日志以什么级别监控哪个接口
    com.zhsh.cloud.service.OpenFeignService: debug

启动cloud-openfeign80
访问 http://localhost/payment/openFeign/timeout

以上是本人观看尚硅谷阳哥视频所整理