Table of Contents generated with DocToc (opens new window)

• OpenFeign
  • 概述
    • Feign能干什么
    • OpenFeign与Feign的区别
  • 使用
    • openfeign服务调用
      • 接口+注解
      • 新建feign-order80模块
      • pom
      • yaml
      • 主启动类
      • 业务类
      • 测试
      • 总结
    • openfeign超时控制
    • openfeign日志打印功能
      • 可配日志级别
      • 配置方式

---

OpenFeign

概述

概念

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

它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支持可拔插式的编码器和解码器。

Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡

Feign能干什么

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

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

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

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

OpenFeign与Feign的区别

Feign	OpenFeign
Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。Feign的使用方式是:使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务	OpenFeign是Spring Cloud在Feign的基础上支持了SpringMVC的注解，如@RequesMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务。

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-feign</artifactId>
</dependency>

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

使用

openfeign服务调用

接口+注解

在微服务调用接口上增加@FeignClient注解

新建feign-order80模块

feign在consumer端使用！

pom

<dependencies>
    <!--        通用的依赖-->
    <dependency>
        <groupId>com.zdk</groupId>
        <artifactId>cloud-api-commons</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-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- eureka 客户端添加的依赖 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!--  openfeign依赖 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

依赖只需新增openfeign的即可(注册中心仍使用eureka)

yaml

server:
  port: 80

spring:
  application:
    name: cloud-consumer-service

eureka:
  client:
    # 不注册到eureka
    register-with-eureka: false
    # false表示自己端就是注册中心，我的职责就是维护服务实例，并不需要检查服务
    fetch-registry: true
    service-url:
      # 设置与 Eureka Server交互的地址查询服务和注册服务都需要依赖这个地址
      # 哪个主机（localhost）的哪个（7001）端口
      #      defaultZone: http://localhost:7001/eureka/
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

主启动类

@SpringBootApplication
@EnableDiscoveryClient
//新增此注解开启feign
@EnableFeignClients
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class, args);
    }
}

业务类

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

新建PaymentFeignService接口并新增注解@FeignClient

@Component
//指定Feign调用的服务的名称(payment8001的名称)
@FeignClient(value = "cloud-payment-service")
public interface PaymentFeignService {

    /**
     * 指定接口
     * @param id
     * @return
     */
    @GetMapping("/payment/get/{id}")
    CommonResult<Payment> getById(@PathVariable("id") Long id);
}

@Slf4j
@RestController
public class OrderFeignController {

    @Resource
    private PaymentFeignService paymentFeignService;

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

测试

访问http://localhost/consumer/payment/get/1 返回结果正确，且带有负载均衡(默认的轮询)

总结

写Feign调用的模板

openfeign超时控制

这里的超时控制，实际上是使用的Ribbon提供的，所以需要增加配置

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

注意!!!!!

在我使用的2020.0.5版本的cloud依赖中(2020及以后)，Spring官方已将除eureka之外的Netflix相关的组件(包括了Ribbon)全部移除了，负载均衡组件取而代之的是SpringCloud自己的LoadBalancer，而LoadBalancer并没有提供超时的控制(近有缓存、重试次数、健康检查等的配置)，所以不能实现此功能，需要的话可以结合hystrix

openfeign日志打印功能

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

可配日志级别

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

配置方式

增加配置类，注册一个Feign的Logger.Level对象；然后在yaml文件中开启配置

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

/**
 * @Description
 * @Author zdk
 * @Date 2022/10/28 16:51
 */
@Configuration
public class FeignConfig {
    @Bean
    public Logger.Level logLevel(){
//        return Logger.Level.NONE;
//        return Logger.Level.BASIC;
//        return Logger.Level.HEADERS;
        return Logger.Level.FULL;
    }
}

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

日志信息：