在应用 Flask 实现 Restful 接口时,须要对申请参数进行校验以判断其是否合乎特定的规定。本文将介绍如何通过
pre-request
库优化校验逻辑。
接口需要
假如咱们须要实现一个收集用户填写的个人信息的接口,该接口的具体需要如下:
- 接口门路:
/user/info/new
- 接口字段:
字段 | 类型 | 阐明 |
---|---|---|
userName | string | 用户昵称,必填,2-20 位字符串 |
gender | int | 用户性别,必填,1- 男 2- 女 |
age | int | 用户年龄,必填,18-60 之间的整数 |
country | string | 用户国籍,选填,默认为 中国 , 字符串长度为 >2 |
接口实现
如果不借助任何第三方工具实现上述接口的话,代码可能如下所示:
from flask import request, Flask
app = Flask(__name__)
@app.route("/user/info/new", methods=["POST"])
def user_info_handler():
# 1. 判断用户名称参数是否非法
user_name = request.form.get("userName")
if not user_name or not isinstance(user_name, str):
return "请填写正确的用户名称"
if len(user_name) < 2 or len(user_name) > 20:
return "用户名称长度不正确"
# 2. 判断用户性别参数是否非法
gender = request.form.get("gender")
if not gender:
return "请填写用户性别"
try:
gender = int(gender)
except ValueError:
return "用户性别格局不正确"
if gender not in [1, 2]:
return "用户性别参数必须在 [1, 2] 之间"
# 3. 判断用户年级参数是否非法
age = request.form.get("age")
if not age:
return "请填写用户年龄"
try:
age = int(age)
except ValueError:
return "用户年龄格局不正确"
if age < 18 or age > 60:
return "年龄必须在 18-60 之间"
# 4. 判断国籍是否非法
country = request.form.get("country", "中国")
country = str(country)
if len(country) < 2:
return "国籍名称长度不非法"
# TODO: 用户信息注册逻辑
return "Success"
if __name__ == "__main__":
app.run(port=8080)
正如下面的代码所示,为了保障存储到数据库中的数据合乎设计要求,开发人员须要对入参做大量的校验工作,稍有不慎就有可能为零碎留下破绽隐患。
应用 pre-request
校验入参
同样是实现上述的接口需要,咱们来看一下通过 pre-request
如何将大量反复的校验逻辑进行屏蔽。
from flask import Flask
from pre_request import pre, Rule
app = Flask(__name__)
rule = {"userName": Rule(type=str, required=True, gte=3, lte=20, dest="user_name"),
"gender": Rule(type=int, required=True, enum=[1, 2]),
"age": Rule(type=int, required=True, gte=18, lte=60),
"country": Rule(type=str, required=False, gte=2, default="中国")
}
@app.route("/user/info/new", methods=["POST"])
def user_info_handler():
params = pre.parse(rule=rule)
# TODO: 用户信息注册逻辑
return "Success"
if __name__ == "__main__":
app.run(port=8080)
如上方所示,简单的参数校验工作变成了校验规定的编写,pre.parse
函数会主动捕捉申请参数并判断是否合乎校验规定,不合乎校验规定时会主动生成谬误响应,用户不须要做任何解决。
pre-request
相干链接
- 代码地址: https://github.com/Eastwu5788…
- 文档地址: https://pre-request.readthedo…