CN111064725A - 一种代码零入侵接口校验方法和校验装置 - Google Patents

Abstract

本发明属于通信技术领域，具体为一种代码零入侵接口校验方法，所述方法具体为：步骤1：建立以接口类为命名的JSON文件；步骤2：通过面向切面编程AOP技术对接口请求做切面拦截，获取接口请求中所包含的接口类、校验字段和与校验字段对应的请求数据；步骤3：根据步骤2中获取的接口类寻找以相同接口类为命名的JSON文件步骤4：判断接口请求中的校验字段所对应的请求数据是否符合JSON文件中相同校验字段的字段校验规则，若有任意一请求数据不符合对应的字段校验规则，则返回异常提示；若所有的数据请求均符合对应的字段校验规则，则通过校验。该方法可以做到不需改动原来代码、无感知的接口校验。同时，本发明还提供一种接口校验装置。

Description

一种代码零入侵接口校验方法和校验装置

技术领域

本发明涉及通信技术领域，具体为一种代码零入侵接口校验装置。

背景技术

接口校验的普遍方法为：在方法头添加注解或者业务方法内做参数校验。

但是这种方法存在的问题在于：每次增加或修改接口参数校验都需要改动代码。

申请人中国银行股份有限公司于2018年提出了一项发明专利申请CN201811338540.5，公开了一种接口报文的校验方法及装置，接收到待校验报文的信息后，根据待校验报文的信息中包括的字段信息，获取与所述字段信息对应的校验规则属性，以获取到与字段信息对应的校验函数名称以及校验规则参数，根据校验函数名称可以获取到与所述校验函数名称对应的校验规则程序，并将获取到的校验规则参数输入到校验规则程序中，以得到对所述字段信息对应的字段进行校验时所需要执行的校验规则程序，并根据得到的校验规则程序对待校验报文中的字段进行校验，而不需要针对不同的字段分别重新编写校验规则程序。且不同的报文或者不同的字段可以根据自身校验规则选择对应的校验规则程序完成校验，提高了校验的灵活性、可移植性以及复用性。

该方法可以解决上述的技术问题，但是该方法同样存在一些问题：比如该方法中涉及的校验函数名称或校验规则参数若存储在数据库中，当需要增加一个新接口方法的校验规则时，至少需要增加两条记录，一条为接口方法，一条为校验字段(包含入参类型、是否必传、长度、可传值等)，记录数根据校验字段增加而增加，记录之间还需要建立关联关系，添加完之后从直观上看不出层级关系，低效容易出错，而且，数据库一般是共享使用的，一旦改错，影响的是所有开发人员。

还比如，传统的接口请求的获取一般的方法为：在请求到接口方法的链路中间做结合接口校验工具类做参数字段校验，链路中间即需要改动原来代码；过滤器也是一种实现方式，但是局限于只能过滤web后台请求的入口。

所以现有技术无法做到真正的代码零入侵接口校验。

发明内容

本发明的目的在于提供一种代码零入侵接口校验方法，该方法可以做到不需改动原来代码、无感知的接口校验。

为实现上述目的，本发明提供如下技术方案：

一种代码零入侵接口校验方法，其特征在于，所述方法具体为：

步骤1：建立以接口类为命名的JSON文件，所述JSON文件中存储有一个或多个以校验字段为键，以字段校验规则为值的键值对；

步骤2：通过面向切面编程AOP技术对接口请求做切面拦截，获取接口请求中所包含的接口类、校验字段和与校验字段对应的请求数据；

步骤3：根据步骤2中获取的接口类寻找以相同接口类为命名的JSON文件，若找到以相同接口类为命名的JSON文件，则进行步骤4；

步骤4：判断接口请求中的校验字段所对应的请求数据是否符合JSON文件中相同校验字段的字段校验规则，若有任意一请求数据不符合对应的字段校验规则，则返回异常提示；若所有的数据请求均符合对应的字段校验规则，则通过校验。

在上述的代码零入侵接口校验方法中，若步骤3中根据步骤2中获取的接口类没有找到以相同接口类为命名的JSON文件，则返回校验通过的结果。

