命名规范的设计

1、Bean的设计

API Bean：外部（DTO） extends ApiBean（来自api-common）

异常

ApiException（以Exception结尾）

入参

AbstractRequest（以Request结尾）
ApiParam/ApiExtParam（以Param结尾）

出参

ApiResponse（泛型）
ApiInfo/ApiExtInfo（以Info结尾）

 

Server Bean：内部（Domain） extends DomainBean（来自server-common）

异常（以Exception结尾）

DomainException

模型（不带后缀）

聚合根
实体
值对象

上下文（以Context、Argument等结尾，避免以Request、Param、Response、Info结尾）

converter context

2、命名设计

Facade命名

{领域名称}{场景名称：可选}{角色名称}{Read/Write}Facade
BuyOrderSellerReadFacade

API命名

{操作名称：动词或动宾结构}
create、createOrder

Request命名

{领域名称}{场景名称：可选}{角色名称}{操作名称}Request
BuyOrderSellerCreateRequest、BuyOrderSellerFindByIdRequest

Request中可以包含级别类型字段和XxxParam类型字段
BuyOrderCreateParam、BuyerParam、SellerParam

 

Response命名

ApiResponse、Response、void
BuyOrderInfo、BuyerInfo、SellerInfo

Model命名

不带后缀
BuyOrder、Buyer、Seller