摘要：意味著我們要對(duì)用戶輸入進(jìn)行嚴(yán)格的驗(yàn)證，開發(fā)時(shí)一般輸入數(shù)據(jù)都以形式發(fā)送到后端，要對(duì)輸入數(shù)據(jù)做驗(yàn)證。一般我都是加很多判斷，各種，導(dǎo)致代碼很丑陋，能不能有一種方式比較優(yōu)雅的驗(yàn)證用戶數(shù)據(jù)呢就派上用場(chǎng)了。
Python Schema使用說(shuō)明
項(xiàng)目地址：GitHub
Schema是什么？
不管我們做什么應(yīng)用，只要和用戶輸入打交道，就有一個(gè)原則--永遠(yuǎn)不要相信用戶的輸入數(shù)據(jù)。意味著我們要對(duì)用戶輸入進(jìn)行嚴(yán)格的驗(yàn)證，web開發(fā)時(shí)一般輸入數(shù)據(jù)都以JSON形式發(fā)送到后端API，API要對(duì)輸入數(shù)據(jù)做驗(yàn)證。一般我都是加很多判斷，各種if，導(dǎo)致代碼很丑陋，能不能有一種方式比較優(yōu)雅的驗(yàn)證用戶數(shù)據(jù)呢？Schema就派上用場(chǎng)了。
Schema非常簡(jiǎn)單，也就幾百行的代碼，最核心的類就一個(gè)：Schema。
1. 給Schema類傳入類型（int、str、float等）
例如：
from schema import Schema
Schema(int).validate(10)
10
Schema(int).validate("10")
SchemaUnexpectedTypeError: "10" should be instance of "int"
可見Schema會(huì)去驗(yàn)證validate方法傳入的對(duì)象是不是所指定的類型，是則返回傳入的數(shù)據(jù)，否則拋出一個(gè)SchemaError的異常(SchemaUnexpectedTypeError是SchemaError的子類）。
2. 給Schema類傳入可調(diào)用的對(duì)象（函數(shù)、帶__call__的類等）
例如：
Schema(lambda x: 0(57) should evaluate to True
可見Schema會(huì)把validate方法傳入的值傳入到對(duì)應(yīng)的函數(shù)里面作為參數(shù)，如果函數(shù)返回值為True則返回輸入數(shù)據(jù)，否則拋出異常。
3. 給Schema類傳入帶有validate方法的對(duì)象
Schema也內(nèi)置了一些類（Use、And、Or等等），這些類的實(shí)例都帶有validate方法，亦可作為Schema的參數(shù)傳入，例如：
from schema import Schema, And
# And代表兩個(gè)條件必須同時(shí)滿足
Schema(And(str, lambda s: len(s) > 2)).validate("abcd")
"abcd"
4. 給Schema類傳入容器對(duì)象（list、tuple、set等）
例如：
Schema([int, float]).validate([1, 2, 3, 4.0])
[1, 2, 3, 4.0]
相當(dāng)于，對(duì)于[1, 2, 3, 4.0]當(dāng)中的任何一個(gè)元素，必須是int或者float才行（注意是or的關(guān)系）
5. 給Schema傳入一個(gè)字典對(duì)象（大部分使用Schema的場(chǎng)景都是傳入字典對(duì)象，這個(gè)很重要）
Schema({"name": str, "age": int}).validate({"name": "foobar", "age": 18})
{"age": 18, "name": "foobar"}
Schema({"name": str, "age": int}).validate({"name": "foobar"})
SchemaMissingKeyError: Missing keys: "age"
首先，明確兩個(gè)概念，Schema類傳入的字典，稱之為模式字典，valdiate方法傳入的字典稱之為數(shù)據(jù)字典。
首先，Schema會(huì)判斷， 模式字典和數(shù)據(jù)字典的key是否完全一樣，不一樣的話直接拋出異常。如果一樣，就去拿數(shù)據(jù)字典的value去驗(yàn)證模式字典相應(yīng)的value，如果數(shù)據(jù)字典的全部value都可以驗(yàn)證通過(guò)的話才返回?cái)?shù)據(jù)，否則拋出異常，是不是感覺這種驗(yàn)證頓時(shí)感覺清爽了呢？
6. faqs
Schema傳入字典很好用，但是我有的數(shù)據(jù)是可選的，也就是說(shuō)有的key可以不提供怎么辦？
from schema import Optional, Schema
Schema({"name": str, Optional("age"): int}).validate({"name": "foobar"})
{"name": "foobar"}
Schema({"name": str, Optional("age", default=18): int}).validate({"name": "foobar"})
{"age": 18, "name": "foobar"}
我想讓Schema只驗(yàn)證傳入字典中的一部分?jǐn)?shù)據(jù)，可以有多余的key但是不要抱錯(cuò)，怎么做？
Schema({"name": str, "age": int}, ignore_extra_keys=True).validate({"name": "foobar", "age": 100, "sex": "male"})
{"age": 100, "name": "foobar"}
Schema拋出的異常信息不是很友好，我想自定義錯(cuò)誤信息，怎么辦？
Schema自帶的類（Use、And、Or、Regex、Schema等）都有一個(gè)參數(shù)error，可以自定義錯(cuò)誤信息
Schema({"name": str, "age": Use(int, error="年齡必須是整數(shù)")}).validate({"name": "foobar", "age": "abc"})
SchemaError: 年齡必須是整數(shù)
文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/40971.html
