近期在用aiohttp替換tornado重構(gòu)一部分api瑞凑，其中一些接口需要驗(yàn)證比較多的請(qǐng)求參數(shù)腕巡，之前同事開(kāi)發(fā)時(shí)挺趕的骚烧，直接在函數(shù)里一個(gè)個(gè)地驗(yàn)證參數(shù)顶瞒，光驗(yàn)證參數(shù)得寫(xiě)一百五六十行代碼夸政。我重構(gòu)時(shí)，想到用表單驗(yàn)證來(lái)解決這個(gè)問(wèn)題搁拙，讓代碼不至于那么臃腫秒梳。
官方文檔
http://wtforms.readthedocs.io/en/latest/
示例程序
示例程序web部分使用的是aiohttp法绵，當(dāng)然換成其他的像flask、tornado都行的酪碘。
import json
import traceback
from multidict import MultiDict
from aiohttp import web
from wtforms import Form, StringField, validators, ValidationError
class ActionForm(Form):
action = StringField('action', [validators.Required()])
async def task_handler(request):
try:
post_data = await request.text()
post_data = json.loads(post_data)
_form = ActionForm(MultiDict(post_data))
if _form.validate():
print('>>>> {} validate success'.format(post_data))
else:
print('<<<< {}'.format(_form.errors))
return web.json_response({'message': 'form validate failed'}, status=400)
return web.json_response({'message': 'task_handler'})
except:
traceback.print_exc()
return web.json_response({'message': 'exception'})
app = web.Application()
app.router.add_post('/task', task_handler)
web.run_app(app, host='127.0.0.1', port=8080)
使用curl測(cè)試
curl -l -H "Content-type: application/json" -X POST -d '{"action": "START"}' 127.0.0.1:8080/task
>>> {"message": "task_handler"}
說(shuō)明
- 定義了ActionForm朋譬，驗(yàn)證一個(gè)類(lèi)型為String的字段action, validators.Required()表示該字段必須要有，若無(wú)則無(wú)法通過(guò)驗(yàn)證兴垦，validators.optional()表示該參數(shù)可選
- 若post_data中有其他參數(shù)未在ActionForm定義的話徙赢，不會(huì)影響form的驗(yàn)證，直接忽略
- 除了StringField外探越，還有其他如：BooleanField狡赐、DateField、IntegerField钦幔、PasswordField枕屉、FieldList、FormField等等鲤氢，可以查看官方文檔
- FieldList是一個(gè)列表字段搀擂，可以指定list中field的類(lèi)型
- FormField類(lèi)似一個(gè)字典字段，可以嵌套定義
- 初始化Form后卷玉，調(diào)用validate()進(jìn)行驗(yàn)證哨颂，若通過(guò)驗(yàn)證則返回True,否則返回False,失敗的情況加Form的errors返回所有所有驗(yàn)證失敗的字段及失敗信息
自定義驗(yàn)證函數(shù) Custom validators
在使用過(guò)程中，會(huì)有需求對(duì)字段進(jìn)行更細(xì)化的驗(yàn)證相种，比如：希望action字段的字符串值在['START', 'CANCEL']范圍內(nèi),此時(shí)就需要編寫(xiě)自定義的驗(yàn)證函數(shù)威恼，對(duì)字段進(jìn)行追加驗(yàn)證。
增加一個(gè)validator寝并，用于驗(yàn)證action字段在['START', 'CANCEL']范圍內(nèi)箫措，若不在則拋出ValidationError異常：
def my_action_check(form, field):
if field.data not in ['START', 'CANCEL']:
raise ValidationError('action must in [START, CANCEL]')
在ActionForm的action字段的validator列表中加入my_action_check,wtForms會(huì)按照先后順序調(diào)用所有的validator對(duì)字段進(jìn)行驗(yàn)證（鏈?zhǔn)秸{(diào)用，某個(gè)環(huán)節(jié)失敗則不繼續(xù)驗(yàn)證）
class ActionForm(Form):
action = StringField('action', [validators.Required(), my_action_check])
- 此時(shí)調(diào)用接口時(shí)若傳入action參數(shù)不為START或CANCEL,則表單無(wú)法通過(guò)驗(yàn)證食茎。
- 驗(yàn)證函數(shù)的form字段即為當(dāng)前的form對(duì)象蒂破，可用來(lái)獲取其他字段的值進(jìn)行聯(lián)合驗(yàn)證
- 驗(yàn)證函數(shù)的field字段即為當(dāng)前的字段對(duì)象，通過(guò)field.data來(lái)獲取值
In-line Validators (內(nèi)聯(lián)别渔？附迷。。不知道怎么翻譯)
以上的方式使得驗(yàn)證函數(shù)具備一定的通用性哎媚，這里還有另一種方式用于驗(yàn)證字段喇伯，在Form類(lèi)中定義validate_fieldname格式的函數(shù)，則Form會(huì)自動(dòng)調(diào)用來(lái)驗(yàn)證對(duì)應(yīng)的字段拨与，函數(shù)同樣接收兩個(gè)參數(shù)：form, field稻据。
class ActionForm(Form):
action = StringField('action', [validators.Required()])
def validate_action(form, field):
if field.data not in ['START', 'CANCEL']:
raise ValidationError('action must in [START, CANCEL]')
以上兩種驗(yàn)證方式效果時(shí)一樣的
自定義字段 Custom Fields
有的場(chǎng)景下，會(huì)post復(fù)雜的json數(shù)據(jù)，wtForms自帶的字段會(huì)感覺(jué)不太夠用捻悯，此時(shí)可以自己定義一個(gè)字段匆赃，能靈活驗(yàn)證數(shù)據(jù)。如嫌FieldList或者FormField用起來(lái)麻煩今缚，可以自己定義一個(gè)ListField算柳、DictField來(lái)驗(yàn)證列表和字典字段。
自定義ListField,驗(yàn)證數(shù)組
class ListField(Field):
def process_formdata(self, valuelist):
try:
if valuelist[0] and isinstance(valuelist[0], list):
self.data = valuelist[0]
else:
raise ValidationError('list validate error')
except:
raise ValidationError('list validate error, exception')
使用curl測(cè)試
curl -l -H "Content-type: application/json" -X POST -d '{"action": "START", "users": ["Tracy", "Kobe", "KD"]}' 127.0.0.1:8080/task
>>> test python3 aiotest.py
======== Running on http://127.0.0.1:8080 ========
(Press CTRL+C to quit)
>>>> {'action': 'START', 'users': ['Tracy', 'Kobe', 'KD']} validate success
若users字段不傳數(shù)組或數(shù)組為空則form無(wú)法通過(guò)驗(yàn)證
- 自定義ListField時(shí)姓言，需重寫(xiě)process_formdata方法處理初始化時(shí)傳入的值瞬项，值通過(guò)valuelist[0]獲取，若驗(yàn)證通過(guò)則將值賦給self.data何荚，那么這個(gè)字段就有值了囱淋，后續(xù)的validators就可以對(duì)此值進(jìn)行驗(yàn)證
- validators.Required()實(shí)際做的事情就是判斷字段的self.data是否為True
小結(jié)
wtForms還有一些其他用法在此就不再介紹了，翻閱文檔吧餐塘。本文代碼均使用python3.5運(yùn)行妥衣。若有問(wèn)題，歡迎交流戒傻。
