快捷導(dǎo)航

Python中rapidjson參數(shù)校驗實現(xiàn)

更新時間：2021年07月23日 09:20:16 作者：程序媛小莊

通常需要對前端傳遞過來的參數(shù)進(jìn)行校驗，校驗的方式有多種，本文主要介紹了Python中rapidjson參數(shù)校驗實現(xiàn)，具有一定的參考價值，感興趣的小伙伴們可以參考一下

前言

在使用Django框架開發(fā)前后端分離的項目時，通常需要對前端傳遞過來的參數(shù)進(jìn)行校驗，校驗的方式有多種，可以使用drf進(jìn)行校驗，也可以使用json進(jìn)行校驗，本文介紹在Python中rapidjson的基本使用以及如何進(jìn)行參數(shù)校驗。

rapidjson簡介和安裝

rapidjson是一個性能非常好的C++ JSON解析器和序列化庫，它被包裝成了Python3的擴展包，就是說在Python3中可以使用rapidjson進(jìn)行數(shù)據(jù)的序列化和反序列化操作并且可以對參數(shù)進(jìn)行校驗，非常方便好用。

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

rapidjson基本使用

rapidjson和json模塊在基本使用方法上一致的，只不過rapidjson在某些參數(shù)方面和json模塊不兼容，這些參數(shù)并不常用，這里不做過多介紹，詳情可參照rapidjson官方文檔?；臼褂媒榻B兩個序列化的方法dump/dumps，反序列化的load/loads使用json模塊的即可。

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

dumps() 方法

該方法返回的結(jié)果是一個Python 字符串實例。參數(shù)非常多，這里只介紹經(jīng)常使用的三個參數(shù)。

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

該參數(shù)表示是否跳過不可用的字典的key進(jìn)行序列化，如果默認(rèn)為False，如果修改為True字典的key如果不屬于基本數(shù)據(jù)類型(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

該參數(shù)表示序列化的結(jié)果是否只包含ASCII字符，默認(rèn)值是True，將Python實例序列化后所有的非ASCII碼的字符都會被轉(zhuǎn)義，如果將該參數(shù)的值修改為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

該參數(shù)表示序列化時是否將字典的key按照字母進(jìn)行排序。默認(rèn)是False，如果修改為True，字典序列化得到的結(jié)果就是按照字典的key的字母順序進(jìn)行排序的。

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

dump()方法

該方法和dumps方法非常類似，不同的是該方法需要一個額外的必須的參數(shù) - 一個file-like的可寫流式對象，比如文件對象，將第一個參數(shù)obj進(jìn)行序列化寫入可寫的流式對象中。

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類可以用來做參數(shù)校驗。Validator的參數(shù)是JSON schema，當(dāng)我們需要知道JSON數(shù)據(jù)中預(yù)期的字段以及值的表示方式時，這就是JSON Schema的用武之地，是描述JSON數(shù)據(jù)結(jié)構(gòu)的一種聲明格式，也可以通俗的理解為是參數(shù)的校驗規(guī)則。如果JSON schema是不可用的JSON格式的數(shù)據(jù)，就會拋出JSONDecodeError的異常。

類的參數(shù)就是校驗規(guī)則，如果給定的JSON數(shù)據(jù)沒有通過校驗就會拋出ValidationError異常，異常包括三個部分，分別是錯誤的類型、校驗的規(guī)則以及在JSON字符串中錯誤出現(xiàn)的位置。

import rapidjson
from pprint import pprint

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

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

validate('["foo", "bar"]')  # 符合規(guī)則
validate('[]')  #  rapidjson.ValidationError: ('minItems', '#', '#')

關(guān)于JSON schema的更多參數(shù)校驗規(guī)則以及定義規(guī)范可以參考*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))

到此這篇關(guān)于Python中rapidjson參數(shù)校驗實現(xiàn)的文章就介紹到這了,更多相關(guān)Python rapidjson參數(shù)校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: