文档

BizWorks规范注解

更新时间:

本文介绍BizWorks规范注解。

注解

含义

常用属性

说明

@ApplicationService

应用服务注解

  • domain:业务域的编码。

  • name:应用服务的名称。

  • desc:应用服务的描述。

加在接口上,声明该接口属于应用服务。

@DomainService

领域服务注解

  • domain:业务域的编码。

  • name:领域服务的名称。

  • desc:领域服务的描述。

加在类上,声明该类属于领域服务。

@DomainObject

领域对象注解

  • domain:业务域的编码。

  • name:领域对象的名称。

  • desc:领域对象的描述。

  • isAggregateRoot:是否聚合根(true/false)。

加在类上,声明该类属于领域对象。

@ValueObject

值对象注解

  • domain:业务域的编码。

  • name:值对象的名称。

  • desc:值对象的描述。

  • isAggregateRoot:是否聚合根(true/false)。

加在类上,声明该类属于值对象。

@StructureObject

结构对象注解

  • asset:业务域或者商业能力的编码。

  • assetType:模型类型(商业能力还是业务域)。

  • name:结构对象的名称。

  • desc:结构对象的描述。

加在类上,声明该类属于结构对象。

@ExtensionPoint

扩展点注解

  • domain:扩展点的编码。

  • name:扩展点的名称。

  • desc:扩展点的描述。

加在方法上,声明该方法属于扩展点。

@Field

属性注解

  • name:字段的名称。

  • value:字段的描述。

  • related:是否有对象关系。默认为false,为true时表示有对象关系。

  • relationType:对象关系,当related设置为true时,需要设置该值。

    有关联(Association),聚合(Aggregation),组合(Composition)三种关系可供设置。

  • relationDetail:对象关系重数,当related设置为true时,需要设置该值。

    有CanBeNone,CanNotBeNone两种对象关系类别可供设置。

    • 如果relationDetail = CanBeNone,当属性类型是集合(List/Set)时,那么对应的建模平台关系重数为0-N,否则对应的建模平台关系重数为0-1;

    • 如果relationDetail = CanNotBeNone,当属性类型是集合(List/Set)时,那么对应的建模平台关系重数为1-N,否则对应的建模平台关系重数为1-1。

加在属性上。

@Method

方法注解

  • name:方法的名称。

  • value:方法的描述。

加在方法上。

@Related

扩展点注解

to:扩展点指向的类。

加在方法上,扩展点不独立存在,扩展点依附于应用服务。

@Parameter

参数注解

  • name:参数的名称。

  • value:参数的描述。

加在方法入参上。

@ReturnValue

返回值注解

  • name:方法的名称。

  • value:方法的描述。

方法有返回值时加在方法上。