如何在Spring Boot中使用OpenFeign，这一篇足够了。

忘是亡心i 2024-03-24 13:47 73阅读 0赞

[第一章 如何在Spring Boot中使用OpenFeign，这一篇足够了。][_Spring Boot_OpenFeign]  
[第二章 OpenFeign修改默认通讯协议Https][OpenFeign_Https]  
[第三章 OpenFeign默认通讯方式修改成OkHttp，包含FeignConfigruation自定义、OkHttp客户端自定义详细配置介绍][OpenFeign_OkHttp_FeignConfigruation_OkHttp]

## 什么是OpenFeign ##

OpenFeign是一个声明式、模板化的HTTP客户端，可以帮助我们更加便捷地编写基于HTTP的服务客户端。它支持多种HTTP请求方式，如GET、POST、PUT、DELETE等，并且具有负载均衡和服务发现等功能，是微服务架构中比较重要的一部分。

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

#### 文章目录 ####

*  什么是OpenFeign
 *  引入依赖
 *  一、创建Feign客户端接口
 *  二、使用步骤
 *   *  1.引入库
     *  2.注入Feign客户端
     *  3.启用Feign
 *  总结

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

## 引入依赖 ##

在Spring Boot中使用OpenFeign需要引入相应的依赖。我们可以在pom.xml文件中添加以下依赖：

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

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

## 一、创建Feign客户端接口 ##

在使用OpenFeign时，我们需要创建一个Feign客户端接口，用于定义我们想要调用的服务接口。

## 二、使用步骤 ##

### 1.引入库 ###

> 代码如下（示例）：

@FeignClient(name = "user-service")
    public interface UserServiceClient {
        
    
        @GetMapping("/users/{id}")
        User getUserById(@PathVariable("id") Long id);
    
        @PostMapping("/users")
        User createUser(@RequestBody User user);
    }

上面的代码中，我们通过@FeignClient注解指定了服务名称为user-service，并且定义了两个方法用于获取用户信息和创建用户。

### 2.注入Feign客户端 ###

代码如下（示例）：

@RestController
    public class UserController {
        
    
        @Autowired
        private UserServiceClient userServiceClient;
    
        @GetMapping("/users/{id}")
        public User getUserById(@PathVariable("id") Long id) {
        
            return userServiceClient.getUserById(id);
        }
    
        @PostMapping("/users")
        public User createUser(@RequestBody User user) {
        
            return userServiceClient.createUser(user);
        }
    }

上面的代码中，我们使用@Autowired注解将UserServiceClient注入到UserController中，并通过该客户端接口调用远程服务。

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

### 3.启用Feign ###

最后，在Spring Boot应用程序中启用OpenFeign需要在@SpringBootApplication注解上添加@EnableFeignClients注解。

代码如下（示例）：

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

上面的代码中，我们使用@Autowired注解将UserServiceClient注入到UserController中，并通过该客户端接口调用远程服务。

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

## 总结 ##

通过使用OpenFeign，我们可以更加便捷地编写HTTP服务客户端，简化了我们的开发流程。在使用OpenFeign时，需要注意定义Feign客户端接口和在其他服务中注入该接口来调用远程服务。  
下一篇：如何修改项目中openfegin的通讯协议http、okhttp等

[_Spring Boot_OpenFeign]: https://blog.csdn.net/qq_28754027/article/details/129924437
[OpenFeign_Https]: https://blog.csdn.net/qq_28754027/article/details/129927529
[OpenFeign_OkHttp_FeignConfigruation_OkHttp]: https://blog.csdn.net/qq_28754027/article/details/129927746