CN115129363A - 面向服务适配的微服务接口元数据模型构造方法 - Google Patents

Abstract

本申请公开了一种面向服务适配的微服务接口元数据模型构造方法、装置以及介质，应用于微服务领域。本申请所提供的方法直接扫描接口以记录接口中注解的包结构和程序名；根据注解的包结构和程序名可将注解分为类注解和方法注解；然后可以获取类注解和方法注解中接口的相关信息。通过这种方式获取到相关信息，不需要入侵原有的代码，因此，不会影响原有代码的结构和可用性。其中，相关信息包括以下至少之一：类名称、方法名称、类注解的参数、方法注解的参数、方法的参数、方法的参数类型、方法的返回值类型。

Description

面向服务适配的微服务接口元数据模型构造方法

技术领域

本申请涉及微服务领域，特别是涉及一种面向服务适配的微服务接口元数据模型构造方法。

背景技术

随着微服务架构越来越盛行，微服务所带来的问题也不断暴露出来。在微服务的场景下，模块划分过多，各个模块之间的接口调用复杂，不同的模块一般由不同的开发人员设计，在集成多个模块时，需要对各模块的接口进行适配，在这个过程中，需要获取各模块的接口的相关信息。目前获取相关信息时，是在原有的代码上进行改动，通过改动的代码实现获取各模块的接口的相关信息。

但是这种方式入侵原有的代码时可能会影响原有代码的结构，若新增的代码有问题，还会导致整个代码不可用。

由此可见，如何在获取接口数据时避免影响原有代码的可用性，是本领域技术人员亟待解决的问题。

发明内容

本申请的目的是提供一种面向服务适配的微服务接口元数据模型构造方法，以便于在获取接口数据时避免影响原有代码的可用性。

为解决上述技术问题，本申请提供一种面向服务适配的微服务接口元数据模型构造方法，包括：

扫描接口以记录所述接口中注解的包结构和程序名；

根据所述包结构和所述程序名将所述注解分为类注解和方法注解；

获取所述类注解和所述方法注解中所述接口的相关信息，其中，所述相关信息包括以下至少之一：类名称、方法名称、所述类注解的参数、所述方法注解的参数、方法的参数、所述方法的参数类型、所述方法的返回值类型。

优选地，所述获取所述类注解和所述方法注解中所述接口的所述相关信息之后，还包括：

根据所述相关信息生成接口数据模型；其中，所述根据所述相关信息生成接口数据模型具体为：将所述相关信息填充至预先生成的模板。

优选地，所述根据所述相关信息生成接口数据模型包括：

解析所述相关信息；

根据解析后的所述相关信息生成所述接口数据模型。

优选地，所述类注解的参数包括：路径信息，所述方法注解的参数包括：路径信息和请求方式。

优选地，所述解析所述相关信息包括：

将所述类注解和所述方法注解上对应的路径信息解析为接口路径；

将所述方法注解的请求方式解析为所述接口的请求方式；

将所述方法的参数解析为所述接口的请求参数；

将所述方法的参数类型解析为所述接口的请求参数类型；

将所述方法的返回值类型解析为所述接口的返回值类型。

优选地，所述解析所述相关信息之前，还包括：

按不同的所述类名称将所述相关信息划分为不同的数据对象；

所述解析所述相关信息具体为：

在各所述数据对象中解析所述相关信息。

优选地，所述根据所述相关信息生成接口数据模型之后，还包括：

在所述接口数据模型中添加所述方法的参数值进行测试；

若测试结果表征所述接口数据模型不符合要求，则重新生成所述接口数据模型。

为解决上述技术问题，本申请还提供一种面向服务适配的微服务接口元数据模型构造装置，包括：

扫描模块，用于扫描接口以记录所述接口中注解的包结构和程序名；

分类模块，用于根据所述包结构和所述程序名将所述注解分为类注解和方法注解；

