Files
ouyangxq 19745e46c1 docs(agents): pointerize duplicated DB rules and add index width guard
18 个服务与公共模块重复复制的 314 字符数据库访问约束改为指向后端根唯一定义,并给索引门禁增加防退化校验。

- 18 处重复段落合并为一句指针,规则正文只在后端根 AGENTS.md 维护
- 门禁新增路由表行宽上限(根/Admin/Client/后端根/海外 PDA),防止业务规则重新回流表格
- 同步包含此前未提交的链接与锚点、表格存在性校验
- 仅索引文档与门禁脚本,未改动业务代码
2026-10-20 12:45:41 +08:00

1.4 KiB

Common Audit 模块指引

数据库访问与中文注释约束

  • 强制继承 ../AGENTS.md 的“数据库访问与中文代码注释”全部规则;该节是分层、SQL 执行和方法/核心逻辑中文注释的唯一维护处,本模块不另设例外。

职责边界

  • 负责业务审计事件采集、注解切面、敏感字段脱敏以及日志/HTTP 输出。
  • 审计记录持久化属于 audit-service/;本模块不依赖具体业务 Entity 或数据库。

快速索引

功能 入口
审计注解与切面 src/main/java/com/baiyue/common/audit/BusinessAudit.java、BusinessAuditAspect.java
事件模型 AuditEvent.java
输出抽象与实现 AuditSink.java、LoggingAuditSink.java、HttpAuditSink.java
敏感数据脱敏 SensitiveDataSanitizer.java
baiyue.audit 配置 AuditProperties.java
自动配置 BaiyueAuditAutoConfiguration.java 与 src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

修改与验证

  • 新增审计字段时先确认不会泄露密码、令牌、证件或客户敏感数据,并检查 audit-service 接收 DTO。
  • 审计失败不应破坏核心业务;调整输出策略时保留超时、关闭开关和安全降级。
  • 从父目录运行 mvn -pl common-audit -am test,并按影响追加验证 audit-service。