1 Feign介绍

Feign是一个声明式的Web服务客户端，它使得编写Web服务客户端变得更加简单。它是Spring Cloud中的一个模块，用于简化对REST服务的调用。使用Feign可以通过简单的接口描述来创建一个HTTP客户端。Feign的主要目标是让远程调用更加简单、编码更少、易于维护。

Feign的核心特性

• 声明式REST客户端：Feign提供了一种声明式的方法来定义REST客户端，使得服务之间的调用变得非常简洁。

• 负载均衡：集成了Ribbon，Feign自带客户端负载均衡功能。

• 容错与断路器：通过集成Hystrix，Feign提供了断路器的支持，增加了服务的容错能力。

• 易于集成和使用：Feign天然集成于Spring Ecosystem，使其非常容易与Spring Boot应用集成使用。

• 可插拔的注解支持：Feign支持Spring MVC注解，也支持JAX-RS注解，甚至可以自定义注解。

• 可定制性：Feign提供了多种可配置的选项，包括编码器、解码器、拦截器等，让你可以根据需求定制Feign的行为。

Feign以其简洁性和强大的功能，成为了微服务架构中进行服务间调用的首选工具。通过使用Feign，可以大大简化远程服务调用的代码，提高开发效率和服务的稳定性。

2 Feign远程调用

先来看我们以前利用RestTemplate发起远程调用的代码：

存在下面的问题：

• 代码可读性差，编程体验不统一

• 参数复杂URL难以维护

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

2.1 Feign替代RestTemplate

Fegin的使用步骤如下：

1）引入依赖

我们在order-service服务的pom文件中引入feign的依赖：

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

2）添加注解

在order-service的启动类添加注解开启Feign的功能：

3）编写Feign的客户端

Feign定义接口的方式在某种程度上与Spring MVC中定义Controller很相似，这种相似性主要体现在使用注解来声明请求路径和参数等信息。

• 都广泛使用注解来定义路由、请求方法和参数绑定等。例如，Feign和Spring MVC都使用@GetMapping、@PostMapping等注解来指定HTTP请求的类型。

• 都支持使用注解来绑定请求参数，比如@RequestParam、@PathVariable、@RequestBody等。

在order-service中新建一个接口，内容如下：

package cn.cloud.order.client;import cn.cloud.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;@FeignClient("userservice")
public interface UserClient {@GetMapping("/user/{id}")User findById(@PathVariable("id") Long id);
}

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：

• 服务名称：userservice
• 请求方式：GET
• 请求路径：/user/{id}
• 请求参数：Long id
• 返回值类型：User

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。

4）测试

修改order-service中的OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate：

是不是看起来优雅多了。

5）总结

使用Feign的步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

④ 使用FeignClient中定义的方法代替RestTemplate

2.2 自定义配置

Feign可以支持很多的自定义配置，如下表所示：

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http远程调用的结果做解析，例如解析json字符串为java对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过http请求发送
feign. Contract	支持的注解格式	默认是SpringMVC的注解
feign. Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用Ribbon的重试

一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置。

配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务：

feign:client:config:userservice: # 针对某个微服务的配置loggerLevel: FULL #  日志级别

也可以针对所有服务：

feign:client:config:default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置loggerLevel: FULL #  日志级别

而日志的级别分为四种：

• NONE：不记录任何日志信息，这是默认值。
• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

Java代码方式

也可以基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：

public class DefaultFeignConfiguration  {@Beanpublic Logger.Level feignLogLevel(){return Logger.Level.BASIC; // 日志级别为BASIC}
}

如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)

2.3 Feign使用优化

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

• URLConnection：默认实现，不支持连接池

• Apache HttpClient ：支持连接池

• OKHttp：支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。

这里我们用Apache的HttpClient来演示。

1）引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖：

<!--httpClient的依赖 -->
<dependency><groupId>io.github.openfeign</groupId><artifactId>feign-httpclient</artifactId>
</dependency>

2）配置连接池

在order-service的application.yml中添加配置：

feign:client:config:default: # default全局的配置loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息httpclient:enabled: true # 开启feign对HttpClient的支持max-connections: 200 # 最大的连接数max-connections-per-route: 50 # 每个路径的最大连接数

接下来，在FeignClientFactoryBean中的loadBalance方法中打断点：

Debug方式启动order-service服务，可以看到这里的client，底层就是Apache HttpClient：

总结，Feign的优化：

1.日志级别尽量用basic

2.使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

