CN108196916A - 一种对接口进行参数校验的方法及其装置、存储介质和电子设备 - Google Patents

Abstract

本发明实施例涉及一种对接口进行参数校验的方法及其装置、存储介质和电子设备，其中该方法包括：指定服务接口类所在的包名，服务接口类下能够继承相关联的一个服务实现类和一个参数校验类；判断指定的包名对应的包内，继承该服务接口类的类的数量是否等于两个，如果等于两个，则服务接口类的项目初始化成功；对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验。本发明实施例提出的对接口进行参数校验的方法及其装置、存储介质和电子设备，通过新增参数校验类，并且与相应的服务实现类继承在同一服务接口类下，减少漏改、漏加的风险，使得接口修改变得友好。

Description

一种对接口进行参数校验的方法及其装置、存储介质和电子 设备

技术领域

本发明属于接口校验技术领域，具体涉及一种对接口进行参数校验的方法及其装置、存储介质和电子设备。

背景技术

对于服务的提供和实现，一般都会有一个服务接口类和服务实现类，服务接口类给第三方使用。为了安全,服务接口类没有任何接口实现代码，第三方调用接口时，才会调用服务实现类对应的接口实现方法，执行具体的业务。在接口实现方法执行具体业务之前，一般会对接口进行参数校验。

现有的对接口进行参数校验的方法，可以采用单独的参数校验方法，对接口实现方法中需要校验的参数进行校验，一般是接口实现方法在执行具体业务之前，先调用参数校验方法对接口进行参数校验。这种校验方法需要接口实现方法在执行具体业务之前，制定和调用参数校验方法。由于参数校验方法和接口实现方法的关联就只有接口实现方法的一次调用，两者的关联性较弱，因此，在接口实现方法中的参数名发生改变，或者接口实现方法中新增参数时，参数校验方法无法感知这些变化，参数校验方法中的参数名不会相应发生改变，参数校验方法中也不会相应增加与新增参数相关的校验内容，导致接口实现方法中的参数名和参数校验方法中的参数名不匹配、接口实现方法和参数校验方法的修改方式不够友好，遗漏了对新增参数的校验。针对现有的对接口进行参数校验所存在的技术问题，有必要研究一种对接口进行参数校验的方案，来有效解决现有对接口进行参数校验时所面临的技术问题。

发明内容

为了解决上述接口实现方法与参数校验方法之间的关联性较弱的技术问题，本发明实施例提出了一种对接口进行参数校验的方法及其装置、存储介质和电子设备。

一种对接口进行参数校验的方法，该方法包括以下步骤：

指定服务接口类所在的包名，服务接口类下能够继承相关联的一个服务实现类和一个参数校验类；

判断指定的包名对应的包内，继承该服务接口类的类的数量是否等于两个，如果等于两个，则服务接口类的项目初始化成功；

对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验。

进一步地，服务实现类用于实现接口实现方法，参数校验类用于实现与继承同一服务接口类的服务实现类对应的参数校验方法。

进一步地，所述对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验包括：找到将要调用的接口实现方法对应的服务实现类的类名，根据上述关联找到对应的参数校验类，通过反射的方式调用相应的参数校验类中的参数校验方法，如果参数不能通过校验，则给出参数校验异常。

进一步地，所述服务实现类是一个配置好的bean组件，所述参数校验类需要经过代码动态转换成bean组件。

一种对接口进行参数校验的装置，该装置包括：

指定模块，用于指定服务接口类所在的包名，服务接口类下能够继承相关联的一个服务实现类和一个参数校验类；

项目初始化模块，用于判断指定的包名对应的包内，继承该服务接口类的类的数量是否等于两个，如果等于两个，则服务接口类的项目初始化成功；

面向切面编程模块，用于对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验。

进一步地，服务实现类用于实现接口实现方法，参数校验类用于实现与继承同一服务接口类的服务实现类对应的参数校验方法。

进一步地，所述对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验包括：找到将要调用的接口实现方法对应的服务实现类的类名，根据上述关联找到对应的参数校验类，通过反射的方式调用相应的参数校验类中的参数校验方法，如果参数不能通过校验，则给出参数校验异常。

