mirror of
https://github.com/hpd840321/starRiverProperty.git
synced 2026-06-10 00:40:30 +08:00
ec05aa777d
- Mark v2.0.17 as current production baseline in AGENTS.md - Update service discovery architecture design doc: add §6-10 for actual implementation state, preserve original as history (§1-5) - Document key decisions: no ZK discovery, ConfigurationBasedServerList, bootstrap aligned with V1
4.3 KiB
4.3 KiB
docs/ — 文档中心
OVERVIEW
starRiverProperty 全仓文档集中地:架构说明、业务走查、构建环境、代码风格、运维脚本。原 dev-support/ 内容已迁入此处。
当前基线版本:v2.0.17(2026-05-05 生产验证通过)
STRUCTURE
docs/
├── README.md # 文档索引与当前排期
├── AGENTS.md # ← 本文件
├── architecture/ # 工程结构
│ ├── Maven聚合工程说明.md # 5 个聚合工程定位
│ ├── 对外接口不变-远程调用与性能优化约定.md # HTTP/Feign 契约约束
│ └── 对外接口不变-走查任务与状态.md # 代码走查清单
├── business/ # 业务说明
│ ├── 访客注册与派梯楼层业务流程走查.md # 访客派梯 Feign 调用链
│ └── 租户访客默认楼层技术产品方案.md # 多租户默认楼层方案
├── build/ # 构建环境
│ └── ORIGINAL_BUILD_JDK.txt # JDK 8 依据
├── style/ # 代码风格
│ └── alibaba-eclipse-codestyle.xml # P3C Eclipse Formatter
├── operations/ # 运维脚本
│ └── deploy_cw_elevator_v1_lib_to_nexus.py # V1 lib → Nexus
├── superpowers/
│ ├── specs/ # 设计规格文档
│ └── data/ # 分析记录与调查报告
└── sql/ # 数据库 DDL 与初始化脚本
WHERE TO LOOK
| Task | Location | Notes |
|---|---|---|
| 当前基线版本 | AGENTS.md |
v2.0.17(2026-05-05) |
| 聚合工程关系 | architecture/Maven聚合工程说明.md |
模块依赖与工程定位 |
| 接口契约约束 | architecture/对外接口不变-远程调用与性能优化约定.md |
不可扩展的 HTTP/Feign 边界 |
| 走查任务清单 | architecture/对外接口不变-走查任务与状态.md |
可修正与须确认项 |
| 代码风格配置 | style/alibaba-eclipse-codestyle.xml |
P3C 格式化 XML |
| JDK 版本依据 | build/ORIGINAL_BUILD_JDK.txt |
JDK 8 强制依据 |
| Nexus 上传 | operations/deploy_cw_elevator_v1_lib_to_nexus.py |
V1 lib 批量部署 |
| 服务发现架构 | superpowers/specs/2026-05-01-service-discovery-architecture-design.md |
设计文档(实施态) |
| ConsulServerList 分析 | superpowers/data/2026-05-05-consulserverlist-static-ip-discovery-analysis.md |
V1 vs V2 服务发现差异调查 |
基线版本信息
| 项目 | 内容 |
|---|---|
| 版本 | v2.0.17 |
| 状态 | ✅ 生产环境验证通过 |
| 验证日期 | 2026-05-05 |
| JAR 文件名 | cw-elevator-application-V1.0.0.20211103.jar(与 V1 一致) |
| 主类 | cn.cloudwalk.elevator.AppApplication(与 V1 一致) |
| Spring Boot | 2.1.18.RELEASE |
| Spring Cloud | Greenwich.SR6 |
| JDK | 1.8(强制) |
| Git rev | 1c5e60f6 |
| 配置基线 | deploy/v2-maven/bootstrap.properties 与 V1 生产完全一致 |
关键决策记录
| 决策 | 选择 | 原因 |
|---|---|---|
| 服务发现 | discovery.enabled=false + ConfigurationBasedServerList |
与 V1 生产一致;ZK 发现依赖已移除 |
| Feign 注解 | OpenFeign(org.springframework.cloud.openfeign.FeignClient) | V1 使用 Netflix Feign,V2 已迁移 |
| 主类名 | AppApplication(与 V1 一致) | 对齐 V1 命名 |
| JAR 文件名 | cw-elevator-application-V1.0.0.20211103.jar(固定) | 生产部署习惯,与 V1 一致 |
| 租户策略 | 新增 tenant_visitor_floor_policy 表 | 新功能,仅在配置策略后生效 |
CONVENTIONS
- 文档用中文撰写(README.md 及所有架构/业务文档)
docs/是文档唯一定位点,dev-support/已废弃- 格式化 XML 路径:所有
maven-*/pom.xml的alibaba.eclipse.codestyle.path均指向docs/style/ - 运行 JAR 还原产物不在
docs/,而在artifacts/decompiled/ - 后续所有开发以 v2.0.17 为基线,在此版本基础上修改和完善