Java POJO/DO/DTO/BO/VO概念及应用案例分析

## 阿里规范

首先看看阿里开发手册中关于 POJO/DO/DTO/BO/VO 的相关描述内容。

**一、 编程规约**

**(一) 命名风格**

3 . 【强制】**类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。**
正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion
反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion

13 . 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

18 . 【参考】： **各层命名规约** ：
B) 领域模型命名规约
1） 数据对象：xxxDO，xxx 即为数据表名。
2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
3） 展示对象：xxxVO，xxx 一般为网页名称。
4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

**(四) OOP 规约**
13 .【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
反例：：POJO 类的 createTime 默认值为 new Date()，但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

**六、工程结构
(一) 应用分层**

4 . 【参考】：**分层领域模型规约：**

* DO（Data Object）：此对象与数据库表结构一一对应，通过 DAO 层向上传输数据源对
* DTO（Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象
* BO（Business Object）：业务对象，可以由 Service 层输出的封装业务逻辑的对象。
* Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。
* VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。

**附 2：专有名词解释**

* DO（Data Object）: 阿里巴巴专指数据库表一一对应的 POJO 类。
* POJO（Plain Ordinary Java Object）: 在本规约中，POJO 专指只有 setter/getter/toString 的
  简单类，包括 DO/DTO/BO/VO 等。

## 与 MVC 三层架构的关系

通常意义上的三层架构就是将整个业务应用划分为：表现层、业务逻辑层、数据访问层。区分层次的目的即为了“高内聚，低耦合”的思想。

* 表现层（web）：用于接收用户提交请求及响应处理。
* 业务逻辑层（service）：对数据业务逻辑处理。
* 数据访问层（dao）：该层所做事务直接操作数据库，针对数据的增添、删除、修改、更新、查找等。
  ![在这里插入图片描述](/media/202204/2022-04-18_0852240.18673776118142538.png)

由之前的相关概念，我们可以看出阿里规范中各种 Object 和三层架构的对应关系
![在这里插入图片描述](/media/202204/2022-04-18_0852240.9144192447953914.png)

* 用户发出请求，web 层接受封装为 WebQuery 查询对象，转换为服务层所要求的 ServiceQuery 查询对象，传送给服务层。服务层转化 ServiceQuery 为 Dao 层所需要的 DaoQuery，传给 Dao 层。
* Dao 层查询的数据封装为 DO 对象，传递给服务层，服务层转化为 DTO 或者 BO 对象传递给 Web 层，Web 层转化为 VO 对象，传递给页面进行渲染。

## 应用案例