在上述的代码零入侵接口校验方法中，若步骤4中，若接口请求中有部分校验字段在JSON文件中没有对应的字段校验规则存在，且其他校验字段的请求数据均符合对应的字段校验规则，则返回校验通过的结果。

在上述的代码零入侵接口校验方法中，若需要增加接口类的校验规则，则在JSON文件中增加键值对或在任一的键值对中增加键值对；

若需要减少或修改接口类的校验规则，则在JSON文件中删除对应的键值对或修改对应的键值对中的校验字段和/或字段校验规则。

同时，本发明还公开了一种接口校验装置，包括如下模块：

JSON文件创建和存储模块：用于建立和存储以接口类为命名的JSON文件，所述JSON文件中存储有一个或多个以校验字段为键，以字段校验规则为值的键值对；

接口请求拦截模块：用于通过面向切面编程AOP技术对接口请求做切面拦截，获取接口请求中所包含的接口类、校验字段和与校验字段对应的请求数据；

JSON文件查找模块：用于根据接口请求拦截模块获取的接口类寻找以相同接口类为命名的JSON文件；

校验模块：用于采用JSON文件查找模块获取的JSON文件中的校验字段的字段校验规则来校验接口请求拦截模块获取的校验字段对应的请求数据，并返回异常提示或输出通过校验的结果。

在上述的接口校验装置中，所述校验模块还用于在JSON文件查找模块查找不到以相同接口类为命名的JSON文件时，输出通过校验的结果。

在上述的接口校验装置中，所述校验模块还用于若接口请求中有部分校验字段在JSON文件中没有对应的字段校验规则存在，且其他校验字段的请求数据均符合对应的字段校验规则，则返回校验通过的结果。

在上述的接口校验装置中，所述JSON文件创建和存储模块还用于在JSON文件中增加键值对或在任一的键值对中增加键值对。

在上述的接口校验装置中，所述JSON文件创建和存储模块还用于若需要减少或修改接口类的校验规则，在JSON文件中删除对应的键值对或修改对应的键值对中的校验字段和/或字段校验规则。

与现有技术相比，本发明的有益效果是：

通过AOP和JSON文件方式，实现对接口方法参数的校验。对于需要校验参数的接口，在指定目录新建一个以接口类为命名的JSON文件，并在JSON文件中添加校验规则(以接口方法名为键，参数校验规则JSON对象字符串为值)，通过AOP对接口请求做切面拦截(获取接口类、方法名和请求数据)，找到相应的JSON校验规则文件，结合接口校验工具类，对方法的入参类型、是否必传、长度、可传值等等做校验，不符合做抛出异常，真正做到不需改动原来代码、无感知。

通过AOP方式，可以在不改动原来代码情况下实现对接口方法请求参数的校验，JSON校验文件存储的是一个接口的所有接口方法校验规则，可以直观地看出一个接口方法的校验规则，添加或删除校验规则，只需要根据类名找到对应的JSON校验文件，并定位到相应的接口方法进行相应修改即可，便于修改，更加直观和高效，且JSON格式具有层级关系，可以方便灵活地实现有多层关系的复杂请求数据校验，JSON文件临时修改本地联调而不提交Git或SVN的情况下不影响其它开发人员，便于本地调试。

附图说明

图1为本发明的实施例1的流程方框图；

图2为本发明的实施例2所涉及的***的结构框图；

图3为本发明的实施例2的结构框图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

实施例1

一种代码零入侵接口校验方法，本方法的应用背景在于请求者向被请求者发出接口请求，请求者一般为前端页面或app或桌面成型，比如某公司网站有一个注册页面，客户填写了注册表单信息后，点击确认按钮，就会提交注册请求；被请求者，通常指的是后端服务，比如用户服务，订单服务，设备管理服务，服务内部增加校验模块功能，在请求达到业务方法前执行请求校验，以确保到达业务方法内的请求数据是齐全并符合规则的。

参考图1，所述方法具体为：

步骤1：建立以接口类为命名的JSON文件，所述JSON文件中存储有一个或多个以校验字段为键，以字段校验规则为值的键值对；

该JSON文件以下述代码为例阐述，但是下述代码并不作为本发明的限制：

JSON校验文件名称：UserServiceImpl.json

代码说明：

