28 lines
1.5 KiB
Markdown
28 lines
1.5 KiB
Markdown
# Audit Service 模块指引
|
||
|
||
## 职责边界
|
||
|
||
- 负责接收 `common-audit` 产生的审计事件并持久化到 `baiyue_audit`。
|
||
- 审计注解、切面、脱敏和发送策略在 `common-audit/`；本服务不复制业务服务的审计采集逻辑。
|
||
|
||
## 快速索引
|
||
|
||
| 功能 | 入口 |
|
||
|---|---|
|
||
| 应用入口 | `src/main/java/com/baiyue/audit/BaiyueAuditApplication.java` |
|
||
| 内部接收 API | `controller/AuditIngestController.java`（`/internal/audit/events`） |
|
||
| 内部令牌保护 | `security/InternalServiceTokenGuard.java` |
|
||
| 接收 DTO | `dto/AuditIngestRequest.java` |
|
||
| 入库编排 | `service/AuditIngestService.java` |
|
||
| 持久化 | `entity/AuditLogEntity.java`、`mapper/AuditLogMapper.java`、`repository/AuditEventRepository.java` |
|
||
| 表结构 | `src/main/resources/db/audit.sql` |
|
||
| 本地/Nacos 配置 | `src/main/resources/application.yml`、`../config/nacos/{local,cn}/audit-service.yml` |
|
||
| 内部令牌测试 | `src/test/java/com/baiyue/audit/security/InternalServiceTokenGuardTest.java` |
|
||
|
||
## 修改与验证
|
||
|
||
- 内部接收接口必须受可信服务身份保护；不对前端直接开放。
|
||
- 入库前确保密码、Token、证件等敏感信息已脱敏；新增字段时同步检查 `../common-audit/src/main/java/com/baiyue/common/audit/AuditEvent.java` 与发送实现。
|
||
- 审计链路故障不得阻塞核心交易；保留幂等、超时、容量和留存策略的演进空间。
|
||
- 从父目录运行 `mvn -pl audit-service -am test`，并验证接收、拒绝非法请求和持久化结果。
|