Spring Cloud Alibaba - Nacos（三）OpenFeign

---

文章目录

• • 一、什么是Feign
  • • 1. Feign的优势
    • 2. Spring Cloud Alibaba快速整合OpenFeign
    • • **2.1 引入依赖**
      • **2.2 添加feign接口**
      • **2.3 在启动类上添加开启Feign的注解**
      • **2.4 在调用的地方使用feign调用**
    • 3.Spring Cloud Feign的自定义配置
    • • 3.1 日志配置
      • 3.2 契约配置
      • 3.3 自定义拦截器实现认证逻辑
      • 3.4 超时时间配置
      • 3.5 客户端组件配置
      • 3.6 GZIP 压缩配置

---

在Java项目中，我们是如何实现接口调用的呢？

1）Httpclient
HttpClient 是 Apache Jakarta Common 下的子项目，用来提供高效的、最新的、功能丰富的支持 Http 协议的客户端编程工具包，并且它支持 HTTP 协议最新版本和建议。HttpClient 相比传统 JDK 自带的 URLConnection，提升了易用性和灵活性，使客户端发送 HTTP 请求变得容易，提高了开发的效率。
2）Okhttp
一个处理网络请求的开源项目，是安卓端最火的轻量级框架，由 Square 公司贡献，用于替代HttpUrlConnection 和 Apache HttpClient。OkHttp 拥有简洁的 API、高效的性能，并支持多种协议（HTTP/2 和 SPDY）。
3）RestTemplate
RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端，RestTemplate 提供了多种便捷访问远程 HTTP 服务的方法，能够大大提高客户端的编写效率。

上面介绍的是最常见的几种调用接口的方法，我们下面要介绍的方法比上面的更简单、方便，它就是 Feign。

一、什么是Feign

Feign是Netflix开发的声明式、模板化的HTTP客户端，其灵感来自Retrofit、JAXRS-2.0以及WebSocket。Feign可帮助我们更加便捷、优雅地调用HTTP API。
Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。Spring Cloud openfeign对Feign进行了增强，使其支持Spring MVC注解，另外还整合了Ribbon/LoadBalancer和Nacos，从而使得Feign的使用更加方便

1. Feign的优势

Feign可以做到使用 HTTP 请求远程服务时就像调用本地方法一样的体验，开发者完全感知不到这是远程方法，更感知不到这是个 HTTP 请求。它像 Dubbo 一样，consumer 直接调用接口方法调用 provider，而不需要通过常规的 Http Client 构造请求再解析返回数据。它解决了让开发者调用远程接口就跟调用本地方法一样，无需关注与远程的交互细节，更无需关注分布式环境开发。

2. Spring Cloud Alibaba快速整合OpenFeign

我们是基于前面两节的代码继续的，需要先看前面的项目是怎么搭建的。

2.1 引入依赖

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-openfeignartifactId>
dependency>

2.2 添加feign接口

@FeignClient(name = "stock-service", path = "/stock")
public interface StockFeign {

    @GetMapping("/reduce")
    String reduce();
}

2.3 在启动类上添加开启Feign的注解

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

2.4 在调用的地方使用feign调用

@RestController
@RequestMapping("/order")
@Slf4j
@RefreshScope
public class OrderController {

    @Resource
    private StockFeign stockFeign;

    @GetMapping("/add")
    public String add() {
        String forObject = stockFeign.reduce();
        return "添加商品成功." + forObject;
    }
}

3.Spring Cloud Feign的自定义配置

Feign 提供了很多的扩展机制，让用户可以更加灵活的使用。

3.1 日志配置

有时候我们遇到 Bug，比如接口调用失败、参数没收到等问题，或者想看看调用性能，就需要配置 Feign 的日志了，以此让 Feign 把请求信息输出来。

因为spring的默认日志级别是info，我们需要先将feign包下的都设置为debug级别，后续才能正常输出日志。

logging:
  level:
    com.alibaba.order.feign: debug

方式一：定义一个配置类，指定日志级别（方式是全局配置）

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

通过源码可以看到日志等级有 4 种，分别是：

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

方式二：局部配置，让调用的微服务生效，不将FeignConfig注入到spring容器中，而是在@FeignClient 注解中指定使用的配置类FeignConfig，

@FeignClient(name = "stock-service", path = "/stock", configuration = FeignConfig.class)
public interface StockFeign {

    @GetMapping("/reduce")
    String reduce();
}

方式三：使用yml方式配置

feign:
  client:
    config:
      stock‐service: #对应微服务
        loggerLevel: FULL # 对应日志级别

3.2 契约配置

Spring Cloud 在 Feign 的基础上做了扩展，使用 Spring MVC 的注解来完成Feign的功能。原生的 Feign 是不支持 Spring MVC 注解的，如果你想在 Spring Cloud 中使用原生的注解方式来定义客户端也是可以的，通过配置契约来改变这个配置，Spring Cloud 中默认的是 SpringMvcContract。Spring Cloud 1 早期版本就是用的原生Fegin. 随着netflix的停更替换成了Open feign

