2.1 KiB
2.1 KiB
Common Web 模块指引
职责边界
- 提供 Servlet Web 通用能力：请求链路标识、上下文和统一异常响应。
- 不放具体业务 Controller、路由或领域异常编排；业务错误通过
common-core的契约表达。
快速索引
| 功能 | 入口 |
|---|---|
| 链路上下文 | src/main/java/com/baiyue/common/web/CorrelationContext.java |
| 请求 ID 过滤器 | src/main/java/com/baiyue/common/web/CorrelationIdFilter.java |
| 自动配置入口 | src/main/java/com/baiyue/common/web/CommonWebAutoConfiguration.java；为只扫描自身包的服务注册异常处理器和 Correlation 过滤器 |
| 全局异常映射与业务失败指标 | src/main/java/com/baiyue/common/web/GlobalExceptionHandler.java；指标 baiyue.api.business.failures 按有限 code 标记 |
| 过滤器测试 | src/test/java/com/baiyue/common/web/CorrelationIdFilterTest.java |
| 异常响应测试 | src/test/java/com/baiyue/common/web/GlobalExceptionHandlerTest.java |
| 长整型 JSON 字符串序列化 | src/main/java/com/baiyue/common/web/LongIdJacksonConfiguration.java |
修改与验证
- 普通
BizException、参数校验和兜底系统异常统一返回 HTTP 200 + 非"200"body code；查询参数/消息解析失败使用A0400，Bean Validation 使用A0422，不要再按 HTTP 400/422 判断业务失败。 - 网关/Servlet Security 的真实 401/403、协议或基础设施错误、Warehouse readiness 503、Audit 202 与 Event Bridge 内部鉴权仍保留真实 HTTP 状态；完整边界见
../docs/统一响应约定改造方案-HTTP200.md。 - 修改自动配置时必须验证
audit-service、event-bridge-service等只扫描自身包的应用仍能加载GlobalExceptionHandler和CorrelationIdFilter。 - 修改 Correlation ID 时检查请求头兼容、线程上下文清理和日志链路。
- 从父目录运行
mvn -pl common-web -am test。 - 所有对外
Long/long值统一序列化为 JSON 字符串，避免 19 位雪花 ID 在浏览器中丢失精度；禁止业务模块重复添加局部转换器。