mirror of
https://github.com/hpd840321/starRiverProperty.git
synced 2026-06-09 16:30:29 +08:00
hpd840321
7b2bd307f1
- backend/: 13 Maven modules (cw-elevator-application, cloudwalk-cloud, intelligent-cwoscomponent, ninca-crk, etc.) - frontend/: 4 Vue projects (elevator-front, cwos-portal, alarm-front, front_acs) + decompiled + scripts - scripts/: build, test-env, tools (Docker Compose, service templates, API parity) - docs/: AGENTS.md, superpowers specs, architecture docs - .gitignore: standard Java/Maven exclusions Moved from legacy maven-*/ root layout to backend/ organized structure.
57 lines
3.7 KiB
Markdown
57 lines
3.7 KiB
Markdown
# `cw-elevator-application-service` 业务逻辑文档总索引
|
||
|
||
本目录以 **本 Maven 模块源码根**（`src/main/java/cn/cloudwalk/elevator`）为范围，对电梯应用 **业务编排层** 作多维度说明：分域业务、接口级能力、用例/时序/流程等图（Mermaid）及与外部系统的协作关系。
|
||
|
||
| 元数据 | 说明 |
|
||
|--------|------|
|
||
| 模块路径 | `maven-cw-elevator-application/cw-elevator-application-service` |
|
||
| 文档根 | 本目录 `.../cw-elevator-application-service/docs/` |
|
||
| 源码包根 | `cn.cloudwalk.elevator` |
|
||
| 产出形态 | Markdown + Mermaid（可用支持 Mermaid 的 IDE、Git 站点或 [mermaid.live](https://mermaid.live) 渲染） |
|
||
|
||
## 与仓库级文档的关系
|
||
|
||
- 全仓约定、走查、接口不变等说明见仓库根下 **`../../../docs/`**（相对本文件）。
|
||
- 发布包与**历史 JAR 接口对拍**（计划/报告）见聚合工程目录 **`../../docs/elevator-api-parity/PLAN.md`**、脚本 `../../scripts/run_elevator_parity.sh`。
|
||
- 本目录专注 **本 service 模块内** 类职责与业务流程梳理，不替代对外 API 合同文档。
|
||
|
||
## 分册导航
|
||
|
||
| 文档 | 内容摘要 |
|
||
|------|----------|
|
||
| [00-overview.md](00-overview.md) | 模块定位、包结构、领域全景、组件依赖图 |
|
||
| [01-device-and-task.md](01-device-and-task.md) | 设备 CRUD、绑定楼层/人员、设备任务与并行推进 |
|
||
| [02-passrule-and-person.md](02-passrule-and-person.md) | 通行规则、图库规则引用、人员规则、人员管理 |
|
||
| [03-record-recognition.md](03-record-recognition.md) | 电梯通行记录、识别记录、图库文件、分析统计 |
|
||
| [04-mqtt-visitor-event.md](04-mqtt-visitor-event.md) | MQTT 推送、访客查询差异、域事件 `VisitorRecordPushEvent` |
|
||
| [05-zone-code.md](05-zone-code.md) | 区域树/分页、电梯区域编码 |
|
||
| [06-export-download-storage.md](06-export-download-storage.md) | 异步导出、下载中心、分片存储 |
|
||
| [07-cross-cutting.md](07-cross-cutting.md) | 缓存、公共应用 ID、基类、空接口等横切项 |
|
||
| [08-visitor-registration-and-elevator-auth.md](08-visitor-registration-and-elevator-auth.md) | **访客：登记/授权边界、派梯 `add/visitor` 全链路、记录打标、时序/活动图** |
|
||
|
||
## 包 → 主入口（速查）
|
||
|
||
| 包路径 | 主要 `*Service` 接口 / 类 |
|
||
|--------|---------------------------|
|
||
| `device` | `AcsElevatorDeviceService`、`AcsDeviceTaskService` |
|
||
| `device/setting` | `AcsDeviceSettingService`、`AcsDeviceImageStoreAppBindService` |
|
||
| `passrule` | `AcsPassRuleService`、`ImageRuleRefService` |
|
||
| `person` | `AcsPersonService`、`PersonRuleService` |
|
||
| `record` | `AcsElevatorRecordService`、`AcsRecogRecordService`、`PersonFileService`、`SendRecordTimeService`（空） |
|
||
| `zone` | `ZoneService` |
|
||
| `codeElevatorArea` | `AcsElevatorCodeService` |
|
||
| `mqtt` | `MqttService` |
|
||
| `export` | `AcsAbstractExportAsyncService` 子类如 `ElevatorDeviceExportService` |
|
||
| `downloadcenter` | `AcsDownloadCenterService` |
|
||
| `storage` | `AcsFileStorageService` |
|
||
| `common` | `AcsApplicationService` |
|
||
| `cacheable` | `AcsAreaTreeCacheableService`（非 interface，为 `@Service` 包装） |
|
||
|
||
## 图例说明
|
||
|
||
- **用例图**：采用 Mermaid `flowchart` / `C4` 简图表达参与者与用例分箱；需要标准 UML 用例图时可自工具导出。
|
||
- **时序图**：`sequenceDiagram` 表示一次调用链。
|
||
- **活动/状态**：`flowchart TB` 或 `stateDiagram-v2` 表示分支与状态。
|
||
|
||
最后更新与源码版本以当前工作区 `cw-elevator-application-service` 反编译/还原代码为准；若与线上运行版本不一致，以发布制品为准。
|