OpenFeign 服务接口调用 😐😐

1、OpenFeign 简介

1-1、OpenFeign 是什么

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

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

GitHub：https://github.com/spring-cloud/spring-cloud-openfeign

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

1-2、能干嘛

Feign 旨在使编写 Java Http 客户端变得更容易，前面在使用 Ribbon+RestTemplate 时，利用 RestTemplate 对 http 请求的封装处理，形成了一套模版化的调用方法。但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以，Feign 在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。

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

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

1-3、Feign 和 OpenFeign 两者区别

Feign：

Feign 是 Spring Cloud 组件中的一个轻量级 RESTful 的 HTTP 服务客户端
Feign 内置了 Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务
Feign 的使用方式是：使用 Feign 的注解定义接口，调用这个接口，就可以调用服务注册中心的服务

1
2
3
4
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-feign</artifactId>
</dependency>

OpenFeign：

OpenFeign 是 Spring Cloud 在 Feign 的基础上支持了 SpringMVC 的注解，如@RequesMapping 等等
OpenFeign 的 @FeignClient 可以解析 SpringMVC 的 @RequestMapping 注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务

1
2
3
4
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2、OpenFeign 使用步骤

接口+注解：微服务调用接口+@FeignClient

2-1、新建 cloud-consumer-feign-order80

pom.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?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>springCloud2023</artifactId>
        <groupId>com.jcvv.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

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

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>
        <!-- Open Feign，他里面也有ribbon，所以有负载均衡 -->
        <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>
            <!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
            <groupId>com.jcvv.springcloud</groupId>
            <artifactId>cloud-api-common</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.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

application.yml

1
2
3
4
5
6
7
8
server:
    port: 80

eureka:
    client:
        register-with-eureka: false
        service-url: # 配置服务中心，openFeign去里面找服务
            defaultZone: http://eureka7001.com:7001/eureka/

主启动类

@EnableFeignClients

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.jcvv.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @Classname OrderFeginMain80
 * @Description chengzhi
 * @Created by chengzhi
 */
@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class, args);
    }
}

service 层

新建 service 接口并新增注解 @FeignClient，别忘了添加 @Component

@RequestMapping 对应调用服务端的访问地址

@FeignClient 对应调用的服务端名称

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package com.jcvv.springcloud.service;

import com.jcvv.springcloud.entities.CommonResult;
import com.jcvv.springcloud.entities.Payment;
import feign.Param;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;

/**
 * @Classname PaymentFeignService
 * @Description chengzhi
 * @Created by chengzhi
 */
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {

    @GetMapping("/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@Param("id") Long id);
}

controller 层

1
2
3
4
5
6
7
8
9
10
11
@RestController
@Slf4j
public class OrderFeginController {
    @Resource
    private PaymentFeginService paymentFeginService;

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

测试

3、OpenFeign 超时控制

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

  • 服务提供方 8001 故意写暂停程序
  • 服务消费方 80 添加超时方法 PaymentFeignService
  • 服务消费方 80 添加超时方法 OrderFeignControIIer

3-1、服务消费方 80 添加超时方法

service 层

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

controller

1
2
3
4
5
@GetMapping("/consumer/payment/feign/timeout")
public String paymentFeignTimeout() {
    //openfeign-ribbon ,客户端默认等待一秒钟
    return paymentFeignService.paymentFeignTimeout();
}

3-2、服务提供端 8001 添加超时方法

controller 层，对应服务端的调用

1
2
3
4
5
6
7
8
9
@GetMapping("/payment/feign/timeout")
public String paymentFeignTimeout() {
    try {
        TimeUnit.SECONDS.sleep(3);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    return serverPort;
}

3-3、测试

超时

Openfeign 默认超时等待为一秒，在消费方 80 配置超时时间

设置超时时限

设置 feign 客户端超时时间(OpenFeign 默认支持 ribbon)

ribbon: #指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
ReadTimeout: 5000 #指的是建立连接后从服务器读取到可用资源所用的时间
ConnectTimeout: 5000

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
server:
    port: 80

eureka:
    client:
        register-with-eureka: false
        service-url: # 配置服务中心，openFeign去里面找服务
            defaultZone: http://eureka7001.com:7001/eureka/

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

4、OpenFeign 开启日志打印

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

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

日志级别

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

4-1、添加 config 配置类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.jcvv.springcloud.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Classname FeginConfig
 * @Description chengzhi
 * @Created by chengzhi
 */
@Configuration
public class FeginConfig {
    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

4-2、application.yml 配置

application.yml 中开启日志打印

logging:
level:

feign 日志以什么级别监控哪个接口

​ com.jcvv.springcloud.service.PaymentFeignService: debug

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
server:
    port: 80

eureka:
    client:
        register-with-eureka: false
        service-url: # 配置服务中心，openFeign去里面找服务
            defaultZone: http://eureka7001.com:7001/eureka/

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

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

4-3、测试

访问地址：localhost/consumer/payment/get/1

相关链接：服务降级——Hystrix断路器