(完結篇)Python框架之FastAPI——一個比Flask和Tornado更高性能的API 框架 - 知乎

0
前端

前言
python


前幾天給你們分別分享了(入門篇)簡析Python web框架FastAPI——一個比Flask和Tornada更高性能的API 框架(進階篇)Python web框架FastAPI——一個比Flask和Tornada更高性能的API 框架。今天歡迎你們來到 FastAPI 系列分享的完結篇,本文主要是對於前面文章的補充和擴展。
web

固然這些功能在實際開發中也扮演者極其重要的角色。ajax






1docker

中間件的使用
後端


Flask 有 鉤子函數,能夠對某些方法進行裝飾,在某些全局或者非全局的狀況下,增添特定的功能。
api


一樣在 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





Docker部署


採用 Docker 部署應用的好處就是不用搭建特定的運行環境(實際上就是 docker 在幫你拉取),經過 Dockerfile 構建 FastAPI 鏡像,啓動 Docker 容器,經過端口映射能夠很輕鬆訪問到你部署的應用。


Nginx


在 Uvicorn/Gunicorn + FastAPI 的基礎上掛上一層 Nginx 服務,一個網站就能夠上線了,事實上直接使用 Uvicorm 或 Gunicorn 也是沒有問題的,但 Nginx 能讓你的網站看起來更像網站。

相關文章
相關標籤/搜索