DDD的类命名规范

以你之姓@ 2022-10-07 03:53 285阅读 0赞

### 文章目录 ###

*  DDD的类命名规范
 *   *  前言
     *  用户界面层的类命名规范
     *  应用层的类命名规范
     *  领域层的类命名规范
     *  基础设施层的类命名规范
     *  其它的类命名规范
     *  参考文档

# DDD的类命名规范 #

## 前言 ##

本文整理了DDD的类命名规范，供参考。

下面按照DDD分层架构进行说明：

*  用户界面层
 *  应用层
 *  领域层
 *  基础设施层

将各个层都会用到的类归到其他的类命名规范中。

## 用户界面层的类命名规范 ##

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>说明</th> 
   <th>建议命名</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>控制器（Controller）</td> 
   <td>MVC控制器</td> 
   <td>XXXController</td> 
   <td>TransferController</td> 
  </tr> 
 </tbody> 
</table>

## 应用层的类命名规范 ##

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>说明</th> 
   <th>建议命名</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>应用服务类（Application Service）</td> 
   <td>封装了技术逻辑，协调者，调用领域层，本身不负责业务逻辑。与领域服务类（Domain Service)同名时，通过类路径来区分。</td> 
   <td>XXXService</td> 
   <td>FundsTransferService</td> 
  </tr> 
 </tbody> 
</table>

## 领域层的类命名规范 ##

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>说明</th> 
   <th>建议命名</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>实体（Entity）</td> 
   <td>名词</td> 
   <td>XXX</td> 
   <td>Account<br>BrokderageAccount<br>Customer<br>Order<br>Invoice<br>Cargo</td> 
  </tr> 
  <tr> 
   <td>值对象（Value Object)</td> 
   <td>名词</td> 
   <td>XXX</td> 
   <td>Address<br>SalesContact<br>Role</td> 
  </tr> 
  <tr> 
   <td>策略（Policy)</td> 
   <td>业务惯例，约束</td> 
   <td>XXXPolicy</td> 
   <td>OverbookingPolicy</td> 
  </tr> 
  <tr> 
   <td>规格（Specification）</td> 
   <td>用于表达特定类型的规则，用来替代条件逻辑，比如“拖欠票据规格”用来验证票据是否拖欠，“大额票据规格”用来判断票据是否为大额票据。参见规格模式。</td> 
   <td>XXXSpecification<br></td> 
   <td>DelinquentInvoiceSpecification<br>BigInvoiceSpecification<br>RouteSpecification</td> 
  </tr> 
  <tr> 
   <td>领域服务（Domian Service)</td> 
   <td>封装不属于任何实体/跨实体和值对象的业务逻辑</td> 
   <td>XXXService</td> 
   <td>RoutingService</td> 
  </tr> 
  <tr> 
   <td>领域事件类（Event）</td> 
   <td>领域事件</td> 
   <td>XXXEvent<br>过去式</td> 
   <td>HandlingEvent<br>BacklogItemCommited</td> 
  </tr> 
  <tr> 
   <td>存储库（Repository)</td> 
   <td>数据读写</td> 
   <td>XXXRepository</td> 
   <td>InvoiceRepository<br>TradeOrderRepository<br>CargoRepository</td> 
  </tr> 
  <tr> 
   <td>工厂类（Factory）</td> 
   <td>创建某种对象的工厂</td> 
   <td>XXXFactory</td> 
   <td>BrokerageAcccountFactory</td> 
  </tr> 
 </tbody> 
</table>

原来我将Repository放到了基础设施层，将Factory放到了其它，但是出于业务逻辑内聚的考虑，还是应该将Repository和Factory放到领域层比较合适。当然非业务逻辑的Factory也可以归到其它。

## 基础设施层的类命名规范 ##

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>说明</th> 
   <th>建议命名</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>基础设施服务（Infrastructure Service）</td> 
   <td>提供基础设施服务。与领域服务类（Domain Service)同名时，通过类路径来区分。</td> 
   <td>XXXService</td> 
   <td>MailService<br>SMSService</td> 
  </tr> 
 </tbody> 
</table>

## 其它的类命名规范 ##

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>说明</th> 
   <th>建议命名</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>助手类（Helper)</td> 
   <td>帮助完成某类操作的工具类</td> 
   <td>XXXHelper</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>工具类（Utils）</td> 
   <td>工具类</td> 
   <td>XXXUtils</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>数据传输对象（DTO，Data Transfer Object)</td> 
   <td>用来在各层之间传递数据的对象，不包含逻辑。</td> 
   <td>XXXDTO</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>视图对象（VO，View Object）</td> 
   <td>View Object本质也是一种Data Transfer Object，只不过是用在用户界面层向应用层传递数据。注意，不要和DDD的Value Object值对象搞混了。</td> 
   <td>XXXVO</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>持久化对象（PO，Persistence Object)</td> 
   <td>用来持久化数据的对象，比如对关系数据库而言一个Persistence Object可能是JPA Entity对象。需要权衡是直接使用DDD Entity来作持久化，还是复制到一个新的JPA Entity中作持久化。</td> 
   <td>XXXPO</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

领域对象（DO，Domain Object，包含Entity和Value Object) 是否直接用在界面展示和数据持久化，还是需要复制并转换成View Object再在界面展示，或转换成Persistence Object再作数据持久化需要权衡。需要考虑：

*  是否泄漏了不应该暴露的数据 （安全问题）
 *  是否读取或传输了过多的数据（性能问题）
 *  是否需要的是合并或处理后的数据（数据问题）
 *  对象复制的成本（性能问题）

## 参考文档 ##

*  [DTO – Data Transfer Objects][DTO _ Data Transfer Objects]
 *  [Martin Fowler | Data Transfer Object][Martin Fowler _ Data Transfer Object]
 *  [DDD: naming convention for Representation Layer and Domain Layer classes][DDD_ naming convention for Representation Layer and Domain Layer classes]
 *  [https://github.com/citerus/dddsample-core][https_github.com_citerus_dddsample-core]

[DTO _ Data Transfer Objects]: https://herbertograca.com/2020/06/23/dto-data-transfer-objects/
[Martin Fowler _ Data Transfer Object]: https://martinfowler.com/eaaCatalog/dataTransferObject.html
[DDD_ naming convention for Representation Layer and Domain Layer classes]: https://stackoverflow.com/questions/30085447/ddd-naming-convention-for-representation-layer-and-domain-layer-classes
[https_github.com_citerus_dddsample-core]: https://github.com/citerus/dddsample-core