外观
Base 基础组件
Base 为 EFC Web 应用提供共同的响应与请求基础。例如,一个接口返回 R.success(data) 后,客户端能读取业务码、数据和 TraceId;参数校验或业务异常也会转换为约定的 JSON 模型。
它还提供会话用户访问契约、携带请求上下文的任务执行器,以及请求读取、文件摘要和轻量数据模型。应用可以只引入 Base,先验证一个不依赖数据库、Store 或业务模块的 HTTP 接口。
能力与阅读入口
| 任务 | 能力 | 文档 |
|---|---|---|
| 接入第一个统一响应接口 | 自动装配、成功响应、校验失败与业务异常 | 快速开始 |
| 统一前后端接口协议 | 响应模型、异常映射、Long 与日期 JSON、Bean 覆盖 | 使用与配置 |
| 关联一次请求及其后台任务 | TraceId、会话用户 SPI、请求覆盖身份、上下文任务执行 | 上下文与异步任务 |
| 处理请求和轻量数据 | Header/Body/IP 读取、MD5、分组统计模型与参数扩展 | 请求与数据工具 |
接入坐标
运行时依赖为 com.own.component:springboot-component-base:4.1.0-SNAPSHOT,由 Component BOM 管理版本,Java 包前缀为 com.own.component.base。它是实际 JAR,传递引入 Constant 基础工具、Spring MVC Web、AspectJ、Validation,以及 JSON 和基础工具依赖。
BaseAutoConfiguration 已注册自动配置入口;无需扫描整个 com.own 包。MVC 转换器与 TraceId 拦截器仅在 Servlet Web 应用启用,其余基础 Bean 按缺失条件注册。
与其他组件协作
- Base 定义 SessionUserProvider 和用户接口,不实现账号登录、Token 校验或菜单授权。身份来源由应用实现,或通过 Authentication 的适配链接入。
- 通用 PO/DTO/Mapper/Service、分页和审计模型属于独立的 Base Business,不应因为名称相近而视为 Base 自带的 CRUD 能力。
- Base 提供请求 TraceId 与响应模型;操作采集和保存使用系统日志组件。它的专用日志队列与 Base 线程池是不同执行机制。
- Base 不带入数据库或 Store 后端。需要统一缓存时接入 Store 组件。
默认响应中 success 并不始终与业务码一致,MVC 与工具 JSON 也使用不同版本的 Jackson。首次接入请先验证快速开始中的成功、校验失败和业务异常三个分支,再按使用页确定应用协议。
按文件查阅方法
重点文件与方法逐项说明核心类、接口和方法重载的用途、参数、返回值、调用示例与注意事项,并链接到公开仓库对应源码。