mirror of
https://github.com/hpd840321/starRiverProperty.git
synced 2026-06-09 16:30:29 +08:00
反编译工作区
dee355b4a7
- artifacts/decompiled 树与相关源码变更 - maven-cw-elevator-application 业务 docs 与 package-info - scripts 下 formatter 校验与辅助脚本 - 其他子工程/接口与发布线一并纳入版本控制 Made-with: Cursor Former-commit-id: e102e8cab64e575bcd23c9a66a598aa1892bb492
56 lines
4.2 KiB
Markdown
56 lines
4.2 KiB
Markdown
# 文档索引（starRiverProperty）
|
||
|
||
本目录集中存放说明类文档与配套资源，按类别分子目录。
|
||
|
||
## 当前排期与范围（2026-04）
|
||
|
||
- 仓库根目录 [`frontend/`](../frontend/) 当前**无可用前端源码与完整静态构建产物**（仅空目录结构；历史快照在 [`artifacts/archive/dated-snapshots/`](../artifacts/archive/dated-snapshots/)）。
|
||
- **凡依赖物业管理端、登记页、H5/PC 前端改动的迭代任务，在本阶段一律跳过**，不纳入当前迭代排期。优先推进**仅涉及后端、数据库、对外 HTTP/Feign 契约不变前提下的服务与配置**类工作（参见 [对外接口不变-走查任务与状态](architecture/对外接口不变-走查任务与状态.md)）。
|
||
- **恢复条件**：取得可维护的前端工程或完整 dist，并确认可编译、可联调后，再单独开项将「前端相关」任务接回排期。
|
||
|
||
## 目录结构
|
||
|
||
| 目录 | 说明 |
|
||
|------|------|
|
||
| [business/](business/) | 业务走查、接口流、用例说明 |
|
||
| [build/](build/) | 构建环境、JDK 版本依据等 |
|
||
| [style/](style/) | 代码风格配置（P3C / Eclipse Formatter XML，供 Maven `formatter-maven-plugin` 引用） |
|
||
| [operations/](operations/) | 发布、私服上传等运维脚本 |
|
||
| [architecture/](architecture/) | 工程结构、Maven 聚合模块说明与模块间关系 |
|
||
|
||
源码归档（`*.jar.src` / `*.jar.src.zip`）不在 `docs/` 内，而在仓库根目录 [**`artifacts/decompiled/`**](../artifacts/decompiled/)（目录名 `decompiled` 为历史约定；与本文并列，见该目录 README）。
|
||
|
||
## 文档列表
|
||
|
||
### 工程说明（architecture）
|
||
|
||
- [Maven 聚合工程说明](architecture/Maven聚合工程说明.md) — 五个 `maven-*` 聚合工程的定位、子模块、技术栈、工程间依赖与 `artifacts`/运行包分工。
|
||
- [对外接口不变-远程调用与性能优化约定](architecture/对外接口不变-远程调用与性能优化约定.md) — HTTP/Feign 不扩展前提下，合并 RPC、有界并行与返回值校验等原则。
|
||
- [对外接口不变-走查任务与状态](architecture/对外接口不变-走查任务与状态.md) — 与约定对齐的代码走查：子任务量、可修正项与不可修正/须确认项。
|
||
|
||
### 业务（business）
|
||
|
||
- [访客注册与派梯楼层业务流程走查](business/访客注册与派梯楼层业务流程走查.md) — 从第三方获取默认楼层到指定楼层、电梯 `add/visitor`、Feign 调用链与用例。
|
||
- [租户访客默认楼层技术产品方案](business/租户访客默认楼层技术产品方案.md) — 从第三方登记页初始化（数据项与接口溯源）到派梯开通的**闭环**、多租户默认楼层的实现路径评估与落地建议。
|
||
|
||
### 构建（build）
|
||
|
||
- [ORIGINAL_BUILD_JDK.txt](build/ORIGINAL_BUILD_JDK.txt) — 原始运行包与构件体现的 **JDK 8** 依据；与各聚合父 POM 中 `maven-enforcer-plugin` 提示一致。
|
||
|
||
### 风格（style）
|
||
|
||
- [alibaba-eclipse-codestyle.xml](style/alibaba-eclipse-codestyle.xml) — 阿里巴巴 P3C Eclipse 格式化配置；各 `maven-*/pom.xml` 中 `alibaba.eclipse.codestyle.path` 指向此处。
|
||
- 仓库根目录 `scripts/check_maven_formatter_validate.sh` — 在 **JDK 8** 下对每个 `maven-*` 跑 `formatter:validate`（插件 **2.16.0**，与父 POM 中 2.24 需更高 JVM 跑插件不同，见 [build/ORIGINAL_BUILD_JDK.txt](build/ORIGINAL_BUILD_JDK.txt) 文末）。`scripts/format_maven_formatter_all.sh` 为同配置批量 `formatter:format`（会改文件，先备份或走评审）。
|
||
|
||
### 运维（operations）
|
||
|
||
- [deploy_cw_elevator_v1_lib_to_nexus.py](operations/deploy_cw_elevator_v1_lib_to_nexus.py) — 将 V1 运行包 `lib` 下 JAR 批量 `deploy-file` 到 Nexus 的脚本。
|
||
|
||
## 源码归档与解压树（`artifacts/`）
|
||
|
||
说明类文档在 **`docs/`**；由运行 JAR 还原得到的 **`*.jar.src.zip` / `*.jar.src/`** 已归纳至仓库根目录 **`artifacts/decompiled/`**（`archives` 与 `trees` 分类），详见 [artifacts/decompiled/README.md](../artifacts/decompiled/README.md)。
|
||
|
||
## 与 `dev-support` 的关系
|
||
|
||
原 `dev-support/` 下文档与配置已迁入 `docs/` 对应子目录。若本地仍有旧路径书签，请改为以 `docs/` 为准。
|