介绍一下Web框架之fastapi

liuian 2024-12-03 16:32 56 浏览

Web框架在最近几年也发生了很大的变化，从大而全，转向现在专注于后端接口服务。例如PHP的codeigniter(我只用过这一点)，比如Python的django框架，都是基于MVC的Web框架，一个框架就可以完全解决前后端的问题。在基于javascript语言的前端大放异彩之后，后端Web框架已经让出了V(视图)，把注意力集中在做MC的工作上，当然前端可以干MC的工作，但先从后端开发同学的工作上来。

Python语言下面的Web框架非常的多。

从大而全的Django。

小而且美的Flask。

很早就支持异步的Tornado。

性能更进一步的异步框架sanic。

以上几款Web框架我多少都有使用过，我一度觉得sanic是pythonWeb框架的未来，支持异步，性能好，类flask的语法，代码简单，没想到被fastapi截胡了，fastapi在github的上星速度非常快。它在如何把后端api做好的这件事情上，做的比sanic更全面，更彻底。

个觉得fastapi在以下几个方面做得很优秀。

性能

先做个简单的性能对比：

flask

# flask==2.0.1
from flask import Flask
from flask import jsonify

app = Flask(__name__)


@app.route("/")
def hello_world():
    return jsonify({"hello": "world"})
1234567891011复制代码类型：[javascript]

fastapi

# fastapi==0.65.1
from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}
12345678910复制代码类型：[javascript]

虽然两个框架都支持异步（flask2.0支持异步），但我们使用的都是同步代码。

JMeter配置：并发（500）*循环（100）*启动时间（1s）=总请求数（50000）

结果flaskfastapigin运行时长67s28s5s最大值37197ms641ms270ms平均值582ms266ms40ms吞吐量751.s/sec1798.3/sec9817.4/sec

虽然是简单的对比，fastapi在各项性能指标，都有非常明显的性能优势。

api文档

fastapi直接支持OpenAPI(前身是Swagger)和redoc两种文档格式。

# main.py
from typing import Optional

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Optional[str] = None):
    return {"item_id": item_id, "q": q}
1234567891011121314151617复制代码类型：[javascript]

启动服务：

> uvicorn main:app --reload
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [19224] using statreload
INFO:     Started server process [23320]
INFO:     Waiting for application startup.
INFO:     Application startup complete.123456复制代码类型：[javascript]

访问：http://127.0.0.1:8000/docs

访问：http://127.0.0.1:8000/redoc

对于开发来说，简直不要太爽了，代码即文档，压根不用写接口文档。试问：还是谁？

类型检查

我们知道python是弱类型的语言，直到python3.5才加入类型系统。而我们在做接口参数校验的时候，必定要写大量代码验证参数是否为空，类型是否正确。

flask

import json
from flask import Flask
from flask import jsonify
from flask import request

app = Flask(__name__)

@app.route('/items/<int:item_id>', methods=['GET', 'POST', "PUT", "DELETE"])
def update_item(item_id):
    if request.method == "PUT":
        try:
            data = json.loads(request.get_data())
        except json.decoder.JSONDecodeError:
            return jsonify({"code":10101, "msg": "format error"})
        try:
            name = data["name"]
            price = data["price"]
            is_offer = data["is_offer"]
        except KeyError:
            return jsonify({"code": 10102, "msg": "key null"})

        if not isinstance(name, str):
            return jsonify({"code": 10103, "msg": "name not is str"})

        if not isinstance(price, float):
            return jsonify({"code": 10104, "msg": "price not is float"})

        if not isinstance(is_offer, bool):
            return jsonify({"code": 10105, "msg": "is_offer not is bool"})

        return jsonify({"item_name": name, "item_id": item_id})
1234567891011121314151617181920212223242526272829303132复制代码类型：[javascript]

在flask中为了验证参数是否为空，以及参数的类型，必须要写大量的异常和类型判断的代码。

fastapi

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    price: float
    is_offer: Optional[bool] = None


@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
    return {"item_name": item.name, "item_id": item_id}
1234567891011121314151617复制代码类型：[javascript]

fastapi通过pydantic检查参数类型，有一点像go的结构体，简直不要太简单。