进一步地，所述服务实现类是一个配置好的bean组件，所述参数校验类需要经过代码动态转换成bean组件。

一种计算机可读存储介质，计算机可读存储介质存储有执行如前任一项所述的方法的计算机程序。

一种电子设备，包括处理器和操作上与所述处理器连接的如前所述的计算机可读存储介质，所述处理器运行执行计算机可读介质中的计算机程序。

本发明的有益效果：本发明实施例提出的对接口进行参数校验的方法及其装置、存储介质和电子设备，通过新增参数校验类，并且与相应的服务实现类继承在同一服务接口类下，相互关联，能够减少对原系统的耦合，减少因接口变动导致参数校验方法漏改、漏加的风险，使得接口修改对参数校验方法的修改变得友好。而且本发明实施例提出的对接口进行参数校验的方法及其装置、存储介质和电子设备，能对业务层面的参数进行校验，而不局限于对简单的非空、长度等进行的校验。本发明实施例提出的对接口进行参数校验的方法及其装置、存储介质和电子设备，参数校验能够和业务代码解耦，不需要在业务代码里添加参数校验，包括简单的非空校验，或者是有业务关联的校验(例如查询设备id是否存在，设备是否已经被删除等)，参数校验能自动调用无需人为调用；并且，参数校验和接口绑定起来，在编译阶段就能够知道哪个接口发生了变化，哪些参数校验需要进行调整，而且可以确保不会漏掉对某个接口参数的校验，方便查看参数校验的覆盖范围。另外，本发明实施例提出的对接口进行参数校验的方法及其装置、存储介质和电子设备，通过将参数校验类动态设置成一个bean组件，方便注入到其他bean组件中进行参数校验；并且通过将动态设置成bean组件的参数校验类注入到服务实现类中，从而将服务实现类和参数校验类绑定在一起，方便后续根据服务实现类去找到对应的参数校验类，并且使得参数校验更加方便。

附图说明

图1是本发明实施例提出的对接口进行参数校验的方法流程图；

图2是本发明实施例提出的对接口进行参数校验的装置的结构示意图。

具体实施方式

为使本发明的目的、技术方案和优点更加清楚明白，以下结合具体实施例，并参照附图，对本发明进一步详细说明。但本领域技术人员知晓，本发明并不局限于附图和以下实施例。

实施例1：

本发明实施例1提出了一种对接口进行参数校验的方法，如图1所示，该方法包括以下步骤：

步骤S101：在配置文件中指定服务接口类所在的包名；

在本发明实施例中，一个服务接口类对应一个接口，每个服务接口类下能够继承相关联的一个服务实现类和一个参数校验类，该服务实现类用于实现接口实现方法，该参数校验类用于实现与服务实现类对应的参数校验方法。

由于参数校验类和服务实现类继承同一服务接口类，因此，编程语言的语法决定了参数校验类中的接口名与服务实现类中的接口名相同，参数校验类中的参数与服务实现类中的参数相同，这样就保证了如果服务实现类中的接口名或参数名发生变化，参数校验类中相应的接口名或参数名也会发生变化；如果服务实现类中新增了参数，参数校验类也必须新增与该新增参数对应的参数校验方法；如果服务实现类中删除了参数，参数校验类也必须删除与该删除参数对应的参数校验方法。

由于该参数校验类的类名与继承同一服务接口类的服务实现类的类名相关联，因此可以根据服务实现类找到相关的参数校验类。

步骤S102：根据配置文件中指定的包名查找到相应的包，并扫描该包内的所有服务接口类，然后再扫描包内的所有类，找出继承同一服务接口类的所有类，判断继承同一服务接口类的类的数量是否等于两个，如果找到的继承同一服务接口类的类的数量等于两个，则该服务接口类的项目初始化成功；如果找到的继承同一服务接口类的类的数量不等于两个，则该服务接口类的项目初始化失败；

由于本发明实施例中，由于一个服务接口类下继承有一个服务实现类和一个参数校验类，因此，对于一个服务接口类，一般会找到两个继承了该服务接口类的类。

