Python中rapidjson参数校验实现


Posted in Python onJuly 25, 2021

前言

在使用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))

到此这篇关于Python中rapidjson参数校验实现的文章就介绍到这了,更多相关Python rapidjson参数校验内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
Python迭代用法实例教程
Sep 08 Python
通过代码实例展示Python中列表生成式的用法
Mar 31 Python
简单的Python2.7编程初学经验总结
Apr 01 Python
使用Python搭建虚拟环境的配置方法
Feb 28 Python
更改Python的pip install 默认安装依赖路径方法详解
Oct 27 Python
python实现桌面壁纸切换功能
Jan 21 Python
讲解Python3中NumPy数组寻找特定元素下标的两种方法
Aug 04 Python
python爬虫中多线程的使用详解
Sep 23 Python
手把手教你pycharm专业版安装破解教程(linux版)
Sep 26 Python
Python中Subprocess的不同函数解析
Dec 10 Python
Python图像处理库PIL的ImageFilter模块使用介绍
Feb 26 Python
python 串行执行和并行执行实例
Apr 30 Python
理解python中装饰器的作用
Jul 21 #Python
opencv检测动态物体的实现
Python爬虫中urllib3与urllib的区别是什么
python Django框架快速入门教程(后台管理)
Python编写nmap扫描工具
Jul 21 #Python
Django模型层实现多表关系创建和多表操作
Jul 21 #Python
Python基本数据类型之字符串str
Jul 21 #Python
You might like
php5中date()得出的时间为什么不是当前时间的解决方法
2008/06/30 PHP
php实现文件上传及头像预览功能
2017/01/15 PHP
PHP基于PDO实现的SQLite操作类【包含增删改查及事务等操作】
2017/06/21 PHP
微信开发之获取JSAPI TICKET
2017/07/07 PHP
PHP7引入的"??"和"?:"的区别讲解
2019/04/08 PHP
JS、jquery实现几分钟前、几小时前、几天前等时间差显示效果的代码实例分享
2014/04/11 Javascript
AngularJS中如何使用$http对MongoLab数据表进行增删改查
2016/01/23 Javascript
jQuery学习心得总结(必看篇)
2016/06/10 Javascript
Ionic默认的Tabs模板使用实例
2016/08/29 Javascript
jQuery查找节点并获取节点属性的方法
2016/09/09 Javascript
self.attachevent is not a function的解决方法
2017/04/04 Javascript
jQuery Ajax自定义分页组件(jquery.loehpagerv1.0)实例详解
2017/05/01 jQuery
js字符串与Unicode编码互相转换
2017/05/17 Javascript
angularJS模态框$modal实例代码
2017/05/27 Javascript
微信小程序实现横向增长表格的方法
2018/07/24 Javascript
在JavaScript中使用严格模式(Strict Mode)
2019/06/13 Javascript
国内常用的js类库大全(CDN公共库)
2020/06/24 Javascript
[03:12]完美世界DOTA2联赛PWL DAY9集锦
2020/11/10 DOTA
python 编写简单网页服务器的实例
2018/06/01 Python
Django框架实现的普通登录案例【使用POST方法】
2019/05/15 Python
Python获取好友地区分布及好友性别分布情况代码详解
2019/07/10 Python
django如何通过类视图使用装饰器
2019/07/24 Python
使用python实现回文数的四种方法小结
2019/11/24 Python
Python散点图与折线图绘制过程解析
2019/11/30 Python
pytorch 模型的train模式与eval模式实例
2020/02/20 Python
耐克奥地利官网:Nike奥地利
2019/08/16 全球购物
上海某公司.net方向笔试题
2014/09/14 面试题
行政前台岗位职责
2013/12/04 职场文书
鸿星尔克广告词
2014/03/21 职场文书
学习雷锋活动总结
2014/04/29 职场文书
旅游与环境专业求职信
2014/06/05 职场文书
县委班子四风对照检查材料思想汇报
2014/09/29 职场文书
四风查摆问题自查报告
2014/10/10 职场文书
社区国庆节活动总结
2015/03/23 职场文书
终止劳动合同通知书
2015/04/16 职场文书
SQL使用复合索引实现数据库查询的优化
2022/05/25 SQL Server