OpenFeign入门使用（跟B站周阳老师学习SpringCloud2.0笔记）

子锋阿

已于 2022-11-17 18:40:24 修改

阅读量268

点赞数

文章标签： spring cloud java eureka

于 2022-11-16 14:54:00 首次发布

本文链接：https://blog.csdn.net/weixin_47339733/article/details/127885152

版权

1. OpenFeign是什么

官网解释：Spring Cloud

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

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

官网文档：https://github.com/spring-cloud/spring-cloud-openfeign

2. OpenFeign能干嘛

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

以前在使用ribbon+restTemple时，利用RestTemple对http请求的封装处理，形成了一套模板化的调用方法。但是实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被对多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需要创建一个接口并使用注解的方式赖配置它（以前是Dao接口上面标注Mapper注解，现在是一个微服务接口上标注一个Feign注解即可），即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自行封装服务调用客户端的开发量

2.1 Feign集成了Ribbon

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

3. Feign和OpenFeign的区别

4. OpenFeign的使用

4.1 建moudel

名字：cloud-consumer-feign-order80

注意：由于此案例是用eureka集成的ribbon，所以需要建eureka服务器，作者偷懒没有写在这里！！！！！！！！！不会的可以翻我以往的博客，Eureka2.0入门使用

4.2 改pom依赖

<?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>cloud2020</artifactId>
        <groupId>com.gzf.springcloud</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>com.gzf.springcloud</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>

4.3 新建yml文件

server:
  port: 80

eureka:
  client:
    #表示是否将自己注册进EurekaServer默认为true。
    register-with-eureka: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

4.4 修改启动类

@SpringBootApplication
@EnableFeignClients //表示自己是Feign客户端
public class OrderFeignMain80
{
    public static void main(String[] args)
    {
        SpringApplication.run(OrderFeignMain80.class,args);
    }
}

4.5 服务调用类

1. 被调用方接口

8001和8002提供的接口

@RestController
@RequestMapping("/payment")
public class PaymentController{
    
    @Value("${server.port}")
    private String serverPort;
    
    @GetMapping(value = "/lb/{id}")
    public String getPaymentLB(@PathVariable("id")String id)
    {
        return "端口号:"+serverPort+",id:"+id;
    }
}

2.服务调用类

package com.gzf.springcloud.service;

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(value = "CLOUD-PAYMENT-SERVICE") // value = 需要调用的服务名
public interface PaymentFeignService
{
    @GetMapping(value = "/payment/lb/{id}")
    String getPaymentLB(@PathVariable("id") String id);
}

4.6 服务调用

package com.gzf.springcloud.controller;

import com.gzf.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(value = "/payment/lb/{id}")
    public String getPaymentLB(@PathVariable("id") String id)
    {
        return paymentFeignService.getPaymentLB(id);
    }
}

5. OpenFeign的超时控制

服务消费方去调服务提供方，这是两个不同的微服务。一定会存在一种现象叫：超时

比如A微服务去调用B微服务，B微服务（服务提供者）处理完成需要3s，B微服务（服务提供者）执行代码是正常的，健康的。但是对于A微服务（服务消费方）而言，可能等不了3s，只能等2s。这样就会产生时间差，就会导致超时调用报错。

这时服务消费方和服务提供者就要约定好，什么样的业务下面需要用多久。

5.1 演示服务超时

@GetMapping(value = "/lb/{id}")
public String getPaymentLB(@PathVariable("id")String id) throws InterruptedException {
    Thread.sleep(100000);
    return "端口号:"+serverPort+",id:"+id;

}

服务提供方增加阻塞时间，异常显示

OpenFeign默认只会等待1s

5.2 开启OpenFeign超时控制

由于OpenFeign已经整合ribbon，所以OpenFeign的超时控制由Ribbon进行限制

修改前

server:
  port: 80

eureka:
  client:
    #表示是否将自己注册进EurekaServer默认为true。
    register-with-eureka: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

修改后

server:
  port: 80

eureka:
  client:
    #表示是否将自己注册进EurekaServer默认为true。
    register-with-eureka: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

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

6. OpenFeign的日志打印功能

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

6.1 日志级别

NONE：默认的，不显示任何日志；

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

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

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

6.2 新建配置类

package com.gzf.springcloud.cfgbeans;

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

/**
 * 开启OpenFeign日志打印
 */
@Configuration
public class FeignConfig
{
    @Bean
    Logger.Level feignLoggerLevel()
    {
        //设置日志级别
        return Logger.Level.FULL;
    }
}

6.3 修改配置文件