使用 FastAPI 整合 gRPC 构建 Python 微服务

为何选择了 FastAPI 和 gRPC?


我们团队内部早期使用的 Django 开发的海外金融产品,后续考虑转型到微服务架构,做了一些调研之后,决定选择 FastAPI 和 gRPC。

FastAPI

完全从异步IO思维整合出来的框架,在 Web 领域异步IO的意义比较大。基于 Encode 团队(开发过大名鼎鼎的 Django REST Framework)的新作品:Starlette

gRPC

在 RPC 之块,Python 还有一个有名的框架 nameko,团队之前使用过,由于国内使用率不高,遇到问题时,难以解决方案,虽然 nameko 的 API 非常优雅,最终还是求稳地选择了 gRPC。gRPC 在云原生时代也是一个标配,流行度上有保证。

落地实践


简单地了解了一些 DDD 思维后,团队就拍着脑袋开始拆分服务啦。总共拆分了 8 个服务,每个服务同时提供 HTTP/RPC 服务。

类 Flask 框架的 FastAPI,拥有微框架的灵活性,但也是这种灵活性,让团队技术水平并不统一的开发者写出了各式各式的项目结构,交叉维护项目的时候,非常头痛。于是团队内部为了统一及简化 FastAPI & gRPC 的开发,迭代出了一个整合的框架:bali,业务代码分布为在两个层次:Model 层和 Resource 层。Model 层是一个 Fat Model 模型,除了字段定义,还有与 Model 相关的一些逻辑;Resource 层提供同时兼容 HTTP/RPC 的资源服务。遵循 RESTful 及 gRPC 的开发指南定义了几个标准方法。

# 注意 bali 框架在 pipy 仓库里面的名称是:bali-core 
pip install bali-core

项目结构

这里只涂两个服务作为实践例子,用户服务(user)和订单服务(order),每个服务都是一个独立的 repo,有个独立的 proto repo 专门用来存放 gRPC 需要使用的 protobuf。

# user repo
├── user
│   ├── Dockerfile
│   ├── README.md
│   ├── clients
│   │   ├── __init__.py
│   │   ├── _config.py
│   │   ├── _utils.py
│   │   ├── intermediates
│   ├── core
│   │   ├── config.py
│   │   ├── constants
│   │   ├── environment.py
│   │   ├── logging.py
│   ├── main.py
│   ├── models
│   │   ├── __init__.py
│   │   ├── user.py
│   ├── requirements.txt
│   ├── requirements_dev.txt
│   ├── resources
│   │   ├── __init__.py
│   │   ├── user.py
│   ├── schemas
│   │   ├── __init__.py
│   │   ├── user.py
│   ├── services
│   │   ├── __init__.py
│   │   ├── db.py
│   │   ├── http
│   │   │   ├── users.py
│   │   └── rpc
│   │       ├── service.py
│   ├── tests
│   │   ├── __init__.py
│   │   ├── test_models
│   │   ├── test_resources
│   │   └── test_services

# order repo
├── user
│   ├── Dockerfile
│   ├── README.md
│   ├── clients
│   │   ├── __init__.py
│   │   ├── _config.py
│   │   ├── _utils.py
│   │   ├── intermediates
│   ├── core
│   │   ├── config.py
│   │   ├── constants
│   │   ├── environment.py
│   │   ├── logging.py
│   ├── main.py
│   ├── models
│   │   ├── __init__.py
│   │   ├── user.py
│   ├── requirements.txt
│   ├── requirements_dev.txt
│   ├── resources
│   │   ├── __init__.py
│   │   ├── user.py
│   ├── schemas
│   │   ├── __init__.py
│   │   ├── user.py
│   ├── services
│   │   ├── __init__.py
│   │   ├── db.py
│   │   ├── http
│   │   │   ├── users.py
│   │   └── rpc
│   │       ├── service.py
│   ├── tests
│   │   ├── __init__.py
│   │   ├── test_models
│   │   ├── test_resources
│   │   └── test_services

# proto repo
proto
├── order
│   └── order.proto
└── user
    └── user.proto

可以看出,微服务的结构是基本一致的,user 服务和 order 服务的业务主要存放在 Models 和 Resources。

HTTP 服务

# user/services/http/users.py

@router.get("/users/", response_model=UserSchema)
def get_users(
    *,
    channel : str = Header(None),
) -> Any:
    return User.get_users()

这是 FastAPI 的自带的 route 定义方式,bali 是兼容的。

# user/resources/user.py

class UserResource(Resource):
    schema = UserSchema

    @action()
    def custome_users(self, schema_in):
        User.get_customer_users()

Resouce 的方式,同时支持 HTTP、RPC。通用的 action 比如 GetUsers 不需要在 Resource 里面定义,已经在 Resource 基类里面实现了。

启动 HTTP 服务:

python main.py --http

RPC 服务

  1. 定义 protobuf 文件
# user/services/rpc/user.proto

编译 proto 文件,按 gRPC 官方提供的方法:

$ python -m grpc_tools.protoc -I../../protos --python_out=. --grpc_python_out=. ../../protos/user.proto

而使用 bali-cli(bali 框架配套的 cli 工具),只需要在项目根目录执行:

pip install bali-cli
bali build 

再配合 CI/CD,user 服务的 user.proto 会自动添加到 proto repo 里面。

  1. gRPC 实现服务
# user/services/rpc/service.py

class UserService(user_pb2_grpc.UserServiceServicer):
    def GetUsers(self, request, context):
        return UserResource(request, context, pb2.UserResponse).get_users()

def serve():
    port = 5000
    server = grpc.server(
        futures.ThreadPoolExecutor(max_workers=50),
        interceptors=[ProcessInterceptor()],
    )
    user_pb2_grpc.add_UserServiceServicer_to_server(UserService(), server)
    server.add_insecure_port(f'[::]:{port}')
    server.start()
    logger.info("Service started on port: %s (env: %s)", port, ENV)
    server.wait_for_termination()

由于 get_users 是一个标准通用的 action,所以在 Resource 里面都不用自己实现,定义好 Model、Schema 就可以直接使用了。

启动 RPC 服务:

python main.py --rpc
  1. gRPC 实现服务

在 order 服务里面调用 user 服务,只需要使用 bali add {service} 命令即可在 order 项目,创建一个 clients 需要的所有文件。

bali add user

在代码里面调用

from clients import UserClient
users = UserClient().get_users()

项目总结

gRPC 确实是未来一个方向,简单、跨语言。而且云原生的 service mesh 都默认支持 gRPC,比如 Linkerd。微服务场景下的网关产品也都对 gRPC 默认支持。

业务代码放哪里这个问题在所有项目里面都会成为一个话题,bali 框架只有两层,Model 和 Resource,开发微服务就不用思考太多东西,效率会高。一套代码,同时兼容 HTTP 和 RPC 服务。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270

推荐阅读更多精彩内容