Feign 原理解析

本文详细解读了Feign的工作原理,涉及注解@FeignClient如何引导Ribbon负载均衡,以及FeignClientFactoryBean如何生成代理并执行请求,涵盖了从启动、实例化到请求路由的全过程。
部署运行你感兴趣的模型镜像

Feign 原理解析

基本原理

现在已经了解了 Ribbon 的负载均衡原理,我们可以来猜想下,Feign 的原理,仅仅通过一个注解 @FeignClient + 一个接口,就可以服务之间的调用。

  • 通过 @FeignClient 在注解中的name,确定服务名,然后 RibbonClient 使用服务名去获取负载均衡器 loadBalancer,再通过负载均衡算法获取到 ip:port, 然后构建的请求为 http://nacos-component-provider/test/{id},当 id = 1时,最后通过参数封装等,请求为http://nacos-component-provider/test/1,然后进行服务名替换,http://ip:port/test/1。这个就是最终的请求,也是 @FeignClient 注解的作用。
  • 那么就需要看下接口的作用了,定义了一个接口,肯定是不能调用接口的方法的,需要有实现类,这时候就就会通过代理,反射生成一个代理类,最后执行最终生成的请求。
/**
 * 定义一个REST风格的请求接口,如果 ribbon 可用,它将具备负载均衡的功能。
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FeignClient {
    // 一般为服务名
	@AliasFor("name")
	String value() default "";
}

//例子,构造的请求最终会是: http://nacos-component-provider/test/{id}
@FeignClient(value = "nacos-component-provider")
public interface ProviderClient {
    @GetMapping("test/{id}")
    String test(@PathVariable("id") Integer id);
}

Feign 初始化

要想使用 Feign,就首先需要加上 @EnableFeignClients 注解开启 Feign功能,然后创建接口和调用方法,接着加上注解 @FeignClient 就可以进行使用了。

  1. 首先 @EnableFeignClients 注解是怎么开启 Feign 功能的,可以看到注解上 @Import FeignClientsRegistrar (feign client 注册类), 将扫描后的接口注册。
//扫描我们定义的包路径(默认为@SpringBootApplication类所在的包)下带有 @FeignClient 注解的接口,然后将这些接口注册为 feign  clients 
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(FeignClientsRegistrar.class)
public @interface EnableFeignClients {

    //扫描的包路径
	String[] value() default {};

	// 扫描的包路径
	String[] basePackages() default {};
}
  1. 进入 FeignClientsRegistrar,查看 registerBeanDefinitions ,这里是使用了 @EnableFeignClients,那么这里是注册的核心逻辑

  2. 将 @FeignClient 注解的接口解析接口和注解的配置信息,包装为 一个 FeignClientFactoryBean 工厂 bean ,注册进 spring 的 beanDefinationMap中。

  3. 看到这里发现只是简单的将 beanDefinition 信息注册进 beanMap,但是还没有真正实例化,那么到底是在哪里实例化的呢?由于这个 bean 是 FeignClientFactoryBean,那么肯定是这个 bean 工厂进行创建的,进入这个类。发现一个重载的 getObject 方法,很明显这个是创建 bean 的方法,肯定是有人依赖 FeignClientBean 也就是我们这里的 ProviderClient,当被自动注入时,就会去获取getBean(ProviderClient.class) 方法,接着就会调用 bean 工厂去创建 bean。下图就是 IOC 的实际运行情况。

  4. 接着就会调用 FeignClientFactoryBean#getObject() 中创建 bean ,进入 getObject(),然后调用了 getTarget(),从 spring 容器中获取了 FeignContext 对象,可以看一下 FeignContext 什么时候注入的,发现在 FeignAutoConfiguration#feignContext() 就进行注入了,也就是 springboot 加载时,就实例化好了。FeignContext 官方注释:给每一个 client 都具有设置一个 springApplicationContext的属性,方便每个 client 获取需要的 bean。简单来说就是每个client 都可以具备 springApplicationContext 的功能。

  5. 使用 FeignContext 构造 Feign.Builder构造器,看名字可以知道就是生成 feiclient 的构造器,将需要的参数进行封装,此时的 ProviderClient 接口的调用url的前缀为:http://nacos-component-provider

  6. 调用 loadBalance() 方法,构造了 HystrixTargeter 对象,然后调用 HystrixTargeter#target 方法,发现这里调用了 Feign#target, 这里就是通过反射将之前的 Feign.Builder 创建出来代理对象,但是还有 ProviderClient 中的方法的 springmvc 的 @RequestMapping 等注解没有解析。

  7. 执行 build()方法,主要是构建配置hystrix集成所需的组件 ReflectiveFeign 对象,然后执行构建代理 bean 的核心方法newInstance(target)。

// build() 构造配置hystrix集成所需的组件 ReflectiveFeign,然后再实例化最终的 bean 对象
public <T> T target(Target<T> target) {
	return build().newInstance(target);
}
  1. 首先通过反射获取 ProviderClient 类中的所有方法,构建为 ProviderClient#test() 为key,value为对应的 methodHandler 形式的 map,其中 methodHandler 具有一个负载均衡客户端 LoadBalancerFeignClient ,用于后面使用 LoadBalancerFeignClient 调用方法,这里是为了后面获取 method上注解的属性,例如 url,httpMethod 等属性准备。

  2. 使用 jdk动态代理,创建完成代理 bean,其中 InvocationHandler 就是最终的调用方,它包括了 ProviderClient 的方法处理器等信息。到这里就是给 ProviderClient 接口构建了个代理对象,然后使用代理对象进行服务的调用。为什么用 jdk动态代理呢?很简单呀,因为这是一个接口,jdk 生成代理对象则必须要实现一个接口。

  3. 当调用 ProviderClient#test 方法时,观察注入的 ProviderClient,就是我们上一步生成好的代理对象,然后调用 ReflectiveFeign#invoke() 实现对方法的调用。

  4. 根据调用的方法,使用 dispatch 调用对应的 methodHandler,dispatch 就是之前构造代理对象中的方法映射 map,然后调用 SynchronousMethodHandler#invoke() 方法,根据方法上的注解信息 value=“test/{id}”、参数id=1,创建 RequestTemplate 对象,其中 URI=test/1。

  5. 使用 LoadBalancerFeignClient执行 request 请求,此时请求已经是一个完整的请求,调用LoadBalancerFeignClient#execute 执行请求的替换和请求调用。

  6. 通过服务名构建一个 FeignLoadBalancer(其中就是一个ZoneAwareLoadBalancer)动态获取 nacos 上服务名对应的注册的所有服务,然后再进行服务的选取,例如轮询、随机等负载均衡策略,默认是轮询可用的服务列表。

  7. 将获取到的服务 server 和旧的uri,进行组装,获取一个最终请求的uri,然后进行请求调用。使用默认的 Client#execute 执行 http 请求调用,然后获取结果,将返回结果进行处理。这就是 feignClient 的调用流程。

您可能感兴趣的与本文相关的镜像

Llama Factory

Llama Factory

模型微调
LLama-Factory

LLaMA Factory 是一个简单易用且高效的大型语言模型(Large Language Model)训练与微调平台。通过 LLaMA Factory,可以在无需编写任何代码的前提下,在本地完成上百种预训练模型的微调

<think>我们正在讨论Feign的工作原理和实现机制。根据用户提供的引用,我们可以总结如下: 1. Feign是一个声明式的HTTP客户端,用于简化HTTP API的调用。 2. 核心思想是通过接口和注解定义HTTP请求,将接口方法映射到远程服务的REST API调用。 3. 使用动态代理机制:当调用接口方法时,Feign根据方法上的注解动态构建HTTP请求并发送到远程服务,然后处理响应并返回结果。 接下来,我将详细解释Feign的工作原理和实现机制。 ### Feign的工作原理 #### 1. **声明式接口定义** - 开发者定义一个接口,使用注解(如`@RequestLine`, `@Headers`, `@Param`等)来描述HTTP请求的细节(方法、路径、参数等)。 - 例如: ```java @FeignClient(name = "service-name") public interface MyService { @RequestMapping(method = RequestMethod.GET, value = "/resource/{id}") String getResource(@PathVariable("id") String id); } ``` #### 2. **动态代理生成** - 在应用启动时,Feign会扫描所有带有`@FeignClient`注解的接口。 - 通过动态代理技术(基于JDK动态代理或CGLIB)为这些接口生成代理对象。 - 代理对象由`Feign.Builder`构建,内部使用`InvocationHandler`来处理所有方法的调用。 #### 3. **方法调用拦截** - 当调用接口方法时,实际上调用的是代理对象的方法。 - 代理对象会拦截方法调用,并根据方法上的注解信息构造HTTP请求。 - 构造过程包括: - 解析方法参数并绑定到URL路径、查询参数或请求体中。 - 设置HTTP方法(GET、POST等)、请求头(Headers)和请求体(Body)。 #### 4. **HTTP请求执行** - 构造好的HTTP请求会被交给底层的HTTP客户端(如JDK的`HttpURLConnection`、Apache `HttpClient`或OkHttp)来执行。 - 如果集成了负载均衡(如Ribbon),则会在发送请求前通过负载均衡器选择一个服务实例。 #### 5. **响应处理** - 收到HTTP响应后,Feign会根据方法返回类型(如`ResponseEntity<T>`、自定义对象等)将响应体转换为相应的Java对象。 - 转换过程使用解码器(Decoder)实现,默认支持JSON(通过Jackson)等格式。 #### 6. **错误处理** - 如果HTTP响应状态码表示错误(如4xx或5xx),Feign调用错误解码器(ErrorDecoder)将错误信息转换为异常抛出。 ### 核心实现机制 #### 1. **代理生成流程** - **扫描注册**:在Spring Cloud应用中,`FeignClientsRegistrar`负责在启动时扫描`@FeignClient`注解并注册Bean定义。 - **构建代理**:通过`Feign.Builder`创建代理实例,核心是`ReflectiveFeign`或`HystrixFeign`(如果启用了熔断)。 - **目标选择**:根据配置决定使用硬编码目标(`HardCodedTarget`)还是负载均衡目标(`LoadBalancerFeignClient`)。 #### 2. **请求模板(RequestTemplate)** - Feign使用`RequestTemplate`类来动态构建HTTP请求,它包含了方法注解解析后的所有请求信息。 - 模板中的变量(如`{id}`)会被方法参数值替换。 #### 3. **编码器与解码器** - **编码器(Encoder)**:将Java对象转换为HTTP请求体(如将对象序列化为JSON)。 - **解码器(Decoder)**:将HTTP响应体转换为Java对象(如将JSON反序列化为对象)。 #### 4. **拦截器(RequestInterceptor)** - 可以在发送请求前对请求进行修改(如添加认证头)。 - 例如: ```java public class AuthInterceptor implements RequestInterceptor { @Override public void apply(RequestTemplate template) { template.header("Authorization", "Bearer token"); } } ``` #### 5. **日志与重试** - **日志**:通过配置`Logger.Level`可以记录不同粒度的请求日志(如无日志、仅记录方法、记录请求头和请求体)。 - **重试**:通过`Retryer`接口实现重试机制(如超时重试)。 ### 流程总结 ```mermaid graph TD A[定义Feign接口] --> B(启动时生成代理) B --> C[调用接口方法] C --> D[代理拦截方法调用] D --> E[构建RequestTemplate] E --> F[应用拦截器修改请求] F --> G[选择HTTP客户端发送请求] G --> H{是否负载均衡?} H -->|是| I[通过Ribbon选择实例] H -->|否| J[直接发送到URL] I --> K[发送HTTP请求] J --> K K --> L[接收HTTP响应] L --> M{状态码正常?} M -->|是| N[解码响应体为对象] M -->|否| O[错误解码器处理] N --> P[返回结果] O --> Q[抛出异常] ``` ### 配置示例 ```yaml # 配置Feign客户端超时 feign: client: config: default: connectTimeout: 5000 readTimeout: 5000 loggerLevel: full ``` > **注意**:Feign默认不启用重试,需结合Ribbon重试或自定义`Retryer`[^4]。 --- ### 相关问题 1. **Feign与Ribbon负载均衡是如何协作的?** 2. **如何自定义Feign的编码器和解码器?** 3. **Feign在微服务调用中如何实现熔断降级?** [^1]: Feign通过动态代理将接口方法映射为HTTP请求[^1][^2] [^2]: 代理对象在运行时构建并发送HTTP请求[^2] [^3]: 声明式接口定义使得调用远程服务调用本地方法[^3] [^4]: 代理生成和请求执行是Feign的核心流程[^4]</think>### Feign 工作原理与实现机制详解 #### 🔍 核心思想 Feign 是一种**声明式 HTTP 客户端**,通过接口和注解将 Java 方法映射为 HTTP 请求,实现**远程调用如同本地方法调用**的体验。开发者只需定义接口,无需编写 HTTP 请求代码[^2][^3]。 --- ### ⚙️ 核心工作流程 #### 阶段 1:代理对象生成(启动时) 1. **接口扫描** Spring Boot 启动时扫描所有 `@FeignClient` 注解的接口,由 `FeignClientsRegistrar` 注册 Bean 定义[^4]。 2. **动态代理构建** 通过 `Feign.Builder` 创建 JDK 动态代理对象: ```java public class FeignProxyFactory { public <T> T createProxy(Class<T> interfaceType) { return (T) Proxy.newProxyInstance( interfaceType.getClassLoader(), new Class<?>[]{interfaceType}, new FeignInvocationHandler() // 核心处理器 ); } } ``` 3. **目标绑定** 根据配置选择目标类型: - `HardCodedTarget`:直连固定 URL - `LoadBalancerFeignClient`:集成 Ribbon 负载均衡[^4] #### 阶段 2:HTTP 请求执行(运行时) ```mermaid sequenceDiagram participant Client as 业务代码 participant Proxy as Feign 代理 participant Encoder as 编码器 participant ClientLB as 负载均衡客户端 participant Server as 远程服务 Client ->> Proxy: 调用接口方法 activate Proxy Proxy -->> Encoder: 1. 解析方法注解 Encoder -->> Proxy: 生成 RequestTemplate Proxy ->> ClientLB: 2. 携带模板请求 activate ClientLB ClientLB -->> ClientLB: 3. 服务发现+负载均衡 ClientLB ->> Server: 4. 发送 HTTP 请求 activate Server Server -->> ClientLB: HTTP 响应 deactivate Server ClientLB -->> Proxy: 响应数据 deactivate ClientLB Proxy -->> Decoder: 5. 响应解码 Decoder -->> Proxy: Java 对象 Proxy ->> Client: 返回结果 deactivate Proxy ``` 1. **注解解析** 通过 `MethodHandler` 解析方法上的注解: - `@RequestMapping` → HTTP 方法和路径 - `@PathVariable` → URL 路径参数 - `@RequestParam` → 查询参数 - `@RequestBody` → 请求体 2. **请求构造** 使用 `RequestTemplate` 构建 HTTP 请求: ```java RequestTemplate template = new RequestTemplate() .method(method) // GET/POST/PUT... .uri(resolvePath(args)) // 替换路径参数 .query(params) // 添加查询参数 .body(body); // 序列化请求体 ``` 3. **负载均衡与发送(集成 Ribbon 时)** `LoadBalancerFeignClient` 执行: - 从 Eureka 获取服务实例列表 - 根据负载策略选择实例 - 替换服务为实际 IP:Port - 通过底层 HTTP 客户端(如 OkHttp)发送请求 4. **响应处理** - **成功响应**:`Decoder` 将 JSON/XML 反序列化为 Java 对象 - **错误响应**:`ErrorDecoder` 转换 HTTP 错误码为异常 --- ### 🔧 核心组件 | 组件 | 作用 | 默认实现 | |---------------------|----------------------------------------------------------------------|------------------------------| | **Encoder** | 序列化请求体 | `SpringEncoder` (支持 JSON) | | **Decoder** | 反序列化响应体 | `SpringDecoder` | | **Logger** | 请求日志记录 | `Slf4jLogger` | | **Retryer** | 失败重试策略 | `NeverRetryer` (默认不重试) | | **ErrorDecoder** | 错误响应处理 | `DefaultErrorDecoder` | | **RequestInterceptor** | 请求拦截器(如添加认证头) | 无默认,需自定义 | --- ### 🛠️ 配置示例 ```yaml # 全局配置 feign: client: config: default: connectTimeout: 5000 # 连接超时(ms) readTimeout: 10000 # 读取超时(ms) loggerLevel: full # 日志级别(BASIC/FULL/NONE) encoder: com.example.CustomEncoder # 自定义编码器 ``` 自定义拦截器示例(添加认证头): ```java public class AuthInterceptor implements RequestInterceptor { @Override public void apply(RequestTemplate template) { template.header("Authorization", "Bearer xxxxx"); } } ``` --- ### ⚠️ 注意事项 1. **性能损耗** 动态代理和反射机制带来额外开销,高频调用场景需评估性能[^1]。 2. **超时配置** 必须配置合理的超时时间,避免因服务不可用导致线程阻塞。 3. **序列化兼容** 服务端与客户端的 DTO 类需保持字段兼容性,否则反序列化失败。 4. **错误处理** 建议实现自定义 `ErrorDecoder` 将 HTTP 错误转换为业务异常。 --- ### 相关问题 1. **Feign 与 Ribbon 负载均衡是如何协作的?** 2. **如何实现 Feign 的请求/响应日志全链路追踪?** 3. **Feign 在微服务调用中如何结合 Hystrix 实现熔断?** 4. **如何自定义 Feign 的编解码器以支持 Protobuf 等二进制协议?** [^1]: Feign 通过动态代理实现方法到 HTTP 请求的映射[^1][^2] [^2]: 核心是将接口方法映射为 REST API 调用[^2] [^3]: 声明式设计使远程调用如同本地方法调用[^3] [^4]: 代理生成和请求构造是 Feign 的核心流程[^4]
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值