② 配置文件开启httpClient功能，设置连接池参数

2.4 最佳实践

所谓最近实践，就是使用过程中总结的经验，最好的一种使用方式。

仔细观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：

feign客户端：

UserController：

有没有一种办法简化这种重复的代码编写呢？

继承方式

一样的代码可以通过继承来共享：

1）定义一个API接口，利用定义方法，并基于SpringMVC注解做声明。

2）Feign客户端和Controller都集成改接口

优点：

• 简单
• 实现了代码共享

缺点：

• 服务提供方、服务消费方紧耦合

• 参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

抽取方式

将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。

例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。

实现基于抽取的最佳实践

1）抽取

首先创建一个module，命名为feign-api：

项目结构：

在feign-api中然后引入feign的starter依赖

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

然后，order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

2）在order-service中使用feign-api

首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。

在order-service的pom文件中中引入feign-api的依赖：

<dependency><groupId>cn.cloud.demo</groupId><artifactId>feign-api</artifactId><version>1.0</version>
</dependency>

修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包

3）重启测试

重启后，发现服务报错了：

这是因为UserClient现在在cn.cloud.feign.clients包下，

而order-service的@EnableFeignClients注解是在cn.cloud.order包下，不在同一个包，无法扫描到UserClient。

4）解决扫描包问题

方式一：

指定Feign应该扫描的包：

@EnableFeignClients(basePackages = "cn.cloud.feign.clients")

方式二：

指定需要加载的Client接口：

@EnableFeignClients(clients = {UserClient.class})

最佳实践之自动装配

之前我们的项目都需要使用 @EnableFeignClients 来指定加载的 Feign 客户端。接下来我们将项目进行改进，使其只要引入 feign-api 模块就能实现自动加载。

在开始之前将 DefaultFeignConfiguration 修改为 FeignConfig ，进行改造之后这个类的意义也发生了改变。不仅仅是维护一个日志的 bean 对象，而是真正的被看作一个配置类。

1）在 feign-api 模块的 resource 目录下新建目录 META-INF

2）在 META-INF 目录下新建文件 spring.factories

3）进入调用 Feign 客户端的启动类那里，找到SpringBoot启动类注解，点进去。

4）找到 EnableAutoConfiguration 注解点进去，复制它的全限定名。

package org.springframework.boot.autoconfigure;import ........@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";Class<?>[] exclude() default {};String[] excludeName() default {};
}
//这里的全限定名称为  org.springframework.boot.autoconfigure.EnableAutoConfiguration

5）得到 EnableAutoConfiguration 的全限定名称后，将其作为 key 而 FeignConfig 的全限定名称作为 value 写入 spring.factories 文件中。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.cloud.feign.config.FeignConfig 

6）将调用 Feign 客户端的启动类的 @EnableFeignClients 注解删掉，拿到 FeignConfig 上。

package cn.cloud.feign.config;import feign.Logger;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** @author shenyang* @version 1.0* @Date 2024/3/17 11:42*/
@Configuration
@EnableFeignClients(basePackages = "cn.cloud.feign.clients")//开启feign功能支持，自动扫描 main启动类下的同级或者一切子目录下的feign客户端资源
public class FeignConfig {@Beanpublic Logger.Level loggerLevel() {return Logger.Level.BASIC;}
}

最后测试一下，可以发现，访问成功。

总结

在本文中，我们深入探讨了Feign——一个声明式的Web服务客户端，它作为Spring Cloud生态系统中的一个重要组成部分，极大地简化了微服务架构下服务间的HTTP调用。通过Feign，开发者可以以最少的努力实现服务之间的通信，这得益于它的声明式编程模型、集成的负载均衡、断路器支持以及与Spring生态系统的无缝集成。

我们讨论了Feign的工作原理、如何使用Feign、以及它的核心特性，这些内容为理解Feign提供了一个全面的视角。通过比较Feign与Spring MVC的定义方式，我们看到了两者之间的相似性和差异性，这不仅凸显了Feign在微服务通信方面的专注和高效，也展示了Spring生态系统内不同组件之间设计哲学的一致性和互补性。

总结而言，Feign是微服务架构中进行服务间调用的理想选择，它通过简化远程调用的复杂性，使得开发者可以更专注于业务逻辑的实现。随着微服务架构的日益普及，掌握Feign将成为每个Spring开发者的重要技能之一。希望这篇博客能够帮助你更好地理解Feign，为你的微服务旅程添砖加瓦。