rapidjson幫你進行參數校驗 | Python 主題月

本文正在參加「Python主題月」，詳情查看 活動連接

微信公衆號搜索【程序媛小莊】，Rest cannot be enjoyed by lazy people~

前言

在使用Django框架開發先後端分離的項目時，一般須要對前端傳遞過來的參數進行校驗，校驗的方式有多種，可使用drf進行校驗，也可使用json進行校驗，本文介紹在Python中rapidjson的基本使用以及如何進行參數校驗。

rapidjson簡介和安裝

rapidjson是一個性能很是好的C++ JSON解析器和序列化庫，它被包裝成了Python3的擴展包，就是說在Python3中可使用rapidjson進行數據的序列化和反序列化操做而且能夠對參數進行校驗，很是方便好用。

rapidjson安裝命令：pip install python-rapidjson。

rapidjson基本使用

rapidjson和json模塊在基本使用方法上一致的，只不過rapidjson在某些參數方面和json模塊不兼容，這些參數並不經常使用，這裏不作過多介紹，詳情可參照rapidjson官方文檔。基本使用介紹兩個序列化的方法dump/dumps，反序列化的load/loads使用json模塊的便可。

dumps & dump這兩個方法都是將Python實例對象序列化爲JSON格式的字符串，用法和參數大體相同，dump方法比dumps方法多了一個必要的file_like參數。

dumps() 方法

該方法返回的結果是一個Python 字符串實例。參數很是多，這裏只介紹常常使用的三個參數。

rapidjson.dumps(obj, *, skipkeys=False, ensure_ascii=True, write_mode=WM_COMPACT, indent=4, default=None, sort_keys=False, number_mode=None, datetime_mode=None, uuid_mode=None, bytes_mode=BM_UTF8, iterable_mode=IM_ANY_ITERABLE, mapping_mode=MM_ANY_MAPPING, allow_nan=True)
複製代碼

skipkeys

該參數表示是否跳過不可用的字典的key進行序列化，若是默認爲False，若是修改成True字典的key若是不屬於基本數據類型(str int float bool None)之一就會跳過該key而不會拋出TypeError的異常。

import rapidjson
from pprint import pprint

dic = {
    True: False,
    (0,): 'python'
}
res = rapidjson.dumps(dic)
pprint(res)  # TypeError: {True: False, (0,): 'python'} is not JSON serializable

res = rapidjson.dumps(dic, skipkeys=True)
pprint(res)  # '{}'
複製代碼

ensure_ascii

該參數表示序列化的結果是否只包含ASCII字符，默認值是True，將Python實例序列化後全部的非ASCII碼的字符都會被轉義，若是將該參數的值修改成False，增會將字符原樣輸出。

dic = {
    'name': '麗麗',
    'name1': 'lili'
}
res = rapidjson.dumps(dic)
pprint(res)   # '{"name":"\\u4E3D\\u4E3D","name1":"lili"}'

res = rapidjson.dumps(dic, ensure_ascii=False)
pprint(res)  # '{"name":"麗麗","name1":"lili"}'
複製代碼

sort_keys

該參數表示序列化時是否將字典的key按照字母進行排序。默認是False，若是修改成True，字典序列化獲得的結果就是按照字典的key的字母順序進行排序的。

dic = {
    'name': '麗麗',
    'age': '10'
}
res = rapidjson.dumps(dic, ensure_ascii=False, sort_keys=True)
pprint(res)  # '{"age":"10","name":"麗麗"}'
複製代碼

dump()方法

該方法和dumps方法很是相似，不一樣的是該方法須要一個額外的必須的參數 - 一個file-like的可寫流式對象，好比文件對象，將第一個參數obj進行序列化寫入可寫的流式對象中。

rapidjson.dump(obj, stream, *, skipkeys=False, ensure_ascii=True, write_mode=WM_COMPACT, indent=4, default=None, sort_keys=False, number_mode=None, datetime_mode=None, uuid_mode=None, bytes_mode=BM_UTF8, iterable_mode=IM_ANY_ITERABLE, mapping_mode=MM_ANY_MAPPING, chunk_size=65536, allow_nan=True)
複製代碼

下面是該方法的基本使用：

# 寫入文件
dic = {
    'name': '麗麗',
    'age': '10'
}
f = open('1.py', 'w', encoding='utf8')
res = rapidjson.dump(dic, f)
pprint(res)

# 或者下面這種用法
import io

stream = io.BytesIO()
dump('bar', stream)
print(stream.getvalue())  # b'"bar"'

複製代碼

Validator class

rapidjson中的Validator類能夠用來作參數校驗。Validator的參數是JSON schema，當咱們須要知道JSON數據中預期的字段以及值的表示方式時，這就是JSON Schema的用武之地，是描述JSON數據結構的一種聲明格式，也能夠通俗的理解爲是參數的校驗規則。若是JSON schema是不可用的JSON格式的數據，就會拋出JSONDecodeError的異常。

類的參數就是校驗規則，若是給定的JSON數據沒有經過校驗就會拋出ValidationError異常，異常包括三個部分，分別是錯誤的類型、校驗的規則以及在JSON字符串中錯誤出現的位置。

import rapidjson
from pprint import pprint

validate = rapidjson.Validator('{"required": ["a", "b"]}')  # 表示a和b這兩個參數是必須的
validate('{"a": null, "b": 1}')  # 符合規則
validate('{"a": null, "c": false}')  # rapidjson.ValidationError: ('required', '#', '#')
複製代碼

validate = rapidjson.Validator('{"type": "array",'  # 參數類型是array
                     ' "items": {"type": "string"},'  # array中的每一個元素類型是string
                     ' "minItems": 1}')  # array中元素數量最少爲1

validate('["foo", "bar"]')  # 符合規則
validate('[]')  # rapidjson.ValidationError: ('minItems', '#', '#')
複製代碼

關於JSON schema的更多參數校驗規則以及定義規範能夠參考*JSON schema官方文檔*，下述是一種JSON schema格式僅供參考：

LOGIN_SCHEMA = {
    "type": "object",
    "properties": {
        "token": "string",
        "number": "integer"
    },
    "required": ["token"],
}   
}

validate = rapidjson.Validator(rapidjson.dumps(LOGIN_SCHEMA))
data = {
    'token': 'python',
    'number': 10
}
validate(rapidjson.dumps(data))
複製代碼

結語

文章首發於微信公衆號程序媛小莊，同步於掘金。

碼字不易，轉載請說明出處，走過路過的小夥伴們伸出可愛的小指頭點個贊再走吧(╹▽╹)