了解@FeignClient注解：简化服务间调用的利器

àì夳堔傛蜴生んèń 2024-04-25 08:55 7阅读 0赞

> 【辰兮要努力】：hello你好我是辰兮，很高兴你能来阅读，昵称是希望自己能不断精进，向着优秀程序员前行！  
>   
> 博客来源于项目以及编程中遇到的问题总结，偶尔会有读书分享，我会陆续更新Java前端、后台、数据库、项目案例等相关知识点总结，感谢你的阅读和关注，希望我的博客能帮助到更多的人，分享获取新知，大家一起进步!  
>   
> 吾等采石之人，应怀大教堂之心，愿我们奔赴在各自的热爱里…

## 一、基础入门 ##

![在这里插入图片描述][ebef86200f1a4b6f99912a8bc815fbb3.png]

FeignClient是Spring Cloud中的一个组件，它是基于Netflix Feign库开发的，用于简化HTTP请求的客户端。FeignClient的作用是使得开发者能够以声明式的方式定义和调用HTTP接口，而不需要手动编写低级的HTTP请求代码。

1.  **声明式API定义**：使用FeignClient可以通过编写接口的方式定义对外暴露的HTTP API。通过注解的方式，可以设置URL、请求类型、请求参数、请求体、请求头等信息。这样就能够清晰地定义服务间的通信接口。
2.  **自动化的请求和响应处理**：FeignClient会根据接口定义自动处理请求和响应。它会自动将Java对象转换为JSON或其他格式的请求体，并将响应体转换为Java对象。FeignClient还支持异常处理，可以根据响应状态码和异常类型进行相应的处理。
3.  集**成了负载均衡**：FeignClient集成了Ribbon负载均衡组件，可以实现请求的负载均衡。FeignClient会根据服务名选择可用的服务实例，将请求发送到其中一个实例上。
4.  **整合了服务发现**：FeignClient可以与Eureka等服务注册中心进行集成，自动发现可用的服务实例。通过服务名来进行服务间的通信，而不需要知道具体的实例地址。
5.  **支持自定义配置和拦截器**：FeignClient提供了一些配置选项，可以用来自定义其行为。也可以通过拦截器来拦截请求和响应，添加额外的处理逻辑。

总的来说，FeignClient使得服务间的通信变得简单和优雅，开发者只需要关注业务逻辑，而不需要处理底层的HTTP请求和响应。它提供了一种方便、高效的方式来调用服务。

--------------------

## 二、案例学习 ##

当使用FeignClient组件时，我们可以通过注解来定义和配置FeignClient接口。下面是一个案例学习，演示如何使用注解来定义和配置FeignClient接口。

首先，我们假设有一个名为"example-service"的服务，我们将使用FeignClient来调用该服务的API接口。

1.  添加依赖：首先，在pom.xml文件中添加FeignClient依赖。

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

1.  启用FeignClient：在启动类上添加`@EnableFeignClients`注解，以启用FeignClient组件。

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

1.  定义FeignClient接口：创建一个接口，使用`@FeignClient`注解来定义FeignClient接口。

@FeignClient(name = "example-service")
    public interface ExampleServiceClient {
        
        
        @GetMapping("/api/resource")
        ResponseEntity<String> getResource();
        
        @PostMapping("/api/resource")
        ResponseEntity<Void> createResource(@RequestBody ResourceDTO resourceDTO);
        
        // more API methods...
    }

在上述示例中，`@FeignClient`注解中的`name`属性是该FeignClient的名称，用于服务的发现和负载均衡。

1.  使用FeignClient接口：在需要使用FeignClient的地方，注入该接口，并调用其定义的方法即可。

@RestController
    public class ExampleController {
        
    
        @Autowired
        private ExampleServiceClient exampleServiceClient;
    
        @GetMapping("/api/resource")
        public ResponseEntity<String> getResource() {
        
            return exampleServiceClient.getResource();
        }
    
        @PostMapping("/api/resource")
        public ResponseEntity<Void> createResource(@RequestBody ResourceDTO resourceDTO) {
        
            return exampleServiceClient.createResource(resourceDTO);
        }
    
        // more API methods...
    }

这样，我们就可以使用FeignClient接口来调用"example-service"服务的API接口了。

以上是一个简单的案例，演示了如何使用注解来定义和配置FeignClient接口。通过合适的注解配置，我们可以灵活地定义和调用服务间的API接口。

--------------------

