FastAPI Web開發(fā)入門、進階與實戰(zhàn)
定 價:129 元
叢書名:Web開發(fā)技術叢書
這是一本從實戰(zhàn)角度介紹FastAPI web開發(fā)的入門與進階型技術書。本書沒有過多的理論介紹,完全從一線工作角度入手,介紹日常web開發(fā)需要掌握的相關知識。本書共分為4篇16章: 第1篇是基礎篇,主要介紹FastAPI的基礎知識,包括FastAPI的基本信息、安裝使用、常規(guī)操作、中間件、數(shù)據(jù)庫相關內(nèi)容。作為初學者,掌握這部分內(nèi)容就可以快速上手使用FastAPI,處理各種日常問題。 第二篇是進階篇,主要圍繞與FastAPI相關的高級技能展開,包括異常處理、功能擴展、安全認證、性能、測試等相關內(nèi)容。 第三篇是實戰(zhàn)篇,主要從案例的角度對FastAPI在典型應用場景中的落地進行分享,包括短鏈應用、websocket、基于公眾號的掛號系統(tǒng)等應用場景。 第四篇是部署篇,這部分重點介紹如何實現(xiàn)FastAPI的自動化部署,這數(shù)據(jù)高階人員技能。本篇提供了三種自動化部署方式。
FastAPI被認為是取代Flask和Django的高性能的Web框架,是業(yè)界公認的Python Web的未來。尤其是在Python盛行的當下,F(xiàn)astAPI前景更被看好。InfoWorld發(fā)布的2021年最佳開源軟件中,F(xiàn)astAPI位列其中。FastAPI具有運行快速、編碼快捷、錯誤更少、操作直觀、簡易、代碼簡短、穩(wěn)健、基于標準。但是學習FastAPI有一定的門檻,本書從0開始,手把手教你玩轉(zhuǎn)FastAPI,是一本從入門到精通的好書。
Preface 前 言 FastAPI框架誕生于2018年12月,如今已經(jīng)活躍在各大廠家的產(chǎn)品中,如HttpRunner(一個通用測試框架),這足以說明它越來越受到人們的喜愛。截至本書完稿時,F(xiàn)astAPI在GitHub上已收獲54100余顆星,且仍然在快速增長中,與Flask這個老牌框架的距離在慢慢拉近(Flask有61800余顆星)。 在國內(nèi),使用FastAPI開發(fā)Web應用程序已經(jīng)開始流行。特別是在測試領域,國內(nèi)有非常多的企業(yè)在生產(chǎn)環(huán)境中將FastAPI作為主要開發(fā)框架。越來越多的Python程序員慢慢從Flask框架遷移到FastAPI,并開始在生產(chǎn)環(huán)境中進行應用。 作者之所以被FastAPI吸引,主要是因為它同時支持同步和異步特性。對于同步來說,從Flask遷移過來沒什么壓力;對于異步來說,F(xiàn)astAPI在單線程的模式下也可以支持更多的任務并發(fā)處理,結(jié)合依賴注入和各種模型校驗等,可以給開發(fā)人員帶來更快、更高效、更便捷的體驗。當然,F(xiàn)astAPI還有很多其他優(yōu)秀的特性,本書會進行深入分析。 FastAPI的流行之風已形成,但是國內(nèi)卻少有完整地介紹如何將FastAPI應用到生產(chǎn)環(huán)境中的教程,這對想使用FastAPI的用戶來說無疑是一個壞消息。為此作者在公眾號上發(fā)布了一系列與FastAPI基礎使用相關的文章,得到了讀者的廣泛好評。有不少讀者建議作者寫一本內(nèi)容全面、講解具體、實戰(zhàn)性強的圖書,于是,本書誕生了。 適合閱讀本書的讀者 要想快速且順暢地掌握本書內(nèi)容,需要廣大讀者掌握Python基礎知識。若讀者對Python完全不了解,則建議先對Python進行簡單學習,以便無障礙地閱讀本書。 具體來說,適合閱讀本書的讀者如下: 所有Python Web初中級開發(fā)人員。 想要從其他框架(如Flask、Django等)轉(zhuǎn)向FastAPI的Python工程師。 Python Web開發(fā)愛好者。 Python Web方向的后端工程師/運維工程師。 想使用FastAPI進行測試開發(fā)工作的工程師。 本書特點 本書的項目中包括了一些常用的知識點,從基礎到實戰(zhàn)都有所涉及,對于一些常見疑難問題,也有所陳述并提供了對應的解決方案,希望讀者可以從中受益。 本書主要在作者多年的項目實踐經(jīng)驗基礎上編寫而成,有以下特點。 (1)內(nèi)容全面,可滿足初中級讀者的需求。本書從基礎使用、運行原理到進階擴展再到高級應用,都進行了深度講解。無論是初級讀者的安裝部署、快速上手需求,還是中級讀者的二次開發(fā)、高級實踐需求,本書都能很好地滿足。 (2)內(nèi)容實用,可真正幫助讀者高效工作。本書所有的案例均來自實際開發(fā)項目,圍繞一線實踐需求展開。尤其對消息隊列的使用、緩存限流器的原理和使用、錯誤統(tǒng)計的實現(xiàn)等讀者關心的內(nèi)容,本書進行了深度解讀。通過閱讀本書,讀者可以真正上手開發(fā)自己的項目,并實現(xiàn)獨立部署上線。 (3)內(nèi)含一個大型的完整案例及多個來自一線的小案例。為了幫助讀者把所學知識落地到實際工作中,本書給出了大量案例,讀者可以邊閱讀邊實操。另外,為了完整展現(xiàn)開發(fā)全流程,讓讀者掌握使用FastAPI開發(fā)項目的方法,本書還給出了一個大型綜合案例預約掛號系統(tǒng),其中包括項目框架結(jié)構(gòu)規(guī)劃、路由分組模塊化、數(shù)據(jù)表模型設計、數(shù)據(jù)庫配置、API實現(xiàn)、異常錯誤處理、日志記錄、訂單處理、接口測試、部署上線等內(nèi)容。 (4)提供完整且可運行的示例源代碼。每章所涉及的示例代碼都是完整可運行的。通過示例代碼,讀者可以看到FastAPI對相關功能的實現(xiàn)過程,也能直觀體驗具體業(yè)務邏輯的處理過程。 開發(fā)工具版本說明 本書使用的開發(fā)工具版本如下: Python 3.9.5。 FastAPI 0.72.0。 PyCharm IDE 2021.2。 本地環(huán)境開發(fā)主要使用Windows 10,生產(chǎn)環(huán)境部署基于Linux的CentOS 7.6。 反饋與交流 本書中的所有示例代碼均托管于碼云(https://gitee.com/xiaozhong1988/fastapi_tutorial)上,讀者可以通過安裝Git客戶端來獲取相關示例代碼。 雖然作者使用FastAPI框架已有些時日,并在生產(chǎn)環(huán)境中進行了正式應用,但是不同企業(yè)或個人的業(yè)務環(huán)境、使用場景千差萬別,加之作者的水平有限,所以本書給出的部分代碼的寫法可能不是最優(yōu)的,也可能存在錯誤。關于代碼錯誤和優(yōu)化的相關問題,歡迎大家批評指正,也懇請讀者不吝賜教。 讀者可以關注公眾號程序員小鐘同學,也可以加入QQ群(247491107),與眾多FastAPI的愛好者一起學習交流。 致謝 首先要感謝FastAPI框架的作者Tiangolo創(chuàng)造了這么優(yōu)秀的產(chǎn)品。 其次要感謝TurboSnail研發(fā)團隊的領航員馬杰老師,是他帶我進入軟件開發(fā)領域。 還要感謝在IT之路上能讓作者堅持下來并給予很多指導和幫助的陳煥老師,在作者灰心喪氣時,陳老師給予了鼓勵及支持,沒有陳老師的幫助就沒有作者在IT領域的成就。感謝在本書編寫的過程中給予作者幫助的郭志強、李時濱及IT之路上的其他伙伴們,他們給作者的幫助是無價的。感謝龍艷給予作者的肯定和支持。還要特別感謝哥哥鐘遠幸給予的建議和指導。 另外,還要感謝教導過并時時記掛著作者的劉善初和黃宗宜老師。 最后要特別感謝在創(chuàng)作本書期間家人給予的幫助,特別是父親和母親的無私關懷和照顧。
目 錄 Contents 前言 第1章 初識FastAPI1 1.1 FastAPI框架概述1 1.1.1 FastAPI與其他Web框架2 1.1.2 FastAPI的特性2 1.2 異步編程基礎4 1.2.1 并發(fā)編程機制4 1.2.2 并發(fā)與并行5 1.2.3 同步與異步6 1.2.4 阻塞與非阻塞6 1.3 asyncio協(xié)程概念7 1.4 asyncio協(xié)程簡單應用8 第2章 初試FastAPI11 2.1 搭建開發(fā)環(huán)境11 2.1.1 安裝Python語言包11 2.1.2 PyCharm的安裝14 2.1.3 PyCharm IDE配置解析器15 2.1.4 PyCharm IDE解析器的切換18 2.1.5 PIP安裝源的設置19 2.2 新建FastAPI項目22 2.2.1 新建簡單項目22 2.2.2 項目依賴庫的安裝24 2.3 簡單項目介紹27 2.3.1 創(chuàng)建app實例對象27 2.3.2 添加API請求路由注冊28 2.3.3 添加后端渲染模板路由29 2.3.4 啟動服務運行30 2.3.5 uvicorn參數(shù)說明34 2.3.6 查看交互式API文檔35 第3章 FastAPI基礎入門38 3.1 app應用配置參數(shù)詳解38 3.1.1 開啟Debug模式39 3.1.2 關于API交互式文檔參數(shù)40 3.1.3 關閉交互式文檔訪問42 3.1.4 全局routes參數(shù)說明42 3.1.5 全局異常/錯誤捕獲43 3.2 API端點路由注冊和匹配44 3.2.1 路由節(jié)點元數(shù)據(jù)44 3.2.2 路由URL匹配46 3.2.3 基于APIRouter實例的 路由注冊48 3.3 同步和異步API端點路由50 3.3.1 同步API端點路由50 3.3.2 異步API端點路由51 3.4 多應用掛載51 3.4.1 主從應用掛載52 3.4.2 掛載其他WSGI應用52 3.5 自定義配置swagger_ui53 3.6 應用配置信息讀取55 3.6.1 基于文件讀取配置參數(shù)55 3.6.2 基于Pydantic和.env環(huán)境變量 讀取配置參數(shù)56 3.6.3 給配置讀取加上緩存58 3.7 API端點路由函數(shù)參數(shù)58 3.7.1 路徑操作及路徑函數(shù)59 3.7.2 Path參數(shù)59 3.7.3 Query參數(shù)63 3.7.4 Body參數(shù)67 3.7.5 Form數(shù)據(jù)和文件處理77 3.7.6 Header參數(shù)81 3.7.7 Cookie參數(shù)設置和讀取83 3.8 請求報文85 3.8.1 Request對象85 3.8.2 更多Request屬性信息86 3.9 響應報文87 3.9.1 HTTP狀態(tài)碼分類88 3.9.2 指定HTTP狀態(tài)碼89 3.9.3 使用response_model定義響應 報文內(nèi)容90 3.9.4 Response類型93 3.9.5 自定義Response類型98 3.10 后臺異步任務執(zhí)行99 3.11 應用啟動和關閉事件100 第4章 FastAPI異常及錯誤102 4.1 HTTPException異常103 4.1.1 HTTPException簡單源碼分析103 4.1.2 HTTPException的使用104 4.1.3 覆蓋HTTPException異常處理105 4.2 RequestValidationError錯誤106 4.2.1 RequestValidationError的使用106 4.2.2 覆蓋RequestValidationError 錯誤處理107 4.3 自定義異常108 4.3.1 自定義異常的實現(xiàn)108 4.3.2 自定義內(nèi)部錯誤碼和異常109 4.4 中間件拋出自定義異常110 第5章 Pydantic數(shù)據(jù)模型管理113 5.1 Pydantic介紹113 5.2 Pydantic的使用114 5.2.1 模型常見數(shù)據(jù)類型114 5.2.2 模型參數(shù)必選和可選115 5.2.3 模型多層嵌套116 5.2.4 模型對象實例化116 5.2.5 模型對象的轉(zhuǎn)換117 5.2.6 模型對象的復制118 5.2.7 異常信息的捕獲119 5.2.8 用Field()函數(shù)擴展更多復雜 驗證120 5.2.9 自定義驗證器123 5.2.10 自定義驗證器的優(yōu)先級124 5.2.11 多字段或模型共享校驗器125 5.2.12 root_validator根驗證器126 5.3 Pydantic在FastAPI中的應用127 5.3.1 模型類和Body的請求127 5.3.2 模型類和依賴注入關系128 5.3.3 模型Config類和ORM轉(zhuǎn)化130 第6章 FastAPI依賴注入機制詳解133 6.1 依賴注入框架134 6.2 依賴項及其聲明方式139 6.2.1 函數(shù)式依賴項140 6.2.2 類方式依賴項142 6.2.3 多個依賴項注入和依賴項 傳參143 6.3 多層依賴項嵌套注入144 6.4 多個依賴對象注入146 6.5 不同位置上的依賴項146 6.5.1 全局依賴項的注入147 6.5.2 路徑操作依賴項的注入148 6.5.3 路由分組依賴項的注入149 第7章 FastAPI中間件151 7.1 HTTP請求中間件151 7.2 @app.middleware裝飾器中間件152 7.3 CORSMiddleware跨域中間件155 7.3.1 跨域中間件的使用156 7.3.2 跨域中間件源碼分析157 7.4 其他中間件161 7.4.1 HTTPSRedirectMiddleware 中間件161 7.4.2 TrustedHostMiddleware中間件162 7.5 自定義中間件164 7.5.1 基于BaseHTTPMiddleware 自定義中間件164 7.5.2 日志追蹤鏈路ID165 7.5.3 IP白名單中間件167 7.5.4 基于中間件獲取響應報文 內(nèi)容168 第8章 數(shù)據(jù)庫的應用170 8.1 數(shù)據(jù)庫基礎170 8.1.1 SQL概述170 8.1.2 SQL數(shù)據(jù)庫170 8.1.3 NoSQL數(shù)據(jù)庫171 8.2 Python操作SQLite數(shù)據(jù)庫171 8.2.1 創(chuàng)建并鏈接到數(shù)據(jù)庫172 8.2.2 游標對象操作數(shù)據(jù)172 8.3 ORM操作數(shù)據(jù)庫173 8.4 SQLAlchemy庫174 8.4.1 數(shù)據(jù)驅(qū)動異步和同步說明174 8.4.2 SQLAlchemy同步使用方式175 8.4.3 SQLAlchemy異步使用方式179 8.4.4 SQLAlchemy ORM反向生成 模型184 8.5 SQLModel庫185 8.5.1 SQLModel同步使用方式186 8.5.2 SQLModel異步使用方式188 8.6 在FastAPI中整合異步 SQLAlchemy處理190 8.6.1 需求分析和結(jié)構(gòu)規(guī)劃190 8.6.2 應用配置信息讀取191 8.6.3 配置數(shù)據(jù)庫引擎191 8.6.4 使用yield管理會話依賴項192 8.6.5 定義表模型192 8.6.6 表模型CRUD封裝193 8.6.7 創(chuàng)建FastAPI實例并完成 表創(chuàng)建194 8.6.8 定義對外可見的API195 8.6.9 完善對外可見的API195 8.6.10 Alembic數(shù)據(jù)庫版本管理199 8.7 Redis數(shù)據(jù)庫及aioredis使用201 8.7.1 連接Redis數(shù)據(jù)庫202 8.7.2 Redis客戶端對象實例化202 8.7.3 Redis基本緩存的應用203 8.7.4 Redis發(fā)布訂閱的應用206 8.7.5 Redis分布式鎖的應用208 第9章 安全認證機制211 9.1 OpenAPI規(guī)范211 9.2 基于標準HTTP的身份驗證方案213 9.2.1 HTTPBasic基本認證方案213 9.2.2 HTTPDigest摘要認證方案215 9.3 基于APIKey的特定密鑰方案221 9.4 基于OAuth 2的授權機制頒發(fā) 令牌方案225 9.4.1 JWT組成結(jié)構(gòu)225 9.4.2 JWT應用實踐227 9.4.3 OAuth 2參數(shù)說明228 9.4.4 OAuth 2主體角色230 9.4.5 客戶端模式230 9.4.6 密碼模式237 9.4.7 授權碼模式243 9.4.8 簡化模式253 第10章 短鏈應用實戰(zhàn)254 10.1 應用開發(fā)背景254 10.2 應用系統(tǒng)功能需求描述255 10.3 項目代碼編寫256 10.3.1 項目規(guī)劃256 10.3.2 應用配置信息讀取257 10.3.3 配置數(shù)據(jù)庫引擎257 10.3.4 使用yield管理會話依賴項257 10.3.5 定義表模型258 10.3.6 用戶信息表CURD封裝259 10.3.7 短鏈信息表CURD封裝260 10.3.8 創(chuàng)建FastAPI實例并初始 化表261 10.3.9 創(chuàng)建測試賬號262 10.3.10 定義短鏈重定向接口262 10.3.11 定義短鏈生成接口263 10.3.12 將子路由添加到根路由并 啟動服務267 第11章 WebSocket Vue簡易聊天室 實戰(zhàn)269 11.1 WebSocket簡介269 11.2 項目系統(tǒng)描述270 11.3 項目代碼編寫271 11.3.1 項目代碼結(jié)構(gòu)271 11.3.2 前端頁面開發(fā)272 11.3.3 后端開發(fā)280 11.3.4 跨進程WebSocket通信290 第12章 預約掛號系統(tǒng)實戰(zhàn)298 12.1 應用開發(fā)背景及系統(tǒng)功能需求299 12.2 項目框架結(jié)構(gòu)規(guī)劃300 12.3 使用路由分組模塊化程序301 12.3.1 APIRouter參數(shù)說明302 12.3.2 APIRouter路由分組創(chuàng)建303 12.3.3 視圖函數(shù)綁定303 12.3.4 APIRouter路由分組注冊304 12.4 數(shù)據(jù)表模型設計304 12.4.1 數(shù)據(jù)庫安裝304 12.4.2 數(shù)據(jù)表設計308 12.4.3 模型類逆向生成310 12.4.4 數(shù)據(jù)庫引擎配置313 12.5 后端項目基礎框架搭建315 12.5.1 數(shù)據(jù)庫配置315 12.5.2 定制統(tǒng)一API內(nèi)容規(guī)范317 12.5.3 定制全局異常/錯誤處理320 12.5.4 基于中間件日志記錄322 12.6 關鍵業(yè)務API實現(xiàn)334 12.6.1 微信登錄授權334 12.6.2 獲取首頁醫(yī)院信息337 12.6.3 獲取醫(yī)生列表信息340 12.6.4 獲取醫(yī)生排班信息341 12.6.5 獲取排班信息詳情345 12.6.6 訂單提交并支付346 12.6.7 未支付訂單再次支付353 12.6.8 微信支付回調(diào)357 12.6.9 歷史預約詳情列表接口361 12.6.10 其他業(yè)務接口說明361 12.7 超時訂單處理362 12.7.1 消息隊列說明362 12.7.2 AMQP介紹362 12.7.3 本地安裝RabbitMQ364 12.7.4 RabbitMQ簡單應用369 12.7.5 RabbitMQ死信隊列371 12.7.6 訂單超時后自動取消的實現(xiàn)373 12.8 同步轉(zhuǎn)異步處理382 12.8.1 asgiref轉(zhuǎn)換庫介紹383 12.8.2 asgiref轉(zhuǎn)換庫應用383 第13章 基于Pytest的API測試385 13.1 Pytest簡單應用385 13.1.1 unittest和Pytest的對比386 13.1.2 pytest.fixture裝飾器的使用390 13.1.3 測試配置文件conftest.py395 13.2 用FastAPI進行API單元測試397 13.2.1 基于TestClient的單元測試397 13.2.2 基于Httpx的異步單元測試398 第14章 生產(chǎn)環(huán)境部署詳解405 14.1 Linux服務器下部署應用程序405 14.1.1 分配具有root權限的 普通用戶406 14.1.2 Linux系統(tǒng)上安裝Python 3406 14.1.3 基于pyenv管理Python版本407 14.1.4 基于pipenv管理虛擬環(huán)境410 14.1.5 生成依賴項配置文件412 14.1.6 基于Gunicorn Uvicorn的 服務部署414 14.1.7 基于Supervisor的服務進程 管理416 14.1.8 基于OpenResty的反向代理419 14.1.9 PostgreSQL數(shù)據(jù)庫的安裝423 14.2 基于SVN自動化部署425 14.3 基于Docker進行服務部署427 14.3.1 Docker的安裝和常用命令428 14.3.2 基于Dockerfile構(gòu)建鏡像430 14.3.3 Docker容器化部署與運行432 14.4 Docker下的環(huán)境變量433 14.4.1 基于OS標準庫433 14.4.2 基于Pydantic中的BaseSettings 自動綁定并解析環(huán)境變量434 14.4.3 Docker下的環(huán)境變量讀取434 14.5 基于Docker Compose進行服務 編排436 14.5.1 多服務容器獨立運行部署436 14.5.2 多Docker容器一鍵編排部署437 14.6 基于Gogs Drone進行可持續(xù) 集成441 14.6.1 通過Gogs搭建自助Git服務441 14.6.2 通過Drone搭建持續(xù)集成和 持續(xù)交付444 第15章 FastAPI實戰(zhàn)常見問題454 15.1 依賴注入項的傳參454 15.2 自定義插件開發(fā)456 15.2.1 插件模板基類的定義456 15.2.2 實現(xiàn)類似Flask鉤子事件 插件457 15.3 body重復消費引發(fā)阻塞問題460 15.3.1 阻塞問題復現(xiàn)460 15.3.2 解決方案462 15.4 全局request變量465 15.5 同步和異步相互轉(zhuǎn)換467 15.5.1 asgiref轉(zhuǎn)換包467 15.5.2 asyncer轉(zhuǎn)換包469 15.6 Model響應報文的排序470 15.7 同步和異步郵件發(fā)送471 15.7.1 同步方式472 15.7.2 異步方式474 15.8 基于Jaeger實現(xiàn)分布式 鏈路追蹤476 15.8.1 分布式鏈路追蹤的簡單定義476 15.8.2 OpenTracing數(shù)據(jù)模型477 15.8.3 Jaeger介紹478 15.8.4 Jaeger安裝和應用479 15.8.5 基于Jaeger SDK實現(xiàn)鏈路 追蹤480 15.8.6 FastAPI整合Jaeger SDK482 15.8.7 基于Jaeger SDK的跨服務 鏈路統(tǒng)計486 15.9 基于Sentry實現(xiàn)錯誤信息收集489 15.9.1 Sentry安裝和配置489 15.9.2 FastAPI框架中引入Sentry492