FastApi 进阶

前言

终于有了第一个使用 FastApi 编写的线上服务, 在开发的过程中还是遇到了些问题, 这里记录一下

正文

目录结构

我们知道, FastApi 的启动方式推荐使用 uvicorn, 其启动方式大致为 uvicorn main:app, 实际上 main 为该文件的名字, app 为生成的 FastApi 对象, 那么, 对于一个比较大的项目, 我们应该怎样去布局项目呢? 我们参考了 https://github.com/nsidnev/fastapi-realworld-example-app 他是在名为 app 的文件夹中的 main.py 文件存放最大的 app, 在 该文件夹下存放各种逻辑文件, 例如: 基础的数据库相关放在 db 文件夹中, 公共的逻辑放在 core 文件夹中, 接口相关放在 api 文件夹中等等...

因为 app 已经放置在app文件夹中的 main.py 文件中, 启动时则是在根目录输入 uvicorn app.main:app

main.py

多级路由处理

类似于 Flask 的蓝图, FastApi 有更为简单的写法

这里以我们的项目为例, 我们有多层, 最顶级的 app 在 app 文件夹的 main.py 中, files 相关的 api 在 app > api > routers > files > api.py 中

我们从最里层的 api.py 看起, 最里层的 app > api > routers > files > api.py 大致是这样的

在 FastApi 中, 多层路由的每一层都可以设置生成一个 APIRouter 对象

我们再看上一层, 也就是 app > api > routers > api.py

这个 api.py 作为 routers 的整个的 router, 同样生成了 APIRouter 对象, 但是该对象因为并不是最下层的路由, 所以导入下层路由的 router 通过 router.include_router 注册到这个上层路由中, prefix 是路由前缀

我们再看 app > main.py

在最外层, 我们就生成了需要使用 uvicorn 启动的 app 对象, app 对象可以直接使用 include_router 注册路由, 那么其实结构是 最底层的 router 直接面向逻辑, 而外层的一层都通过 include_router 注册他, 同时在注册时可以设置前缀等操作

启动与结束事件

有时候, 我们希望在服务启动时进行一些操作, 比如初始化数据库连接池等操作, 原来我们可能是直接写在生成 app 的时候, 而在服务关闭时关闭连接池则需要费些心思, FastApi提供了事件, 我们注册到某个事件后其在指定的时候执行我们注册的功能, 还拿 main.py 举例

add_event_handler 代表添加事件, 参数1为事件的名字, 默认的有一些, 比如 startup, 参数二则是传入我们自写的函数逻辑, 注意接收一个参数为 app 对象

webSocket状态捕捉

FastApi 同样支持 webSocket, 其官方给的例子类似

其实这种如果客户端主动断开的话, 因服务端是 while 1 , 还在尝试从一个已经关闭的wb里获取数据, 所以会报错, 体现在接口里就是500, 所以我们需要捕捉此异常

依赖注入

我们知道, 在 Flask 中有一个 g 对象, 他穿插在 Flask 的生命周期中, 我们可以给某些接口使用装饰器来做一些通用的操作, 然后将数据依附在 g 中传递给具体的逻辑中方便使用, 那么在 FastApi 中也可以做到, 例如

我们在接收参数时, 可以指定某个参数是由 Depends 传出, 这便意味着这个参数不是由请求传递的, 而是由我们指定的逻辑生成后传入的, 比如上面的代码, 我们接受参数 fs, 这个参数 fs 是 Depends 生成的, 那么此参数就是这个接口的 依赖, 请求进入时会执行 Depends 包裹的函数, 也就是 get_bucket 函数, 此函数是我们自己写的, 目的是将数据库连接生成, 然后作为参数 fs 传入具体逻辑, 在里面使用

后台任务

比如我们有一个接口, 这个接口需要向某个邮箱发送邮件, 因为发送邮件这个动作可能持续几秒, 我们不能让这个请求在这边夯住直到发送完成, 我们希望理想的效果是: 接口立即返回任务提交成功,由后台发送邮件, FastApi 的 background tasks 可以帮我们做到

如上图, 我们在接收参数时加上一个 BackgroundTasks 类型的参数, 这个参数并不是由请求传递, 当我们希望将某个逻辑放到背后去执行时, 只需要 .add_task 即可, 他接受多个参数, 参数1为要执行的函数名, 后面是该函数的参数, 既可以使用顺序传参也可使用关键字传参

当我们注册后, FastApi 只是将其加入了 BackgroundTasks 中, 并不会立即执行, 而是在这个请求响应后才执行, 也就是在 return 后