实践
思考与方案

关于DO,VO,DTO,QueryParam的思考

# 关于DO,VO,DTO,QueryParam的思考

总结一下最近项目中的一些问题

DO（Domain Object）：领域对象，就是从现实世界中抽象出来的有形或无形的业务实体。

在项目中Do的作用域用于真正操作数据库的Dao层实现类中。

VO（View Object）：视图对象，用于前端展示层，它的作用是把某个指定页面（或组件）的所有数据封装起来

在项目中涉及到-----新增、删除、修改等操作时，作为后端Controller接口的入参对象。当针对的查询语句时，可以将查询的VO对象单独定义一个，用QueryParam作为查询对象，与基本的VO区别开来

DTO（Data Transfer Object）：数据传输对象，主要用于外部接口参数传递封装，接口与接口进行传递使用

在项目中接口和接口间常常需要获取大量参数，DTO就是将这些参数封装成为一个对象，简化参数的直接传递

# 实际例子

下面用一个实际的例子展示上述几个对象在具体的开发中的作用域

本文的项目结构为如下

以一个简单的数据库为例，数据库中包含id、name、address、ctime、state五种字段，分别表示用户的id，名字，地址，数据创建事件，状态。

# POJO类设计

与之对应的DO、DTO、VO、QueryParam如下

DO：设计上需要包含所有数据库字段

package com.test.understand.pojo.domain;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.util.Date;
import lombok.Data;

@Data
@TableName("test")
public class TestDataDO {
    @TableId
    private Integer id;

    @TableField("name")
    private String name;

    @TableField("address")
    private String location;

    @TableField(value = "ctime",fill = FieldFill.INSERT)
    private Date creatTime;

    @TableField("state")
    private Byte state;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

DTO：用于接口间的传输，可以不同于DO传递接口间需要的参数，本文DTO和DO一致

package com.test.understand.pojo.dto;
import java.util.Date;
import lombok.Data;

@Data
public class TestDataDTO {

    private Integer id;

    private String name;

    private String location;

    private Date creatTime;

    private Byte state;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

VO：用于页面展示，不同于DO，有些数据库字段是不必要展示的，VO可以抛弃这些字段，如本文中的id或ctime等

package com.test.understand.pojo.vo;

import lombok.Data;

@Data
public class TestDataVO {
    private String name;

    private String location;

    private Byte state;
}

1
2
3
4
5
6
7
8
9
10
11
12

QueryParam：为了查询参数专门封装的类对象，可包含查询相关字段

package com.test.understand.pojo.query;

import lombok.Data;

@Data
public class TestDataQueryParam {
    
    private Integer id; 
    
    private String name;

    private String location;

    private Byte state;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# Controller

以最简单的增删改查为例。我们规定前端传输为JSON，对于增加、修改和删除来说，入参统一接收为VO对象。对于查询操作，我们规定入参统一为QueryParam对象。如下图红框所示：

# 类型转换

首先讲解saveOrUpdate方法和deleteTestData方法。

在这两个方法中，VO对象进入到Controller之后需要转化为DTO对象，因为后续他将经过Service-->ServiceImpl-->Dao-->DaoImpl，即接口之间的传输，其作用域在Controller进入之后到Mapper操作数据库之前。

转化的过程也很简单，可以利用spring提供的BeanUtils.copyProperites快速的将VO中的属性赋值给DTO对象，避免一堆set方法赋值的麻烦。

saveOrUpdate方法：

deleteTestData方法：

对于getTestDataLocation方法其入参QueryParam进入Controller之后无需转换，因为其包含查询字段，可直接通过Service-->ServiceImpl-->Dao-->DaoImpl传递。其作用域在Controller进入之后到Mapper操作完数据库之后的整个阶段。

getTestDataLocation方法：

# Service层

在service和serviceImpl层中，对DTO对象和QueryParam对象无需做对象类型转化

# Dao层

在Dao和DaoImpl的入参定义中，DTO和QueryParam统一不需要转换对象，因为还是接口之间的参数传递，但在DaoImpl中，操作数据库之前，需要将DTO对象转化为DO对象，而QueryParam可以选择用QueryWapper等包装类或者直接传输的方式交给Mapper操作。如下图红框所示

# Mapper层

mapper层用于真正操作数据库，这里采用Mybatis-plus中的BaseMapper提供的接口实现增删改，查询则通过Location查数据，重写一下对应的mapper.xml文件的sql即可

# 数据返回

增加删除修改等操作，前端往往只需要判断操作成功没有即可，所以返回值一般不是一个对象，对于非对象的传输可以直接返回。另外如查询操作，一般会涉及到分页，查出来的数据是List形式展现而从数据库查到的是DO对象，当这种操作返回值时会从Mapper-->Dao-->Service-->Controller一层一层返回回去，这时候就又变成了接口之间的参数传输了，DO对象显然不适合，所以还需转化为DTO对象。如下图红框操作所示，从DO的list转化为DTO的list作为返回值列表。