首页 > 编程语言 >(完结篇)Python web框架FastAPI——一个比Flask和Tornada更高性能的API 框架

(完结篇)Python web框架FastAPI——一个比Flask和Tornada更高性能的API 框架

时间:2023-04-25 14:32:59浏览次数:39  
标签:完结篇 return 框架 FastAPI app API async import def


借问酒家何处有,牧童遥指杏花村。

0

前言

    前几天给大家分别分享了(入门篇)简析Python web框架FastAPI——一个比Flask和Tornada更高性能的API 框架和(进阶篇)Python web框架FastAPI——一个比Flask和Tornada更高性能的API 框架。今天欢迎大家来到 FastAPI 系列分享的完结篇,本文主要是对于前面文章的补充和扩展。

当然这些功能在实际开发中也扮演者极其重要的角色。

(完结篇)Python web框架FastAPI——一个比Flask和Tornada更高性能的API 框架_ico

1

中间件的使用

    Flask 有 钩子函数,可以对某些方法进行装饰,在某些全局或者非全局的情况下,增添特定的功能。

    同样在 FastAPI 中也存在着像钩子函数的东西,也就是中间件 Middleware了。

计算回调时间

# -*- coding: UTF-8 -*-
import time
from fastapi import FastAPI
from starlette.requests import Request

app = FastAPI()


@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
    start_time = time.time()
    response = await call_next(request)
    process_time = time.time() - start_time
    response.headers["X-Process-Time"] = str(process_time)
    print(response.headers)
    return response


@app.get("/")
async def main():
    return {"message": "Hello World"}


if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app, host="127.0.0.1", port=8000)

请求重定向中间件

from fastapi import FastAPI
from starlette.middleware.httpsredirect import HTTPSRedirectMiddleware

app = FastAPI()

app.add_middleware(HTTPSRedirectMiddleware)

# 被重定向到 301
@app.get("/")
async def main():
    return {"message": "Hello World"}

授权允许 Host 访问列表(支持通配符匹配)

from fastapi import FastAPI
from starlette.middleware.trustedhost import TrustedHostMiddleware

app = FastAPI()

app.add_middleware(
    TrustedHostMiddleware, allowed_hosts=["example.com", "*.example.com"]
)


@app.get("/")
async def main():
    return {"message": "Hello World"}

跨域资源共享

from fastapi import FastAPI
from starlette.middleware.cors import CORSMiddleware

app = FastAPI()

#允许跨域请求的域名列表(不一致的端口也会被视为不同的域名)
origins = [
    "https://gzky.live",
    "https://google.com",
    "http://localhost:5000",
    "http://localhost:8000",
]

# 通配符匹配,允许域名和方法
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,   
    allow_credentials=True, 
    allow_methods=["*"],   
    allow_headers=["*"],   
)

    在前端 ajax 请求,出现了外部链接的时候就要考虑到跨域的问题,如果不设置允许跨域,浏览器就会自动报错,跨域资源 的安全问题。

    所以,中间件的应用场景还是比较广的,比如爬虫,有时候在做全站爬取时抓到的 Url 请求结果为 301,302, 之类的重定向状态码,那就有可能是网站管理员设置了该域名(二级域名) 不在 Host 访问列表 中而做出的重定向处理,当然如果你也是网站的管理员,也能根据中间件做些反爬的措施。

更多中间件参考  https://fastapi.tiangolo.com/advanced/middleware

2

BackgroundTasks

    创建异步任务函数,使用 async 或者普通 def 函数来对后端函数进行调用。

发送消息

# -*- coding: UTF-8 -*-
from fastapi import BackgroundTasks, Depends, FastAPI

app = FastAPI()


def write_log(message: str):
    with open("log.txt", mode="a") as log:
        log.write(message)


def get_query(background_tasks: BackgroundTasks, q: str = None):
    if q:
        message = f"found query: {q}\n"
        background_tasks.add_task(write_log, message)
    return q


@app.post("/send-notification/{email}")
async def send_notification(
    email: str, background_tasks: BackgroundTasks, q: str = Depends(get_query)
):
    message = f"message to {email}\n"
    background_tasks.add_task(write_log, message)
    return {"message": "Message sent"}

    使用方法极其的简单,也就不多废话了,write_log 当成 task 方法被调用,先方法名,后传参。

3

自定义 Response 状态码

在一些特殊场景我们需要自己定义返回的状态码

from fastapi import FastAPI
from starlette import status

app = FastAPI()

# 201
@app.get("/201/", status_code=status.HTTP_201_CREATED)
async def item201():
    return {"httpStatus": 201}

# 302
@app.get("/302/", status_code=status.HTTP_302_FOUND)
async def items302():
    return {"httpStatus": 302}

# 404
@app.get("/404/", status_code=status.HTTP_404_NOT_FOUND)
async def items404():
    return {"httpStatus": 404}

# 500
@app.get("/500/", status_code=status.HTTP_500_INTERNAL_SERVER_ERROR)
async def items500():
    return {"httpStatus": 500}


if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app, host="127.0.0.1", port=8000)

这么一来就有趣了,设想有个人写了这么一段代码

async def getHtml(self, url, session):
    try:
        async with session.get(url, headers=self.headers, timeout=60, verify_ssl=False) as resp:
            if resp.status in [200, 201]:
                data = await resp.text()
                return data
    except Exception as e:
        print(e)
        pass

    那么就有趣了,这段获取 Html 源码的函数根据 Http状态码 来判断是否正常的返回。那如果根据上面的写法,我直接返回一个 404 或者 304 的状态码,但是响应数据却正常,那么这个爬虫岂不是什么都爬不到了么。所以,嘿嘿你懂的!!

