CN116680168A - Api接口入参动态校验方法、装置、电子设备及存储介质 - Google Patents

Abstract

本申请提供了一种API接口入参动态校验方法、装置、电子设备及存储介质，所述方法包括：定义API接口入参的目标校验规则，并将目标校验规则持久化至数据库中；从数据库中获取目标校验规则，将目标校验规则加载至数据校验框架中；响应于API接口入参，判断API接口入参是否需要动态校验，响应于API接口入参需要动态校验，则根据数据校验框架匹配出与API接口入参对应的目标校验实例，以执行数据校验。本申请从数据库中读取校验规则，将校验规则按照数据校验框架的规范，调用其提供的扩展接口，并加载至数据校验框架中，并与校验规则中的API和场景号为key创建关联关系，以达到API接口入参的动态校验的技术效果。

Description

API接口入参动态校验方法、装置、电子设备及存储介质

技术领域

本申请属于基础能力-通用后端技术领域，尤其涉及一种API接口入参动态校验方法、装置、电子设备及存储介质。

背景技术

在需求多样化的后端应用中，API接口入参可能存在不同场景下校验规则不一样的情况，现在后端应用的参数校验大多依赖hibernate-validator框架，而此框架提供的校验规则大多是通过注解的形式，比如场景1时，字段1和字段2均不可为空，场景2时，字段1可为空，字段2不可为空，这种情况下无法做到动态判断，特别是在同一接口对接多个web应用或第三方调用者时缺点尤为明显。

发明内容

有鉴于此，本申请旨在提出一种API接口入参动态校验方法、装置、电子设备及存储介质，以解决通过代码硬编码加注解的方式无法进行动态校验的问题。

为达到上述目的，本申请的技术方案是这样实现的：

本申请提供了一种API接口入参动态校验方法，所述方法包括：

定义API接口入参的目标校验规则，并将所述目标校验规则持久化至数据库中；

从所述数据库中获取所述目标校验规则，将所述目标校验规则加载至数据校验框架中；

响应于API接口入参，判断所述API接口入参是否需要动态校验，响应于所述API接口入参需要动态校验，则根据所述数据校验框架匹配出与所述API接口入参对应的目标校验实例，以执行数据校验。

进一步地，所述定义API接口入参的目标校验规则，并将所述目标校验规则持久化至数据库，包括：

获取API接口入参的需求配置文件，并根据所述需求配置文件配置生成目标校验规则；

通过sql语句或后台管理平台将所述API接口入参对应的目标校验规则持久化至数据库中。

进一步地，所述从所述数据库中获取所述目标校验规则，将所述目标校验规则加载至数据校验框架中，包括：

从数据库中读取所述目标校验规则，根据所述目标校验规则调用其对应的扩展接口加载至数据校验框架中，并以所述目标校验规则中的API+场景号为key创建关联关系。

进一步地，所述响应于API接口入参，判断所述API接口入参是否需要动态校验，响应于所述API接口入参需要动态校验，则根据所述数据校验框架匹配出与所述API接口入参对应的目标校验实例，以执行数据校验，包括：

判断所述API接口入参是否需要动态检验，响应于所述API接口入参需要动态校验，根据所述key查找对应的动态校验规则，进而匹配出对应的目标校验实例。

进一步地，还包括：

响应于执行数据校验成功，则进行后续业务流程处理；

响应于执行数据校验失败，则抛出异常提示。

基于同一发明构思，本申请还提供了一种API接口入参动态校验装置，所述装置包括：

定义模块，被配置为，定义API接口入参的目标校验规则，并将所述目标校验规则持久化至数据库中；

加载模块，被配置为，从所述数据库中获取所述目标校验规则，将所述目标校验规则加载至数据校验框架中；

数据校验模块，被配置为，响应于API接口入参，判断所述API接口入参是否需要动态校验，响应于所述API接口入参需要动态校验，则根据所述数据校验框架匹配出与所述API接口入参对应的目标校验实例，以执行数据校验。

基于同一发明构思，本申请还提供了一种电子设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述程序时实现如上所述的API接口入参动态校验方法。