步骤S103：对项目初始化成功的服务接口类的服务实现类进行面向切面编程(Aspect Oriented Programming，AOP)，通过与服务实现类继承同一服务接口类的参数校验类，进行参数校验。

所述对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过与服务实现类继承同一服务接口类的参数校验类，进行参数校验包括：找到将要调用的接口实现方法对应的服务实现类的类名，根据上述关联找到对应的参数校验类，通过反射的方式调用相应的参数校验类中的参数校验方法，如果服务实现类中的参数不能通过校验，则给出参数校验异常，通过对参数校验方法的异常进行捕捉，则可获知服务实现类中参数的异常情况，如果捕获到服务实现类中的参数出现异常，打印异常信息，返回参数校验错误给调用方；如果没有捕获到服务实现类中参数的异常情况，程序正常执行，例如调用接口实现方法。

通过配置所有接口在调用前都先执行面向切面编程方法，这样就不需要对每一个接口进行调用接口实现方法前的参数校验方法。

本发明实施例提出的对接口进行参数校验的方法中，通过新增参数校验类，并且与相应的服务实现类继承在同一服务接口类下，相互关联，能够减少对原系统的耦合，减少因接口变动导致参数校验方法漏改、漏加的风险，使得接口修改对参数校验方法的修改变得友好。而且本发明实施例提出的对接口进行参数校验的方法，能对业务层面的参数进行校验，而不局限于对简单的非空、长度等进行的校验。本发明实施例提出的对接口进行参数校验的方法，参数校验能够和业务代码解耦，不需要在业务代码里添加参数校验，包括简单的非空校验，或者是有业务关联的校验(例如查询设备id是否存在，设备是否已经被删除等)，参数校验能自动调用无需人为调用；并且，参数校验和接口绑定起来，在编译阶段就能够知道哪个接口发生了变化，哪些参数校验需要进行调整，而且可以确保不会漏掉对某个接口参数的校验，方便查看参数校验的覆盖范围。

本发明实施例1还提出了一种对接口进行参数校验的装置，如图2所示，该装置包括：指定模块、项目初始化模块和面向切面编程模块。

所述指定模块用于在配置文件中指定服务接口类所在的包名；

在本发明实施例中，一个服务接口类对应一个接口，每个服务接口类下能够继承相关联的一个服务实现类和一个参数校验类，该服务实现类用于实现接口实现方法，该参数校验类用于实现与服务实现类对应的参数校验方法。

由于参数校验类和服务实现类继承同一服务接口类，因此，编程语言的语法决定了参数校验类中的接口名与服务实现类中的接口名相同，参数校验类中的参数与服务实现类中的参数相同，这样就保证了如果服务实现类中的接口名或参数名发生变化，参数校验类中相应的接口名或参数名也会发生变化；如果服务实现类中新增了参数，参数校验类也必须新增与该新增参数对应的参数校验方法；如果服务实现类中删除了参数，参数校验类也必须删除与该删除参数对应的参数校验方法。

由于该参数校验类的类名与继承同一服务接口类的服务实现类的类名相关联，因此可以根据服务实现类找到相关的参数校验类。

所述项目初始化模块用于根据配置文件中指定的包名查找到相应的包，并扫描该包内的所有服务接口类，然后再扫描包内的所有类，找出继承同一服务接口类的所有类，判断继承同一服务接口类的类的数量是否等于两个，如果找到的继承同一服务接口类的类的数量等于两个，则该服务接口类的项目初始化成功；如果找到的继承同一服务接口类的类的数量不等于两个，则该服务接口类的项目初始化失败；

由于本发明实施例中，由于一个服务接口类下继承有一个服务实现类和一个参数校验类，因此，对于一个服务接口类，一般会找到两个继承了该服务接口类的类。

所述面向切面编程模块用于对项目初始化成功的服务接口类的服务实现类进行面向切面编程(Aspect Oriented Programming，AOP)，通过与服务实现类继承同一服务接口类的参数校验类，进行参数校验。

