refactor(flow): id 净化抽 BpmnIdSanitizer,补可逆 restore+碰撞消解(D7 地基)

ProcessDiagramController.sanitizeBpmnIds 的中文 id→安全 ASCII 净化逻辑抽成
BpmnIdSanitizer(sanitize 返 Result{xml,idMap} / restore 逆向还原),为 D7「发布存量
流程 key 不变」打地基。

- 双射保证:同文档两个不同中文 id hash 碰撞时基名追加 -2/-3 序号,生成 id 亦不与既有
  合法 id 冲突;非碰撞场景净化输出与旧实现逐字节一致(查看器零回归)。
- restore 前缀安全:复用 ID_ATTR 正则逐属性值精确匹配,不裸 String.replace 子串替换
  (n1 不误伤 n1x);映射外 ASCII id(设计器新增节点)原样保留。
- ProcessDiagramController.sanitizeBpmnIds 改为委托,原包级签名/行为不变。

测试:新增 BpmnIdSanitizerTest 7 例(中文全引用面 restore 逐字节还原/撞哈希 中Aa~中BB
双射/restore n1~n1x 前缀安全/合法 NCName 不改写/混合只映射中文/空 XML 防御);
既有 ProcessDiagramControllerTest 4 例零修改仍绿;flowable-service 全模块 65 测试通过。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
2026-07-02 10:10:47 +08:00
parent 7a97b712b4
commit 3cf58fe72c
3 changed files with 293 additions and 52 deletions

View File