基于同一发明构思，本申请还提供了一种非暂态计算机可读存储介质，其中，所述非暂态计算机可读存储介质存储计算机指令，所述计算机指令用于使所述计算机执行如上所述的API接口入参动态校验方法。

相对于现有技术，本申请所述的API接口入参动态校验方法、装置、电子设备及存储介质具有以下有益效果：

本申请所述的API接口入参动态校验方法、装置、电子设备及存储介质，所述方法旨在兼容hibernate-validator的情况下，将校验规则持久化，并在项目启动时加载至校验框架中，针对同一API接口不同场景下的接口入参进行动态校验，在兼容原有的校验框架的情况下，增加了动态校验的特性，且易于维护、易于扩展，在一个API对接多个第三方调用时尤为明显，同时，所述API接口入参的动态校验代码简洁，将参数校验统一处理，提高程序的可读性，减少不必要的校验代码逻辑。

附图说明

构成本申请的一部分的附图用来提供对本申请的进一步理解，本申请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中：

图1为本申请实施例所述的API接口入参动态校验方法流程示意图；

图2为本申请实施例所述的API接口入参动态校验装置结构示意图；

图3为本申请实施例所述的电子设备的结构示意图。

具体实施方式

为使本申请的目的、技术方案和优点更加清楚明白，以下结合具体实施例，并参照附图，对本申请进一步详细说明。

需要说明的是，除非另外定义，本申请实施例使用的技术术语或者科学术语应当为本申请所属领域内具有一般技能的人士所理解的通常意义。本申请实施例中使用的“第一”、“第二”以及类似的词语并不表示任何顺序、数量或者重要性，而只是用来区分不同的组成部分。“包括”或者“包含”等类似的词语意指出现该词前面的元件或者物件涵盖出现在该词后面列举的元件或者物件及其等同，而不排除其他元件或者物件。“连接”或者“相连”等类似的词语并非限定于物理的或者机械的连接，而是可以包括电性的连接，不管是直接的还是间接的。“上”、“下”、“左”、“右”等仅用于表示相对位置关系，当被描述对象的绝对位置改变后，则该相对位置关系也可能相应地改变。

如背景技术部分所述，目前大多方案都只是通过代码硬编码，加注解的形式进行参数校验，这无法支持复杂场景，开发人员只能够在代码中通过不同场景判断，增加许多代码块来做这个事情，比如一个API接口有10个场景，则需要10段代码来处理参数校验，相关的API接口入参校验方法存在无法动态校验、不能满足复杂场景的缺陷，难以满足API接口入参的校验需求。

基于此，本申请中的一个或多个实施例中提供了API接口入参动态校验方法，本申请旨在兼容hibernate-validator的情况下，将校验规则持久化，并在项目启动时加载至校验框架中，针对同一API接口不同场景下的接口入参进行动态校验，在兼容原有的校验框架的情况下，增加了动态校验的特性，且易于维护、易于扩展，在一个API对接多个第三方调用时尤为明显，同时，所述API接口入参的动态校验代码简洁，将参数校验统一处理，提高程序的可读性，减少不必要的校验代码逻辑。

以下结合附图详细说明本申请的实施例。

请参阅图1所示，本申请实施例提供了一种API接口入参动态校验方法，所述方法包括：

S101、定义API接口入参的目标校验规则，并将目标校验规则持久化至数据库中。

在一些实施方式中，获取API接口入参的需求配置文件，并根据需求配置文件配置生成目标校验规则；

通过sql语句或后台管理平台将API接口入参对应的目标校验规则持久化至数据库中。

需要说明的是，API接口入参是指API接口输入参数，通过获取API接口输入参数的需求配置文件，这里的需求配置文件可以是commitlint，利用commitlint规范定义目标校验规则，亦或其他配置文件，能够实现对API接口入参的目标校验规则即可，均纳入至本申请的保护范围之内。

S102、从数据库中获取目标校验规则，将目标校验规则加载至数据校验框架中。

