API 设计与软件架构
架构决定了软件能在多长时间内保持易于修改。我们围绕业务领域设计系统,为每个服务制定清晰的契约,并选择能承受负载的最简单结构,从一个井然有序的应用到一组服务。
工具
REST 与 CRUD API、OpenAPI 契约、WebSocket、微服务、消息队列和领域驱动设计。
REST
基于资源的 HTTP API,命名、状态码、分页和版本管理保持一致。REST 是我们在 Web、移动端和合作伙伴集成中的默认选择。
CRUD
把增、查、改、删做到位:数据校验、权限控制、变更记录,以及两人同时编辑同一条记录时的安全处理。大多数业务软件的核心都是 CRUD。
OpenAPI
先用 OpenAPI(Swagger)规范描述 API。前端、移动端和合作伙伴团队可获得交互式文档和自动生成的客户端,并行开发。
WebSocket
与 REST API 并行的双向实时通道,用于实时仪表盘、通知和多人游戏。
微服务
相互独立的服务,各有自己的数据和部署流程,以容器交付。当团队规模或负载需要时我们才拆分系统,否则保持一个结构良好的单体应用。
事件驱动消息
服务之间通过 JMS 等消息队列通信,而不是互相等待,某一步变慢或失败不会拖住其余部分。
领域驱动设计
代码使用业务的语言。限界上下文把每个领域的规则集中在一处,让大型系统保持可理解。
整洁架构
业务规则与框架、数据库和界面分离,各部分可以单独测试,替换时无需重写。
反向代理
所有应用的统一入口:nginx 或 Apache 负责 TLS 终止,把每个路径转发到正确的服务,缓存静态文件并拦截不需要的流量。我们运营的每个网站和产品都位于反向代理之后。
负载均衡
流量分布到多台应用服务器并带有健康检查,负载得以分担,某台服务器下线更新时用户毫无察觉。
集群故障转移
当一个节点故障时由健康节点接管的集群,会话保持不断。我们曾为必须持续在线的系统(例如医疗系统)搭建集群化的应用服务器。
我们的工作方式
契约先行
先商定并评审 API 契约再写代码,契约的变更都有版本。
默认安全
每个端点都使用 OAuth2 和 JWT,校验输入并限制调用频率。
遗留系统现代化
在稳定的 API 之后逐步替换旧系统,迁移期间用户照常工作。
决策有记录
简短的架构决策记录说明每个选择的原因,方便后来的开发者。
背后的经验
这项技术在哪些真实项目中使用过。
了解技术栈的其他部分
正在规划基于这套技术栈的项目?
告诉我们您在构建什么,我们会告诉您我们将如何着手。
