天下武功,唯快不破。在软件开发中更是如此,“快”能从多方面提升用户体验。谈到Python,它似乎天生就和速度无关,你可能很熟悉Django、Flask这些框架,虽然开发效率的确不错,但是速度就一言难尽。那么在前后端分离开发的时代,有没有能拿得出手的Python Web框架呢?当然是有的,FastApi它来了。
一、为什么是FastApi?
人们在介绍FastApi的时候通常会说“FastApi”是一个高性能的异步WEB框架。我相信没有哪个程序员会跟“高性能”过不去,这往往也是我们所追求的东西。fastapi具有并发性能强、能够快速上手、容错能力强、自动生成交互式文档的特点,这些都是我们选择它的理由。
二、到底有多快?
很多人介绍FastApi框架时,经常说其并发性能能够和NodeJS以及Go媲美,其实言过其实。在Go语言中文社区中梦想做小猿分别对Go、Flask、FastApi做了性能测试,迫于篇幅限制,我这里直接放结果:
FastAPI:500并发 30秒:Speed=955466 pages/min, 238685 bytes/sec
Flask:500并发 30秒:Speed=33706 pages/min, 96457 bytes/sec
Go:500并发 30秒:Speed=116962 pages/min, 278740 bytes/sec
可见Go还是很强大的,但是fastapi已经远远超过了同为python框架的 flask。
与PHP7对比:
分别用PHP7、FastAPI从mongodb数据库中取出相同的数据做成接口,相同参数得到相同的数据结果,速度如下:
FastApi用时43.06ms:
PHP7 用时43.73ms:
经过多次测试,成绩较为稳定,无需取平均值,由此看来,FastApi速度上相比于其他Python框架,是占有绝对优势的!
三、安装相关模块
FaseApi这么快,想必你已经迫不及待想要了解如何使用了。接下来我们讲讲如何开始第一个FastApi项目。
安装FastApi执行 pip install fastapi
由于FastApi还需要一个ASGI服务框架 uvicorn,需要执行pip install uvicorn来安装uvicorn。
注意Linux下一般会报错如下:
Centos 执行yum install python3-devel,Ubuntu 执行sudo apt-get install python3-dev,即可解决问题,非常简单!
四、Hello, API
现在就来快速上手吧:
第一个api:
创建文件zhiliao.py,码代码:
然后在zhiliao.py文件所在目录,执行uvicorn zhiliao:app --reload
其中,zhiliao是py文件名,冒号后面的app是我们在代码中创建的FastAPI实例,这一点类似Flask,其他参数等下会详细说到。
执行之后,得到反馈信息。
可以看到Uvicorn running on [http://127.0.0.1:8000 [0m (Press CTRL+C to quit),打开浏览器:
这样就成功的创建了第一个接口服务,每次请求的同时我们也能能够看到,请求日志,方便调试。
获取路径参数:
接着写如下代码:
保存之后可以看到:
项目自动重新加载了,我们无需再执行uvicorn……,原因是我们刚刚启动实例时,加了--reload参数,这一点类似于Flask中的debug=True,不推荐在线上环境中开启,仅为了线下调试方便。
访问浏览器:http://127.0.0.1:8000/hello/知了,可以看到:
我们不难发现,res在程序中是一个字典,而fastapi将其自动转为了json格式,无需再使用json模块进行编码,这极大的便利了我们的开发。
问号传参与数据类型限制:
为了防止用户填写表单时不按套路来,我们最好对参数类型进行限制,上代码:
浏览器访问http://127.0.0.1:8000/zhiliao?name=张三&age=23:
如果改成http://127.0.0.1:8000/zhiliao?name=张三&age='23'也即是字符23,会报错,提示数据类型错误。
{"detail":[{"loc":["query","age"],"msg":"value is not a valid integer","type":"type_error.integer"}]}
自动生成文档:
fastapi具有自动生成文档的能力:
交互文档:
访问:http://127.0.0.1:8000/docs,可以看到,上面我们写的三个接口都已经给出了文档。
还可以继续用于测试,我们测试一下第三个接口,填写两个值,然后点击 execute:
可以看到,给出了非常详细的反馈信息:
API文档:
我们打开http://127.0.0.1:8000/redoc
可以看到详细的文档:
五、进阶篇:
1. 基础参数配置:
我们使用uvicorn 配合fastapi,它是一个基于 asyncio 开发的一个轻量级高效的 Web 服务器框架。
下面一条命令演示常用参数:
--host是绑定的地址,127.0.0.1为本地,如果是0.0.0.0,那么意味着它将暴露在公网中,所有人都可以访问,线上环境常用。
--port 80表示,使用80端口作为该服务的默认端口,无需在地址后加端口号,可以直接访问 http://127.0.0.1
2. 开启 HTTPS, 给你的网站加把小锁:
鲜有人在讲fastapi时提到开启HTTPS,大人,时代变了,http早已经被谷歌浏览器标记为不安全。不过,你还别说,网站上了https 还真是好看呢。
另外,如果我们的应用不开启https,那么将意味着只能被未开启ssl的网站调用,假设我们主站用的是https,那么我们必须开启HTTPS,否则会调用失败。
说了这么多,其实做起来很简单,执行uvicorn --help可以看到详细的配置文档,可以看到:
有这么三个参数,第一个是证书的key文件,第二个是crt文件,第三个不用管是默认的。
只需执行:
uvicorn zhiliao:app --host 0.0.0.0 --port 8080 --ssl-keyfile /ssl/private.key --ssl-certfile /ssl/certificate.crt
这意味着我们的应用将会在8080端口运行,并且暴露在公网中,人们都可以访问,--ssl-keyfile参数后面跟key文件目录,--ssl-certfile,同理。可以看到,网站已经可以用https访问。
3. 配置跨域传参
既然是接口服务,那么跨域传参是必然要碰到的问题。
现有情景如下我们的Api服务是127.0.0.0:8000,而我们的网站主域名是127.0.0.1,
不同端口属于不同域,下面的介绍也适合其他跨域场景比如主站是www.xx.com而api服务的域名是api.xx.com,同样适合。
现在网站要调用api的接口,我们用jquery的 ajax试一下:
建立一个测试文件zhiliao.html,写入如下内容并访问:
可以看到,由于是不同域,访问失败:
加上几行代码,最终如下:
我们刷新浏览器:
跨域传参成功,获取数据成功。
那么,介绍到这里就结束了,相信有了python+fastapi的加持,python在web领域又多了一席之地。也希望,fastapi成为你的得力工具。
更多干货内容,欢迎关注公众号:知了python