SpringCloud:服务调用-OpenFeign

2022-7-9

OpenFeign概述

是什么

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

作用

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

在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用.在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是一个微服务接口上面标注一个Feign注解即可)，即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

即服务提供方有哪些接口，Feign里面即有与之对应的方法直接调用。

Feign集成了Ribbon

Feign与OpenFeign的区别

OpenFeign使用步骤

以前我们在消费者服务调用生产者服务时，采用Ribbon+restTemplate进行客户端服务调用和负载均衡。现在采用OpenFeign绑定服务接口。
Feign 是使用在消费端！

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

1.建module

创建cloud-consumer-openfeign-order80 模块

2.写pom

        <!--openfeign   新增-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

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>cloud6</artifactId>
        <groupId>com.tinstu.cloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

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

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <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>com.tinstu.cloud</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>
    </dependencies>
</project>

OpenFeign整合了Ribbon，所以具有负载均衡的功能

3.写yaml

不将其注册到Eureka作为微服务，而是作为一个Feign客户端

application.yaml

server:
  port: 80

eureka:
  client:
    # 表示不将其注入Eureka作为微服务，不作为Eureak客户端了，而是作为Feign客户端
    register-with-eureka: false
    service-url:
      # 集群版
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka

4.主启动类

openFeignMain80

主启动类上添加 @EableFeignClients 注解

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

5.业务类

声明一个远程调用服务接口，不需要能被Springboot扫描到

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

新建PaymentFeignService接口并新增注解@FeignClient
@FeignClient("provider微服务名字")
注意：

这里声明的方法签名，必须和provider微服务（服务提供者微服务）中的controller中方法的签名一致
如果需要传递参数，那么@RequestParam 和@RequestBody @PathVariable 不能省必加

PaymentFeignService

@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE") //作为一个Feign功能绑定的的接口
public interface PaymentFeignService {
    @GetMapping("/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}

这样就可以找到CLOUD-PAYMENT-SERVICE微服务下面的/payment/get/{id}这个地址。

PaymentFeignService接口+@FeignClient注解，完成Feign的包装调用
指明找哪个微服务上面的地址

5.2 consumer的控制层Controller

通过自己的80 Service接口层，去调用服务提供者中的接口

OrderFeignController

@RestController
@Slf4j
public class OrderFeignController {
    //直接将PaymentFeignService的对象注入
    @Resource
    private PaymentFeignService paymentFeignService;

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

测试

先启动两个Eureka集群 7001/7002
再启动两个paymentprovider微服务 8001/8002
启动使用OpenFeign的OrderFeign80

访问:http://127.0.0.1:8001/payment/get/1,正常访问

比较符合我们的编程习惯，在80中还是controller调用service，service再去调用8001的controller。

超时控制

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

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

8001controller中暂停程序,3秒后才响应

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

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

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

1.3 消费方80添加超时方法到controller

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

测试:

访问: http://127.0.0.1:8001/payment/feign/timeout 3秒后出结果

访问: http://127.0.0.1:8001/payment/feign/timeout 404

超时报错 OpenFeign默认等待时间为1s，超过后报错

2.超时报错

OpenFeign默认等待时间为1秒钟，超过后报错

Feign 默认是支持Ribbon ，Feign依赖里自己带了Ribbon；Feign客户端的负载均衡和超时控制都由Ribbon控制

配置超时时间

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

3.0.3版本
feign.client.config.default.connect-timeout=5000 feign.client.config.default.read-timeout=5000

测试

访问: http://127.0.0.1:8001/payment/feign/timeout 3秒后正常

OpenFeign日志打印功能

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

1.日志级别

配置日志

配置在消费端

2.1 配置日志bean

FeignConfig

package com.atguigu.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.2 配置消费端的yml文件

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

2.3 查看后台日志

阅读剩余

作者：Tin

链接：http://www.tinstu.com/2235.html

文章版权归作者所有，未经允许请勿转载。

THE END

SpringCloud:服务调用-Ribbon

<<上一篇

SpringCloud:服务熔断/降级-Hystrix断路器(1)

下一篇>>