4

关于部署

部署 FastAPI 应用程序相对容易

Uvicorn 

    FastAPI 文档推荐使用 Uvicorn 来部署应用( 其次是 hypercorn),Uvicorn 是一个基于 asyncio 开发的一个轻量级高效的 Web 服务器框架(仅支持 python 3.5.3 以上版本)

安装

pip install uvicorn

启动方式

uvicorn main:app --reload --host 0.0.0.0 --port 8000

Gunicorn

    如果你仍然喜欢用 Gunicorn 在部署项目的话,请看下面

安装

pip install gunicorn

启动方式

gunicorn -w 4 -b 0.0.0.0:5000  manage:app -D

(完结篇)Python web框架FastAPI——一个比Flask和Tornada更高性能的API 框架_中间件_02

Docker部署

    采用 Docker 部署应用的好处就是不用搭建特定的运行环境(实际上就是  docker 在帮你拉取),通过 Dockerfile 构建 FastAPI  镜像,启动 Docker 容器,通过端口映射可以很轻松访问到你部署的应用。

Nginx

    在 Uvicorn/Gunicorn  + FastAPI 的基础上挂上一层 Nginx 服务,一个网站就可以上线了,事实上直接使用 Uvicorm 或 Gunicorn 也是没有问题的,但 Nginx 能让你的网站看起来更像网站。

撒花 !!!


标签:完结篇,return,框架,FastAPI,app,API,async,import,def
From: https://blog.51cto.com/u_13389043/6223855

相关文章

  • qiankun 框架是怎么做的样式隔离
    Qiankun是一个微前端框架,它在技术上采用了WebComponents技术实现样式隔离。具体来说,Qiankun利用ShadowDOM的特性,在应用程序容器中创建一个隔离的DOM树,使得每个子应用都可以拥有自己独立的样式作用域。在Qiankun中,每个子应用都被封装为一个CustomElement,这个Custom......
  • 记录使用Layui中一些常用的api
    获取当前操作行数据varcols=[[{title:'操作',toolbar:'#option',align:'center',height:80,width:120,fixed:'right'}]]<scriptty......
  • DDP运行报错(单卡无错):ERROR:torch.distributed.elastic.multiprocessing.api:failed (e
    使用DDP时出现错误,但是单卡跑无错误。错误记录如下:RuntimeError:Expectedtohavefinishedreductionintheprioriterationbeforestartinganewone.Thiserrorindicatesthatyourmodulehasparametersthatwerenotusedinproducingloss.Youcanenableunu......
  • 十大 API 平台网站分享(包括常用的API 大全整理)
    一、AWSAPIGateway是亚马逊云服务中的API管理平台,可以快速创建、发布和管理API,并提供可扩展的后端服务。 二、GoogleCloudEndpoints是GoogleCloudPlatform中的API管理平台,支持多种编程语言,可以轻松地创建、部署和管理API。 三、MicrosoftAzureAPIManagement......
  • 淘宝API接口对接(商品详情,评论,按图搜图,订单列表)代码封装,可高并发
    淘宝OpenAPI(Openapplicationprogramminginterface)是一套REST方式的开放应用程序编程接口。淘宝网根据自己提供的电子商务基础服务,抽象并做成一系列的API接口。通过这些接口,可以让外部用户能够通过程序的方式访问淘宝网的数据和平台。淘宝OpenAPI是淘宝开放平台的重要组成......
  • Unity框架:JKFrame2.0学习笔记(十一)——MonoSystem(1)
    内部结构MonoSystemMonoSystem是继承MonoBehaviour的,声明几个action,在MonoBehaviour的声明周期内调用,实现了不继承MonoBehaviour也可以用mono的生命周期。包括以下几个方法可供外部调用:Init:初始化,获取MonoSystem的实例AddUpdateListener:添加Update监听RemoveUpdateListener:移除Upd......
  • Linux基础知识(17)- Kerberos (二) | krb5 API 的 C 程序示例
    在“Linux基础知识(16)-Kerberos(一)|Kerberos安装配置”里我们演示了Kerberos安装配置和Kadmin等命令行工具的用法,本文将演示krb5API的使用方法。Krb5API:http://web.mit.edu/kerberos/krb5-current/doc/appldev/refs/api/index.html 1.系统环境   操作......
  • API接口,用户登录,获取用户信息,用户退出
    这个是前端请求的用户相关接口。路由:routers/apiRouters.go  funcApiRouter(router*gin.Engine){//会员登录router.POST("users/login",controllers.UserLogin)//使用JWT对用户的请求进行验证user:=router.Group("users/",middleware.CheckAuth......
  • Java基础知识点API之Objects
    一:Objects的概述它是一个对象工具类,提供一些操作对象的方法。二:Objects的成员方法方法名说明publicstaticbooleanequals(Objecta,Objectb)先做非空判断,比较两对象publicstaticbooleanisNull(Objectobj)判断对象是否为null,为null返回true,否则返回falsepublicstaticboolea......
  • 大型网站框架的演变
    大型网站框架的演变之前也有一些介绍大型网站架构演变的文章,例如LiveJournal的、ebay的,都是非常值得参考的,不过感觉他们讲的更多的是每次演变的结果,而没有很详细的讲为什么需要做这样的演变,再加上近来感觉有不少同学都很难明白为什么一个网站需要那么复杂的......