@@ -0,0 +1,163 @@
package com.eip4.flowservice.api;
import static org.assertj.core.api.Assertions.assertThat;
import java.util.LinkedHashMap;
import java.util.Map;
import org.junit.jupiter.api.Test;
/**
* BpmnIdSanitizer 可逆双射单测:净化(中文 id→安全 ASCII)与还原(restore)严格互逆,
* 覆盖 hash 碰撞消解、restore 前缀安全、合法 id 不动、混合场景。
*
* <p>非碰撞净化输出须与 ProcessDiagramController 旧实现逐字节一致(由既有 ProcessDiagramControllerTest 兜底),
* 本类聚焦「可逆」这一新增契约。</p>
*/
class BpmnIdSanitizerTest {
/** 中文 process id + processRef/sourceRef/targetRef/default/attachedToRef 全引用面净化→restore 须逐字节还原。 */
@Test
void 净化后还原_逐字节等于原文() {
String xml = """
<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL">
<process id="总包合同交底" name="总包合同交底">
<startEvent id="start"/>
<userTask id="审批" name="审批人"/>
<boundaryEvent id="超时" attachedToRef="审批"/>
<exclusiveGateway id="gw" default="回退"/>
<sequenceFlow id="回退" sourceRef="gw" targetRef="审批"/>
<sequenceFlow id="通过" sourceRef="审批" targetRef="end"/>
<endEvent id="end"/>
</process>
<collaboration id="collab">
<participant id="part" processRef="总包合同交底"/>
</collaboration>
<bpmndi:BPMNDiagram id="di" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI">
<bpmndi:BPMNPlane bpmnElement="总包合同交底"/>
</bpmndi:BPMNDiagram>
</definitions>""";
BpmnIdSanitizer.Result r = BpmnIdSanitizer.sanitize(xml);
// 中文 id 不再出现在 id/引用类属性中;name 展示属性照旧保留中文
assertThat(r.xml()).doesNotContain("id=\"总包合同交底\"");
assertThat(r.xml()).doesNotContain("processRef=\"总包合同交底\"");
assertThat(r.xml()).doesNotContain("attachedToRef=\"审批\"");
assertThat(r.xml()).contains("name=\"总包合同交底\"");
assertThat(r.xml()).contains("name=\"审批人\"");
// idMap 覆盖全部 5 个中文 id(合法 ASCII id 不入 map)
assertThat(r.idMap()).containsOnlyKeys("总包合同交底", "审批", "超时", "回退", "通过");
// restore 逐字节还原
assertThat(BpmnIdSanitizer.restore(r.xml(), r.idMap())).isEqualTo(xml);
}
/**
* hash 碰撞消解:Java String.hashCode 下 "中Aa" 与 "中BB" 撞哈希('A'*31+'a' == 'B'*31+'B' == 2112),
* 二者又都是非法 NCName(含中文)→ 旧实现会撞成同一净化 id(非双射)。sanitize 须给两者不同净化 id,restore 仍完整还原。
*/
@Test
void 撞哈希两中文id_净化后仍双射可逆() {
// 前置自证:确实撞哈希
assertThat("中Aa".hashCode()).isEqualTo("中BB".hashCode());
String xml = """
<definitions>
<process id="p">
<userTask id="中Aa"/>
<userTask id="中BB"/>
<sequenceFlow id="f1" sourceRef="中Aa" targetRef="中BB"/>
</process>
</definitions>""";
BpmnIdSanitizer.Result r = BpmnIdSanitizer.sanitize(xml);
String s1 = r.idMap().get("中Aa");
String s2 = r.idMap().get("中BB");
// 双射:两净化 id 互不相同(否则 sourceRef/targetRef 引用会串)
assertThat(s1).isNotNull();
assertThat(s2).isNotNull();
assertThat(s1).isNotEqualTo(s2);
// 碰撞消解序号:其一为基名,另一为基名 +"-2"
assertThat(s1 + "|" + s2).containsPattern("-2");
// 净化后中文 id 消失
assertThat(r.xml()).doesNotContain("中Aa");
assertThat(r.xml()).doesNotContain("中BB");
// restore 逐字节还原(引用不串)
assertThat(BpmnIdSanitizer.restore(r.xml(), r.idMap())).isEqualTo(xml);
}
/**
* restore 前缀安全:idMap 同时含净化 id "n1" 与 "n1x"(后者以前者为前缀)。
* 裸 String.replace("n1",..) 会把 "n1x" 误伤成 "<orig1>x";必须锚定完整属性值精确匹配。
*/
@Test
void restore前缀安全_n1不误伤n1x() {
Map<String, String> idMap = new LinkedHashMap<>();
idMap.put("原A", "n1");
idMap.put("原B", "n1x");
String xml = "<userTask id=\"n1x\"/><sequenceFlow id=\"f\" sourceRef=\"n1\" targetRef=\"n1x\"/>";
String out = BpmnIdSanitizer.restore(xml, idMap);
assertThat(out).isEqualTo("<userTask id=\"原B\"/><sequenceFlow id=\"f\" sourceRef=\"原A\" targetRef=\"原B\"/>");
assertThat(out).doesNotContain("原Ax"); // 无前缀误伤
assertThat(out).doesNotContain("n1x");
assertThat(out).doesNotContain("n1\"");
}
/** 全合法 NCName id:不改写,idMap 为空,restore 无副作用。 */
@Test
void 合法NCName_id不改写_映射为空() {
String xml = "<process id=\"p\"><userTask id=\"sid-A\"/>"
+ "<sequenceFlow id=\"f1\" sourceRef=\"p\" targetRef=\"sid-A\" default=\"f1\"/></process>";
BpmnIdSanitizer.Result r = BpmnIdSanitizer.sanitize(xml);
assertThat(r.idMap()).isEmpty();
assertThat(r.xml()).isEqualTo(xml);
// 空 idMap 的 restore 原样返回
assertThat(BpmnIdSanitizer.restore(xml, r.idMap())).isEqualTo(xml);
}
/** 混合:部分中文部分合法,只映射中文者;合法 id 原样保留;restore 还原。 */
@Test
void 混合_只映射中文id_合法id原样保留() {
String xml = "<process id=\"审批流程\"><userTask id=\"legalTask\"/>"
+ "<sequenceFlow id=\"f1\" sourceRef=\"审批流程\" targetRef=\"legalTask\"/></process>";
BpmnIdSanitizer.Result r = BpmnIdSanitizer.sanitize(xml);
assertThat(r.idMap()).containsOnlyKeys("审批流程");
assertThat(r.xml()).contains("id=\"legalTask\"");
assertThat(r.xml()).contains("targetRef=\"legalTask\"");
assertThat(r.xml()).doesNotContain("审批流程");
assertThat(BpmnIdSanitizer.restore(r.xml(), r.idMap())).isEqualTo(xml);
}
/** restore 只回写映射内 id;净化后新增的 ASCII 节点 id(不在 idMap)原样保留。 */
@Test
void restore只回写映射内id_新增ascii_id保留() {
Map<String, String> idMap = new LinkedHashMap<>();
idMap.put("审批", "n5");
// n9 是设计器新增节点,不在 idMap → restore 不得改动
String xml = "<userTask id=\"n5\"/><userTask id=\"n9\"/>"
+ "<sequenceFlow id=\"f\" sourceRef=\"n5\" targetRef=\"n9\"/>";
String out = BpmnIdSanitizer.restore(xml, idMap);
assertThat(out).isEqualTo("<userTask id=\"审批\"/><userTask id=\"n9\"/>"
+ "<sequenceFlow id=\"f\" sourceRef=\"审批\" targetRef=\"n9\"/>");
}
/** null/空 XML 防御:不抛,idMap 为空。 */
@Test
void 空xml不抛_映射为空() {
assertThat(BpmnIdSanitizer.sanitize(null).idMap()).isEmpty();
assertThat(BpmnIdSanitizer.sanitize("").idMap()).isEmpty();
assertThat(BpmnIdSanitizer.restore(null, Map.of())).isNull();
assertThat(BpmnIdSanitizer.restore("<a/>", Map.of())).isEqualTo("<a/>");
}
}