io.github.dddplus.dsl

注释类型 KeyElement

@Target(value=FIELD)
 @Retention(value=SOURCE)
public @interface KeyElement

业务对象的核心属性：业务方可感知的最小完备集.

排除为了(查询，报表)等场景而冗余的宽表逻辑字段.

Example:

 

 class Order {
     ℗KeyElement(type = KeyElement.Type.Quantity, name = "totalPrice")
     private BigDecimal price;
 }
 
 

可选元素概要

可选元素

限定符和类型	可选元素和说明
boolean	byJavadoc 使用javadoc作为属性名称.
boolean	byType 该属性的名称是否根据类型来命名: 默认byName.
String	name 该属性名称在逆向建模时被修正为哪一个统一语言名称.
String	remark 补充说明.
boolean	remarkFromJavadoc 使用源代码的Javadoc作为补充说明.
KeyElement.Type[]	types 该属性属于哪些分类.

元素详细资料

types

public abstract KeyElement.Type[] types

该属性属于哪些分类.

默认值:

io.github.dddplus.dsl.KeyElement.Type.Structural

name

public abstract String name

该属性名称在逆向建模时被修正为哪一个统一语言名称.

通过该机制，可以表达把多要素组合.

例如：name = "(bizType, bizNo)".

这样，可以解决Java Annotation只能应用在单一字段的局限性.

默认值:

""

byJavadoc

public abstract boolean byJavadoc

使用javadoc作为属性名称.

默认值:

false

byType

public abstract boolean byType

该属性的名称是否根据类型来命名: 默认byName.

String sku，这样的属性是不能按类型来命名的: 无区分度

OrderLine orderLine，这样的属性适合byType = true

默认值:

false

remark

public abstract String remark

补充说明.

默认值:

""

remarkFromJavadoc

public abstract boolean remarkFromJavadoc

使用源代码的Javadoc作为补充说明.

默认值:

false