[发明专利]面向互联网接口服务的JSON报文校验方法

说明书

技术领域

本发明涉及报文校验技术，具体涉及一种面向互联网接口服务的JSON报文校验方法。

背景技术

传统JSON数据校验采用针对具体参数的逐一格式验证方式。服务端在接受到JSON格式数据后首先要对每个字段进行校验，若校验成功则继续执行剩余业务，失败则返回。

这种校验方式使字符校验和业务逻辑相耦合，每个业务编写都要进行重复的校验工作，导致代码容易出错，而且接口数据格式一旦发生变化，平台端代码也要随着变化，服务要重打包部署，由此增加了大量的复杂工作。可见传统JSON校验缺乏对JSON数据格式的整体规范性验证方法，存在着校验效率低的缺陷。

发明内容

本发明所要解决的技术问题是：提出一种面向互联网接口服务的JSON报文校验方法，解决传统技术中JSON校验缺乏对JSON数据格式的整体规范性验证方法带来的校验效率低的问题。

本发明采用的技术方案如下：

面向互联网接口服务的JSON报文校验方法，包括以下步骤：

a.针对定义好的JSON格式规范创建schema文件；

b.将创建的schema文件以注解的方式添加至定义的类属性字段上；

c.在接收到业务端的数据请求之后，依据schema文件对JSON数据进行校验；

d.向请求端返回校验结果。

作为进一步优化，所述schema文件中定义了验证报文的schema规则。

作为进一步优化，所述schema规则包括：报文体中允许包含的字段，字段数据类型，以及基础必填项。

作为进一步优化，步骤c中，还包括：

若校验通过，则执行后续处理步骤；若校验失败，则根据schema规则反馈出错明细。

作为进一步优化，步骤b中，在为类属性添加注解时，注解值为schema文件相对地址。

本发明的有益效果是：

本发明提出的JSON报文校验方法不需要在业务逻辑中嵌入任何校验相关代码，只需添加注解即可完成JSON数据的整体校验，而且当JSON数据格式发生变化也不需要修改业务代码，只需改动配置文件即可。

附图说明

图1为本发明实施例中的JSON报文校验方法流程图。

具体实施方式

本发明旨在提出一种面向互联网接口服务的JSON报文校验方法，解决传统技术中JSON校验缺乏对JSON数据格式的整体规范性验证方法带来的校验效率低的问题。

在本发明中，采用定义schema方式，开发人员先针对定义好的JSON格式规范创建一个schema文件，然后以注解的方式添加至接受类的属性之上，在接受到JSON数据之后容器会自动依照schema文件对JSON数据进行校验，通过之后执行后续操作，若校验失败，抛出异常，业务开发人员只需关注异常信息即可，无需关系具体校验过程。

下面结合附图及实施例对本发明的方案作进一步的描述：

如图1所示，本实施例中的面向互联网接口服务的JSON报文校验方法，包括以下步骤：

1、针对定义好的JSON格式规范创建schema文件；

本步骤中，创建的schema文件中定义了验证报文的schema规则；

此规则包含报文体中允许包含的字段，字段数据类型，以及基础必填项等规则：

2、将创建的schema文件以注解的方式添加至定义的类属性字段上；

本步骤中，将编写好的schema文件以注解的方式添加至定义的类属性字段上，注解值为schema文件相对地址。

3、在接收到业务端的数据请求之后，依据schema文件对JSON数据进行校验；

本步骤中，业务端向服务端发送请求时，将要验证的JSON报文内容和已定义的Schema规则传输服务端，服务端按照封装好的验证方案依据Schema规则对JSON报文进行校验。若校验成功，则执行后续业务处理步骤，若检验失败，则捕获异常信息；

4、向请求端返回校验结果；

本步骤中，向业务端返回校验成功或失败的标识，若为校验失败，还反馈具体的出错明细，以便进行处理。