Spring Cloud微服务使用OpenFeign实现调用其他模块接口方法

ゝ一世哀愁。 2022-11-25 05:28 456阅读 0赞

前言：Spring cloud微服务架构现在是最为流行的开发架构之一，它想要开发一种由多个小服务组成的应用。每个服务运行于独立的进程，并且采用轻量级交互。

**那么我们如何实现各个模块之间的调用呢？**

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

### 文章目录 ###

*   *  一。查看Eureka上的注册子服务模块
     *  二。编写映射接口类
     *  三。使用postman测试接口

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

## 一。查看Eureka上的注册子服务模块 ##

**1.这里本地注册模块为`interact-service`，调用模块为`user-service`：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70]

## 二。编写映射接口类 ##

**1.导入依赖：**

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

**2.在本地模块新建一个接口类，用于映射user-service模块中的接口：**

@FeignClient(value = "user-service", fallback = UserClientFallback.class)
    public interface UserClient { 
      
        // 根据id查询用户姓名
        @GetMapping("/api/v1/user/find/name")
        HttpRespond findNameById(@RequestParam("trainUserId") int trainUserId);
    
        // 查询当前用户信息
        @RequestMapping(value = "/api/v1/user/detail", method = RequestMethod.GET)
        HttpRespond getUserDetail();
    
        // 根据id查询用户角色信息
        @RequestMapping(value = "/api/v1/user/user_role_name_by_id", method = RequestMethod.GET)
        HttpRespond getRolesByUserId(@RequestParam("userId") Integer userId);
    
    
    }

**说明：**

1.  接口方法上需要加`@FeignClient`注解，来使用和发现其他模块的服务。其中`value`属性的值为在eureka上已经注册服务的子服务模块名称，这里的值为user-service，`fallback`属性则指定一个回调类，当发生异常错误时会回调该类中的逻辑方法：  
    ![在这里插入图片描述][20200807164620237.png]
2.  该映射接口类的访问地址，接口参数，以及接口请求方式都要与调用模块接口一致，否则映射将不成功：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 1]  
    ![在这里插入图片描述][20200807170010143.png]

**3.映射接口回调类：**

@Component
    public class UserClientFallback implements UserClient { 
        @Override
        public HttpRespond getUserDetail() { 
            return HttpRespond.unknownException();
        }
    
        @Override
        public HttpRespond findNameById(int trainUserId) { 
            return HttpRespond.unknownException();
        }
    
        @Override
        public HttpRespond getRolesByUserId(Integer userId) { 
            return HttpRespond.unknownException();
        }

**4.新建一个测试Controller，测试调用接口：**

@RestController
    @RequestMapping("/api/v1/interact/test")
    public class TestController { 
        @Autowired
        UserClient userClient;
    
        /** * 测试用户模块中根据id查找用户名接口 * @return */
        @GetMapping("/findNameById")
        public HttpRespond findNameById(){ 
            HttpRespond httpRespond = userClient.findNameById(1);
            return httpRespond;
        }
    
        /** * 测试用户模块当前用户具体信息 * @return */
        @GetMapping("/getUserDetail")
        public HttpRespond getUserDetail(){ 
    
            HttpRespond httpRespond = userClient.getUserDetail();
            return httpRespond;
        }
    
        /** * 测试用户模块根据ID查找用户角色信息 * @return */
        @GetMapping("/getRolesByUserId")
        public HttpRespond getRolesByUserId(){ 
    
            HttpRespond httpRespond = userClient.getRolesByUserId(1);
            return httpRespond;
    
        }
    
    }

**5.在SpringBoot启动类加上`@EnableFeignClients`注解，调用其他服务的api：**  
![在这里插入图片描述][20200807172842353.png]

## 三。使用postman测试接口 ##

**1.这个interact-service子模块是不含有登录处理的，所以想要我们在浏览器登录系统后在请求头拿到对应的uid以及token信息：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 2]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 3]

**2.将uid与token信息加入到postman请求头中：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 4]

**3.发送请求，请求成功返回数据：**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 5]  
**至此，基于Spring Cloud微服务架构调用其他模块接口方法已经实现。**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70]: /images/20221124/92677f2669d849fda8482ceec49f9ad9.png
[20200807164620237.png]: /images/20221124/9b0c05b8e00b49968d451017f8da6e65.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 1]: /images/20221124/453d5d46d2d44765803adf31adc19b91.png
[20200807170010143.png]: /images/20221124/7f3d40170388430cacc10fa62bc9bf02.png
[20200807172842353.png]: /images/20221124/7b1475a7d96d4e8390ce262ab112dd43.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 2]: /images/20221124/41d2b549dd10433cb32b27a7f5c5ca0d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 3]: /images/20221124/1194492b10a64f99ae602327747a0b3f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 4]: /images/20221124/b36ee21b2dca43569116fdd830edb8e2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70 5]: /images/20221124/9d263afae0c44190aa250327de25483f.png