## 三、源码学习 ##

`@FeignClient`是Spring Cloud中用于声明Feign客户端的注解，用于简化 Feign 客户端的创建和使用。在编译过程中，`@FeignClient`注解会被解析并生成相应的代理类，该代理类封装了Feign客户端的调用逻辑。

以下是`@FeignClient`注解的源码讲解：

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface FeignClient {
        
        // 服务名称
        String value() default "";
        // 服务名称，与value属性相同
        String name() default "";
        // 服务URL，用于指定URL方式调用
        String url() default "";
        // 是否使用默认配置
        boolean decode404() default false;
        // 自定义配置类，用于提供额外的配置选项
        Class<?>[] configuration() default {
        };
        // 熔断降级实现类
        Class<?> fallback() default void.class;
        // 熔断降级工厂类，用于创建Fallback实例
        Class<?> fallbackFactory() default void.class;
        // 服务标签列表，用于负载均衡
        String[] qualifiers() default {
        };
        // 服务Id，用于服务发现
        String qualifier() default "";
    }

`@FeignClient`注解使用了Java的元注解`@Target`、`@Retention`和`@Documented`，确定了`@FeignClient`注解的适用范围、保留策略和文档说明。

主要的属性包括：

*  `value`和`name`属性用于指定服务名称，二者作用相同。
 *  `url`属性用于指定具体的服务URL，优先于服务发现的方式。
 *  `decode404`属性用于指定是否解码404错误响应，默认为false。如果服务返回404错误，Feign客户端会抛出`FeignException`异常。
 *  `configuration`属性可以指定自定义的配置类，用于提供额外的配置选项，如超时时间、拦截器等。
 *  `fallback`属性用于指定熔断降级实现类，当服务调用失败或超时时，会使用该实现类的备选方法。
 *  `fallbackFactory`属性与`fallback`类似，但使用fallback工厂类来创建Fallback实例。
 *  `qualifiers`和`qualifier`属性用于指定服务的负载均衡标签或服务发现的服务Id。

通过对`@FeignClient`注解的配置，可以快速定义并使用Feign客户端的接口，简化了Feign客户端的创建和使用过程。

--------------------

## 四、拓展补充 ##

FeignClient是Spring Cloud提供的一个声明式的HTTP客户端工具，它通过使用动态代理技术来实现接口的方法调用转换为HTTP请求。

主要参考FeignClient的源代码在`org.springframework.cloud.openfeign.FeignClient`类中。

1.  FeignClient注解的解析和注册：

在Spring应用程序上下文启动时，会扫描所有使用了`@FeignClient`注解的接口，并将其解析成FeignClient的配置类，然后注册到Spring容器中。在解析过程中，会根据注解的属性值来创建FeignClient的Bean。

1.  生成动态代理类：

当需要调用FeignClient接口的方法时，实际上是调用了动态代理类的方法。FeignClient使用了JDK的动态代理来生成代理类，该代理类实现了FeignClient接口，并在方法调用时将其转换为HTTP请求。

1.  使用Ribbon进行服务发现和负载均衡：

FeignClient默认集成了Ribbon负载均衡器，通过Ribbon可以实现服务的发现和负载均衡。在FeignClient的动态代理类中，会通过Ribbon选择合适的服务实例来发送HTTP请求。

1.  集成Hystrix进行熔断降级：

FeignClient还可以集成Hystrix来实现熔断降级功能。通过在`@FeignClient`注解中配置`fallback`属性，可以指定一个熔断降级实现类。当FeignClient的请求失败或超时时，会使用熔断降级实现类的备选方法进行处理。

总结起来，FeignClient通过动态代理技术将接口的方法调用转换为HTTP请求，并集成了Ribbon和Hystrix来实现服务发现、负载均衡和熔断降级功能。这样可以方便地通过接口调用方式来访问远程服务。

![在这里插入图片描述][c52d65740fe942c68ae0186add4013ac.png]

--------------------

📖☕️🌊📝📚🎩🚀  
📣非常感谢你阅读到这里，如果这篇文章对你有帮助，希望能留下你的点赞👍 关注❤️ 分享👥 留言💬thanks！！！

📚愿我们奔赴在各自的热爱里！

[ebef86200f1a4b6f99912a8bc815fbb3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/ea9d7f707c294cb79f8d9cd905eb80e2.png
[c52d65740fe942c68ae0186add4013ac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/5481659abc2040799b74ffbf45b13947.png