所述对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过与服务实现类继承同一服务接口类的参数校验类，进行参数校验包括：找到将要调用的接口实现方法对应的服务实现类的类名，根据上述关联找到对应的参数校验类，通过反射的方式调用相应的参数校验类中的参数校验方法，如果服务实现类中的参数不能通过校验，则给出参数校验异常，通过对参数校验方法的异常进行捕捉，则可获知服务实现类中参数的异常情况，如果捕获到服务实现类中的参数出现异常，打印异常信息，返回参数校验错误给调用方；如果没有捕获到服务实现类中参数的异常情况，程序正常执行，例如调用接口实现方法。

通过配置所有接口在调用前都先执行面向切面编程方法，这样就不需要对每一个接口进行调用接口实现方法前的参数校验方法。

本发明实施例提出的对接口进行参数校验的装置中，通过新增参数校验类，并且与相应的服务实现类继承在同一服务接口类下，相互关联，能够减少对原系统的耦合，减少因接口变动导致参数校验方法漏改、漏加的风险，使得接口修改对参数校验方法的修改变得友好。而且本发明实施例提出的对接口进行参数校验的方法，能对业务层面的参数进行校验，而不局限于对简单的非空、长度等进行的校验。本发明实施例提出的对接口进行参数校验的装置，参数校验能够和业务代码解耦，不需要在业务代码里添加参数校验，包括简单的非空校验，或者是有业务关联的校验(例如查询设备id是否存在，设备是否已经被删除等)，参数校验能自动调用无需人为调用；并且，参数校验和接口绑定起来，在编译阶段就能够知道哪个接口发生了变化，哪些参数校验需要进行调整，而且可以确保不会漏掉对某个接口参数的校验，方便查看参数校验的覆盖范围。

实施例2：

在本发明实施例2中，实施例1中的所述服务实现类具体是一个配置好的bean组件，保证在调用接口时，服务实现类能够直接被调用；所述参数校验类需要经过代码动态转换成bean组件。将所述参数检验类转换成bean组件的好处是，转换成bean组件的参数校验类可以直接注入到其他bean组件中，例如服务实现类中；注入了参数校验类的其他组件被调用时，就可以借助参数校验类进行参数校验。

bean组件由Spring负责管理，bean组件之间可以互相依赖，也可以通过注入的方式调用其他bean组件，用于判断、校验等。因此，将参数校验类动态转换成bean组件后，就能够注入到其他bean组件中，在其他bean组件被调用时，其他bean组件就可以借助注入的参数校验类，进行参数校验。在校验出错时，只需要在校验出错的条件里给出参数校验异常即可，由于返回值没做处理，因此返回值都可以是null。

在本发明实施例2中，调用接口时，调用的是配置好的bean组件，即服务实现类，而不是注入到服务实现类中的参数校验类。

在本发明实施例2中，通过将参数校验类动态设置成一个bean组件，方便注入到其他bean组件中进行参数校验；并且通过将动态设置成bean组件的参数校验类注入到服务实现类中，从而将服务实现类和参数校验类绑定在一起，方便后续根据服务实现类去找到对应的参数校验类，并且使得参数校验更加方便。

本发明实施例还提出一种计算机可读存储介质，存储有执行前述方法的计算机程序。

本发明实施例还提出一种电子设备，包括处理器和操作上与所述处理器连接的上述计算机可读存储介质，所述处理器运行执行计算机可读介质中的计算机程序。

本领域技术人员可以理解，在流程图中表示或在此以其他方式描述的逻辑和/或步骤，例如，可以被认为是用于实现逻辑功能的可执行指令的定序列表，可以具体实现在任何计算机可读介质中，以供指令执行系统、装置或设备(如基于计算机的系统、包括处理器的系统或其他可以从指令执行系统、装置或设备取指令并执行指令的系统)使用，或结合这些指令执行系统、装置或设备而使用。就本说明书而言，“计算机可读介质”可以是任何可以包含、存储、通信、传播或传输程序以供指令执行系统、装置或设备或结合这些指令执行系统、装置或设备而使用的装置。