在一些实施方式中，从数据库中读取目标校验规则，根据目标校验规则调用其对应的扩展接口加载至数据校验框架中，并以目标校验规则中的API+场景号为key创建关联关系。

具体地，项目启动时，从数据库中读取校验规则，将校验规则按照数据校验框架(hibernate-validator)的规范，调用其提供的扩展接口，并加载至数据校验框架中，并与校验规则中的API和场景号为key创建关联关系，建立一个API接口可以对接不同场景下的校验规则，也就解决了一个API接口入参存在不同场景下校验规则不一样的情况，为后续查找对应的动态校验规则提供技术前提支持。

需要说明的是，本申请所述hibernate-validator为本领域成熟的数据校验框架，本申请也是以hibernate-validator为基础，依赖hibernate-validator框架实现的，在兼容原有的数据校验框架下，增加动态校验的特性，实现API接口入参的动态校验。

S103、响应于API接口入参，判断API接口入参是否需要动态校验，响应于API接口入参需要动态校验，则根据数据校验框架匹配出与API接口入参对应的目标校验实例，以执行数据校验。

在一些实施方式中，判断所述API接口入参是否需要动态检验，响应于所述API接口入参需要动态校验，根据所述key查找对应的动态校验规则，进而匹配出对应的目标校验实例。

具体地，在API接口参数校验部分判断是否需要动态校验，如果需要动态校验，则以API+场景号为key，查找对应动态校验规则，根据对应的key匹配出validator实例，执行validator的校验方法。

在一些实施方式中，响应于执行数据校验成功，则进行后续业务流程处理；

响应于执行数据校验失败，则抛出异常提示。

需要说明的是，上述对本申请的一些实施例进行了描述。其它实施例在所附权利要求书的范围内。在一些情况下，在权利要求书中记载的动作或步骤可以按照不同于上述实施例中的顺序来执行并且仍然可以实现期望的结果。另外，在附图中描绘的过程不一定要求示出的特定顺序或者连续顺序才能实现期望的结果。在某些实施方式中，多任务处理和并行处理也是可以的或者可能是有利的。

基于同一发明构思，与上述任意实施例方法相对应的，本申请的实施例还提供了一种API接口入参动态校验装置。

如图2所示，所述API接口入参动态校验装置，包括：

定义模块11，被配置为，定义API接口入参的目标校验规则，并将目标校验规则持久化至数据库中。

在一些实施方式中，定义模块11，还被配置为，获取API接口入参的需求配置文件，并根据需求配置文件配置生成目标校验规则；

通过sql语句或后台管理平台将API接口入参对应的目标校验规则持久化至数据库中。

加载模块12，被配置为，从数据库中获取目标校验规则，将目标校验规则加载至数据校验框架中。

在一些实施方式中，加载模块12，还被配置为，从数据库中读取目标校验规则，根据目标校验规则调用其对应的扩展接口加载至数据校验框架中，并以目标校验规则中的API+场景号为key创建关联关系。

数据校验模块13，被配置，为响应于API接口入参，判断API接口入参是否需要动态校验，响应于API接口入参需要动态校验，则根据数据校验框架匹配出与API接口入参对应的目标校验实例，以执行数据校验。

在一些实施方式中，数据校验模块13，还被配置，判断所述API接口入参是否需要动态检验，响应于所述API接口入参需要动态校验，根据所述key查找对应的动态校验规则，进而匹配出对应的目标校验实例。

在一些实施方式中，数据校验模块13，还被配置，响应于执行数据校验成功，则进行后续业务流程处理；

响应于执行数据校验失败，则抛出异常提示。

为了描述的方便，描述以上装置时以功能分为各种模块分别描述。当然，在实施本申请的实施例时可以把各模块的功能在同一个或多个软件和/或硬件中实现。

上述实施例的装置用于实现前述任一实施例中相应的API接口入参动态校验方法，并且具有相应的方法实施例的有益效果，在此不再赘述。

基于同一发明构思，与上述任意实施例方法相对应的，本申请的实施例还提供了一种电子设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述程序时实现如上任意一实施例所述的API接口入参动态校验方法。

