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程序中访问Java类的简单示例
Apr 20 Python
python面向对象_详谈类的继承与方法的重载
Jun 07 Python
Python使用cx_Oracle调用Oracle存储过程的方法示例
Oct 07 Python
pandas DataFrame实现几列数据合并成为新的一列方法
Jun 08 Python
使用celery执行Django串行异步任务的方法步骤
Jun 06 Python
python pytest进阶之conftest.py详解
Jun 27 Python
决策树剪枝算法的python实现方法详解
Sep 18 Python
使用Python操作ArangoDB的方法步骤
Feb 02 Python
python实现QQ邮箱发送邮件
Mar 06 Python
python批量合成bilibili的m4s缓存文件为MP4格式 ver2.5
Dec 01 Python
python制作图形界面的2048游戏, 基于tkinter
Apr 06 Python
Python图片检索之以图搜图
May 31 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制作静态网站的模板框架(一)
2006/10/09 PHP
PHP生成图像验证码的方法小结(2种方法)
2016/07/18 PHP
替换php字符串中的单引号为双引号的方法
2017/02/16 PHP
PHP大文件分割上传 PHP分片上传
2017/08/28 PHP
PHP基于imagick扩展实现合成图片的两种方法【附imagick扩展下载】
2017/11/14 PHP
js 小贴士一星期合集
2010/04/07 Javascript
jQuery setTimeout()函数使用方法
2013/04/07 Javascript
js返回上一页并刷新的多种实现方法
2014/02/26 Javascript
jquery实现的缩略图预览滑块实例
2015/06/25 Javascript
jQuery UI结合Ajax创建可定制的Web界面
2016/06/22 Javascript
Vue单文件组件基础模板小结
2017/08/10 Javascript
angular2系列之路由转场动画的示例代码
2017/11/09 Javascript
利用vue+elementUI实现部分引入组件的方法详解
2017/11/22 Javascript
解决vue页面DOM操作不生效的问题
2018/03/17 Javascript
微信小程序自定义prompt组件步骤详解
2018/06/12 Javascript
jQuery实现炫丽的3d旋转星空效果
2018/07/04 jQuery
Vue利用History记录上一页面的数据方法实例
2018/11/02 Javascript
React Component存在的几种形式详解
2018/11/06 Javascript
jQuery实现图片随机切换、抽奖功能(实例代码)
2019/10/23 jQuery
Vue分页效果与购物车功能
2019/12/13 Javascript
JSONP解决JS跨域问题的实现
2020/05/25 Javascript
Nodejs + sequelize 实现增删改查操作
2020/11/07 NodeJs
Vue中computed和watch有哪些区别
2020/12/19 Vue.js
[56:00]2018DOTA2亚洲邀请赛 4.6 淘汰赛 VP vs TNC 第二场
2018/04/10 DOTA
python实现微信机器人: 登录微信、消息接收、自动回复功能
2019/04/29 Python
解决Python中pandas读取*.csv文件出现编码问题
2019/07/12 Python
Python响应对象text属性乱码解决方案
2020/03/31 Python
python利用Excel读取和存储测试数据完成接口自动化教程
2020/04/30 Python
入股协议书
2014/04/14 职场文书
工会工作先进事迹
2014/08/18 职场文书
关于成绩下滑的自我检讨书
2014/09/20 职场文书
合法的离婚协议书范本
2014/10/23 职场文书
2014年打非治违工作总结
2014/11/13 职场文书
李白经典诗之一:全文无一“月”字,却句句有月
2019/07/12 职场文书
html+css实现滚动到元素位置显示加载动画效果
2021/08/02 HTML / CSS
MySQL多表查询机制
2022/03/17 MySQL