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 后
FastApi 进阶的更多相关文章
- fastapi教程进阶
一个简单的栗子 from fastapi import FastAPI app = FastAPI() @app.get("/") async def root(): return ...
- FastAPI实践项目:SayHello(FastAPI + vue.js + axios + element ui)
目录 简介 翻版 VS 本尊 后端服务 源码 接下来 简介 这次带来的是FastAPI + vue.js + axios + element ui (一个html文件里使用的) 实现的<Flas ...
- nodejs进阶(6)—连接MySQL数据库
1. 建库连库 连接MySQL数据库需要安装支持 npm install mysql 我们需要提前安装按mysql sever端 建一个数据库mydb1 mysql> CREATE DATABA ...
- nodejs进阶(4)—读取图片到页面
我们先实现从指定路径读取图片然后输出到页面的功能. 先准备一张图片imgs/dog.jpg. file.js里面继续添加readImg方法,在这里注意读写的时候都需要声明'binary'.(file. ...
- JavaScript进阶之路(一)初学者的开始
一:写在前面的问题和话 一个javascript初学者的进阶之路! 背景:3年后端(ASP.NET)工作经验,javascript水平一般般,前端水平一般般.学习资料:犀牛书. 如有误导,或者错误的地 ...
- nodejs进阶(3)—路由处理
1. url.parse(url)解析 该方法将一个URL字符串转换成对象并返回. url.parse(urlStr, [parseQueryString], [slashesDenoteHost]) ...
- nodejs进阶(5)—接收请求参数
1. get请求参数接收 我们简单举一个需要接收参数的例子 如果有个查找功能,查找关键词需要从url里接收,http://localhost:8000/search?keyword=地球.通过前面的进 ...
- nodejs进阶(1)—输出hello world
下面将带领大家一步步学习nodejs,知道怎么使用nodejs搭建服务器,响应get/post请求,连接数据库等. 搭建服务器页面输出hello world var http = require ...
- [C#] 进阶 - LINQ 标准查询操作概述
LINQ 标准查询操作概述 序 “标准查询运算符”是组成语言集成查询 (LINQ) 模式的方法.大多数这些方法都在序列上运行,其中的序列是一个对象,其类型实现了IEnumerable<T> ...
随机推荐
- LeetCode初级算法之数组:1 两数之和
两数之和 题目地址:https://leetcode-cn.com/problems/two-sum/ 给定一个整数数组 nums 和一个目标值 target,请你在该数组中找出和为目标值的那 两个整 ...
- Scrum 冲刺 第五篇
Scrum 冲刺 第五篇 每日会议照片 昨天已完成工作 队员 昨日完成任务 黄梓浩 初步完成app项目架构搭建 黄清山 完成部分个人界面模块数据库的接口 邓富荣 完成后台首页模块数据库的接口 钟俊豪 ...
- 第二篇 Scrum 冲刺博客
一.站立式会议 1. 会议照片 2. 工作汇报 成员名称 昨日(23日)完成的工作 今天(24日)计划完成的工作 工作中遇到的困难 陈锐基 - 完成个人资料编辑功能- 对接获取表白动态的接口数据并渲染 ...
- 原生js获取页面所有的checkbox
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...
- MySQL的验证方式
mysql8之后root用户的密码验证方式修改了,mysql8的加密方式为caching_sha2_passoword,而navicat连接所用的方式为native_password. 使用命令mys ...
- Linux下基于.NET5开发CAX应用
<<.NET5下的三维应用程序开发>>一文中介绍了如何在.NET5下使用AnyCAD开发应用程序.相比.NET4.x,.NET5一大进步便是可以跨平台,即可以在Linux.Ma ...
- php代码审计小技巧
1.file_put_contents()函数:众所周知此函数是将一个字符串写入至文件中. 看到此函数说明当传入数据为数组时,会被PHP强制转换为字符串,因此会绕过正则达到getshell的目的. & ...
- mysql 查询出来的内容无法显示全部
前几天在做查询的时候,由于使用了字段拼接,所以查出来的其中一列,数据很长,但是每次显示一定的长度后,后面的就无法显示 原因是因为mysql设置查询出来的长度,好像默认是1024,因为我使用的是yii2 ...
- Autofac的基本使用---2、普通类型
Autofac的基本使用---目录 准备 使用的表是Student,创建相关的IDAL.DAL.IBLL.BLL层. 使用EF,创建一个Model层,存放edmx文件. 控制台程序的使用 using ...
- mysql数据安全之利用二进制日志mysqlbinlog备份数据
mysql数据安全之利用二进制日志mysqlbinlog备份数据 简介:如何利用二进制日志来备份数据 什么是二进制日志: 二进制日志就是记录着mysql数据库中的一些写入性操作,比如一些增删改,但是, ...