springcloud【六】OpenFeign服务调用

学习视频 https://www.bilibili.com/video/BV18E411x7eT?p=43

一、Feign的介绍

1、简介

Feign是一个声明式的Web服务客户端，让编写Web服务客户端变得非常容易，只需创建一个借口并在接口上添加注解即可。

在使用 Ribbon + RestTemplate 进行服务调用。封装了 RestTemplate 请求 ，形成了一套模板化的调用方法。但在实际开发中，对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常会针对每个微服务自行封装一些客户端类来包装这些服务依赖的调用。

所以，Feign 就是在此基础上除了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign 的实现下，我们只需要创建一个接口，并使用注解的方式来配置它（以前是Dao 接口上面标注 Mapper 注解，现在是一个微服务接口上面标注一个Feign 注解即可），即可完成对一个服务提供方的接口绑定，简化了使用 Spring cloud Ribbon 时， 自动封装服务调用客户端的开发量。

2、Feign 集成了 Ribbon

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

3、Feign和OpenFeign的区别

二、订单模块服务调用 cloud-consumer-feign-order80

1 目录结构

2 修改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>springcloud</artifactId>
        <groupId>org.example</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>
        <!--引入自定义的api通用包，可以使用Payment支付Entity-->
        <dependency>
            <groupId>org.example</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>
        <!--一般基础通用配置-->
        <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>
        <dependency>
            <groupId>com.aiguigu.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>1.0-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>
</project>

3 添加application.yml

配置端口号与Eureka注册中心

server:
  port: 80

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

4 主启动类 OrderOpenFeignMain80

开启@EnableFeignClients注解。

package org.example.springcloud;

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

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

}

5 服务调用接口 PaymentFeignService

package org.example.springcloud.service;

import org.example.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;
import org.springframework.web.bind.annotation.RequestMapping;

@Component
@FeignClient("CLOUD-PROVIDER-SERVICE") //服务名称
@RequestMapping("/payment")
public interface PaymentFeignService {
    @GetMapping(value = "/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id);
}

6 控制层 OrderFeignController

package org.example.springcloud.controller;

import org.example.springcloud.entities.CommonResult;
import org.example.springcloud.service.PaymentFeignService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * @Description:
 * @Author: fsy
 * @Date: 2020/9/29 0029 10:43
 */
@RestController
@RequestMapping("/consumer/payment")
public class OrderFeignController {

    @Resource
    private PaymentFeignService paymentFeignService;

    @GetMapping(value = "/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id){
        CommonResult paymentById =paymentFeignService.getPaymentById(id);
        return paymentById;
    };
}

7 测试

测试 http://localhost/consumer/payment/get/3

三、超时控制

Feign中引入了Ribbon依赖，Ribbon 客户端默认1s超时。对于一些计算复杂的业务，1秒可能会不够，所以我们需要自己配置超时时间。

1 超时效果

在不重新配置超时时间的情况下，写一个三秒延迟的接口，调用查看结果。

1）在8001，8002支付模块的Controller中添加如下方法

 @GetMapping("/feign/timeout")
    public String paymentFeignTimeOut() {
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return serverPort;
    }

2）PaymentFeignService中添加服务调用接口

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

3）OrderFeignController 中添加客户端调用接口

 @GetMapping("/feign/timeout")
    public String paymentFeignTimeOut(){
        return paymentFeignService.paymentFeignTimeOut();
    } ;

4）测试

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

2 超时配置

添加Ribbon的超时时间配置，加大到5秒。

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

再次测试：http://localhost/consumer/payment/feign/timeout

虽然时间慢了点，但最终结果还是出来了。

四、日志增强

1 日志级别

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

2 配置日志

1）添加配置类 FeignConfig

package org.example.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(){
        return Logger.Level.FULL;
    }
}

2）application.yml中添加配置

logging:
  level:
    #feign日志以什么级别监控哪个接口
    org.example.springcloud.service.PaymentFeignService: debug

3）测试

测试：http://localhost/consumer/payment/get/3

本文地址：https://blog.csdn.net/qq_40359932/article/details/108865401