webargs，參數(shù)校驗神器！
用Python做Web后端開發(fā)的同學想必都知道，如何快速解析和校驗前端傳遞過來的請求參數(shù)是代碼中必不可少的任務。
以flask為例
@app.route("/api/login", methods=["POST"])
def login():
data = request.get_json()
# 郵箱格式校驗
email = data.get("email")
if not email or re.match(r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)", email):
return jsonify({"code": 400, "msg": "參數(shù)有誤"}), 400
# 密碼長度校驗
password = data.get("password")
if not password or len(password) < 6:
return jsonify({"code": 400, "msg": "參數(shù)有誤"}), 400
# 數(shù)據(jù)庫查詢
return jsonify({"code": 200, "msg": "ok"})
對于一個簡單的登錄接口，要寫一堆又臭又長的參數(shù)校驗邏輯，而這些本是和業(yè)務邏輯沒什么關系的代碼。
只要是和業(yè)務無關的代碼，我們總能找到一些框架或者庫來解決問題，而針對web請求參數(shù)的解析和校驗庫， webargs 就是一款強大的工具。它直接站在巨人的肩膀上，基于marshmallow做了字段規(guī)則校驗工作，如果熟悉 marshmallow 的同學上手這個庫也就半小時。
另一個特點是它針對市面上常見的web框架都寫了一個單獨的解析器parser，對開發(fā)者來說無疑是真香，不管你用的是哪個web框架，都能無縫接入webargs到項目中，無需我們自己做過多封裝。
安裝
$ pip install -U webargs
使用
from webargs import fields
from webargs.flaskparser import use_args
app = Flask("hello")
@app.route("/api/login", methods=["POST"])
@use_args({"username": fields.Str(required=True),
"password": fields.Str(required=True, validate=lambda x: len(x) >= 6)})
def login(args):
name = args['username']
password = args['password']
return jsonify({"code": 200, "msg": "ok"})
use_args 是 webargs 提供的裝飾器，正是有了這個裝飾器，它能處理前端傳過來的請求參數(shù)，我們只要定義好schema，剩下的交給webargs。
所謂 schema 就是你希望前端傳過來的參數(shù)有哪些，每個參數(shù)的類型是什么，應該滿足什么規(guī)則等等。
這里我們定義的schema要求usename字段必須是字符串，而且是必填項， password 的長度必須大于6.
如果你用的是django，只需要導入djangoparser下的use_args 即可
from webargs.djangoparser import use_args
如果用戶沒有按照要求發(fā)送數(shù)據(jù)，代碼壓根就不會執(zhí)行到我們的業(yè)務代碼中去，直接在裝飾器就把錯誤返回給上層了，所以代碼整潔了不少。
如果傳的參數(shù)不符合要求，默認返回的錯誤碼是422。但是返回的錯誤信息似乎看不懂，api的調(diào)用者看了并不知道參數(shù)錯在哪里。
我們可以專門針對錯誤重新處理一下，同樣返回一個格式可讀的json體給前端， 這是flask的特性，如果是django，請自行查找相應的方法
@app.errorhandler(422)
@app.errorhandler(400)
def handle_error(err):
headers = err.data.get("headers", None)
messages = err.data.get("messages", ["Invalid request."])
if headers:
return jsonify({"errors": messages}), err.code, headers
else:
return jsonify({"errors": messages}), 400
location
webargs 默認情況下是從請求body中以json格式來讀取和解析參數(shù)的，如果要通過其他方式獲取，就需要指定在use_args中指定location
@app.route("/", methods=["GET"])
@use_args({"name": fields.Str(missing="Friend")}, location="querystring")
def index(args):
"""A welcome page."""
return jsonify({"message": "Welcome, {}!".format(args["name"])})
location可支持的類型有：
'querystring'：通過url后面的查詢參數(shù)獲取 'json' # 把請求body當作json來獲取參數(shù) 'form' # 通過form表單獲取參數(shù) 'headers' # 通過請求頭獲取參數(shù) 'cookies' # 通過cookie獲取 'files' # 通過文件獲取
驗證器
webargs 最強大的地方其實還在Field提供的校驗規(guī)則，依賴于marshmallow，我們可以指定每個字段的數(shù)據(jù)類型，支持的類型非常多。大部分都是marshmallow提供了，webargs自己也提供了部分字段類型。
除了可以指定具體的類型外，我們還可以指定驗證器來要求字段符合某種規(guī)則， validate 接收的參數(shù)是函數(shù)，意味著我們可以自定義任何規(guī)則。
def must_exist_in_db(val):
if val != 1:
raise ValidationError("id not exist")
hello_args = {"name": fields.Str(missing="Friend"),
"id": fields.Integer(required=True, validate=must_exist_in_db)}
@app.route("/", methods=["GET"])
@use_args(hello_args, location="query")
def hello(args):
"""A welcome page."""
return jsonify({"message": "Welcome, {}!".format(args["name"])})
先介紹這么多，更多高級功能參考：https://webargs.readthedocs.io/en/latest/quickstart.html
趕緊在你的項目中試試吧！
- EOF -
回復關鍵字“簡明python ”，立即獲取入門必備書籍《簡明python教程》電子版
回復關鍵字“爬蟲”，立即獲取爬蟲學習資料
推薦