以上述代码为例，键的格式为”字段”，表示必须传参数名称为”字段”的参数值，如”companyId”:"String"，必须传参companyId；

键的格式为”(option)字段”，表示不强制传参数名称为”字段”的参数值，如”remark(option)”:”String”，表示可以不传参数remark；

值的格式为”类型”，表示入参值必须为对应的类型，如”Integer”，必须为整型数值；

值的格式为”类型[]”，表示必须为对应类型的数组，如”String[]”，必须为字符串数组；

值的格式为”类型(length)”，表示必须为对应类型且长度不超过length，如为类型数值，则表示大小不超过length，如”String(20)”，必须为不大于20位长度的字符串；如”Integer(20)”，必须为不大于20的整型数值；

值的格式为”类型{item1,item2...itemX}”，表示入参值为对应类型，且值只能为item1,item2...itemX，如”Integer{1,2}”，必须为数值1或2，不能为3或者4；

值的格式为”{字段1:xxx,字段2:xxx}”，表示参数值是一个JSON对象，JSON对象里的字段校验遵从上述规则；

值的格式为”[{字段1:xxx,字段2:xxx}]”，表示参数值是一个JSON对象数组，JSON对象里的字段校验遵从上述规则；

通过上述的代码说明我们可以得知其含有多个键值对，比如：键companyID，值string字符串；键userName，值string字符串等。

采用JSON文件的优势在于：JSON校验文件更直观可以看到每个接口方法的参数校验规则，且更加灵活多变，方便实现复杂的多层参数校验。

在传统技术中，大多采用数据库存储校验规则，在传统数据库存储校验规则时，使用不灵活，且实现难度高，一旦遇到复杂规则的校验参数，甚至需要变更底层结构，且不直观。

下面以一个具体的例子来说明，如果要在一个用户接口中增加一个地址信息的校验，则代码变成如下内容：

在添加用户接口中，添加多一个地址信息的校验，只需要在JSON文件中userList数组对象中添加多一层addressList校验规则即可，便捷高效且直观。而如果放在数据库中，至少需要增加两条记录，一条为接口方法，一条为校验字段(包含入参类型、是否必传、长度、可传值等)，记录数根据校验字段增加而增加，记录之间还需要建立关联关系，添加完之后从直观上看不出层级关系，低效容易出错，而且，数据库一般是共享使用的，一旦改错，影响的是所有开发人员，而JSON文件，支持本地调试，安全便捷。

同理对于校验规则的修改删除也是非常方便。

步骤2：通过面向切面编程AOP技术对接口请求做切面拦截，获取接口请求中所包含的接口类、校验字段和与校验字段对应的请求数据；

面向切面编程AOP技术对接口请求做切面拦截是在被请求者如后端服务一方进行的，通过面向切面编程AOP技术对接口请求做切面拦截，获取接口请求中所包含的接口类如通过对于接口请求进行解析发现该接口请求属于用户接口类。同时还解析该接口请求分析该接口请求中的校验字段和与校验字段对应的请求数据，如校验字段为用户注册接口方法，请求数据是与用户注册接口方法的校验规则相适应的请求数据。

通过AOP技术，可以在不变动原来接口代码的情况下实现拦截校验。

在传统技术中，大多通过其它方式来实现接口请求的拦截，比如可以在请求到接口方法的链路中间做结合接口校验工具类做参数字段校验，链路中间即需要改动原来代码；

采用过滤器也是一种实现方式，但是局限于只能过滤web后台请求的入口，

而切面编程AOP技术不管是web请求还是纯后台业务代码都可以实现过滤，过滤不符合校验规则的请求，并抛出提示。

一般来说，接口请求需要根据接口的校验规则传输指定的参数字段值，如添加用户接口，需要在提交表单带上用户名、用户账号、密码等参数值，删除用户接口，需要带上用户id。

如下：

批量添加用户接口的请求参数数据：

请求参数数据的字段、必传值、参数类型、可选值，必须符合用户接口类的添加用户方法参数校验规则，如不符合，则拦截请求。如：

(1)提示参数companyId不能为空:

(2)提示参数roleIds必须为数组类型：

