一种基于SpringMVC管理对外http接口的方法与流程

一种基于springmvc管理对外http接口的方法
技术领域
1.本发明涉及互联网技术领域，具体涉及一种基于springmvc管理对外http接口的方法。


背景技术：

2.研发人员通过不断地迭代或者由于突发的系统业务故障，导致需要http接口需要长期或临时禁止对外服务。
3.现行的解决方式无非是如下两种：
4.第一种是在系统代码中添加开关，当需要停止指定http接口时，则关闭特定的开关，实现接口不可对外服务。
5.弊端：虽然添加开关的方式，可以解决这一问题，但是一旦接口增多，开关也会随之增多，不利于维护。
6.第二种是直接在代码的controller控制类中删除指定接口，阻断与外部系统的通信。
7.弊端：删除代码的方式显得粗暴，当接口要重新开放时，不可避免又要将代码再开发一遍。


技术实现要素：

8.本发明的目的是提供一种基于springmvc管理对外http接口的方法，实现了http接口进行系统自动注册、动态管理，降低手动在代码中维护接口的繁琐程序。
9.为了实现上述目的，本发明提供如下技术方案：一种基于springmvc管理对外http接口的方法，包括以下步骤：
10.s001、创建controller控制类；
11.s002、创建注解类，并将注解定义在所述controller控制类的方法上；
12.s003、通过springmvc组件获取所述controller控制类中所有方法列表，再通过java反射机制，判断当前方法是否标注有注解，如果有，则获取注解的备注信息，并与方法对应的http接口请求地址一起存储进数据库，否，则不对当前方法做任何处理；
13.s004、设置http接口的对外状态由默认状态的0修改为1时，则为已启用状态；
14.s005、基于所述步骤4基础上调用所述http请求路径时，受拦截请求并判断当前http请求的状态，若“未启用”则响应接口不可调用，若“已启用”则响应接口允许调用。
15.优选的，所述步骤2中的控制类的方法中包括声明对外开放的http请求路径注解，并设定对外开放的http请求路径。
16.优选的，所述步骤2中注解具体为一个字符串变量，用于备注http请求路径信息。
17.优选的，所述注解的名称autoregister，所述变量的名称desc。
18.优选的，所述步骤2中将注解定义在所述controller控制类的方法上，则对应的http接口需要自动注册和动态管理。
19.优选的，所述动态管理包括http接口的对外状态的设置，是指存储进数据库的接口信息，其默认状态为0，则为未启用状态。
20.优选的，所述步骤5中拦截外部请求以校验http接口是否可提供服务的处理步骤如下：
21.s006、发起所述http请求，效验所述http状态为0时，则接口不可用，若效验所述http状态为1时，则接口可用；
22.s007、所述述http请求被接口允许通过并进入业务处理，处理结束之后返回执行结果，并以弹窗的形式进行提示。
23.优选的，所述步骤6中当所述效验所述http状态为0时，则拦截的所述http请求会返回，并以窗口弹出形式进行报错提示。
24.在上述技术方案中，本发明提供的一种基于springmvc管理对外http接口的方法，具备以下有益效果：通过spring mvc注解和java反射机制实现http接口自动注册，实现了灵活状态管理的目的，即实现http接口对外服务的开放和关闭。
附图说明
25.为了更清楚地说明本技术实施例或现有技术中的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明中记载的一些实施例，对于本领域普通技术人员来讲，还可以根据这些附图获得其他的附图。
26.图1为本发明实施例提供的流程结构示意图；
27.图2为本发明实施例提供的校验http接口是否可提供服务的流程部分结构示意图；
28.图3为本发明实施例提供的创建controller控制类的示意图；
29.图4为本发明实施例提供的创建注解类的示意图；
30.图5为本发明实施例提供的存储进数据库的接口信息状态结构示意图。
具体实施方式
31.下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。
32.实施例1
33.如图1、图3、图4及图5所示，一种基于springmvc管理对外http接口的方法，包括以下步骤：
34.s001、创建controller控制类，而所指的控制类的方法中包括声明对外开放的http请求路径注解，并设定对外开放的http请求路径；如图3，其接口的请求地址为/oauth/enterprise/form/token；
35.s002、创建注解类，并将注解定义在controller控制类的方法上，并将注解定义在controller控制类的方法上，则对应的http接口需要自动注册和动态管理；如图4，注解名称autoregister，变量名称desc；
36.s003、通过springmvc组件获取controller控制类中所有方法列表，再通过java反射机制，判断当前方法是否标注有注解，如果有，则获取注解的备注信息，并与方法对应的http接口请求地址一起存储进数据库，否，则不对当前方法做任何处理，结合图5所示，存储进数据库的接口信息对外状的默认状为为0-未启用；
37.s004、设置http接口的对外状态由默认状态的0修改为1时，则为已启用状态；
38.s005、基于步骤4基础上调用http请求路径时，受拦截请求并判断当前http请求的状态，若“未启用”则响应接口不可调用，若“已启用”则响应接口允许调用。
39.再者，动态管理包括http接口的对外状态的设置，是指存储进数据库的接口信息，其默认状态为0，则为未启用状态。
40.上述技术方案中，过spring mvc注解和java反射机制实现http接口自动注册，实现了灵活状态管理的目的，即实现http接口对外服务的开放和关闭。
41.实施例2
42.如图2作为本发明进一步提供的一个实施例，实施例1中的拦截外部请求以校验http接口是否可提供服务的处理步骤如下：
43.s006、发起http请求，效验http状态为0时，则接口不可用，若效验http状态为1时，则接口可用；
44.s007、述http请求被接口允许通过并进入业务处理，处理结束之后返回执行结果，并以弹窗的形式进行提示。
45.进一步的，步骤6中当效验http状态为0时，则拦截的http请求会返回，并以窗口弹出形式进行报错提示。
46.本领域内的技术人员应明白，本发明的实施例可提供为方法、系统、或计算机程序产品。因此，本发明可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本发明可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器、cd-rom、光学存储器等)上实施的计算机程序产品的形式。
47.本发明是参照根据本发明实施例的方法、设备(系统)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。
48.这些计算机程序指令也可存储在能引导计算机或其他可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能。
49.这些计算机程序指令也可装载到计算机或其他可编程数据处理设备上，使得在计算机或其他可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其他可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。
50.本发明中应用了具体实施例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想；同时，对于本领域的一般技术人员，依据本发明的思想，在具体实施方式及应用范围上均会有改变之处，综上所述，本说明书内容不应理解为对本发明的限制。
51.本技术的实施例还提供能够实现上述实施例中的方法中全部步骤的一种电子设备的具体实施方式，所述电子设备具体包括如下内容：
52.处理器(processor)、存储器(memory)、通信接口(communications interface)和总线；
53.其中，所述处理器、存储器、通信接口通过所述总线完成相互间的通信；
54.所述处理器用于调用所述存储器中的计算机程序，所述处理器执行所述计算机程序时实现上述实施例中的方法中的全部步骤。
55.本技术的实施例还提供能够实现上述实施例中的方法中全部步骤的一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，该计算机程序被处理器执行时实现上述实施例中的方法的全部步骤。
56.本说明书中的各个实施例均采用递进的方式描述，各个实施例之间相同相似的部分互相参见即可，每个实施例重点说明的都是与其他实施例的不同之处。尤其，对于硬件 程序类实施例而言，由于其基本相似于方法实施例，所以描述的比较简单，相关之处参见方法实施例的部分说明即可。虽然本说明书实施例提供了如实施例或流程图所述的方法操作步骤，但基于常规或者无创造性的手段可以包括更多或者更少的操作步骤。实施例中列举的步骤顺序仅仅为众多步骤执行顺序中的一种方式，不代表唯一的执行顺序。在实际中的装置或终端产品执行时，可以按照实施例或者附图所示的方法顺序执行或者并行执行(例如并行处理器或者多线程处理的环境，甚至为分布式数据处理环境)。术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、产品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、产品或者设备所固有的要素。在没有更多限制的情况下，并不排除在包括所述要素的过程、方法、产品或者设备中还存在另外的相同或等同要素。为了描述的方便，描述以上装置时以功能分为各种模块分别描述。当然，在实施本说明书实施例时可以把各模块的功能在同一个或多个软件和/或硬件中实现，也可以将实现同一功能的模块由多个子模块或子单元的组合实现等。以上所描述的装置实施例仅仅是示意性的，例如，所述单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，例如多个单元或组件可以结合或者可以集成到另一个系统，或一些特征可以忽略，或不执行。另一点，所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些接口，装置或单元的间接耦合或通信连接，可以是电性，机械或其它的形式。本发明是参照根据本发明实施例的方法、设备(系统)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。
57.本领域技术人员应明白，本说明书的实施例可提供为方法、系统或计算机程序产品。因此，本说明书实施例可采用完全硬件实施例、完全软件实施例或结合软件和硬件方面的实施例的形式。而且，本说明书实施例可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器、cd-rom、光学存储器等)上实施的计算机程序产品的形式。本说明书中的各个实施例均采用递进的方式描述，各个实施例之间相同相似的部分互相参见即可，每个实施例重点说明的都是与其他实施例的不同之处。尤其，对于系统实施例而言，由于其基本相似于方法实施例，所以描述的比较简单，相关之处参见方法实施例的部分说明即可。在本说明书的描述中，参考术语“一个实施例”、“一些实施例”、“示例”、“具体示例”、或“一些示例”等的描述意指结合该实施例或示例描述的具体特征、结构、材料或者特点包含于本说明书实施例的至少一个实施例或示例中。
58.在本说明书中，对上述术语的示意性表述不必须针对的是相同的实施例或示例。此外，在不相互矛盾的情况下，本领域的技术人员可以将本说明书中描述的不同实施例或示例以及不同实施例或示例的特征进行结合和组合。以上所述仅为本说明书实施例的实施例而已，并不用于限制本说明书实施例。对于本领域技术人员来说，本说明书实施例可以有各种更改和变化。凡在本说明书实施例的精神和原理之内所作的任何修改、等同替换、改进等，均应包含在本说明书实施例的权利要求范围之内。