rapidjson怎么安裝和使用

本篇內容介紹了“rapidjson怎么安裝和使用”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

rapidjson簡介和安裝

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

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

rapidjson基本使用

rapidjson和json模塊在基本使用方法上一致的，只不過rapidjson在某些參數方面和json模塊不兼容，這些參數并不常用，這里不做過多介紹，詳情可參照rapidjson官方文檔?；臼褂媒榻B兩個序列化的方法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":"u4E3Du4E3D","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))

“rapidjson怎么安裝和使用”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！