步骤3：根据步骤2中获取的接口类寻找以相同接口类为命名的JSON文件，若找到以相同接口类为命名的JSON文件，则进行步骤4；若以相同接口类为命名的JSON文件，则返回校验通过的结果。

在步骤2中，比如该接口请求的接口类属于用户接口类，则在本步骤中需要找到JSON文件名称为用户接口的JSON文件，并从该JSON文件中找到用户注册接口方法和对应的校验规则。

步骤4：判断接口请求中的校验字段所对应的请求数据是否符合JSON文件中相同校验字段的字段校验规则，若有任意一请求数据不符合对应的字段校验规则，则返回异常提示至用户界面；若所有的数据请求均符合对应的字段校验规则，则通过校验。

判断接口请求中的校验字段所对应的请求数据是否符合JSON文件中相同校验字段的字段校验规则需要通过校验工具类来进行，该校验工具类可采用专用的或现有的校验程序实现。

步骤4中的异常提示一般返回值用户界面，比如在上述的接口类的接口请求校验过程中，如用户没有填写用户名，则返回的异常提示至用户界面提示用户名不能为空。

在现实应用中，还会出现一些具体情况，如接口请求中有部分校验字段在JSON文件中没有对应的字段校验规则存在，且其他校验字段的请求数据均符合对应的字段校验规则，则返回校验通过的结果。

本发明的方法实施例通过AOP方式，可以在不改动原来代码情况下实现对接口方法请求参数的校验，JSON校验文件存储的是一个接口的所有接口方法校验规则，可以直观地看出一个接口方法的校验规则，添加或删除校验规则，只需要根据类名找到对应的JSON校验文件，并定位到相应的接口方法进行相应修改即可，便于修改，更加直观和高效，且JSON格式具有层级关系，可以方便灵活地实现有多层关系的复杂请求数据校验，JSON文件临时修改本地联调而不提交Git或SVN的情况下不影响其它开发人员，便于本地调试。

实施例2

一种用于实现实施例1所述方法的接口校验装置B2，该装置以硬件或软件的形式存在于应用程序或服务所在的服务端B上，具体来说，本装置适用的***包括客户端A、服务端B，服务端B具有网关B1，网关B1下接用户服务，用户服务包括接口服务B3和本接口校验装置B2，包括如下模块：

JSON文件创建和存储模块1：用于建立和存储以接口类为命名的JSON文件，所述JSON文件中存储有一个或多个以校验字段为键，以字段校验规则为值的键值对；用于在JSON文件中增加键值对或在任一的键值对中增加键值对，该增加的键值对中同样是以校验字段为键，以字段校验规则为值；此外，还可以用于若需要减少或修改接口类的校验规则，在JSON文件中删除对应的键值对或修改对应的键值对中的校验字段和/或字段校验规则。

接口请求拦截模块2：用于通过面向切面编程AOP技术对接口请求做切面拦截，获取接口请求中所包含的接口类、校验字段和与校验字段对应的请求数据；

JSON文件查找模块3：用于根据接口请求拦截模块2获取的接口类通过JSON文件创建和存储模块1寻找以相同接口类为命名的JSON文件；

校验模块4：用于采用JSON文件查找模块3获取的JSON文件中的校验字段的字段校验规则来校验接口请求拦截模块2获取的校验字段对应的请求数据，并返回异常提示或输出通过校验的结果，此外，其还用于在JSON文件查找模块3查找不到以相同接口类为命名的JSON文件时，输出通过校验的结果，还可以用于若接口请求中有部分校验字段在JSON文件中没有对应的字段校验规则存在，且其他校验字段的请求数据均符合对应的字段校验规则，则返回校验通过的结果。

本装置的工作过程为：客户端A向服务端B发出接口请求，服务端B的网关B1对接口请求进行转发，本实施例所述的服务如接口请求或订单服务，每个服务都有服务接口，在服务接口处采用接口请求拦截模块2拦截接口请求，然后JSON文件查找模块3根据接口请求中的接口类通过JSON文件创建和存储模块1找到与该接口类同名的JSON文件，定位该JSON文件中的校验字段和校验规则，通过校验模块4采用校验工具类对接口请求中的校验字段、请求数据进行校验，判断请求数据是否符合校验字段的校验规则，若通过，则该接口请求校验通过，客户端A可调用该服务的接口，如果不通过，则反馈给客户端A异常提示。

