全面拥抱 FastApi — 多应用程序项目结构规划

简介: 全面拥抱 FastApi — 多应用程序项目结构规划

640.jpg

FastAPI最近比较火,自从看到这款框架后就一直在关注着。据官方文档上的介绍它是一个并发性可以和 NodeJS 以及 Go 相媲美的 web 框架,具有强大的性能

本人最近也是一直在使用和学习 FastApi,相比之前用的框架性能确实有很大的提升,用完后有如下几点感受:

  • 性能并发更强了,支持异步 async
  • 基于 Pydantic 的类型声明,自动校验参数
  • 自动生成交互式的 API 接口文档
  • 上手简单,能快速编码

上手快是真的,上班期间零零散散的看了两天文档,就将现有的一个服务改成 FastApi 服务了,配合 gunicorn+uvicorn 部署,最近测试也没出现什么问题。

由于之前 Flask 用的比较多,在 FastAPI 上隐隐约约能看到 Flask 的影子,两者的设计范式很类似。

例如:更大的应用程序服务多文件多 url 处理功能,在 Flask 中称之为蓝图的,对应 FastApI 中的 APIRouter

Flask 蓝图机制及应用

使用 APIRouter

上面说过和 Flask 非常的类似,比如创建一个简单的 FastAPI 服务

from fastapi import FastAPI
app = FastAPI()
@app.get("/")
asyncdef index():
    return"Hello world"
@app.get("/items/{item_id}")
asyncdef read_item(item_id: str, q: str = None, short: bool = False):
    item = {"item_id": item_id}
    if q:
        item.update({"q": q})
    ifnot short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item

上述代码中有两个视图函数以及 url 路径,现在这种情况看起来还好

但是如果服务中视图函数有 10 个或者更多呢?这时候就不建议写在一个文件里面了,因为代码不易维护且显得臃肿

这时候便要考虑将视图函数分文件处理了,APIRouter 就给我们提供了在多个文件中注册路由的功能。

类似生活中的常用的插线板,能提供更多的插口插入电器插头,然后我们最终只需要将这一个或多个插线板 (APIRouter) 插到主线路 (app = FastAPI() ) 即可

比如服务中两个应用模块,combination 和 level 分别对应两个应用模块,通过 APIRouter 来对其路由进行注册,用法如下:

combination.py

from fastapi import APIRouter
router = APIRouter()
@router.get("/users/", tags=["users"])
asyncdef read_users():
    return [{"username": "Foo"}, {"username": "Bar"}]
@router.get("/users/me", tags=["users"])
asyncdef read_user_me():
    return {"username": "fakecurrentuser"}

相应的 level.py 也能这样写,但是你是否会发现创建了两个 APIRouter() 的对象

这样当然也是可以的,官方文档就是这样举例的,你甚至可以创建更多。不过我觉得两个应用创建两个 router 感觉有点 "浪费", 我们是否可以这样:只创建一个 router ,然后在每个模块导入创建好的 router,当然也是可以,效果一样

这部分就是另起文件,创建 router, 代码非常简单,但是记住要导入模块对应视图函数,

routers.py

from fastapi import APIRouter
router = APIRouter()
from ..combination import views
from ..level2 import views

接下来就是在模块视图函数中导入上述创建好的 router

from app.routers import router
@router.get("/users/", tags=["users"])
asyncdef read_users():
    return [{"username": "Foo"}, {"username": "Bar"}]
@router.get("/users/me", tags=["users"])
asyncdef read_user_me():
    return {"username": "fakecurrentuser"}

另外一个模块也是一样的导入,代码就不贴了,理解就行

注册 APIRouter

最后一个步骤就是要将我们的 APIRouter 注册到核心对象上去,就像前面举的示例将插线板插到主线路插口上

和之前我们创建主文件一样导入 FastApi

from fastapi import FastAPI
app = FastAPI()
app.include_router(routers.router, prefix="/api")

其中 include_router() 函数就是上面说的注册。

这时候就完成了,使用该 app 来启动服务即可。当然你也可以将该核心对象包装成函数返回,然后在主目录调用启动,

