《Java 消息中间件·事件驱动架构》附录 B 架构决策记录模板

import java.util.*;

public class ADRValidator {

    record ADR(String id, String title, String status, String background,
                 String factors, String options, String conclusion,
                 String consequences, String validation) {}

    static final Set<String> VALID_STATUSES = Set.of("草稿", "已接受", "已废弃");
    static final Map<String, List<String>> VALID_TRANSITIONS = Map.of(
        "草稿", List.of("已接受", "已废弃"),
        "已接受", List.of("已废弃"),
        "已废弃", List.of()
    );

    static List<String> validate(ADR adr) {
        List<String> errors = new ArrayList<>();
        if (isBlank(adr.title())) errors.add("标题缺失");
        if (isBlank(adr.status())) errors.add("状态缺失");
        if (!VALID_STATUSES.contains(adr.status())) errors.add("状态非法: " + adr.status());
        if (isBlank(adr.background())) errors.add("背景缺失");
        if (isBlank(adr.factors())) errors.add("决策因素缺失");
        if (isBlank(adr.options())) errors.add("选项对比缺失");
        if (isBlank(adr.conclusion())) errors.add("结论缺失");
        if (isBlank(adr.consequences())) errors.add("后果缺失");
        if (isBlank(adr.validation())) errors.add("验证条件缺失");
        return errors;
    }

    static boolean isBlank(String s) { return s == null || s.trim().isEmpty(); }

    static boolean canTransition(String from, String to) {
        List<String> allowed = VALID_TRANSITIONS.getOrDefault(from, List.of());
        return allowed.contains(to);
    }

    public static void main(String[] args) {
        ADR good = new ADR("ADR-001", "消息中间件选型", "已接受",
            "需要引入事件驱动架构", "吞吐、延迟、运维",
            "Kafka vs RabbitMQ vs Pulsar", "选 Kafka",
            "好处:吞吐达标;风险:运维复杂", "压测通过");

        ADR bad = new ADR("ADR-002", "", "草稿",
            "需要选序列化格式", "", "JSON vs Protobuf", "选 JSON",
            "好处:可读性高", "");

        ADR invalidTransition = new ADR("ADR-003", "一致性方案", "已废弃",
            "跨服务事务", "一致性强弱", "2PC vs Saga", "选 Saga",
            "性能好", "验证通过");

        System.out.println("=== ADR 完整性校验 ===\n");

        System.out.println("[ADR-001] 完整案例:");
        List<String> e1 = validate(good);
        System.out.println(e1.isEmpty() ? "✓ 通过" : "✗ " + e1);

        System.out.println("\n[ADR-002] 缺失字段案例:");
        List<String> e2 = validate(bad);
        e2.forEach(err -> System.out.println("  ✗ " + err));

        System.out.println("\n[ADR-003] 状态转换检查:");
        boolean ok = canTransition("已接受", "已废弃");
        System.out.println("已接受 → 已废弃: " + (ok ? "✓ 合法" : "✗ 非法"));

        boolean badTrans = canTransition("已废弃", "已接受");
        System.out.println("已废弃 → 已接受: " + (badTrans ? "✓ 合法" : "✗ 非法"));

        System.out.println("\n校验规则:");
        System.out.println("- 七个必填字段: 标题、状态、背景、因素、对比、结论、后果、验证");
        System.out.println("- 合法状态: 草稿、已接受、已废弃");
        System.out.println("- 合法转换: 草稿→已接受/已废弃, 已接受→已废弃");
    }
}

=== ADR 完整性校验 ===

[ADR-001] 完整案例:
✓ 通过

[ADR-002] 缺失字段案例:
  ✗ 标题缺失
  ✗ 决策因素缺失
  ✗ 验证条件缺失

[ADR-003] 状态转换检查:
已接受 → 已废弃: ✓ 合法
已废弃 → 已接受: ✗ 非法

校验规则:
- 七个必填字段: 标题、状态、背景、因素、对比、结论、后果、验证
- 合法状态: 草稿、已接受、已废弃
- 合法转换: 草稿→已接受/已废弃, 已接受→已废弃