SpringCloud-Alibaba之OpenFeign

此文章主要讲解springcloud中OpenFeign服务接口调用相关知识。

Feign简介

• Feign是Netflix公司开发的声明式、模板化的HTTP客户端，其灵感来自Retrofit、JAXRS-2.0以及WebSocket。

• Feign可以帮助我们更加便捷、优雅的调用HTTP的API。

• 在SpringCloud中，使用Feign非常简单–创建一个接口，并在接口上添加一些注解，代码就完成了。

• Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。

• SpringCloud对Feign进行了增强，使得Feign支持了SpringMVC注解，并整合了Ribbon和Eureka，从而让Feign的使用更加简单。

概述

Feign 和 OpenFeign的区别

Feign和Ribbon的联系

• Ribbon是一个基于HTTP和TCP客户端的负载均衡工具。它可以在客户端配置RibbonServerList（服务端列表），使用HttpClient或者RestTemplate模拟HTTP请求，步骤相当繁琐。

• Feign是在Ribbon的基础上进行了一次改进，是一个使用起来更加方便的HTTP客户端。采用接口的方式，只需要创建一个接口，然后在上面添加注解，将需要调用的其他服务的方法定义成抽象方法即可，不需要自己构建HTTP请求。然后就像调用自身工程的方法调用个，而感觉不到调用远程方法，使得编写客户端变得非常容易。

• Feign本身已经集成了Ribbon的依赖和自动配置，因此我们不需要额外的引入依赖，也不需要再注册RestTemplate对象。我们可以通过ribbon.xx来进行全局配置，或者通过服务名.ribbon.xx来对指定的服务配置。

使用步骤

Feign 在消费端使用

新建模块

cloud-consumer-feign-order80

POM文件

<dependencies>
    <!-- Open Feign -->
    <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通用包-->
    <dependency>
        <groupId>com.itjing.springcloud</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.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <!--lombok-->
    <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>

可以看出，OpenFeign自带Ribbon ，具有负载均衡功能

YML文件

server:
  port: 80

spring:
  application:
    name: cloud-order-service

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

主启动类

@SpringBootApplication
@EnableFeignClients   //使用feign，激活开启
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class, args);
    }
}

业务类

新建Service接口

这个 service 还是 consumer模块的接口，便于测试，和提供者没有任何关系，不需要包类名一致。它使用起来就相当于是普通的 service 。

@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")  //服务名称，要和eureka上面的一致才行
public interface PaymentFeignService {
    
    @GetMapping(value = "/payment/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id);

}

新建Controller

@RestController
@Slf4j
public class OrderFeignController {

    @Resource
    private PaymentFeignService paymentFeignService;

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

启动访问测试

1. 先启动2个eureka集群 7001 和 7002
2. 再启动2个提供者 8001 和 8002
3. 启动 openfeign 的消费者 80
4. 访问： http://localhost/consumer/feign/payment/1

访问成功，并且实现负载均衡

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-uDdI6dN0-1621991110961)(https://gitee.com/xiaojinggege/blogImage/raw/master/img/image-20210117144124939.png)]

Feign的配置

从Spring Cloud Edeware开始，Feign支持使用属性自定义。对于一个指定名称的Feign Client（例如该Feign Client的名称是feignName），Feign支持如下的配置项。

# 配置Feign  
feign:
  client:
    config:
      feignName: # 自定义FeignClient的名称
        connectTimeout: 5000 # 建立连接的超时时间
        readTimeout: 5000 # 读取的超时时间
        # 配置Feign的日志级别
        loggerLevel: full
        # Feign的错误解码器，相当于代码配置方式中的ErrorDecoder
        errorDecoder: feign.codec.ErrorDecoder.Default
        # 配置重试
        retryer: feign.Retryer.Default
        # 配置请求拦截器
        requestInterceptors:
          - BasicAuthRequestInterceptor
          - BaseRequestInterceptor
        # 配置熔断不处理404异常
        decode404: false

如果需要改变所有的Feign Client，可使用默认的feign名称创建配置属性：

feign:
  client:
    config:
      default:
        connectTimeout: 5000
        readTimeout: 5000
        loggerLevel: basic

请求压缩

Spring Cloud Feign支持对请求和响应进行Gzip压缩，以减少通信过程中的性能损耗。通过下面的参数可以开启请求和响应的压缩功能。

# 配置Feign
feign:
  compression:
    request:
      enabled: true # 开启请求压缩
    response:
      enabled: true # 开启响应压缩

同时，我们也可以对请求的数据类型以及触发压缩大小的下限进行设置

# 配置Feign
feign:
  compression:
    request:
      enabled: true # 开启请求压缩
      min-request-size: 2048 # 设置触发压缩的大小下限
      mime-types: text/html,application/xml,application/json #设置压缩的数据类型
    response:
      enabled: true # 开启响应压缩

超时控制

OpenFeign 默认等待一秒钟，超过后报错。

为了避免这样的情况，有时候我们需要设置 Feign 客户端的超时控制。

在 yml 配置文件中配置

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

日志打印功能

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

在开发或者运行阶段的时候往往希望看到Feign请求过程的日志记录，默认情况下Feign的日志是没有开启的。

如果想要属性配置方式来达到日志效果，只需要在application.yml中添加如下的内容即可：

# 配置Feign
feign:
  client:
    config:
      service-product:
        # 配置Feign的日志级别
        loggerLevel: full
        
logging:
  level:
  	# feign日志以什么级别监控哪个接口
    com.itjing.springcloud.service.PaymentService: debug

• logging.level.xxx: debug：Feign日志只会对日志级别的debug做出响应。

• feign.client.config.service-product.loggerLevel：默认Feign的日志级别有四种。

• • NONE（性能最佳，适用于生产）：不记录任何日志（默认值）。
• • BASIC（适用于生产环境追踪问题）：仅记录请求方法、URL、响应状态码以及执行时间。
• • HEADERS：记录BASIC级别的基础上，记录请求和响应的header。
• • FULL（比较适用于开发和测试环境定位问题）：记录请求和响应的header、body和元数据。

也可以使用配置Bean的方式开启所有的日志功能：

@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}