图3示出了本实施例所提供的一种更为具体的电子设备硬件结构示意图，该设备可以包括：处理器1010、存储器1020、输入/输出接口1030、通信接口1040和总线1050。其中处理器1010、存储器1020、输入/输出接口1030和通信接口1040通过总线1050实现彼此之间在设备内部的通信连接。

处理器1010可以采用通用的CPU(Central Processing Unit，中央处理器)、微处理器、应用专用集成电路(Application Specific Integrated Circuit，ASIC)、或者一个或多个集成电路等方式实现，用于执行相关程序，以实现本说明书实施例所提供的技术方案。

存储器1020可以采用ROM(Read Only Memory，只读存储器)、RAM(Random AccessMemory，随机存取存储器)、静态存储设备，动态存储设备等形式实现。存储器1020可以存储操作系统和其他应用程序，在通过软件或者固件来实现本说明书实施例所提供的技术方案时，相关的程序代码保存在存储器1020中，并由处理器1010来调用执行。

输入/输出接口1030用于连接输入/输出模块，以实现信息输入及输出。输入输出/模块可以作为组件配置在设备中(图中未示出)，也可以外接于设备以提供相应功能。其中输入设备可以包括键盘、鼠标、触摸屏、麦克风、各类传感器等，输出设备可以包括显示器、扬声器、振动器、指示灯等。

通信接口1040用于连接通信模块(图中未示出)，以实现本设备与其他设备的通信交互。其中通信模块可以通过有线方式(例如USB、网线等)实现通信，也可以通过无线方式(例如移动网络、WIFI、蓝牙等)实现通信。

总线1050包括一通路，在设备的各个组件(例如处理器1010、存储器1020、输入/输出接口1030和通信接口1040)之间传输信息。

需要说明的是，尽管上述设备仅示出了处理器1010、存储器1020、输入/输出接口1030、通信接口1040以及总线1050，但是在具体实施过程中，该设备还可以包括实现正常运行所必需的其他组件。此外，本领域的技术人员可以理解的是，上述设备中也可以仅包含实现本说明书实施例方案所必需的组件，而不必包含图中所示的全部组件。

上述实施例的电子设备用于实现前述任一实施例中相应的API接口入参动态校验方法，并且具有相应的方法实施例的有益效果，在此不再赘述。

基于同一发明构思，与上述任意实施例方法相对应的，本申请还提供了一种非暂态计算机可读存储介质，所述非暂态计算机可读存储介质存储计算机指令，所述计算机指令用于使所述计算机执行如上任一实施例所述的API接口入参动态校验方法。

本实施例的计算机可读介质包括永久性和非永久性、可移动和非可移动媒体可以由任何方法或技术来实现信息存储。信息可以是计算机可读指令、数据结构、程序的模块或其他数据。计算机的存储介质的例子包括，但不限于相变内存(PRAM)、静态随机存取存储器(SRAM)、动态随机存取存储器(DRAM)、其他类型的随机存取存储器(RAM)、只读存储器(ROM)、电可擦除可编程只读存储器(EEPROM)、快闪记忆体或其他内存技术、只读光盘只读存储器(CD-ROM)、数字多功能光盘(DVD)或其他光学存储、磁盒式磁带，磁带磁磁盘存储或其他磁性存储设备或任何其他非传输介质，可用于存储可以被计算设备访问的信息。

上述实施例的存储介质存储的计算机指令用于使所述计算机执行如上任一实施例所述的API接口入参动态校验方法，并且具有相应的方法实施例的有益效果，在此不再赘述。

所属领域的普通技术人员应当理解：以上任何实施例的讨论仅为示例性的，并非旨在暗示本申请的范围(包括权利要求)被限于这些例子；在本申请的思路下，以上实施例或者不同实施例中的技术特征之间也可以进行组合，步骤可以以任意顺序实现，并存在如上所述的本申请实施例的不同方面的许多其它变化，为了简明它们没有在细节中提供。

