服务调用 Feign

[`yudao-spring-boot-starter-rpc` (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-framework/yudao-spring-boot-starter-rpc/)技术组件，基于 Feign 实现服务之间的调用。

为什么不使用 Dubbo 呢？

Feign 通用性更强，学习成本更低，对于绝大多数场景，都能够很好的满足需求。虽然 Dubbo 提供的性能更强，特性更全，但都是非必须的。

目前国内 95% 左右都是采用 Feign，而 Dubbo 的使用率只有 5% 左右。所以，我们也选择了 Feign。

如果你对 Feign 了解较少，可以阅读 [《芋道 Spring Cloud 声明式调用 Feign 入门》 (opens new window)](https://www.iocoder.cn/Spring-Cloud/Feign/?yudao)系统学习。

## [#](https://cloud.iocoder.cn/rpc/#_1-rpc-%E4%BD%BF%E7%94%A8%E8%A7%84%E7%BA%A6)1\. RPC 使用规约

本小节，我们来讲解下项目中 RPC 使用的规约。

### [#](https://cloud.iocoder.cn/rpc/#_1-1-api-%E5%89%8D%E7%BC%80)1.1 API 前缀

API 使用 HTTP 协议，所有的 API 前缀，都以 [`/rpc-api` (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/enums/RpcConstants.java#L15)开头，方便做统一的全局处理。

### [#](https://cloud.iocoder.cn/rpc/#_1-2-api-%E6%9D%83%E9%99%90)1.2 API 权限

服务之间的调用，不需要进行权限校验，所以需要在每个服务的 SecurityConfiguration 权限配置类中，添加如下配置：

```
// RPC 服务的安全配置
registry.antMatchers(ApiConstants.PREFIX + "/**").permitAll();
```

### [#](https://cloud.iocoder.cn/rpc/#_1-3-api-%E5%85%A8%E5%B1%80%E8%BF%94%E5%9B%9E)1.3 API 全局返回

所有 API 接口返回使用 [CommonResult (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/CommonResult.java)返回，和前端 RESTful API 保持统一。例如说：

```
public interface DeptApi {

@GetMapping(PREFIX + "/get")
    @Operation(summary = "获得部门信息")
    @Parameter(name = "id", description = "部门编号", required = true, example = "1024")
    CommonResult<DeptRespDTO> getDept(@RequestParam("id") Long id);
    
}
```

### [#](https://cloud.iocoder.cn/rpc/#_1-4-%E7%94%A8%E6%88%B7%E4%BC%A0%E9%80%92)1.4 用户传递

服务调用时，已经封装 Feign 将用户信息通过 HTTP 请求头 `login-user` 传递，通过 [LoginUserRequestInterceptor (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-framework/yudao-spring-boot-starter-security/src/main/java/cn/iocoder/yudao/framework/security/core/rpc/LoginUserRequestInterceptor.java)类实现。

这样，被调用服务，可以通过 SecurityFrameworkUtils 获取到用户信息，例如说：

-   `#getLoginUser()` 方法，获取当前用户。
-   `#getLoginUserId()` 方法，获取当前用户编号。

## [#](https://cloud.iocoder.cn/rpc/#_2-%E5%A6%82%E4%BD%95%E5%AE%9A%E4%B9%89%E4%B8%80%E4%B8%AA-api-%E6%8E%A5%E5%8F%A3)2\. 如何定义一个 API 接口

本小节，我们来讲解下如何定义一个 API 接口。以 AdminUserApi 提供的 getUser 接口来举例子。

### [#](https://cloud.iocoder.cn/rpc/#_2-1-%E6%9C%8D%E5%8A%A1%E6%8F%90%E4%BE%9B%E8%80%85)2.1 服务提供者

AdminUserApi 由 `system-server` 服务所提供。

#### [#](https://cloud.iocoder.cn/rpc/#_2-1-1-apiconstants)2.1.1 ApiConstants

在 `yudao-module-system-api` 模块，创建 [ApiConstants (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/enums/ApiConstants.java)类，定义 API 相关的枚举。代码如下：

```
public class ApiConstants {

/**
     * 服务名
     *
     * 注意，需要保证和 spring.application.name 保持一致
     */
    public static final String NAME = "system-server";

public static final String PREFIX = RpcConstants.RPC_API_PREFIX +  "/system";

public static final String VERSION = "1.0.0";

}
```

#### [#](https://cloud.iocoder.cn/rpc/#_2-1-2-adminuserapi)2.1.2 AdminUserApi

在 `yudao-module-system-api` 模块，创建 [AdminUserApi (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/user/AdminUserApi.java)类，定义 API 接口。代码如下：

```
@FeignClient(name = ApiConstants.NAME) // ① @FeignClient 注解
@Tag(name = "RPC 服务 - 管理员用户") // ② Swagger 接口文档
public interface AdminUserApi {

String PREFIX = ApiConstants.PREFIX + "/user";

@GetMapping(PREFIX + "/get") // ③ Spring MVC 接口注解
    @Operation(summary = "通过用户 ID 查询用户")  // ② Swagger 接口文档
    @Parameter(name = "id", description = "部门编号", required = true, example = "1024") // ② Swagger 接口文档
    CommonResult<AdminUserRespDTO> getUser(@RequestParam("id") Long id);
    
}
```

另外，需要创建 [AdminUserRespDTO (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/user/dto/AdminUserRespDTO.java)类，定义用户 Response DTO。代码如下：

```
@Data
public class AdminUserRespDTO {

/**
     * 用户ID
     */
    private Long id;
    /**
     * 用户昵称
     */
    private String nickname;
    /**
     * 帐号状态
     *
     * 枚举 {@link CommonStatusEnum}
     */
    private Integer status;

/**
     * 部门ID
     */
    private Long deptId;
    /**
     * 岗位编号数组
     */
    private Set<Long> postIds;
    /**
     * 手机号码
     */
    private String mobile;

}
```

#### [#](https://cloud.iocoder.cn/rpc/#_2-1-3-adminuserrpcimpl)2.1.3 AdminUserRpcImpl

在 `yudao-module-system-biz` 模块，创建 [AdminUserRpcImpl (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/api/user/AdminUserApiImpl.java)类，实现 API 接口。代码如下：

```
@RestController // 提供 RESTful API 接口，给 Feign 调用
@Validated
public class AdminUserApiImpl implements AdminUserApi {

@Resource
    private AdminUserService userService;

@Override
    public CommonResult<AdminUserRespDTO> getUser(Long id) {
        AdminUserDO user = userService.getUser(id);
        return success(UserConvert.INSTANCE.convert4(user));
    }
    
}
```

### [#](https://cloud.iocoder.cn/rpc/#_2-2-%E6%9C%8D%E5%8A%A1%E6%B6%88%E8%B4%B9%E8%80%85)2.2 服务消费者

`bpm-server` 服务，调用了 AdminUserApi 接口。

#### [#](https://cloud.iocoder.cn/rpc/#_2-2-1-%E5%BC%95%E5%85%A5%E4%BE%9D%E8%B5%96)2.2.1 引入依赖

在 `yudao-module-bpm-biz` 模块的 [`pom.xml` (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-module-bpm/yudao-module-bpm-biz/pom.xml#L30-L34)，引入 `yudao-module-system-api` 模块的依赖。代码如下：

```
<dependency>
    <groupId>cn.iocoder.cloud</groupId>
    <artifactId>yudao-module-system-api</artifactId>
    <version>${revision}</version>
</dependency>
```

#### [#](https://cloud.iocoder.cn/rpc/#_2-2-2-%E5%BC%95%E7%94%A8-api)2.2.2 引用 API

在 `yudao-module-bpm-biz` 模块，创建 [RpcConfiguration (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/framework/rpc/config/RpcConfiguration.java)配置类，注入 AdminUserApi 接口。代码如下：

```
@Configuration(proxyBeanMethods = false)
@EnableFeignClients(clients = {AdminUserApi.class.class})
public class RpcConfiguration {
}
```

#### [#](https://cloud.iocoder.cn/rpc/#_2-2-3-%E8%B0%83%E7%94%A8-api)2.2.3 调用 API

例如说，[BpmTaskServiceImpl (opens new window)](https://github.com/YunaiV/yudao-cloud/blob/master/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/service/task/BpmTaskServiceImpl.java#L302)调用了 AdminUserApi 接口，代码如下：

```
@Service
public class BpmTaskServiceImpl implements BpmTaskService {

@Resource
    private AdminUserApi adminUserApi;

@Override
    public void updateTaskExtAssign(Task task) {
        // ... 省略非关键代码
        AdminUserRespDTO startUser = adminUserApi.getUser(id).getCheckedData();
    }
}
```