|
| 1 | +--- |
| 2 | +name: java/domain-modeling-convention |
| 3 | +module: java |
| 4 | +description: 领域建模规范:同一性判断、聚合间深复制、可配置单一出口与只读集合 |
| 5 | +status: 已实现 |
| 6 | +scope: 后端 |
| 7 | +source: 项目自有 |
| 8 | +--- |
| 9 | + |
| 10 | +## 解决什么问题 |
| 11 | + |
| 12 | +领域逻辑写成「外部函数 + 到处开的口子」后,模型只剩数据容器: |
| 13 | + |
| 14 | +- 同一性判断写成静态函数,散落在各个 Service 里,口径逐渐分叉; |
| 15 | +- 覆盖 `equals` 用 `id` 比较,但实体 `id` 会从 0 变为非 0,放进 `HashSet` / `HashMap` 后取不出来; |
| 16 | +- 聚合之间直接共享可变引用,改一个项目的名单,方案模板跟着变,下一次立项少人; |
| 17 | +- 「还能不能改」各处各写一遍 `state != END`,理解不一致; |
| 18 | +- 集合直接从 getter 外泄,所有「不许改」的校验被一句 `getXxx().add(...)` 绕过去。 |
| 19 | + |
| 20 | +## 如何使用 |
| 21 | + |
| 22 | +### 同一性判断属于对象 |
| 23 | + |
| 24 | +统一使用实例方法 `isSameAs`,规则固定为:**同引用,或同类且 `id` 非 0 并相等**。 |
| 25 | + |
| 26 | +- 不覆盖 `equals`:实体 `id` 会从 0 变为非 0,破坏哈希容器不变量; |
| 27 | +- 批量版本 `isSameAsAny(Collection)` 也属于对象,读作「我是否在这组里」; |
| 28 | +- 禁止写成 `containsXxx(集合, 我)` 这类外部静态函数。 |
| 29 | + |
| 30 | +### 重载歧义换名字,不靠强转 |
| 31 | + |
| 32 | +当一个类型同时实现两个都声明了 `isSameAs` 的接口时(如部门既是组织、又是参与方),「拿部门比部门」会让编译器无法选择。此时**换名字**而不是强转,例如组织侧叫 `isSameOrganizationAs`。「判断同一性的是这个对象」这条原则不变,只是名字要让编译器分得清。 |
| 33 | + |
| 34 | +### 聚合之间复制,不共享可变引用 |
| 35 | + |
| 36 | +跨聚合复制时**深复制行与值**,定义类对象(指标定义、类型定义等)仍可共用。 |
| 37 | + |
| 38 | +判断口诀:**A 的编辑动作会不会写进 B 的资料?会,就说明该复制。** |
| 39 | + |
| 40 | +### 「能不能改」只判定一次 |
| 41 | + |
| 42 | +聚合根暴露唯一的 `isConfigurable()`,所有调整动作先过 `requireConfigurable(action)`,提示语带上动作名。禁止各处自写 `state != END`,各自理解什么叫「还能改」。 |
| 43 | + |
| 44 | +### 集合出口返回只读快照 |
| 45 | + |
| 46 | +`getXxx()` 返回 `List.copyOf(...)`,要改只能走领域动作。只包一层外层列表不够,**内层对象自己的集合也要收口**。 |
| 47 | + |
| 48 | +## 使用实例 |
| 49 | + |
| 50 | +### ✅ 正确示例 |
| 51 | + |
| 52 | +```java |
| 53 | +public class Project { |
| 54 | + private long id; |
| 55 | + |
| 56 | + public boolean isSameAs(Project other) { |
| 57 | + if (this == other) { |
| 58 | + return true; |
| 59 | + } |
| 60 | + if (other == null || getClass() != other.getClass()) { |
| 61 | + return false; |
| 62 | + } |
| 63 | + return id != 0 && id == other.id; |
| 64 | + } |
| 65 | + |
| 66 | + public boolean isSameAsAny(Collection<Project> others) { |
| 67 | + return others.stream().anyMatch(this::isSameAs); |
| 68 | + } |
| 69 | +} |
| 70 | +``` |
| 71 | + |
| 72 | +```java |
| 73 | +// 深复制行与值,定义对象共用 |
| 74 | +public Project copyFrom(PlanInstance plan) { |
| 75 | + Project project = new Project(); |
| 76 | + project.items = plan.getItems().stream() |
| 77 | + .map(PlanItem::copy) |
| 78 | + .collect(Collectors.toList()); |
| 79 | + project.weight = plan.getWeight(); |
| 80 | + project.indicator = plan.getIndicator(); // 定义对象共用 |
| 81 | + return project; |
| 82 | +} |
| 83 | +``` |
| 84 | + |
| 85 | +```java |
| 86 | +// 唯一出口 + 带动作名的提示 |
| 87 | +public boolean isConfigurable() { |
| 88 | + return state != State.END; |
| 89 | +} |
| 90 | + |
| 91 | +private void requireConfigurable(String action) { |
| 92 | + if (!isConfigurable()) { |
| 93 | + throw new BusinessException("当前状态不允许" + action); |
| 94 | + } |
| 95 | +} |
| 96 | + |
| 97 | +public void adjustWeight(int weight) { |
| 98 | + requireConfigurable("调整权重"); |
| 99 | + this.weight = weight; |
| 100 | +} |
| 101 | +``` |
| 102 | + |
| 103 | +```java |
| 104 | +// 只读快照 |
| 105 | +public List<PlanItem> getItems() { |
| 106 | + return List.copyOf(items); |
| 107 | +} |
| 108 | +``` |
| 109 | + |
| 110 | +### ❌ 错误示例 |
| 111 | + |
| 112 | +```java |
| 113 | +// ❌ 覆盖 equals 用可变 id,破坏哈希容器 |
| 114 | +@Override |
| 115 | +public boolean equals(Object o) { |
| 116 | + return o instanceof Project && ((Project) o).id == this.id; |
| 117 | +} |
| 118 | +``` |
| 119 | + |
| 120 | +```java |
| 121 | +// ❌ 外部静态函数判断同一性,口径分散 |
| 122 | +public static boolean isSamePlan(Project a, Project b) { ... } |
| 123 | +public static boolean containsProject(List<Project> list, Project p) { ... } |
| 124 | +``` |
| 125 | + |
| 126 | +```java |
| 127 | +// ❌ 共享可变引用:改项目会写回模板 |
| 128 | +public Project from(PlanInstance plan) { |
| 129 | + Project project = new Project(); |
| 130 | + project.items = plan.getItems(); // 同一个 List |
| 131 | + return project; |
| 132 | +} |
| 133 | +``` |
| 134 | + |
| 135 | +```java |
| 136 | +// ❌ 「能不能改」各处自行理解 |
| 137 | +public void adjustWeight(int weight) { |
| 138 | + if (state == State.END) { // 别处可能还允许 PAUSED |
| 139 | + throw new BusinessException("已结束"); |
| 140 | + } |
| 141 | + this.weight = weight; |
| 142 | +} |
| 143 | +``` |
| 144 | + |
| 145 | +```java |
| 146 | +// ❌ 集合直接外泄 |
| 147 | +public List<PlanItem> getItems() { |
| 148 | + return items; // 调用方可直接 add / remove |
| 149 | +} |
| 150 | +``` |
| 151 | + |
| 152 | +## 自查清单 |
| 153 | + |
| 154 | +- [ ] 同一性判断是否为对象上的 `isSameAs` / `isSameAsAny` |
| 155 | +- [ ] 是否没有覆盖 `equals`(实体/聚合根) |
| 156 | +- [ ] 跨聚合复制是否深复制了行与值 |
| 157 | +- [ ] 「能不能改」是否只经 `isConfigurable()` + `requireConfigurable(action)` |
| 158 | +- [ ] 集合出口是否为只读快照,内层集合是否也收口 |
0 commit comments