近期在用aiohttp替換tornado重構一部分api，其中一些接口需要驗證比較多的請求參數，之前同事開發時挺趕的，直接在函數里一個個地驗證參數，光驗證參數得寫一百五六十行代碼。我重構時，想到用表單驗證來解決這個問題，讓代碼不至于那么臃腫。
官方文檔
http://wtforms.readthedocs.io/en/latest/
示例程序
示例程序web部分使用的是aiohttp，當然換成其他的像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測試
curl -l -H "Content-type: application/json" -X POST -d '{"action": "START"}' 127.0.0.1:8080/task
>>> {"message": "task_handler"}
說明
- 定義了ActionForm，驗證一個類型為String的字段action, validators.Required()表示該字段必須要有，若無則無法通過驗證，validators.optional()表示該參數可選
- 若post_data中有其他參數未在ActionForm定義的話，不會影響form的驗證，直接忽略
- 除了StringField外，還有其他如：BooleanField、DateField、IntegerField、PasswordField、FieldList、FormField等等，可以查看官方文檔
- FieldList是一個列表字段，可以指定list中field的類型
- FormField類似一個字典字段，可以嵌套定義
- 初始化Form后，調用validate()進行驗證，若通過驗證則返回True,否則返回False,失敗的情況加Form的errors返回所有所有驗證失敗的字段及失敗信息
自定義驗證函數 Custom validators
在使用過程中，會有需求對字段進行更細化的驗證，比如：希望action字段的字符串值在['START', 'CANCEL']范圍內,此時就需要編寫自定義的驗證函數，對字段進行追加驗證。
增加一個validator，用于驗證action字段在['START', 'CANCEL']范圍內，若不在則拋出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會按照先后順序調用所有的validator對字段進行驗證（鏈式調用，某個環節失敗則不繼續驗證）
class ActionForm(Form):
action = StringField('action', [validators.Required(), my_action_check])
- 此時調用接口時若傳入action參數不為START或CANCEL,則表單無法通過驗證。
- 驗證函數的form字段即為當前的form對象，可用來獲取其他字段的值進行聯合驗證
- 驗證函數的field字段即為當前的字段對象，通過field.data來獲取值
In-line Validators (內聯？。。不知道怎么翻譯)
以上的方式使得驗證函數具備一定的通用性，這里還有另一種方式用于驗證字段，在Form類中定義validate_fieldname格式的函數，則Form會自動調用來驗證對應的字段，函數同樣接收兩個參數：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]')
以上兩種驗證方式效果時一樣的
自定義字段 Custom Fields
有的場景下，會post復雜的json數據，wtForms自帶的字段會感覺不太夠用，此時可以自己定義一個字段，能靈活驗證數據。如嫌FieldList或者FormField用起來麻煩，可以自己定義一個ListField、DictField來驗證列表和字典字段。
自定義ListField,驗證數組
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測試
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字段不傳數組或數組為空則form無法通過驗證
- 自定義ListField時，需重寫process_formdata方法處理初始化時傳入的值，值通過valuelist[0]獲取，若驗證通過則將值賦給self.data，那么這個字段就有值了，后續的validators就可以對此值進行驗證
- validators.Required()實際做的事情就是判斷字段的self.data是否為True
小結
wtForms還有一些其他用法在此就不再介紹了，翻閱文檔吧。本文代碼均使用python3.5運行。若有問題，歡迎交流。