如果JSON文件查找模块3找不到对应的JSON文件，校验通过；如果接口请求中有部分校验字段无法从JSON文件中找到且其他的请求数据均通过校验，该校验通过。

对于本领域技术人员而言，显然本发明不限于上述示范性实施例的细节，而且在不背离本发明的精神或基本特征的情况下，能够以其他的具体形式实现本发明。因此，无论从哪一点来看，均应将实施例看作是示范性的，而且是非限制性的，本发明的范围由所附权利要求而不是上述说明限定，因此旨在将落在权利要求的等同要件的含义和范围内的所有变化囊括在本发明内。不应将权利要求中的任何附图标记视为限制所涉及的权利要求。

Claims (9)

1.一种代码零入侵接口校验方法，其特征在于，所述方法具体为：

步骤1：建立以接口类为命名的JSON文件，所述JSON文件中存储有一个或多个以校验字段为键，以字段校验规则为值的键值对；

步骤2：通过面向切面编程AOP技术对接口请求做切面拦截，获取接口请求中所包含的接口类、校验字段和与校验字段对应的请求数据；

步骤3：根据步骤2中获取的接口类寻找以相同接口类为命名的JSON文件，若找到以相同接口类为命名的JSON文件，则进行步骤4；

步骤4：判断接口请求中的校验字段所对应的请求数据是否符合JSON文件中相同校验字段的字段校验规则，若有任意一请求数据不符合对应的字段校验规则，则返回异常提示；若所有的数据请求均符合对应的字段校验规则，则通过校验。

2.根据权利要求1所述的代码零入侵接口校验方法，其特征在于，若步骤3中根据步骤2中获取的接口类没有找到以相同接口类为命名的JSON文件，则返回校验通过的结果。

3.根据权利要求1所述的代码零入侵接口校验方法，其特征在于，若步骤4中，若接口请求中有部分校验字段在JSON文件中没有对应的字段校验规则存在，且其他校验字段的请求数据均符合对应的字段校验规则，则返回校验通过的结果。

4.根据权利要求1所述的代码零入侵接口校验方法，其特征在于，若需要增加接口类的校验规则，则在JSON文件中增加键值对或在任一的键值对中增加键值对；

若需要减少或修改接口类的校验规则，则在JSON文件中删除对应的键值对或修改对应的键值对中的校验字段和/或字段校验规则。

5.一种接口校验装置，其特征在于，包括如下模块：

JSON文件创建和存储模块：用于建立和存储以接口类为命名的JSON文件，所述JSON文件中存储有一个或多个以校验字段为键，以字段校验规则为值的键值对；

接口请求拦截模块：用于通过面向切面编程AOP技术对接口请求做切面拦截，获取接口请求中所包含的接口类、校验字段和与校验字段对应的请求数据；

JSON文件查找模块：用于根据接口请求拦截模块获取的接口类通过JSON文件创建和存储模块寻找以相同接口类为命名的JSON文件；

校验模块：用于采用JSON文件查找模块获取的JSON文件中的校验字段的字段校验规则来校验接口请求拦截模块获取的校验字段对应的请求数据，并返回异常提示或输出通过校验的结果。

6.根据权利要求5所述的接口校验装置，其特征在于，所述校验模块还用于在JSON文件查找模块查找不到以相同接口类为命名的JSON文件时，输出通过校验的结果。

7.根据权利要求5所述的接口校验装置，其特征在于，所述校验模块还用于若接口请求中有部分校验字段在JSON文件中没有对应的字段校验规则存在，且其他校验字段的请求数据均符合对应的字段校验规则，则返回校验通过的结果。

8.根据权利要求5所述的接口校验装置，其特征在于，所述JSON文件创建和存储模块还用于在JSON文件中增加键值对或在任一的键值对中增加键值对。

9.根据权利要求5所述的接口校验装置，其特征在于，所述JSON文件创建和存储模块还用于若需要减少或修改接口类的校验规则，在JSON文件中删除对应的键值对或修改对应的键值对中的校验字段和/或字段校验规则。

Images