JSONLINT:python的json数据验证库实例解析


Posted in Python onNovember 28, 2017

JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式,易于人阅读和编写。

JSON 函数

使用 JSON 函数需要导入 json 库:import json。

函数 描述
json.dumps 将 Python 对象编码成 JSON 字符串
json.loads 将已编码的 JSON 字符串解码为 Python 对象

随着前后端分离和 REST APIs 的火热,开发者不断寻找着一种灵活的、优雅的方式验证 json 数据。有直接手动获取数据验证的,也有使用 json scheme 验证的。前者容易使得函数变得冗长,还可能存在不少重复的验证;后者验证又不灵活。

本文介绍的 jsonlint 启发自 python 的表单验证工具 wtforms,wtforms 通过继承 Form 类也能进行 json 数据验证,但是 wtforms 对于 json 的数组(Array)类型处理有着很诡异的行为,需要通过 a-1 、 a-2 这样来传递数组数据,常常不能有效的处理数组数据。 jsonlint 大部分代码来着 wtforms,可以视为 wtforms 的一个分支。但 jsonlint 删去了 wtforms 的表单渲染部分,更改了传入的数据格式,最重要的是使用正确的逻辑验证数组(Array)和对象(Object)类型。下面是一些例子:

基本的字符串类型json验证

对于基本的字符串类型,我们只需要创建一个 Json 的子类,填写对应的 Field 即可。使用方式和 wtforms 类型:

from jsonlint import Json
from jsonlint.fields import StringField
from jsonlint.validators import DataRequired
class MyLint(Json):
 name = StringField(validators=[DataRequired()])
mylint = MyLint({'name': 'demo'})
print mylint.validate() # True
print mylint.name.data # demo

更灵活的验证 json 数据

jsonlint 继承了 wtforms 的优点,可以进行一些更灵活的自定义json数据验证,只要将 field 类的实例名写成函数 validate_fieldname ,即可自定义验证改字段:

from jsonlint import Json
from jsonlint.fields import IntegerField
from jsonlint.validators import ValidationError
class AgeLint(Json):
 age = IntegerField()
 def validate_age(form, field):
  if field.data < 13:
   raise ValidationError("We're sorry, you must be 13 or older to register")
agelint = AgeLint({'age': 12})
print agelint.validate() # False
print agelint.age.errors # ["We're sorry, you must be 13 or older to register"]

对数组类型进行验证

jsonlint 诞生可以说主要就是为了解决如何验证数组类型的问题,在jsonlint这很容易实现:

from jsonlint import Json
from jsonlint.fields import StringField, ListField
from jsonlint.validators import DataRequired, ValidationError
class ListLint(Json):
 cars = ListField(StringField(validators=[DataRequired()]))
 def validate_cars(form, field):
  if 'BMW' in field.data:
   raise ValidationError("We're sorry, you cannot drive BMW")
listlint = ListLint({'cars': ['Benz', 'BMW', 'Audi']})
print listlint.validate() # False
print listlint.cars.errors # ["We're sorry, you cannot drive BMW"]

ListField 类作为一个 Field 容器,容纳其它类型 Field 的数组,将对应类型的数组直接传入,即可有效的验证;ListField 同样也可以进行自定义验证。

对对象类型进行验证

对象类型在一些 REST APIs 的 web 应用中也经常存在,对此 jsonlint 也作了支持。只要将 Json 子类传入 ObjectField 中即可进行验证:

from jsonlint import Json
from jsonlint.fields import ObjectField, IntegerField, BooleanField
class T(Json):
 status = BooleanField()
 code = IntegerField()
class DataLint(Json):
 data = ObjectField(T)
datalint = DataLint({'data': {'status': True, 'code': 200}})
print datalint.validate() # False
print datalint.data.code.data # 200

写在最后

jsonlint 诞生初衷就是因为本人想用类似 wtforms 的方式来验证json,这样不但有着良好的验证方式,还可以分割业务,避免接口主函数变得十分冗长。例如,可以定义类:

class RegisterLint(UserLint):
 def validata_nickname(self, field):
  ...
 def validate_account(self, field):
  ...
 def create_user(self):
  ...
user = RegisterLint()

这样既可以使用 RegisterLint 的实例 user 验证数据,同时又能直接执行 user.create_user() 进行数据库操作,将数据库逻辑更好的封装。这样可以说是在 MVC 设计模式的基础上独立出了一层。

想要尝试使用 jsonlint 可以直接使用 pip 安装:

pip install jsonlint

