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中的join()方法的使用
May 19 Python
Python基本语法经典教程
Mar 11 Python
使用python遍历指定城市的一周气温
Mar 31 Python
tensorflow实现简单的卷积网络
May 24 Python
Python基于pandas实现json格式转换成dataframe的方法
Jun 22 Python
Python 利用内置set函数对字符串和列表进行去重的方法
Jun 29 Python
对python捕获ctrl+c手工中断程序的两种方法详解
Dec 26 Python
在PyCharm下使用 ipython 交互式编程的方法
Jan 17 Python
Python实现删除排序数组中重复项的两种方法示例
Jan 31 Python
Python使用crontab模块设置和清除定时任务操作详解
Apr 09 Python
Python学习笔记之列表和成员运算符及列表相关方法详解
Aug 22 Python
python中setuptools的作用是什么
Jun 19 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
php制作动态随机验证码
2015/02/12 PHP
PHP保留两位小数的几种方法
2019/07/24 PHP
PHP反射基础知识回顾
2020/09/10 PHP
csdn 博客的css样式 v3
2009/02/24 Javascript
cnblogs csdn 代码运行框实现代码
2009/11/02 Javascript
Javascript 刷新全集常用代码
2009/11/22 Javascript
JQuery 学习笔记01 JQuery初接触
2010/05/06 Javascript
.net,js捕捉文本框回车键事件的小例子(兼容多浏览器)
2013/03/11 Javascript
script标签属性用type还是language
2015/01/21 Javascript
Jquery幻灯片特效代码分享--鼠标点击按钮时切换(1)
2015/08/15 Javascript
JavaScript下的时间格式处理函数Date.prototype.format
2016/01/27 Javascript
jQuery Dialog 打开时自动聚焦的解决方法(两种方法)
2016/11/24 Javascript
JS中用try catch对代码运行的性能影响分析
2016/12/26 Javascript
jQuery移除或禁用html元素点击事件常用方法小结
2017/02/10 Javascript
基于js中document.cookie全面解析
2017/09/14 Javascript
Vue 进阶之路(三)
2019/04/18 Javascript
JS实现求字符串中出现最多次数的字符和次数示例
2019/07/05 Javascript
基于canvas实现手写签名(vue)
2020/05/21 Javascript
基于原生js实现判断元素是否有指定class名
2020/07/11 Javascript
[01:34]2016国际邀请赛中国区预选赛IG战队教练采访
2016/06/27 DOTA
Python在Windows和在Linux下调用动态链接库的教程
2015/08/18 Python
Python 编码处理-str与Unicode的区别
2016/09/06 Python
利用python画出折线图
2018/07/26 Python
Python正则表达式指南 推荐
2018/10/09 Python
Python爬虫:url中带字典列表参数的编码转换方法
2019/08/21 Python
Python如何使用字符打印照片
2020/01/03 Python
Python BeautifulReport可视化报告代码实例
2020/04/13 Python
使paramiko库执行命令时在给定的时间强制退出功能的实现
2021/03/03 Python
HTML5实现的震撼3D焦点图动画的示例代码
2019/09/26 HTML / CSS
中国京东和泰国中央集团合资的网站:JD CENTRAL
2020/08/22 全球购物
自我评价怎么写正确呢?
2013/12/02 职场文书
办公室经理岗位职责
2014/01/01 职场文书
地理信息科学专业推荐信
2014/09/08 职场文书
会计简历自我评价
2015/03/10 职场文书
2015年保送生自荐信
2015/03/24 职场文书
用php如何解决大文件分片上传问题
2021/07/07 PHP