backend-design-review

后端设计评审

评审工作流

遵循以下系统化评审流程：

1. 评审前准备

• 收集设计文档（架构图、API 规范、数据库架构、ADR）
• 了解需求（功能、非功能、合规性）
• 确定评审范围和优先级
• 识别约束条件（技术、预算、时间安排）

2. API 设计评审

• 评估 RESTful 资源建模、HTTP 方法使用情况和状态码
• 评审 GraphQL 架构、类型定义和查询模式
• 评估 gRPC 服务定义和 protobuf 架构
• 验证 API 版本控制策略和文档
• 检查身份验证、授权和安全措施

3. 数据库设计验证

• 评审数据建模、实体关系和规范化
• 评估架构设计、列类型、约束和索引
• 评估查询模式和 N+1 查询防范
• 检查数据完整性规则和引用完整性
• 评审可扩展性方案（分片、副本、缓存）

4. 架构评估

• 评估服务边界和拆分方式
• 评审通信模式（同步/异步、事件驱动）
• 评估弹性模式（熔断器、重试、超时）
• 检查服务发现和负载均衡设计
• 验证数据管理和一致性策略

5. 安全评审

• 评估身份验证机制（OAuth 2.0、JWT）
• 评审授权模型（RBAC、ABAC）
• 评估数据保护（静态/传输中加密、密钥）
• 检查输入验证和注入攻击防范
• 评审安全监控和审计日志记录

6. 性能与可扩展性

• 评估缓存策略（层级、失效、TTL）
• 评审数据库索引和查询优化
• 评估水平/垂直扩展方案
• 检查负载均衡和自动扩缩容设计
• 评审异步处理模式

7. 生成报告

• 按严重程度对发现的问题分类（严重、高、中、低）
• 提供包含示例的详细问题说明
• 提出具体、可执行的建议
• 创建架构改进图
• 制定实施路线图和优先级

评审范围

API 设计质量

• RESTful API 评估（资源建模、HTTP 方法、状态码、版本控制）
• GraphQL 架构评审（类型、解析器、复杂度、N+1 防范）
• gRPC 服务评审（protobuf 定义、流式处理、错误处理）
• API 文档质量（OpenAPI/Swagger 完整性）
• API 安全设计（身份验证、授权、速率限制、验证）

数据库架构

• 数据建模（实体关系、规范化、领域对齐）
• 架构设计（表、列、约束、索引、分区）
• 查询模式（效率、索引使用、N+1 防范）
• 数据完整性（引用完整性、约束、验证）
• 可扩展性（分片、只读副本、缓存）

微服务模式

• 服务边界（拆分、有界上下文、DDD 对齐）
• 通信模式（同步/异步、事件驱动、编排）
• 数据管理（每个服务独立数据库、最终一致性、Saga）
• 服务发现（注册表、负载均衡）
• 弹性（熔断器、重试、超时、舱壁隔离）

集成架构

• 集成模式（API、消息队列、事件流、Webhook）
• 消息队列设计（选择、架构、DLQ、幂等性）
• 事件流（事件溯源、CQRS、流处理）
• 外部 API 集成（重试逻辑、熔断器、版本控制）
• 批处理（ETL、作业调度、错误处理）

安全架构

• 身份验证设计（JWT、OAuth 2.0、会话管理）
• 授权设计（RBAC、ABAC、权限模型）
• 数据保护（静态/传输中加密、密钥管理）
• API 安全（验证、注入攻击防范、速率限制）
• 安全监控（审计日志记录、异常检测）

严重级别

对发现的问题使用以下严重程度评级：

• 🔴 严重：安全风险、数据丢失、功能故障——必须在实施前修复
• 🟠 高：影响可扩展性、性能、可靠性的重大缺陷——应在正式上线前修复
• 🟡 中：中等问题或偏离最佳实践——在下一次迭代中处理
• 🟢 低：细微改进或优化——记录下来，以便日后改进

报告结构

后端设计审查报告应包含：

1. 执行摘要——项目背景、审查日期、总体评估
2. 审查范围——审查内容、审查深度、重点领域
3. 关键发现摘要——严重和高严重级别问题概述
4. 详细发现——每项发现均包含严重程度、描述、影响、建议和示例
5. 积极观察——优势和良好的设计决策
6. 建议——按优先级排序的改进建议及实施指导
7. 架构图——当前状态及拟议的改进
8. 行动项——具体任务、负责人、截止日期和状态跟踪
9. 后续步骤——立即采取的行动、短期任务、后续审查计划

参考文件

根据具体审查需求，加载详细指南：

• 审查流程：参见 backend-design-review-process.md，了解全面的分步审查工作流，涵盖 API 设计、数据库验证、微服务评估、安全审查和性能评估，并附有详细检查清单

• API 设计模式：审查 RESTful API、GraphQL 架构或 gRPC 服务时，参见 api-design-patterns.md——包含资源建模、HTTP 方法、状态码、版本策略、身份验证模式和常见反模式

• 数据库设计模式：参见 database-design-patterns.md，了解数据建模、规范化、索引策略、查询优化、数据库扩展模式、NoSQL 模式和缓存策略的详细指南

• 微服务与集成模式：审查微服务架构、服务边界、通信模式、弹性模式、消息队列、事件流和分布式系统设计时，参见 microservices-integration-patterns.md

• 报告模板：参见 report-template.md，获取完整的报告结构，其中包含执行摘要、发现、建议、架构图和行动项等部分

• 严重级别：参见 severity-levels.md，了解详细的严重程度评级标准（严重、高、中、低），以及相应示例和行动要求