VO 对象转换、数据翻译

## 1. 对象转换
对象转换，指的是 A 类型对象，转换成 B 类型对象。例如说，我们有一个 UserDO 类型对象，需要转换成 UserVO 或者 UserDTO 类型对象。
市面上有很多的对象转换工具，例如说 MapStruct、Dozer、各种 BeanUtils、BeanCopier 等等。目前我们提供了 MapStruct、BeanUtils 两种解决方案。
相比来说，MapStruct 性能会略好于 BeanUtils，但是相比数据库操作带来的耗时来说，基本可以忽略不计。因此，一般情况下，建议使用 BeanUtils 即可。

### 1.1 MapStruct
项目使用 MapStruct (opens new window)实现 VO、DO、DTO 等对象之间的转换。
如果你没有学习过 MapStruct，需要阅读下 《芋道 Spring Boot 对象转换 MapStruct 入门》 (opens new window)文章。
在每个 yudao-module-xxx-biz 模块的 convert 包下，可以看到各个业务的 Convert 接口，如下图所示：

![](/media/202408/2024-08-27_095028_777739.png)

1.2 BeanUtils
项目提供了 BeanUtils 类，它是基于 Hutool 的 BeanUtil 封装一层。如下图所示：

![](/media/202408/2024-08-27_095046_555586.png)

1、在简单场景，直接使用 BeanUtils 的 #toBean(...) 方法，如下图所示：

![](/media/202408/2024-08-27_095057_736153.png)

2、在复杂场景，可以通过 Consumer 进一步拼接，如下图所示：

![](/media/202408/2024-08-27_095109_348092.png)

当然，如果 Consumer 的逻辑比较复杂，又希望 Controller 代码精简一点，可以放到对应的 Convert 类里，如下图所示：

![](/media/202408/2024-08-27_095127_559236.png)

## 2. 数据翻译
数据翻译，指的是将 A 类型对象的某个字段，“翻译”成 B 类型对象的某个字段。例如说，我们有一个 UserVO 的 deptId 字段，读取对应 DeptDO 的 name 字段，最终设置到 UserVO 的 deptName 字段。
一般来说，目前有两种方案：
- 方案一：数据库 SQL 联表查询，可见 《MyBatis 联表&分页查询》 文档
- 方案二：数据库多次单表查询，然后在 Java 代码中进行数据拼接（翻译）。其实就是「1.2 BeanUtils」的“复杂场景”。如下图所示：

![](/media/202408/2024-08-27_095153_012854.png)

项目里，大多数采用“方案二”，因为这样可以减少数据库的压力，避免 SQL 过于复杂，也方便后续维护。
不过如果你觉得“方案二”比较麻烦，我们也集成了 easy-trans (opens new window)框架，一个注解，搞定数据翻译。
下面，我们来分场景，看看具体如何使用！

### 2.1 场景一：模块内翻译
模块内翻译，指的是在同一个模块内，进行数据翻译。例如说，OperateLogRespVO 属于 dtpc-module-system 模块，需要读取模块内的 AdminUserDO 数据。

① 第一步，给 OperateLogRespVO 实现 com.fhs.core.trans.vo.VO 接口。

② 第二步，给 OperateLogRespVO 的 deptId 字段，添加 @Trans 注解，如下图所示：

![](/media/202408/2024-08-27_095413_116801.png)

- type 属性：使用 TransType.SIMPLE 简单翻译，使用 MyBatis Plus
- target 属性：目标 DO 实体的类，例如说 AdminUserDO.class
- fields 属性：读取 DO 实体的字段，例如说 nickname。如果是多个字段，它也是个数组
- ref 属性：设置 VO 类的字段，例如说 userNickname。如果是多个字段，可以使用 refs
更多关于 @Trans 注解的讲解，可见 《Trans 注解详解(必读)》 (opens new window)文档。

### 2.2 场景二：跨服务翻译
跨服务翻译，指的是在不同服务，通过 RPC 进行数据翻译。例如说，CrmProductRespVO 属于 dtpc-module-crm 服务，需要读取 dtpc-module-system 服务的 AdminUserRespDTO 数据。
使用上，会分成两块：
- 【自定义翻译器】在 dtpc-module-system 服务中，自定义一个 AutoTransable 数据翻译器的实现，提供 AdminUserRespDTO 的查询方法
- 【使用翻译器】在 dtpc-module-crm 服务中，使用刚定义的 AutoTransable 数据翻译器，实现数据翻译

### 2.2.1 自定义翻译器
整体参考 《AUTO_TRANS 使用》 (opens new window)文档。
① 第一步，给 AdminUserRespDTO 实现 com.fhs.core.trans.vo.VO 接口。
② 第二步，给 AdminUserApi 实现 com.fhs.trans.service.AutoTransable 接口，并实现对应的 #selectByIds(...) 和 #selectById(...) 方法，还要添加 @AutoTrans 注解，如下图所示：

![](/media/202408/2024-08-27_095555_849986.png)

其中 @AutoTrans 注解，主要是两个属性：
namespace 属性：指定数据翻译器的命名空间，需要全局唯一，这里可以直接使用 AdminUserApi 的 PREFIX
fields 属性：哪些属性可以被翻译，例如说 nickname 昵称可以被翻译

2.2.2 使用翻译器
① 第一步，给 CrmProductRespVO 实现 com.fhs.core.trans.vo.VO 接口。
② 第二步，给 CrmProductRespVO 的 ownerUserId 字段，添加 @Trans 注解，如下图所示：

![](/media/202408/2024-08-27_095642_209573.png)

- type 属性：使用 TransType.AUTO_TRANS 自定义翻译器
- key 属性：使用自定义翻译器的 namespace 属性，这里就是 AdminUserApi 的 PREFIX
- fields 和 ref 属性：同上，不重复解释

### 2.3 场景三：Excel 导出翻译
在 Excel 导出时，如果也有数据翻译的需求，需要调用 TranslateUtils的 #translate(...) 方法，如下图所示：

![](/media/202408/2024-08-27_095720_050948.png)

本质上，它就是 easy-trans 的手动翻译，可见 [《Trans 基础使用(必读)》的“3、自动翻译和手动翻译”](http://http://easy-trans.fhs-opensource.top/components/basic.html#_3%E3%80%81%E8%87%AA%E5%8A%A8%E7%BF%BB%E8%AF%91%E5%92%8C%E6%89%8B%E5%8A%A8%E7%BF%BB%E8%AF%91 "《Trans 基础使用(必读)》的“3、自动翻译和手动翻译”")

② 如果希望一个普通方法，也自动翻译，可以在方法上添加 @TransMethodResult 注解，框架会自动翻译方法 return 的值基于 Spring AOP 实现。例如说：

![](/media/202408/2024-08-27_095803_104187.png)