mirror of
https://github.com/hpd840321/starRiverProperty.git
synced 2026-06-09 08:20:31 +08:00
b43a38358e
Made-with: Cursor
Former-commit-id: fdb2c04f11
文档索引(starRiverProperty)
本目录集中存放说明类文档与配套资源,按类别分子目录。
目录结构
| 目录 | 说明 |
|---|---|
| business/ | 业务走查、接口流、用例说明 |
| build/ | 构建环境、JDK 版本依据等 |
| style/ | 代码风格配置(P3C / Eclipse Formatter XML,供 Maven formatter-maven-plugin 引用) |
| operations/ | 发布、私服上传等运维脚本 |
| architecture/ | 工程结构、Maven 聚合模块说明与模块间关系 |
源码归档(*.jar.src / *.jar.src.zip)不在 docs/ 内,而在仓库根目录 artifacts/decompiled/(目录名 decompiled 为历史约定;与本文并列,见该目录 README)。
文档列表
工程说明(architecture)
- Maven 聚合工程说明 — 五个
maven-*聚合工程的定位、子模块、技术栈、工程间依赖与artifacts/运行包分工。 - 对外接口不变-远程调用与性能优化约定 — HTTP/Feign 不扩展前提下,合并 RPC、有界并行与返回值校验等原则。
- 对外接口不变-走查任务与状态 — 与约定对齐的代码走查:子任务量、可修正项与不可修正/须确认项。
业务(business)
- 访客注册与派梯楼层业务流程走查 — 从第三方获取默认楼层到指定楼层、电梯
add/visitor、Feign 调用链与用例。 - 租户访客默认楼层技术产品方案 — 从第三方登记页初始化(数据项与接口溯源)到派梯开通的闭环、多租户默认楼层的实现路径评估与落地建议。
构建(build)
- ORIGINAL_BUILD_JDK.txt — 原始运行包与构件体现的 JDK 8 依据;与各聚合父 POM 中
maven-enforcer-plugin提示一致。
风格(style)
- alibaba-eclipse-codestyle.xml — 阿里巴巴 P3C Eclipse 格式化配置;各
maven-*/pom.xml中alibaba.eclipse.codestyle.path指向此处。
运维(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。
与 dev-support 的关系
原 dev-support/ 下文档与配置已迁入 docs/ 对应子目录。若本地仍有旧路径书签,请改为以 docs/ 为准。