使用Python FastAPI构建Web服务的实现

fastapi 是一个使用 python 编写的 web 框架，还应用了 python asyncio 库中最新的优化。本文将会介绍如何搭建基于容器的开发环境，还会展示如何使用 fastapi 实现一个小型 web 服务。

起步

我们将使用 fedora 作为基础镜像来搭建开发环境，并使用 dockerfile 为镜像注入 fastapi、uvicorn 和 这几个包。

from fedora:32
run dnf install -y python-pip \
  && dnf clean all \
  && pip install fastapi uvicorn aiofiles
workdir /srv
cmd ["uvicorn", "main:app", "--reload"]

在工作目录下保存 dockerfile 之后，执行 podman 命令构建容器镜像。

$ podman build -t fastapi .
$ podman images
repository tag image id created size
localhost/fastapi latest 01e974cabe8b 18 seconds ago 326 mb

下面我们可以开始创建一个简单的 fastapi 应用程序，并通过容器镜像运行。

from fastapi import fastapi
 
app = fastapi()
 
@app.get("/")
async def root():
  return {"message": "hello fedora magazine!"}

将上面的代码保存到 main.py 文件中，然后执行以下命令开始运行：

$ podman run --rm -v $pwd:/srv:z -p 8000:8000 --name fastapi -d fastapi
$ curl http://127.0.0.1:8000
{"message":"hello fedora magazine!"

这样，一个基于 fastapi 的 web 服务就跑起来了。由于指定了 --reload 参数，一旦 main.py 文件发生了改变，整个应用都会自动重新加载。你可以尝试将返回信息 "hello fedora magazine!" 修改为其它内容，然后观察效果。

可以使用以下命令停止应用程序：

$ podman stop fastapi

构建一个小型 web 服务

接下来我们会构建一个需要 i/o 操作的应用程序，通过这个应用程序，我们可以看到 fastapi 自身的特点，以及它在性能上有什么优势（可以在这里参考 fastapi 和其它 python web 框架的对比）。为简单起见，我们直接使用 dnf history 命令的输出来作为这个应用程序使用的数据。

首先将 dnf history 命令的输出保存到文件。

$ dnf history | tail --lines=+3 > history.txt

在上面的命令中，我们使用 tail 去除了 dnf history 输出内容中无用的表头信息。剩余的每一条 dnf 事务都包括了以下信息：

• id：事务编号（每次运行一条新事务时该编号都会递增）
• command：事务中运行的 dnf 命令
• date：执行事务的日期和时间

然后修改 main.py 文件将相关的数据结构添加进去。

from fastapi import fastapi
from pydantic import basemodel
 
app = fastapi()
 
class dnftransaction(basemodel):
  id: int
  command: str
  date: str

fastapi 自带的 库让你可以轻松定义一个数据类，其中的类型注释对数据的验证也提供了方便。

再增加一个函数，用于从 history.txt 文件中读取数据。

import aiofiles
 
from fastapi import fastapi
from pydantic import basemodel
 
app = fastapi()
 
class dnftransaction(basemodel):
  id: int
  command: str
  date: str
 
 
async def read_history():
  transactions = []
  async with aiofiles.open("history.txt") as f:
    async for line in f:
      transactions.append(dnftransaction(
        id=line.split("|")[0].strip(" "),
        command=line.split("|")[1].strip(" "),
        date=line.split("|")[2].strip(" ")))
  return transactions

这个函数中使用了 aiofiles 库，这个库提供了一个异步 api 来处理 python 中的文件，因此打开文件或读取文件的时候不会阻塞其它对服务器的请求。

最后，修改 root 函数，让它返回事务列表中的数据。

@app.get("/")
async def read_root():
  return await read_history()

执行以下命令就可以看到应用程序的输出内容了。

$ curl http://127.0.0.1:8000 | python -m json.tool
[
{
"id": 103,
"command": "update",
"date": "2020-05-25 08:35"
},
{
"id": 102,
"command": "update",
"date": "2020-05-23 15:46"
},
{
"id": 101,
"command": "update",
"date": "2020-05-22 11:32"
},
....
]

总结

fastapi 提供了一种使用 asyncio 构建 web 服务的简单方法，因此它在 python web 框架的生态中日趋流行。要了解 fastapi 的更多信息，欢迎查阅 fastapi 文档。

本文中的代码可以在 github 上找到。

到此这篇关于使用python fastapi构建web服务的实现的文章就介绍到这了,更多相关python fastapi构建web服务内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！