最后,jsonlint 开源在 Github : https://github.com/tangwz/jsonlint

jsonlint 现阶段仅由我一人维护,虽然单元测试覆盖率尽可能的全覆盖,但也不代表没有bug,希望您提出您宝贵的意见,或一起维护、迭代jsonlint:

https://github.com/tangwz/jsonlint/issues

如果使用 Flask 进行 web 开发,也可以使用封装好的结合了 Flask 和 jsonlint 的库: Flask-Lint

Python 相关文章推荐
Python的Flask站点中集成xhEditor文本编辑器的教程
Jun 13 Python
Python使用zip合并相邻列表项的方法示例
Mar 17 Python
python3+PyQt5实现拖放功能
Apr 24 Python
Python 中 function(#) (X)格式 和 (#)在Python3.*中的注意事项
Nov 30 Python
对python中数据集划分函数StratifiedShuffleSplit的使用详解
Dec 11 Python
Python3中的bytes和str类型详解
May 02 Python
如何爬取通过ajax加载数据的网站
Aug 15 Python
Python字符串大小写转换拼接删除空白
Sep 19 Python
Python datetime 格式化 明天,昨天实例
Mar 02 Python
Python基于smtplib模块发送邮件代码实例
May 29 Python
从Pytorch模型pth文件中读取参数成numpy矩阵的操作
Mar 04 Python
Python如何利用正则表达式爬取网页信息及图片
Apr 17 Python
详解如何使用Python编写vim插件
Nov 28 #Python
从头学Python之编写可执行的.py文件
Nov 28 #Python
浅谈用Python实现一个大数据搜索引擎
Nov 28 #Python
Python中用psycopg2模块操作PostgreSQL方法
Nov 28 #Python
Python搜索引擎实现原理和方法
Nov 27 #Python
python输入错误密码用户锁定实现方法
Nov 27 #Python
动态规划之矩阵连乘问题Python实现方法
Nov 27 #Python
You might like
php录入页面中动态从数据库中提取数据的实现
2006/10/09 PHP
PHP数字格式化
2006/12/06 PHP
Discuz 5.0 中读取纯真IP数据库函数分析
2007/03/16 PHP
php 时间计算问题小结
2009/01/04 PHP
PHP 八种基本的数据类型小结
2011/06/01 PHP
作为PHP程序员应该了解MongoDB的五件事
2013/06/03 PHP
PHP函数之日期时间函数date()使用详解
2013/09/09 PHP
php生成动态验证码gif图片
2015/10/19 PHP
客户端静态页面玩分页
2006/06/26 Javascript
onpropertypchange
2006/07/01 Javascript
javascript开发中因空格引发的错误
2010/11/08 Javascript
Array.prototype.concat不是通用方法反驳[译]
2012/09/20 Javascript
js小数运算出现多位小数如何解决
2015/10/08 Javascript
JavaScript获取客户端IP的方法(新方法)
2016/03/11 Javascript
jQuery解决$符号命名冲突
2016/06/18 Javascript
Vue项目webpack打包部署到服务器的实例详解
2017/07/17 Javascript
使用travis-ci如何持续部署node.js应用详解
2017/07/30 Javascript
使用cropper.js裁剪头像的实例代码
2017/09/29 Javascript
官方推荐react-navigation的具体使用详解
2018/05/08 Javascript
pyqt4教程之messagebox使用示例分享
2014/03/07 Python
Numpy中矩阵matrix读取一列的方法及数组和矩阵的相互转换实例
2018/07/02 Python
利用CSS3动画实现圆圈由小变大向外扩散的效果实例
2018/09/10 HTML / CSS
详解FireFox下Canvas使用图像合成绘制SVG的Bug
2019/07/10 HTML / CSS
请解释流与文件有什么不同
2016/07/29 面试题
优秀毕业生自我鉴定
2014/01/19 职场文书
毕业生欢送会主持词
2014/03/31 职场文书
阳光体育活动实施方案
2014/05/25 职场文书
三方股东合作协议书
2014/10/28 职场文书
好媳妇事迹材料
2014/12/24 职场文书
2015迎新晚会开场白
2015/07/17 职场文书
领导新年致辞2016
2015/07/29 职场文书
《抽屉原理》教学反思
2016/02/20 职场文书
竞聘演讲报告:基本写作有哪些?附开头范文
2019/10/16 职场文书
PHP实现rar解压读取扩展包小结
2021/06/03 PHP
一起来学习Python的元组和列表
2022/03/13 Python
Python 匹配文本并在其上一行追加文本
2022/05/11 Python