获取模块，用于获取所述类注解和所述方法注解中所述接口的相关信息，其中，所述相关信息包括以下至少之一：类名称、方法名称、所述类注解的参数、所述方法注解的参数、方法的参数、所述方法的参数类型、所述方法的返回值类型。

为解决上述技术问题，本申请还提供一种面向服务适配的微服务接口元数据模型构造装置，包括：存储器，用于存储计算机程序；

处理器，用于执行计算机程序时实现上述面向服务适配的微服务接口元数据模型构造方法的步骤。

为解决上述技术问题，本申请还提供一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现上述面向服务适配的微服务接口元数据模型构造方法的步骤。

本申请所提供的面向服务适配的微服务接口元数据模型构造方法，直接扫描接口以记录接口中注解的包结构和程序名；根据注解的包结构和程序名可将注解分为类注解和方法注解；然后可以获取类注解和方法注解中接口的相关信息。通过这种方式获取到相关信息，不需要入侵原有的代码，因此，不会影响原有代码的结构和可用性。其中，相关信息包括以下至少之一：类名称、方法名称、类注解的参数、方法注解的参数、方法的参数、方法的参数类型、方法的返回值类型。

本申请还提供了一种面向服务适配的微服务接口元数据模型构造装置以及介质，与上述方法对应，故具有与上述方法相同的有益效果。

附图说明

为了更清楚地说明本申请实施例，下面将对实施例中所需要使用的附图做简单的介绍，显而易见地，下面描述中的附图仅仅是本申请的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1为本申请实施例提供的一种面向服务适配的微服务接口元数据模型构造方法的流程图；

图2为本申请实施例提供的面向服务适配的微服务接口元数据模型构造装置的结构图；

图3为本申请另一实施例提供的面向服务适配的微服务接口元数据模型构造装置的结构图。

具体实施方式

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

本申请的核心是提供一种面向服务适配的微服务接口元数据模型构造方法。

为了使本技术领域的人员更好地理解本申请方案，下面结合附图和具体实施方式对本申请作进一步的详细说明。

表述性状态转换(Representational State Transfer，REST)描述了一个架构样式的网络***，比如Web应用。它是一种软件架构风格、设计风格，而不是标准，它提供了一组设计原则和约束条件，主要用于客户端和服务端交互类的软件。基于这个风格设计的软件可以更简介，更有层次，更易于实现缓存等机制。REST指的是一组架构约束条件和原则，满足这些约束条件和原则的应用程序或设计就是RESTful。本申请一般是针对微服务的各模块中结合了RESTful设计风格的接口。

微服务是一种开发软件的架构和组织方法，其中，软件由多个小型独立的模块组成，一个模块也相当于一个服务。这些模块由各个小型独立团队负责。微服务架构使应用程序更易于扩展和更快地开发，从而加速创新并缩短新功能的上市时间。随着微服务架构越来越盛行，微服务所带来的问题也不断暴露出来。在微服务的场景下，模块划分过多，各个模块之间的接口调用复杂，微服务化之后如何在各模块的开发人员之间形成一个契约或沟通，来规范数据的格式，从而完成数据交互就成了我们不得不面对的问题。这个过程就是对各模块的接口进行适配，在这个过程中，需要获取各模块的接口的相关信息，目前获取相关信息时需要入侵原有代码，会影响原有代码的可用性，为了解决该问题，本申请实施例提供一种面向服务适配的微服务接口元数据模型构造方法，图1为本申请实施例提供的一种面向服务适配的微服务接口元数据模型构造方法的流程图，如图1所示，该方法包括如下步骤：S10：扫描接口以记录接口中注解的包结构和程序名。S11：根据包结构和程序名将注解分为类注解和方法注解。S12：获取类注解和方法注解中接口的相关信息。其中，相关信息包括以下至少之一：类名称、方法名称、类注解的参数、方法注解的参数、方法的参数、方法的参数类型、方法的返回值类型。

