backend-design

后端设计

工作流

遵循以下系统化设计流程：

1. 需求分析

   • 收集功能需求（功能、操作）
   • 明确非功能需求（性能、可扩展性、可用性）
   • 识别约束条件（预算、时间线、技术、合规性）

2. 架构选择

   • 选择架构模式（单体、微服务、无服务器）
   • 根据需求选择技术栈
   • 明确服务边界和职责

3. API 设计

   • 设计 RESTful 端点，并恰当建模资源
   • 定义请求/响应架构和契约
   • 制定版本控制策略和文档
   • REST/GraphQL/gRPC 模式请参阅 api-design-guide.md

4. 数据库设计

   • 建模实体和关系
   • 设计规范化架构
   • 制定索引和分区策略
   • 关系型和 NoSQL 模式请参阅 database-design.md

5. 安全设计

   • 设计身份验证流程（OAuth 2.0、JWT）
   • 制定授权模型（RBAC、ABAC）
   • 定义数据加密和保护策略

6. 可扩展性与性能

   • 设计缓存策略（Redis、CDN）
   • 制定负载均衡和自动扩缩容计划
   • 使用消息队列定义异步处理机制

7. 文档

   • 创建 API 规范（OpenAPI/Swagger）
   • 使用 Mermaid 图表记录架构决策
   • 提供实现指南和路线图

输出结构

使用以下章节呈现后端设计：

1. 系统概览 - 高层架构、组件、技术栈
2. API 规范 - 端点、架构、身份验证、OpenAPI 文档
3. 数据库设计 - ERD、架构、索引、迁移计划
4. 架构决策 - 服务拆分、通信模式、一致性模型
5. 安全实现 - 身份验证/授权流程、加密
6. 可扩展性计划 - 负载均衡、缓存、数据库扩展、自动扩缩容
7. 部署架构 - 容器、基础设施、CI/CD、监控
8. 实施路线图 - 阶段、里程碑、依赖项、风险

核心原则

• API 优先 - 在实现前设计并记录 API
• 安全设计 - 从一开始就构建身份验证、授权和加密机制
• 面向可扩展性设计 - 通过缓存、负载均衡和水平扩展为增长做好准备
• 预先规划故障处理 - 纳入错误处理、重试、熔断器和优雅降级
• 完善文档 - 创建清晰的 API 规范、Mermaid 架构图和实现指南

参考文件

根据具体需求加载其他资源：

• 详细设计流程：请参阅 backend-design-process.md，了解全面的分步工作流及示例，涵盖 API 设计、数据库建模、身份验证流程和微服务模式

• API 设计指南：设计 RESTful API、GraphQL 架构或 gRPC 服务时，请参阅 api-design-guide.md——其中包括资源建模、状态码、版本控制策略和文档编写

• 数据库设计：请参阅 database-design.md，了解关系型和 NoSQL 数据库设计、规范化、索引、分区和复制策略的详细指导

• 最佳实践：请参阅 best-practices.md，了解 API 设计、数据库优化、安全加固、性能调优和可靠性模式

• 常见模式：请参阅 common-patterns.md，查看仓储模式、服务层、依赖注入和其他架构模式的代码示例

• 示例项目：请参阅 examples.md，了解完整的架构示例，包括电子商务系统、实时聊天应用和微服务实现