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抓取Discuz!用户名脚本代码
Dec 30 Python
Python中的面向对象编程详解(下)
Apr 13 Python
Python使用MYSQLDB实现从数据库中导出XML文件的方法
May 11 Python
Python脚本简单实现打开默认浏览器登录人人和打开QQ的方法
Apr 12 Python
python虚拟环境virtualenv的使用教程
Oct 20 Python
python实现字符串和字典的转换
Sep 29 Python
如何用Python来搭建一个简单的推荐系统
Aug 07 Python
解决python多行注释引发缩进错误的问题
Aug 23 Python
Python3操作MongoDB增册改查等方法详解
Feb 10 Python
Django media static外部访问Django中的图片设置教程
Apr 07 Python
Python使用20行代码实现微信聊天机器人
Jun 05 Python
Python集合的基础操作
Nov 01 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基础教程 php内置函数实例教程
2012/08/21 PHP
浅析PHP的静态成员函数效率更高的原因
2014/06/13 PHP
Zend Framework 2.0事件管理器(The EventManager)入门教程
2014/08/11 PHP
Thinkphp 3.2框架使用Redis的方法详解
2019/10/24 PHP
Javascript 原型和继承(Prototypes and Inheritance)
2009/04/01 Javascript
Javascript Select操作大集合
2009/05/26 Javascript
js创建子窗口并且回传值示例代码
2013/07/02 Javascript
js实现幻灯片播放图片示例代码
2013/11/07 Javascript
深入理解JavaScript系列(31):设计模式之代理模式详解
2015/03/03 Javascript
png在IE6 下无法透明的解决方法汇总
2015/05/21 Javascript
js实现的简单radio背景颜色选择器代码
2015/08/18 Javascript
jQuery Chart图表制作组件Highcharts用法详解
2016/06/01 Javascript
javascript与jquery动态创建html元素示例
2016/07/25 Javascript
利用js来实现缩略语列表、文献来源链接和快捷键列表
2016/12/16 Javascript
vue+mockjs模拟数据实现前后端分离开发的实例代码
2017/08/08 Javascript
js获取文件里面的所有文件名(实例)
2017/10/17 Javascript
vue以组件或者插件的形式实现throttle或者debounce
2019/05/22 Javascript
微信小程序渲染性能调优小结
2019/07/30 Javascript
在react中使用vue的状态管理的方法示例
2020/05/02 Javascript
python实现按行切分文本文件的方法
2016/04/18 Python
利用python实现简易版的贪吃蛇游戏(面向python小白)
2018/12/30 Python
Python3.4学习笔记之 idle 清屏扩展插件用法分析
2019/03/01 Python
python 爬取疫情数据的源码
2020/02/09 Python
python实现学生通讯录管理系统
2021/02/25 Python
国外最大的眼镜网站:Coastal
2017/08/09 全球购物
Johnston & Murphy官网: 约翰斯顿·墨菲牛津总统鞋
2018/01/09 全球购物
数控专业毕业生求职信范文
2013/09/21 职场文书
大学校庆策划书
2014/01/31 职场文书
企业节能减排实施方案
2014/03/19 职场文书
扩大国家免疫规划实施方案
2014/03/21 职场文书
警校毕业生自我评价
2014/04/06 职场文书
法人代表证明书
2014/09/18 职场文书
教师党员群众路线教育实践活动心得体会
2014/11/04 职场文书
党员廉洁自律个人总结
2015/02/13 职场文书
中学教师读书笔记
2015/07/01 职场文书
导游词之五台山
2019/10/11 职场文书