以RESTful设计风格的接口为例，该接口支持Spring框架及相关衍生框架通过注解进行配置，允许开发者通过支持RESTful风格接口的框架进行应用程序开发，这些框架会提供注解，在开发接口以实现各模块的接口适配时，可以直接获取相关接口的注解。获取到注解之后，记录注解中的包结构和程序名，根据包结构和程序名可将注解分为类注解和方法注解，类注解和方法注解具有不同的相关信息。相关信息一般包括：类名称、方法名称、类注解的参数、方法注解的参数、方法的参数、方法的参数类型、方法的返回值类型。一个模块通常有多个接口，比如浏览器的注册、登录功能的接口，登录时，账号、密码和验证码等提示信息就相当于方法的参数，方法的参数类型和方法的返回值类型有String，Int，Long等。获取到这些相关信息之后，开发者可根据这些相关信息完成多个接口间的适配。另外，根据包结构和程序名还可以定位出这个接口是哪个功能的接口。

本申请实施例所提供的面向服务适配的微服务接口元数据模型构造方法，直接扫描接口以记录接口中注解的包结构和程序名；根据注解的包结构和程序名可将注解分为类注解和方法注解；然后可以获取类注解和方法注解中接口的相关信息。通过这种方式获取到相关信息，不需要入侵原有的代码，因此，不会影响原有代码的结构和可用性。其中，相关信息包括以下至少之一：类名称、方法名称、类注解的参数、方法注解的参数、方法的参数、方法的参数类型、方法的返回值类型。

在具体实施中，开发者需要根据相关信息得到接口文档，才能够准确、快速、直观的了解服务接口的相关信息。因此，获取类注解和方法注解中接口的相关信息之后，还包括：根据相关信息生成接口数据模型；实际上，根据相关信息生成接口数据模型就是将相关信息填充至预先生成的模板，填充后就可得到更为直观的接口文档。首先扫描各模块中RESTful设计风格接口的注解，得到相关信息后，先按不同的类名称将相关信息划分为不同的数据对象，将相关信息隔离开之后，再在各数据对象中解析相关信息，通常，每个数据对象均代表一个接口。而根据相关信息生成接口数据模型的具体步骤为：解析相关信息；然后根据解析后的相关信息生成接口数据模型。其中，相关信息中的类注解的参数包括路径信息，方法注解的参数包括路径信息和请求方式。则解析相关信息包括：1、将类注解和方法注解上的路径信息解析为接口路径；2、将方法注解的请求方式解析为接口的请求方式；3、将方法的参数解析为接口的请求参数；4、将方法的参数类型解析为接口的请求参数类型；5、将方法的返回值类型解析为接口的返回值类型。即解析后的相关信息一般包括：接口路径、接口的请求方式、接口的请求参数、接口的请求参数类型、接口的返回值类型；根据这些信息就可以生成接口数据模型，具体应用时可导出不同格式的接口文档，让开发者准确、快速、直观的了解服务接口的相关信息。

根据相关信息生成接口数据模型之后，可以对接口数据模型进行测试，具体为在接口数据模型中添加方法的参数值进行测试；在上述实施例中提到，在登录时，账号、密码和验证码等提示信息就相当于方法的参数，而实际输入的账号、密码和验证码就是参数值，输入之后就可以对接口数据模型进行测试，若测试结果表征接口数据模型不符合要求，则重新生成接口数据模型。若多次生成的模型都不符合要求，则说明获取的相关信息可能有误，可重新进行获取。本申请实施例对生成的接口数据模型进行测试，以防止接口数据模型不可用。

在上述实施例中，对于面向服务适配的微服务接口元数据模型构造方法进行了详细描述，本申请还提供面向服务适配的微服务接口元数据模型构造装置对应的实施例。需要说明的是，本申请从两个角度对装置部分的实施例进行描述，一种是基于功能模块的角度，另一种是基于硬件的角度。

基于功能模块的角度，本实施例提供一种面向服务适配的微服务接口元数据模型构造装置，图2为本申请实施例提供的面向服务适配的微服务接口元数据模型构造装置的结构图，如图2所示，该装置包括：