计算机可读介质的更具体的示例(非穷尽性列表)包括以下：具有一个或多个布线的电连接部(电子装置)，便携式计算机盘盒(磁装置)，随机存取存储器(RAM)，只读存储器(ROM)，可擦除可编辑只读存储器(EPROM或闪速存储器)，光纤装置，以及便携式光盘只读存储器(CDROM)。另外，计算机可读介质甚至可以是可在其上打印所述程序的纸或其他合适的介质，因为可以例如通过对纸或其他介质进行光学扫描，接着进行编辑、解译或必要时以其他合适方式进行处理来以电子方式获得所述程序，然后将其存储在计算机存储器中。

应当理解，本发明实施例的各部分可以用硬件、软件、固件或它们的组合来实现。在上述实施方式中，多个步骤或方法可以用存储在存储器中且由合适的指令执行系统执行的软件或固件来实现。例如，如果用硬件来实现，和在另一实施方式中一样，可用本领域公知的下列技术中的任一项或它们的组合来实现：具有用于对数据信号实现逻辑功能的逻辑门电路的离散逻辑电路，具有合适的组合逻辑门电路的专用集成电路，可编程门阵列(PGA)，现场可编程门阵列(FPGA)等。

在本说明书的描述中，参考术语“一个实施例”、“一些实施例”、“示例”、“具体示例”、或“一些示例”等的描述意指结合该实施例或示例描述的具体特征、结构、材料或者特点包含于本发明的至少一个实施例或示例中。在本说明书中，对上述术语的示意性表述不一定指的是相同的实施例或示例。而且，描述的具体特征、结构、材料或者特点可以在任何的一个或多个实施例或示例中以合适的方式结合。

以上，对本发明的实施方式进行了说明。但是，本发明不限定于上述实施方式。凡在本发明的精神和原则之内，所做的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。

Claims (10)

1.一种对接口进行参数校验的方法，其特征在于，该方法包括以下步骤：

指定服务接口类所在的包名，服务接口类下能够继承相关联的一个服务实现类和一个参数校验类；

判断指定的包名对应的包内，继承该服务接口类的类的数量是否等于两个，如果等于两个，则服务接口类的项目初始化成功；

对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验。

2.根据权利要求1所述的方法，其特征在于，服务实现类用于实现接口实现方法，参数校验类用于实现与继承同一服务接口类的服务实现类对应的参数校验方法。

3.根据权利要求2所述的方法，其特征在于，所述对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验包括：找到将要调用的接口实现方法对应的服务实现类的类名，根据上述关联找到对应的参数校验类，通过反射的方式调用相应的参数校验类中的参数校验方法，如果参数不能通过校验，则给出参数校验异常。

4.根据权利要求1至3中任一项所述的方法，其特征在于，所述服务实现类是一个配置好的bean组件，所述参数校验类需要经过代码动态转换成bean组件。

5.一种对接口进行参数校验的装置，其特征在于，该装置包括：

指定模块，用于指定服务接口类所在的包名，服务接口类下能够继承相关联的一个服务实现类和一个参数校验类；

项目初始化模块，用于判断指定的包名对应的包内，继承该服务接口类的类的数量是否等于两个，如果等于两个，则服务接口类的项目初始化成功；

面向切面编程模块，用于对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验。

6.根据权利要求5所述的装置，其特征在于，服务实现类用于实现接口实现方法，参数校验类用于实现与继承同一服务接口类的服务实现类对应的参数校验方法。

7.根据权利要求6所述的装置，其特征在于，所述对项目初始化成功的服务接口类的服务实现类进行面向切面编程，通过相关联的参数校验类进行参数校验包括：找到将要调用的接口实现方法对应的服务实现类的类名，根据上述关联找到对应的参数校验类，通过反射的方式调用相应的参数校验类中的参数校验方法，如果参数不能通过校验，则给出参数校验异常。

8.根据权利要求5至7中任一项所述的装置，其特征在于，所述服务实现类是一个配置好的bean组件，所述参数校验类需要经过代码动态转换成bean组件。

9.一种计算机可读存储介质，其特征在于，计算机可读存储介质存储有执行如权利要求1至4中任一项所述的方法的计算机程序。

10.一种电子设备，其特征在于，包括处理器和操作上与所述处理器连接的如权利要求9所述的计算机可读存储介质，所述处理器运行执行计算机可读介质中的计算机程序。