README.zh-Hans.md

Seckill-Sanic

English | 简体中文

基于 Sanic 实现简化秒杀场景，采用微服务基础架构实现。 项目模拟简单秒杀服务场景，拆分成三个微服务进行实现：

• 产品服务
  • 支持产品列表/详情查询
  • 支持产品添加/移除/编辑
• 活动服务
  • 活动列表/详情查询
  • 活动添加/编辑
  • 活动秒杀
• 订单服务
  • 订单查询
  • 订单管理

原始需求描述

编写一个 web 服务模拟大量用户参与抢购某个商品的秒杀活动：

• 提供一个 web API，可以基于 HTTP 或 TCP，用户可以针对秒杀活动下单
• 用户可以发送多次抢购请求（无论第一次抢没抢到），但是系统要保证一个用户最多只能抢到一个商品
• 用户订单信息需要进行持久化存储，服务/服务器重启后仍能查询到结果
• 每次秒杀活动关联一个商品，并且只有当商品库存大于 0 的时候用户才可以下单
• 最终生成订单中的商品总和应该和商品的库存数一致
• 服务必须要能够处理不同用户的并发请求（例如达到 100 TPS）

特性

• 使用 Sanic 异步框架实现接口服务, 简洁，轻量，高效
• 使用 aiomysql 作为数据库驱动，进行数据库连接及操作，异步执行 SQL 语句
• 使用 aiohttp 实现客户端发起异步 HTTP 请求，对其他微服务进行访问
• 使用 peewee 作为 ORM，用于模型设计及迁移
• 使用 sanic-opentracing 实现分布式追踪系统
• 使用 sanic-openapi 自动生成 Swagger API 文档

运行截图

Swagger API

Jaeger Server

运行环境

docker-compose 运行环境

配置对应环境变量 .env

创建 .env 文件进行环境变量配置，可以 .env_template 为模板。

DOCKER_DIR=~/you/project/patch/sanic_seckill/seckill/deployment
MYSQL_ROOT_PASSWORD=sanicroot

启动所有服务

使用 docker-compose 构建并开启所有服务，你可以根据自身需求调整对应的端口映射。

docker-compose build  
docker-compose up

访问服务

默认 docker-compose 会暴露相关的服务端口到 Host 主机，可以根据环境需求编辑docker-compose 中对应的端口映射。

• Consul UI: http://localhost:8501
• Jaeger UI: http://localhost:8502
• Product Service: http://localhost:8503
• Activity Service: http://localhost:8504
• Order Service: http://localhost:8505

如果一切运行正常，你可以看到 Consul 界面上服务已经成功注册，并且相关 health 状态检查一切正常。默认 docker-compose.yml 中只有 activity service TRACE_ALL=true，所以在 Jaeger 界面可以看到对应的请求追踪。

本地开发环境搭建

docker 卷挂载方式

Python 虚拟环境

技术实现

服务端

服务端启动前

• 创建 DB 连接池
• 创建 Client 连接，用于请求其他微服务
• 根据配置创建 jaeger.tracer 进行分布式追踪

中间件

• 对 request 注入请求头，处理跨域请求
• 对 response 进行封装，统一格式以及相关的数据格式

异常处理

对抛出的异常进行处理，返回统一格式。

注册任务

创建 ServiceWatcher 任务，进行服务发现以及服务状态维护，维护对应的服务列表到 app.services。

数据模型

ORM 使用 peewee, 用于模型设计和数据迁移, 数据操作使用 aiomysql

• 通过环境变量进行指定 DB 连接参数
• 如果是使用 docker-compose 启动服务则不需要手动创建数据库
• 否则需要手动运行命令 python migrations.py 进行数据模型创建

数据库操作

使用 aiomysql 为数据库驱动, 对数据库连接进行封装, 执行数据库操作。

• acquire() 返回非事务数据库连接, 对于只涉及到查询的使用非事务，可以提高查询效率
• tansaction() 函数为事务操作，对于增删改必须使用事务操作
• 如果 trace 变量为真，则所有数据库操作会被追踪记录

HTTP 异步请求客户端

使用 aiohttp 中的 client，对客户端进行了简单的封装，用于异步访问其他微服务。

日志处理

使用 Python logging, 配置文件为 logging.yml，JsonFormatter 将日志转成 json 格式。

分布式追踪系统

• OpenTracing 是以 Dapper，Zipkin 等分布式追踪系统为依据, 为分布式追踪建立了统一的标准。
• Opentracing 跟踪每一个请求，记录请求所经过的每一个微服务，以链条的方式串联起来，对分析微服务的性能瓶颈至关重要。
• 使用 opentracing 框架，但是在输出时转换成 Jaeger 格式。
• 通过环境变量决定是否对 DB、Client 进行记录追踪

错误处理

使用 app.error_handler = CustomHander() 对抛出的异常进行处理

• code：错误码，无异常时为 0，其他值都为异常
• message：状态码信息
• status_code：HTTP 状态码，使用标准的 HTTP 状态码