JZTXT

各层命名规约

发布时间 2023-04-20 21:24:07作者: Jimmyhus

各层命名规约：

A）Service / DAO 层方法命名规约：
1）获取单个对象的方法用 get 做前缀。
2）获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects
3）获取统计值的方法用 count 做前缀。
4）插入的方法用 save / insert 做前缀。
5）删除的方法用 remove / delete 做前缀。
6）修改的方法用 update 做前缀。
B）领域模型命名规约：
1）数据对象：xxxDO，xxx 即为数据表名。
2）数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
3）展示对象：xxxVO，xxx 一般为网页名称。
4）POJO 是 DO / DTO / BO / VO 的统称，禁止命名成 xxxPOJO。

image

分层领域模型规约：

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

DTO（Data Transfer Object）数据传输对象

这个传输通常指的前后端之间的传输
DTO是一个比较特殊的对象，他有两种存在形式：
在后端，他的存在形式是java对象，也就是在controller里面定义的那个东东，通常在后端不需要关心怎么从json转成java对象的，这个都是由一些成熟的框架帮你完成啦，比如spring框架
在前端，他的存在形式通常是js里面的对象（也可以简单理解成json），也就是通过ajax请求的那个数据体
这也是为什么把他画成横跨两层的原因

这里可能会遇到个问题，现在微服务盛行，服务和服务之间调用的传输对象能叫DTO吗？
我的理解是看情况
DTO本身的一个隐含的意义是要能够完整的表达一个业务模块的输出
如果服务和服务之间相对独立，那就可以叫DTO
如果服务和服务之间不独立，每个都不是一个完整的业务模块，拆开可能仅仅是因为计算复杂度或者性能的问题，那这就不能够叫做DTO，只能是BO

VO（Value Object）值对象

VO就是展示用的数据，不管展示方式是网页，还是客户端，还是APP，只要是这个东西是让人看到的，这就叫VO
VO主要的存在形式就是js里面的对象（也可以简单理解成json）

VO和DTO的区别

主要有两个区别
一个是字段不一样，VO根据需要会删减一些字段
另一个是值不一样，VO会根据需要对DTO中的值进行展示业务的解释
举个简单的例子
DTO可能是这样的
{ "gender":"男", "age":35 }
对于业务一来说只需要性别，而且因为是一个古风聊天室，也不能直接展示男，因此经过业务解释业务一的VO是
{ "gender":"公子" }
对于业务二来说只需要年龄，而且不需要精确的年龄，因此经过业务解释业务二的VO是

PO（Persistant Object）持久对象

PO比较好理解
简单说PO就是数据库中的记录，一个PO的数据结构对应着库中表的结构，表中的一条记录就是一个PO对象
通常PO里面除了get，set之外没有别的方法
对于PO来说，数量是相对固定的，一定不会超过数据库表的数量
等同于Entity，这俩概念是一致的

BO（Business Object）业务对象

BO就是PO的组合
简单的例子比如说PO是一条交易记录，BO是一个人全部的交易记录集合对象
复杂点儿的例子PO1是交易记录，PO2是登录记录，PO3是商品浏览记录，PO4是添加购物车记录，PO5是搜索记录，BO是个人网站行为对象
BO是一个业务对象，一类业务就会对应一个BO，数量上没有限制，而且BO会有很多业务操作，也就是说除了get，set方法以外，BO会有很多针对自身数据进行计算的方法
为什么BO也画成横跨两层呢？原因是现在很多持久层框架自身就提供了数据组合的功能，因此BO有可能是在业务层由业务来拼装PO而成，也有可能是在数据库访问层由框架直接生成
很多情况下为了追求查询的效率，框架跳过PO直接生成BO的情况非常普遍，PO只是用来增删改使用

BO和DTO的区别

这两个的区别主要是就是字段的删减
BO对内，为了进行业务计算需要辅助数据，或者是一个业务有多个对外的接口，BO可能会含有很多接口对外所不需要的数据，因此DTO需要在BO的基础上，只要自己需要的数据，然后对外提供
在这个关系上，通常不会有数据内容的变化，内容变化要么在BO内部业务计算的时候完成，要么在解释VO的时候完成

不同复杂度业务的实际运用：

系统和系统的复杂度不同，协作水平不同，完全没有必要按照上述的分层严格执行；

  1. PO这个没法省，不管叫PO、DO还是Entity，怎么着都得有
  2. 一些工具类的系统和一些业务不是很复杂的系统DTO是可以和BO合并成一个，当业务扩展的时候注意拆分就行；
  3. 展示业务不复杂的可以不用VO，直接用DTO；

专有名词解释

  1. POJO（Plain Ordinary Java Object）： POJO 专指只有 setter / getter / toString 的简单类，包括 DO / DTO / BO / VO 等。

  2. DO（Data Object）：专指数据库表一 一对应的 POJO 类。此对象与数据库表结构一 一对应，通过 DAO 层向上传输数据源对象。

  • 一个是阿里巴巴的开发手册中的定义：DO（ Data Object）这个等同于上面的PO
  • 另一个是在DDD（Domain-Driven Design）领域驱动设计中：DO（Domain Object）这个等同于上面的BO

  1. PO（Persistent Object）：也指数据库表一 一对应的 POJO 类。此对象与数据库表结构一 一对应，通过 DAO 层向上传输数据源对象。

  2. DTO（Data Transfer Object ）：数据传输对象，Service 或 Manager 向外传输的对象。

  3. BO（Business Object）：业务对象，可以由 Service 层输出的封装业务逻辑的对象。

  4. Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。

  5. VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。