Guangfei.Zhao
1e0cbb86a2
- Introduced integration layer design with Resilience4j for external vendor calls. - Established API design standards with unified response structures and global exception handling. - Defined configuration and service governance using Kubernetes native solutions. - Implemented observability practices including trace ID propagation and structured logging. - Outlined build and multi-environment deployment strategies using Gradle and GitLab CI/CD. - Specified testing strategies across different layers, utilizing JUnit, MockK, Testcontainers, and WireMock.
3.7 KiB
3.7 KiB
conti-docs
Continental Retail APP 相关的文档参考仓库，用于沉淀架构决策、系统/网络架构图，以及后续会陆续补充的后端设计和 API 文档。
目录说明
App 架构决策文档
Flutter APP 的分包、分层、技术选型等决策记录，按序号阅读：
| 文档 | 内容 |
|---|---|
| 01-project-structure.md | 工程结构 / 分包策略（Melos monorepo） |
| 02-layering.md | 分层架构规范（presentation/domain/data） |
| 03-state-management.md | 状态管理方案（Riverpod） |
| 04-routing.md | 路由方案（go_router） |
| 05-networking.md | 网络层设计（dio） |
| 06-local-storage.md | 本地存储方案（Drift / secure storage / shared_preferences） |
| 07-native-integration.md | 原生能力集成方式（Pigeon） |
| 08-build-flavors.md | 多环境构建（dev/uat/prod flavor） |
| 09-testing.md | 测试策略（单元/Widget/集成测试） |
Architecture-Diagram/
前期系统架构、网络架构梳理阶段产出的图和说明文档，先保留作为历史参考，后续可能会做精简：
architecture-diagram.drawio/architecture-diagram-explanation.md— 系统架构图（System Overview / System Architecture / Key Flows）及说明network-architecture-diagram.drawio/network-architecture-explanation.md— 多云网络架构图（业务域边界、VNet/VPC 拓扑）及说明app-architecture-diagram.drawio— APP 侧架构图deployment-architecture-diagram.drawio/system-architecture-diagram.drawio— 部署架构图 / 系统架构图gitlab-cicd-azure-deployment-diagram.drawio— GitLab CI/CD 到 Azure 的部署流程图202606-Continental-Retail-APP-PRD.md— 产品需求文档（PRD）202606-Conti-Retail-APP-Component-data-source.md— 功能模块与数据来源整理零售商系统方案研讨会PPT.retro.md— 方案研讨会复盘记录extract_requirements_to_md.py/extract_component_data_to_md.py— 从原始材料提取内容生成上述 md 文档的脚本
.drawio 文件可用 draw.io 桌面版 或 VS Code 的 Draw.io Integration 插件打开查看。
backend/
后端（Kotlin + Spring Boot + Gradle）架构决策文档，按序号阅读：
| 文档 | 内容 |
|---|---|
| backend/01-project-structure.md | 工程结构 / 模块划分（Gradle 多模块，模块化单体） |
| backend/02-layering.md | 分层规范（api/application/domain/infrastructure） |
| backend/03-persistence.md | 持久层方案（Spring Data JPA + Hibernate，Flyway） |
| backend/04-security-auth.md | 安全与认证方案（Spring Security + JWT，门店上下文） |
| backend/05-integration-layer.md | 集成层设计（F6 Adapter / Mini 域客户端） |
| backend/06-api-design.md | API 设计规范（统一响应、DTO、版本化） |
| backend/07-config-governance.md | 配置与服务治理（K8s ConfigMap/Secret） |
| backend/08-observability.md | 可观测性（Trace ID、日志、审计） |
| backend/09-build-deploy.md | 构建与多环境部署（Gradle、Docker、GitLab CI/CD） |
| backend/10-testing.md | 测试策略 |
待补充
- API 文档
语言约定
文档以中文为主。