乐趣区

关于python:用它5分钟以后我放弃用了四年的-Flask

jiezi

有一个非常简单的需要：编写一个 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 材料汇总 &&6W 字常识手册（长期更新）

退出移动版