扫描模块10，用于扫描接口以记录接口中注解的包结构和程序名；

分类模块11，用于根据包结构和程序名将注解分为类注解和方法注解；

获取模块12，用于获取类注解和方法注解中接口的相关信息，其中，相关信息包括以下至少之一：类名称、方法名称、类注解的参数、方法注解的参数、方法的参数、方法的参数类型、方法的返回值类型。

由于装置部分的实施例与方法部分的实施例相互对应，因此装置部分的实施例请参见方法部分的实施例的描述，这里暂不赘述。

本实施例提供的面向服务适配的微服务接口元数据模型构造装置，与上述方法对应，故具有与上述方法相同的有益效果。

基于硬件的角度，本实施例提供了另一种面向服务适配的微服务接口元数据模型构造装置，图3为本申请另一实施例提供的面向服务适配的微服务接口元数据模型构造装置的结构图，如图3所示，面向服务适配的微服务接口元数据模型构造装置包括：存储器20，用于存储计算机程序；

处理器21，用于执行计算机程序时实现如上述实施例中所提到的面向服务适配的微服务接口元数据模型构造方法的步骤。

本实施例提供的面向服务适配的微服务接口元数据模型构造装置可以包括但不限于智能手机、平板电脑、笔记本电脑或台式电脑等。

其中，处理器21可以包括一个或多个处理核心，比如4核心处理器、8核心处理器等。处理器21可以采用数字信号处理器(Digital Signal Processor，DSP)、现场可编程门阵列(Field－Programmable Gate Array，FPGA)、可编程逻辑阵列(Programmable LogicArray，PLA)中的至少一种硬件形式来实现。处理器21也可以包括主处理器和协处理器，主处理器是用于对在唤醒状态下的数据进行处理的处理器，也称中央处理器(CentralProcessing Unit，CPU)；协处理器是用于对在待机状态下的数据进行处理的低功耗处理器。在一些实施例中，处理器21可以集成有图像处理器(Graphics Processing Unit，GPU)，GPU用于负责显示屏所需要显示的内容的渲染和绘制。一些实施例中，处理器21还可以包括人工智能(Artificial Intelligence，AI)处理器，该AI处理器用于处理有关机器学习的计算操作。

存储器20可以包括一个或多个计算机可读存储介质，该计算机可读存储介质可以是非暂态的。存储器20还可包括高速随机存取存储器，以及非易失性存储器，比如一个或多个磁盘存储设备、闪存存储设备。本实施例中，存储器20至少用于存储以下计算机程序201，其中，该计算机程序被处理器21加载并执行之后，能够实现前述任一实施例公开的面向服务适配的微服务接口元数据模型构造方法的相关步骤。另外，存储器20所存储的资源还可以包括操作***202和数据203等，存储方式可以是短暂存储或者永久存储。其中，操作***202可以包括Windows、Unix、Linux等。数据203可以包括但不限于面向服务适配的微服务接口元数据模型构造方法涉及到的数据等。

在一些实施例中，面向服务适配的微服务接口元数据模型构造装置还可包括有显示屏22、输入输出接口23、通信接口24、电源25以及通信总线26。

本领域技术人员可以理解，图中示出的结构并不构成对面向服务适配的微服务接口元数据模型构造装置的限定，可以包括比图示更多或更少的组件。

本申请实施例提供的面向服务适配的微服务接口元数据模型构造装置，包括存储器和处理器，处理器在执行存储器存储的程序时，能够实现如下方法：面向服务适配的微服务接口元数据模型构造方法。

本实施例提供的面向服务适配的微服务接口元数据模型构造装置，与上述方法对应，故具有与上述方法相同的有益效果。

最后，本申请还提供一种计算机可读存储介质对应的实施例。计算机可读存储介质上存储有计算机程序，计算机程序被处理器执行时实现如上述方法实施例中记载的步骤。

可以理解的是，如果上述实施例中的方法以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本申请的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的全部或部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，执行本申请各个实施例描述的方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(Read-Only Memory，ROM)、随机存取存储器(Random Access Memory，RAM)、磁碟或者光盘等各种可以存储程序代码的介质。

