目錄前言rapidjson簡(jiǎn)介和安裝rapidjson基本使用dumps() 方法skipkeysensure_asciisort_keysdump()方法Validator class前言

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

rapidjson簡(jiǎn)介和安裝

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

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

rapidjson基本使用

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

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

dumps() 方法

該方法返回的結(jié)果是一個(gè)Python 字符串實(shí)例。參數(shù)非常多，這里只介紹經(jīng)常使用的三個(gè)參數(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ù)表示是否跳過(guò)不可用的字典的key進(jìn)行序列化，如果默認(rèn)為False，如果修改為T(mén)rue字典的key如果不屬于基本數(shù)據(jù)類型(str int float bool None)之一就會(huì)跳過(guò)該key而不會(huì)拋出TypeError的異常。

import rapidjsonfrom pprint import pprintdic = { True: False, (0,): ’python’}res = rapidjson.dumps(dic)pprint(res) # TypeError: {True: False, (0,): ’python’} is not JSON serializableres = rapidjson.dumps(dic, skipkeys=True)pprint(res) # ’{}’ensure_ascii

該參數(shù)表示序列化的結(jié)果是否只包含ASCII字符，默認(rèn)值是True，將Python實(shí)例序列化后所有的非ASCII碼的字符都會(huì)被轉(zhuǎn)義，如果將該參數(shù)的值修改為False，增會(huì)將字符原樣輸出。

dic = { ’name’: ’麗麗’, ’name1’: ’lili’}res = rapidjson.dumps(dic)pprint(res) # ’{'name':'u4E3Du4E3D','name1':'lili'}’res = rapidjson.dumps(dic, ensure_ascii=False)pprint(res) # ’{'name':'麗麗','name1':'lili'}’sort_keys

該參數(shù)表示序列化時(shí)是否將字典的key按照字母進(jìn)行排序。默認(rèn)是False，如果修改為T(mén)rue，字典序列化得到的結(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方法非常類似，不同的是該方法需要一個(gè)額外的必須的參數(shù) - 一個(gè)file-like的可寫(xiě)流式對(duì)象，比如文件對(duì)象，將第一個(gè)參數(shù)obj進(jìn)行序列化寫(xiě)入可寫(xiě)的流式對(duì)象中。

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)

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

# 寫(xiě)入文件dic = { ’name’: ’麗麗’, ’age’: ’10’}f = open(’1.py’, ’w’, encoding=’utf8’)res = rapidjson.dump(dic, f)pprint(res)# 或者下面這種用法import iostream = io.BytesIO()dump(’bar’, stream)print(stream.getvalue()) # b’'bar'’Validator class

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

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

import rapidjsonfrom pprint import pprintvalidate = rapidjson.Validator(’{'required': ['a', 'b']}’) # 表示a和b這兩個(gè)參數(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中的每個(gè)元素類型是string ’ 'minItems': 1}’) # array中元素?cái)?shù)量最少為1validate(’['foo', 'bar']’) # 符合規(guī)則validate(’[]’) # rapidjson.ValidationError: (’minItems’, ’#’, ’#’)

關(guān)于JSON schema的更多參數(shù)校驗(yàn)規(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ù)校驗(yàn)實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Python rapidjson參數(shù)校驗(yàn)內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！