3.2.1 修改契约配置，支持Feign原生的注解

/**
* 修改契约配置，支持Feign原生的注解
* @return
*/
@Bean
public Contract feignContract() {
  return new Contract.Default();
}

注意：修改契约配置后，StockFeign不再支持springmvc的注解，需要使用Feign原生的注解

3.2.2 StockFeignService 中配置使用Feign原生的注解

@FeignClient(name = "stock-service",path = "/stock")
public interface StockFeign {
	@RequestLine("GET /reduce/{id}"){
    String reduce(@PathVariable("id") String id);
}

3.2.3 也可以通过yml配置契约，这中方式的优势是可以对某个feign单独配置

feign:
  client:
    config:
      stock‐service: #对应微服务
        loggerLevel: FULL
        contract: feign.Contract.Default #指定Feign原生注解契约配置

3.3 自定义拦截器实现认证逻辑

只需要实现RequestInterceptor接口，然后自己根据你的需求定制开发就好。

public class FeignRequestInterceptor implements RequestInterceptor {

    @Override
    public void apply(RequestTemplate requestTemplate) {
        // 业务逻辑 假设在这里带上token
        String access_token = UUID.randomUUID().toString();
        requestTemplate.header("Authorization", access_token);
    }

}

配置方式一：直接在自定义的FeignRequestInterceptor类上添加@Component注解就行，只是这是全局生效的。

配置方式二：将自定义的FeignRequestInterceptor类添加到对应的Feign中

@FeignClient(name = "stock-service", path = "/stock", configuration = {FeignConfig.class, FeignRequestInterceptor.class})
public interface StockFeign {

    @GetMapping("/reduce/{id}")
    String reduce(@PathVariable("id") String id);
}

配置方式三：使用yml配置方式

feign:
  client:
    config:
      stock‐service: #对应微服务
        loggerLevel: FULL
        requestInterceptors[0]: # 配置拦截器
          com.alibaba.order.interceptor.FeignRequestInterceptor

3.4 超时时间配置

通过 Options 可以配置连接超时时间和读取超时时间，Options 的第一个时间是连接的超时时间，默认值是 2s；第二个时间是请求处理的超时时间，默认值是 5s。

这也是全局的配置

@Bean
public Request.Options options() {
    new Request.Options(1000, TimeUnit.MILLISECONDS, 2000, TimeUnit.MILLISECONDS, true);
}

可以在yml在对应的服务下配置

feign:
  client:
    config:
      stock‐service: #对应微服务
        loggerLevel: FULL
        # 连接超时时间，默认2s
        connectTimeout: 1000
        # 读取超时时间，默认5s
        readTimeout: 3000

补充说明： Feign的底层用的是Ribbon，但超时时间以Feign配置为准，当然，本次版本是使用的loadBalancer。

3.5 客户端组件配置

Feign 中默认使用 JDK 原生的 URLConnection 发送 HTTP 请求，我们可以集成别的组件来替换掉 URLConnection，比如 Apache HttpClient，OkHttp。
Feign发起调用真正执行逻辑：feign.Client#execute （扩展点）

// 这就是feign自己实现的默认调用
@Override
public Response execute(Request request, Options options) throws IOException {
    HttpURLConnection connection = convertAndSend(request, options);
    return convertResponse(connection, request);
}

定位到FeignAutoConfiguration类，可以看到他有很多的实现，我们只需要添加对应的依赖和配置就行。

3.5.1 配置Apache HttpClient

引入依赖

 
<dependency>
    <groupId>org.apache.httpcomponentsgroupId>
    <artifactId>httpclientartifactId>
    <version>4.5.7version>
dependency>
<dependency>
    <groupId>io.github.openfeigngroupId>
    <artifactId>feign‐httpclientartifactId>
    <version>10.1.0version>
dependency>

添加yml配置

feign:
  httpclient: 
    enabled: true

3.5.2 配置OkHttp

引入依赖

 
 <dependency>
     <groupId>io.github.openfeigngroupId>
     <artifactId>feign-okhttpartifactId>
dependency>

添加yml配置

feign:
  okhttp: 
    enabled: true

3.6 GZIP 压缩配置

开启压缩可以有效节约网络资源，提升接口性能，我们可以配置 GZIP 来压缩数据：

feign:
  # 配置 GZIP 来压缩数据
  compression:
    request:
      enabled: true
      # 配置压缩的类型
      mime-types: text/xml,application/xml,application/json
      # 最小压缩值
      min-request-size: 2048
    response:
      enabled: true

注意：只有当 Feign 的 Http Client 不是 okhttp3 的时候，压缩才会生效，配置源码在FeignAcceptGzipEncodingAutoConfiguration

--------------最后感谢大家的阅读，愿大家技术越来越流弊！--------------

--------------也希望大家给我点支持，谢谢各位大佬了！！！--------------