[案例源码地址](https://gitee.com/pearl88/study-demo/tree/master/spring-boot-validation-demo)
模拟一个查询用户信息的接口，根据用户 ID、登录账号、邮箱，传入其中一个参数，就可以查询到该用户的基本信息及角色信息。

1. 环境搭建，创建一个 Spring Boot 工程，集成 MybatisPlus 框架，找了一个开源的项目 SQL 导入，并使用 Plus 生成三层架构代码。
2. 创建三层各自对应的查询对象

```java
@Data
public class UserInfoWebQuery {

private Integer userId;

private String loginName;

private String email;

private String phone;

private String address;
}
@Data
public class UserInfoServiceQuery {

private Integer userId;

private String loginName;

private String email;
}
@Data
public class UserInfoDbQuery {

private Integer userId;

private String loginName;

private String phone;

private String email;

}
```

3. Dao 层创建数据库查询结果对象 PO，根据 Dao 查询对象返回 PO 对象。
   PO 对象：

```java
// PO
@Data
public class UserInfoPO {

private Integer userId;

private String userName;

private String loginName;

private Integer gender;

private String phone;

private String address;

private Integer organizationId;

private String email;

List<Role> roles;
}
```

XML：

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.pearl.validation.demo.dao.UserMapper">

<select id="getUserInfo" resultMap="userInfoMap" >
        SELECT
	        base_user.* , base_role.*
        FROM
	        base_user
	    LEFT JOIN base_user_role ON ( base_user.user_id = base_user_role.user_id )
	    LEFT JOIN base_role ON (base_user_role.role_id = base_role.role_id )
        <where>
            <choose>
                <when test="userId != null">
                    base_user.user_id = #{ userId }
                </when>
                <when test="loginName != null">
                    base_user.login_name = #{ loginName }
                </when>
                <when test="email != null">
                    base_user.email = #{ email }
                </when>
            </choose>
        </where>
    </select>

</mapper>
```

Mapper 接口:

```java
public interface UserMapper extends BaseMapper<User> {
    UserInfoPO getUserInfo(UserInfoDbQuery  userInfoDbQuery );
}
```

4. 服务层创建 DTO 对象，并添加根据业务层查询对象，转换为 Dao 层查询对象，然后获取 PO 对象结果集，并封装为 DTO 对象返回
   DTO：

```java
@Data
public class UserInfoDTO {
    private Integer userId;

private String userName;

private String loginName;

private Integer gender;

private String phone;

private String address;

private Integer organizationId;

private String email;

List<Role> roles;
}
```

接口：

```java
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {

@Autowired
    UserMapper userMapper;

@Override
    public UserInfoDTO getUserInfo(UserInfoServiceQuery userInfoServiceQuery) {
        // 查询对象转换 userInfoServiceQuery=》userInfoDbQuery
        UserInfoDbQuery userInfoDbQuery=new UserInfoDbQuery();
        BeanUtils.copyProperties(userInfoServiceQuery,userInfoDbQuery);
        
        // 返回结果集转换 userInfoPO=》userInfoDTO
        UserInfoPO userInfoPO = userMapper.getUserInfo(userInfoDbQuery);
        UserInfoDTO userInfoDTO=new UserInfoDTO();
        BeanUtils.copyProperties(userInfoPO,userInfoDTO);

return userInfoDTO;
    }
}
```

5. Web 层添加接口 返回 VO
   VO：

```java
@Data
public class UserVo {

private String userName;

private String loginName;

private Integer gender;

private String phone;

private String address;

private String email;

List<Role> roles;
}
```

接口：

```java
@GetMapping("/getUserInfo")
    public UserVo getUserInfo(UserInfoWebQuery userInfoWebQuery) {
        // 转换 UserInfoWebQuery=》UserInfoServiceQuery
        UserInfoServiceQuery userInfoServiceQuery = new UserInfoServiceQuery();
        BeanUtils.copyProperties(userInfoWebQuery, userInfoServiceQuery);
        // 查询对象转换 UserInfoDTO=》UserVo
        UserInfoDTO userInfo = userService.getUserInfo(userInfoServiceQuery);
        UserVo userVo = new UserVo();
        BeanUtils.copyProperties(userInfo, userVo);
        return userVo;
    }
```

6. 访问接口，接受到 VO 对象数据![在这里插入图片描述](/media/202204/2022-04-18_0852240.4222002936958916.png)

## 案例分析

**存在的问题** ：

1. 分层领域模型，每层分的太细，导致各层都需要各种对象转换
2. 对象转换次数过多，肯定会造成性能损失
3. 各种对象太多，其中大部分字段都一样，不易于书写及维护，案例中的 Role 对象还未分层，不然更多
4. 使用 BeanUtils 进行转换，当字段名不一致时还不能转。。。

**优化措施** ：

1. 根据自己的项目和业务需求，减少相关模型分类，比如就只封装一个查询对象，因为大部分参数差不多。DTO 及 PO 我就统一封装为 BO（业务对象）对象，因为查询返回的结果，多表时肯定得使用对象封装，这时候返回的数据信息是最多的，然后 Web 根据页面显示需求，转换为需要的 VO。
2. 使用更高级的对象转换框架，比如 MapStruct
   ![在这里插入图片描述](/media/202204/2022-04-18_0852240.28690741656629637.png)

**提醒** ：
很多项目中各层 Model 采用 Map 一把梭，或者入参出参都是 jsonObject，一定程度上解决了各层转换问题，使用起来也是相当“方便”。

```java
@GetMapping("/test")
    public Map<String, Object> test(@RequestBody Map<String, Object> params) {
        return null;
    }
```

但是千万别这么干，所谓开发一时爽，xxxxxx：

1. 不易于维护，参数出参都是 Map，别人接手时肯定会 xxx，不知道里面放的是啥
2. 使用 Swagger 时，无法识别当前出参入参的字段说明
3. 不便于参数校验，用用 spring 中的 @Validated 就知道
4. 可能不兼容其他框架，比如之前使用 MybatisPlus 时，实体类为 Map 就会存在问题