本实施例提供的计算机可读存储介质，与上述方法对应，故具有与上述方法相同的有益效果。

以上对本申请所提供的面向服务适配的微服务接口元数据模型构造方法、装置以及介质进行了详细介绍。说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。应当指出，对于本技术领域的普通技术人员来说，在不脱离本申请原理的前提下，还可以对本申请进行若干改进和修饰，这些改进和修饰也落入本申请权利要求的保护范围内。

还需要说明的是，在本说明书中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括上述要素的过程、方法、物品或者设备中还存在另外的相同要素。

Claims (10)

1.一种面向服务适配的微服务接口元数据模型构造方法，其特征在于，包括：

扫描接口以记录所述接口中注解的包结构和程序名；

根据所述包结构和所述程序名将所述注解分为类注解和方法注解；

获取所述类注解和所述方法注解中所述接口的相关信息，其中，所述相关信息包括以下至少之一：类名称、方法名称、所述类注解的参数、所述方法注解的参数、方法的参数、所述方法的参数类型、所述方法的返回值类型。

2.根据权利要求1所述的面向服务适配的微服务接口元数据模型构造方法，其特征在于，所述获取所述类注解和所述方法注解中所述接口的所述相关信息之后，还包括：

根据所述相关信息生成接口数据模型；其中，所述根据所述相关信息生成接口数据模型具体为：将所述相关信息填充至预先生成的模板。

3.根据权利要求2所述的面向服务适配的微服务接口元数据模型构造方法，其特征在于，所述根据所述相关信息生成接口数据模型包括：

解析所述相关信息；

根据解析后的所述相关信息生成所述接口数据模型。

4.根据权利要求3所述的面向服务适配的微服务接口元数据模型构造方法，其特征在于，所述类注解的参数包括：路径信息，所述方法注解的参数包括：路径信息和请求方式。

5.根据权利要求4所述的面向服务适配的微服务接口元数据模型构造方法，其特征在于，所述解析所述相关信息包括：

将所述类注解和所述方法注解上对应的路径信息解析为接口路径；

将所述方法注解的请求方式解析为所述接口的请求方式；

将所述方法的参数解析为所述接口的请求参数；

将所述方法的参数类型解析为所述接口的请求参数类型；

将所述方法的返回值类型解析为所述接口的返回值类型。

6.根据权利要求5所述的面向服务适配的微服务接口元数据模型构造方法，其特征在于，所述解析所述相关信息之前，还包括：

按不同的所述类名称将所述相关信息划分为不同的数据对象；

所述解析所述相关信息具体为：

在各所述数据对象中解析所述相关信息。

7.根据权利要求2至6任意一项所述的面向服务适配的微服务接口元数据模型构造方法，其特征在于，所述根据所述相关信息生成接口数据模型之后，还包括：

在所述接口数据模型中添加所述方法的参数值进行测试；

若测试结果表征所述接口数据模型不符合要求，则重新生成所述接口数据模型。

8.一种面向服务适配的微服务接口元数据模型构造装置，其特征在于，包括：

扫描模块，用于扫描接口以记录所述接口中注解的包结构和程序名；

分类模块，用于根据所述包结构和所述程序名将所述注解分为类注解和方法注解；

获取模块，用于获取所述类注解和所述方法注解中所述接口的相关信息，其中，所述相关信息包括以下至少之一：类名称、方法名称、所述类注解的参数、所述方法注解的参数、方法的参数、所述方法的参数类型、所述方法的返回值类型。

9.一种面向服务适配的微服务接口元数据模型构造装置，其特征在于，包括存储器，用于存储计算机程序；

处理器，用于执行所述计算机程序时实现如权利要求1至7任一项所述的面向服务适配的微服务接口元数据模型构造方法的步骤。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现如权利要求1至7任一项所述的面向服务适配的微服务接口元数据模型构造方法的步骤。

Images