别再用Flask了，来看看它[web开发常见问题]

  • Z时代
  • 2024-01-10
  • 分类：综合

python

Flask"/>

用它5分钟以后，我放弃用了四年的 Flask

有一个非常简单的需求：编写一个 HTTP接口，使用 POST 方式发送一个 JSON 字符串，接口里面读取发送上来的参数，对其中某个参数进行处理，并返回。

如果我们使用 Flask 来开发这个接口，那么代码是这样的：

from flask import Flask, request
app = Flask(__name__)@app.route('/insert', methods=['POST'])def insert():
    info = request.json
    name = info['name']
    age = info['age']
    age_after_10_years = age + 10
    msg = f'此人名叫：{name}，10年后，此人年龄：{age_after_10_years}'    return {'success': True, 'msg': msg}复制代码

代码看起来已经很简洁了。我们用requests发个请求看看效果，如下图所示：

看起来没什么问题。

现在，我搞点破坏，把age字段改成字符串，再运行一下：

不出所料，报错了。

现在我们把age字段改回数字，但是直接移除name字段：

又报错了。

为了防止用户不按规矩提交数据，我们必需在接口里面做好各种异常数据的判断。于是增加判断以后的代码变得复杂了：

@app.route('/insert', methods=['POST'])
def insert():
    info = request.json
    name = info.get('name', '')
    if not name:
        return {'success': False, 'msg': 'name 参数不可省略，不可为空！'}
    age = info.get('age', 0)
    if not isinstance(age, int):
        return {'success': False, 'msg': 'age参数不是数字！'}
    age_after_10_years = age + 10
    msg = f'此人名叫：{name}，10年后，此人年龄：{age_after_10_years}'
    return {'success': True, 'msg': msg}

看来，用 Flask，虽然能让你用很短的代码写出一个能工作的项目。但要写成一个可以正常使用的项目，还是需要你自己写更多代码。

下面我们来看一下，现代化的 web 框架：FaskApi能把这个工程简化到什么程度：

from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class People(BaseModel):
    name: str
    age: int
    address: str
    salary: float
    
@app.post('/insert')
def insert(people: People):
    age_after_10_years = people.age + 10
    msg = f'此人名字叫做：{people.name}，十年后此人年龄：{age_after_10_years}'
    return {'success': True, 'msg': msg}

我们还是使用 requests 发一条信息给 FastApi 开发的 HTTP接口。对于正常数据，正常使用：

现在我们把age字段改成字符串：

返回友好的提示信息，告诉我类型错误：age 字段不是 integer。

我们再试一试把name字段去掉：

返回友好信息，提示值错误：name字段丢失。

整个过程中，对类型的检查全都由 FastApi 自己完成。我们省下来很多时间。

我用了 Flask 四年，但在使用了5分钟 FastApi 以后，我决定以后不再使用 Flask 了。

回过头来，我们好好介绍一下 FastApi。

使用pip或者pipenv即可安装 FastApi：

pip install fastapi
pipenv install fastapi

安装完成以后，我们来完成第一个 API：

from fastapi import FastAPI
app = FastAPI()
@app.get('/')
def index():    
    return {'message': '你已经正确创建 FastApi 服务！'}

这里的写法跟 Flask 几乎一致。只不过在 Flask 中，我们定义路由的装饰器为@app.route('/')。而这里写为@app.get('/')

如下图所示：

写好代码以后，我们需要使用uvicorn来运行 FastApi。首先使用pip或者pipenv安装uvicorn：

pip install uvicorn
pipenv install uvicorn

然后执行命令：

uvicorn main:app --reload

其中main表示我们的代码文件为main.py，app表示我们初始化的FastApi 对象的名字。--reload参数表示在修改了代码以后立即生效，不需要重启。

运行命令以后，我们访问http://127.0.0.1:8000可以看到接口已经正确返回了 JSON 格式的数据：

那么如何定义一个带参数的 GET 方法呢？我们再写一段代码：

@app.get('/query/{uid}')
def query(uid):
    msg = f'你查询的 uid 为：{uid}'    
    return {'success': True, 'msg': msg}

写好代码以后，我们直接在浏览器里面访问新的地址，可以看到修改已经生效了，如下图所示：

如果想限定uid 只能是数字，不能是字符串怎么办呢？你只需要多加4个字符：

@app.get('/query/{uid}')
def query(uid: int):
    msg = f'你查询的 uid 为：{uid}'    
    return {'success': True, 'msg': msg}

对函数query的参数使用类型标注，标注为 int 类型。现在我们再来访问一下接口：

当 query 后面的参数不是整数时，正常报错了。

我们再来看一下本文一开始的 POST 方法。在使用 Flask 的时候，我们需要手动验证用户 POST 提交上来的数据是什么格式的，字段对不对。

但使用 FastApi 的时候，我们只需要类型标注就能解决所有问题。首先我们导入from pydantic import BaseModel，然后继承BaseModel实现我们允许 POST 方法提交上来的数据字段和格式：

from pydantic import BaseModel
app = FastAPI()
class People(BaseModel):
    name: str
    age: int
    address: str
    salary: float

People这个类通过类型标注，指定了它里面的4个字段和他们的类型。现在，我们来实现 POST 方法：

@app.post('/insert')
def insert(people: People):
    age_after_10_years = people.age + 10
    msg = f'此人名字叫做：{people.name}，十年后此人年龄：{age_after_10_years}'    
    return {'success': True, 'msg': msg}

insert函数的参数people通过类型标注指定为People类型。

当我们使用 POST 方式提交数据时，FastApi 自动会以People中定义的字段为基准来校验数据，发现不对就返回报错信息。

除了开发接口变得非常简单外，FastApi 还会自动帮我们生成接口文档。大家访问http://127.0.0.1:8000/docs，可以看到接口文档已经自动生成好了：

这个接口不仅能看，而且直接就能在接口页面修改样例数据，发送请求，现场测试：

以上是对 FastApi 的极简介绍。有兴趣的同学可以查阅它的官方文档

最后，告诉大家，FastApi 是一个异步 Web 框架，它的速度非常非常非常快。远远超过 Flask。


FastApi 是最快的几个 Web 框架之一。速度可以匹敌 Golang写的接口。详细的对比可以看：one of the fastest Python frameworks available

更多python相关文章请关注网。

以上是 别再用Flask了，来看看它[web开发常见问题] 的全部内容， 来源链接： utcz.com/z/527682.html

回到顶部