def create_app():
    app = FastAPI()
    app.include_router(routers.router, prefix="/nlp_service")
    return app

主目录中创建 main.py 文件调用启动,

from app import create_app
app = create_app()

启动命令:

uvicorn main:app --host=0.0.0.0 --port=8800

640.png


本节完!敬请期待后续更多更新



相关文章
|
6月前
|
前端开发 开发者
探索前端技术的新趋势:Web组件化开发
【2月更文挑战第11天】 在这篇文章中,我们将深入探讨Web组件化开发的概念及其对前端开发领域的影响。不同于传统的摘要方式,我们通过一个故事来引入主题:想象在一个快速变化的数字世界里,有一座由各种小型、独立、可复用的建筑块构成的城市,每个建筑块都拥有独特的功能和风格,它们可以自由组合,创造出无限可能的城市景观。这座城市,就像是使用了Web组件化开发技术的前端项目。接下来,我们将详细探讨Web组件化开发的优势、实现方式以及面临的挑战,为前端开发者提供一个全面的视角来理解和应用这一重要的技术趋势。
|
6月前
|
缓存 前端开发 JavaScript
Vite 构建流程大揭秘:快速构建前端项目的秘密武器
Vite 构建流程大揭秘:快速构建前端项目的秘密武器
|
24天前
|
运维 Cloud Native Java
Java项目部署的发展流程
本文介绍了四种不同的应用部署方式:传统部署、虚拟化部署、容器化部署和云原生部署。每种方式的特点、部署流程及优缺点进行了详细说明。传统部署直接在物理机上运行应用,存在资源利用率低和运维成本高的问题;虚拟化部署通过虚拟机实现资源隔离和复用,但有性能损失和单点故障风险;容器化部署则提供轻量级、可移植的应用环境,具备良好的隔离性和一致性;云原生部署结合了容器化和微服务架构,实现高效运维和灵活扩展。
Java项目部署的发展流程
|
3月前
|
缓存 NoSQL 数据库
【超实用秘籍】FastAPI高手教你如何通过最佳实践构建高效Web应用:从代码组织到异步编程与缓存优化的全方位指南!
【8月更文挑战第31天】FastAPI凭借出色性能和易用性成为现代Web应用的首选框架。本文通过示例代码介绍构建高效FastAPI应用的最佳实践,包括开发环境搭建、代码模块化组织、异步编程及性能优化等。通过模块化设计和异步数据库操作,结合缓存技术,大幅提升应用性能与可维护性,助您轻松应对高并发场景。
154 0
|
4月前
|
移动开发 小程序 JavaScript
跨端技术问题之转Web运行时的“框架”模块主要负责什么功能
跨端技术问题之转Web运行时的“框架”模块主要负责什么功能
|
存储 API 数据安全/隐私保护
项目重要技术点介绍
项目重要技术点介绍
|
存储 缓存 资源调度
Monorepo,大型前端项目管理模式实践
阅读本文您将了解到:什么是 monorepo、为什么要 monorepo、如何实践 monorepo。
6854 50
Monorepo,大型前端项目管理模式实践
|
存储 资源调度 JavaScript
基于 Yeoman 脚手架技术构建前端项目的实践
基于 Yeoman 脚手架技术构建前端项目的实践
172 0
|
JavaScript 前端开发 算法
测试圈相亲平台开发流程 (2): vue和django 初始化,打通联调。
测试圈相亲平台开发流程 (2): vue和django 初始化,打通联调。
测试圈相亲平台开发流程 (2): vue和django 初始化,打通联调。
|
监控 前端开发 安全
迈出工程开放的第一步,DEF工程微平台体系升级之路
DEF 研发平台从 18 年 7 月由原有淘系的发布流程引擎平台 升级建设之后,服役到目前已经是第三个年头了。目前以各种形式服务着淘系及集团大多数前端研发、部署的流程。随着平台的维护和发展,也遇到了一些业务上的困境和挑战。
迈出工程开放的第一步,DEF工程微平台体系升级之路