另外，为简化说明和讨论，并且为了不会使本申请实施例难以理解，在所提供的附图中可以示出或可以不示出与集成电路(IC)芯片和其它部件的公知的电源/接地连接。此外，可以以框图的形式示出装置，以便避免使本申请实施例难以理解，并且这也考虑了以下事实，即关于这些框图装置的实施方式的细节是高度取决于将要实施本申请实施例的平台的(即，这些细节应当完全处于本领域技术人员的理解范围内)。在阐述了具体细节(例如，电路)以描述本申请的示例性实施例的情况下，对本领域技术人员来说显而易见的是，可以在没有这些具体细节的情况下或者这些具体细节有变化的情况下实施本申请实施例。因此，这些描述应被认为是说明性的而不是限制性的。

尽管已经结合了本申请的具体实施例对本申请进行了描述，但是根据前面的描述，这些实施例的很多替换、修改和变型对本领域普通技术人员来说将是显而易见的。例如，其它存储器架构(例如，动态RAM(DRAM))可以使用所讨论的实施例。

本申请实施例旨在涵盖落入所附权利要求的宽泛范围之内的所有这样的替换、修改和变型。因此，凡在本申请实施例的精神和原则之内，所做的任何省略、修改、等同替换、改进等，均应包含在本申请的保护范围之内。

Claims (8)

1.一种API接口入参动态校验方法，其特征在于，所述方法包括：

定义API接口入参的目标校验规则，并将所述目标校验规则持久化至数据库中；

从所述数据库中获取所述目标校验规则，将所述目标校验规则加载至数据校验框架中；

响应于API接口入参，判断所述API接口入参是否需要动态校验，响应于所述API接口入参需要动态校验，则根据所述数据校验框架匹配出与所述API接口入参对应的目标校验实例，以执行数据校验。

2.根据权利要求1所述的API接口入参动态校验方法，其特征在于，所述定义API接口入参的目标校验规则，并将所述目标校验规则持久化至数据库，包括：

获取API接口入参的需求配置文件，并根据所述需求配置文件配置生成目标校验规则；

通过sql语句或后台管理平台将所述API接口入参对应的目标校验规则持久化至数据库中。

3.根据权利要求1所述的API接口入参动态校验方法，其特征在于，所述从所述数据库中获取所述目标校验规则，将所述目标校验规则加载至数据校验框架中，包括：

从数据库中读取所述目标校验规则，根据所述目标校验规则调用其对应的扩展接口加载至数据校验框架中，并以所述目标校验规则中的API+场景号为key创建关联关系。

4.根据权利要求3所述的API接口入参动态校验方法，其特征在于，所述响应于API接口入参，判断所述API接口入参是否需要动态校验，响应于所述API接口入参需要动态校验，则根据所述数据校验框架匹配出与所述API接口入参对应的目标校验实例，以执行数据校验，包括：

判断所述API接口入参是否需要动态检验，响应于所述API接口入参需要动态校验，根据所述key查找对应的动态校验规则，进而匹配出对应的目标校验实例。

5.根据权利要求4所述的API接口入参动态校验方法，其特征在于，还包括：

响应于执行数据校验成功，则进行后续业务流程处理；

响应于执行数据校验失败，则抛出异常提示。

6.一种API接口入参动态校验装置，其特征在于，所述装置包括：

定义模块，被配置为，定义API接口入参的目标校验规则，并将所述目标校验规则持久化至数据库中；

加载模块，被配置为，从所述数据库中获取所述目标校验规则，将所述目标校验规则加载至数据校验框架中；

数据校验模块，被配置为，响应于API接口入参，判断所述API接口入参是否需要动态校验，响应于所述API接口入参需要动态校验，则根据所述数据校验框架匹配出与所述API接口入参对应的目标校验实例，以执行数据校验。

7.一种电子设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，其特征在于，所述处理器执行所述程序时实现权利要求1-5任一项所述的API接口入参动态校验方法。

8.一种非暂态计算机可读存储介质，其特征在于，其中，所述非暂态计算机可读存储介质存储计算机指令，所述计算机指令用于使所述计算机执行权利要求1-5任一项所述的API接口入参动态校验方法。