CN115129363A - Method for constructing metadata model of micro service interface facing service adaptation - Google Patents
Method for constructing metadata model of micro service interface facing service adaptation Download PDFInfo
- Publication number
- CN115129363A CN115129363A CN202210742972.2A CN202210742972A CN115129363A CN 115129363 A CN115129363 A CN 115129363A CN 202210742972 A CN202210742972 A CN 202210742972A CN 115129363 A CN115129363 A CN 115129363A
- Authority
- CN
- China
- Prior art keywords
- interface
- annotation
- class
- service
- related information
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/70—Software maintenance or management
- G06F8/73—Program documentation
Landscapes
- Engineering & Computer Science (AREA)
- Software Systems (AREA)
- General Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- Library & Information Science (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Stored Programmes (AREA)
Abstract
The application discloses a method, a device and a medium for constructing a micro-service interface metadata model facing service adaptation, which are applied to the field of micro-services. The method provided by the application directly scans the interface to record the package structure and program name of the annotation in the interface; the annotation can be divided into class annotation and method annotation according to the package structure and program name of the annotation; then, the relevant information of the interface in the class annotation and the method annotation can be obtained. The related information is acquired in the mode, and the original code is not required to be invaded, so that the structure and the usability of the original code are not influenced. Wherein the related information comprises at least one of: class name, method name, parameters of class annotation, parameters of method, parameter type of method, and return value type of method.
Description
Technical Field
The application relates to the field of micro services, in particular to a method for constructing a micro service interface metadata model facing service adaptation.
Background
As micro-service architectures become more prevalent, the problems associated with micro-services continue to emerge. In the micro-service scenario, the modules are divided too much, the interface between the modules is complex to call, different modules are generally designed by different developers, when a plurality of modules are integrated, the interfaces of the modules need to be adapted, and in the process, the relevant information of the interfaces of the modules needs to be acquired. When the related information is obtained, the original code is changed, and the related information of the interface of each module is obtained through the changed code.
However, when the method invades the original code, the structure of the original code can be influenced, and if the newly added code has problems, the whole code can be unavailable.
Therefore, how to avoid affecting the availability of the original code when acquiring the interface data is an urgent problem to be solved by those skilled in the art.
Disclosure of Invention
The method aims to provide a method for constructing a micro service interface metadata model oriented to service adaptation so as to avoid influencing the usability of original codes when interface data are obtained.
In order to solve the above technical problem, the present application provides a method for constructing a metadata model of a micro service interface oriented to service adaptation, including:
scanning an interface to record a package structure and a program name annotated in the interface;
classifying the annotations into class annotations and method annotations according to the package structure and the program name;
obtaining relevant information of the interface in the class annotation and the method annotation, wherein the relevant information comprises at least one of the following: class name, method name, parameters of the class annotation, parameters of the method, parameter types of the method, return value types of the method.
Preferably, after obtaining the relevant information of the interface in the class annotation and the method annotation, the method further includes:
generating an interface data model according to the related information; the generating of the interface data model according to the relevant information specifically includes: and filling the related information into a pre-generated template.
Preferably, the generating an interface data model according to the related information comprises:
analyzing the related information;
and generating the interface data model according to the analyzed related information.
Preferably, the parameters of the class annotation include: path information, parameters annotated by the method including: path information and request mode.
Preferably, the parsing the related information includes:
analyzing the corresponding path information on the class annotation and the method annotation into an interface path;
analyzing the request mode of the method annotation into the request mode of the interface;
analyzing the parameters of the method into request parameters of the interface;
analyzing the parameter type of the method into a request parameter type of the interface;
and resolving the return value type of the method into the return value type of the interface.
Preferably, before parsing the related information, the method further includes:
dividing the related information into different data objects according to different class names;
the analyzing the related information specifically comprises:
and analyzing the related information in each data object.
Preferably, after generating the interface data model according to the related information, the method further includes:
adding parameter values of the method in the interface data model for testing;
and if the test result represents that the interface data model does not meet the requirements, regenerating the interface data model.
In order to solve the above technical problem, the present application further provides a micro service interface metadata model construction device for service adaptation, including:
the scanning module is used for scanning the interface to record the package structure and the program name of the annotation in the interface;
a classification module for classifying the annotations into class annotations and method annotations according to the package structure and the program name;
an obtaining module, configured to obtain relevant information of the interface in the class annotation and the method annotation, where the relevant information includes at least one of: class name, method name, parameters of the class annotation, parameters of the method, parameter type of the method, return value type of the method.
In order to solve the above technical problem, the present application further provides a device for constructing a metadata model of a microservice interface facing service adaptation, including: a memory for storing a computer program;
and the processor is used for realizing the steps of the micro service interface metadata model construction method facing the service adaptation when executing the computer program.
To solve the above technical problem, the present application further provides a computer-readable storage medium, on which a computer program is stored, where the computer program, when executed by a processor, implements the steps of the above method for constructing a micro service interface metadata model for service adaptation.
The method for constructing the metadata model of the micro service interface facing the service adaptation directly scans the interface to record the annotated packet structure and the program name in the interface; the annotation can be classified into class annotation and method annotation according to the packet structure and program name of the annotation; then, the related information of the interface in the class annotation and the method annotation can be obtained. The related information is acquired in the mode, and the original code is not required to be invaded, so that the structure and the usability of the original code are not influenced. Wherein the related information comprises at least one of: class name, method name, parameters of class annotation, parameters of method, parameter type of method, and return value type of method.
The application also provides a device and a medium for constructing the metadata model of the micro service interface facing the service adaptation, which correspond to the method, so the method has the same beneficial effects as the method.
Drawings
In order to more clearly illustrate the embodiments of the present application, the drawings required for the embodiments will be briefly described below, and it is obvious that the drawings in the following description are only some embodiments of the present application, and that other drawings may be obtained by those skilled in the art without inventive effort.
Fig. 1 is a flowchart of a method for constructing a metadata model of a micro service interface oriented to service adaptation according to an embodiment of the present application;
fig. 2 is a structural diagram of a metadata model construction apparatus of a micro service interface for service adaptation provided in an embodiment of the present application;
fig. 3 is a block diagram of a device for constructing a metadata model of a micro service interface adapted for service according to another embodiment of the present application.
Detailed Description
The technical solutions in the embodiments of the present application will be clearly and completely described below with reference to the drawings in the embodiments of the present application, and it is obvious that the described embodiments are only a part of the embodiments of the present application, and not all the embodiments. All other embodiments obtained by a person of ordinary skill in the art based on the embodiments in the present application without any creative effort belong to the protection scope of the present application.
The core of the application is to provide a method for constructing a micro service interface metadata model facing service adaptation.
In order that those skilled in the art will better understand the disclosure, the following detailed description will be given with reference to the accompanying drawings.
Representational State Transfer (REST) describes an architectural style of network system, such as a Web application. The software is a software architecture style and a design style, but not a standard, provides a set of design principles and constraint conditions, and is mainly used for interactive software of a client and a server. Software designed based on this style can be more brief, more hierarchical, and easier to implement caching mechanisms. REST refers to a set of architectural constraints and principles, and the application or design that satisfies these constraints and principles is RESTful. The application is generally directed to an interface that incorporates a RESTful design style in modules of a microservice.
Microservice is a framework and organizational approach to developing software that consists of multiple small, independent modules, one module also acting as a service. These modules are responsible for each small independent team. The microservice architecture makes applications easier to expand and develop faster, speeding innovation and shortening time-to-market for new functionality. As micro-service architectures become more prevalent, the problems associated with micro-services continue to emerge. In the micro-service scene, the modules are divided too much, the interface between the modules is called complicatedly, and after the micro-service, how to form a contract or communication between developers of the modules to standardize the format of data becomes a problem which people have to face. In order to solve the problem, an embodiment of the present application provides a method for constructing a micro service interface metadata model facing service adaptation, where fig. 1 is a flowchart of a method for constructing a micro service interface metadata model facing service adaptation provided by an embodiment of the present application, and as shown in fig. 1, the method includes the following steps: s10: the interface is scanned to record the package structure and program name of the annotations in the interface. S11: the annotations are classified into class annotations and method annotations according to packet structure and program name. S12: and acquiring related information of the interface in the class annotation and the method annotation. Wherein the related information comprises at least one of: class name, method name, parameters of class annotation, parameters of method, parameter type of method, and return value type of method.
Taking an RESTful design style interface as an example, the interface supports a Spring framework and related derivative frameworks to be configured through annotations, and allows a developer to develop an application program through the framework supporting the RESTful style interface, the frameworks provide the annotations, and the annotations of the related interfaces can be directly obtained when the interface is developed to realize the interface adaptation of each module. After the annotation is obtained, the package structure and the program name in the annotation are recorded, the annotation can be divided into class annotation and method annotation according to the package structure and the program name, and the class annotation and the method annotation have different related information. The relevant information generally includes: class name, method name, parameters of class annotation, parameters of method, parameter type of method, and return value type of method. One module usually has a plurality of interfaces, such as interfaces of registration and login functions of a browser, when logging in, prompt information such as an account number, a password, a verification code and the like is equivalent to parameters of a method, and the types of the parameters of the method and the types of return values of the method include String, Int, Long and the like. After obtaining the relevant information, the developer can complete the adaptation among the plurality of interfaces according to the relevant information. In addition, it can also be located which function interface is according to the packet structure and program name.
The method for constructing the metadata model of the micro service interface facing the service adaptation, provided by the embodiment of the application, directly scans the interface to record the annotated packet structure and program name in the interface; the annotation can be classified into class annotation and method annotation according to the packet structure and program name of the annotation; then, the related information of the interface in the class annotation and the method annotation can be obtained. The related information is acquired in the mode, and the original code is not required to be invaded, so that the structure and the usability of the original code are not influenced. Wherein the related information comprises at least one of: class name, method name, parameters of class annotation, parameters of method, parameter type of method, and return value type of method.
In specific implementation, a developer can accurately, quickly and intuitively know the relevant information of the service interface according to the interface document obtained by the relevant information. Therefore, after obtaining the relevant information of the interface in the class annotation and the method annotation, the method further comprises: generating an interface data model according to the relevant information; in fact, generating the interface data model according to the related information is to fill the related information into a pre-generated template, and a more intuitive interface document can be obtained after filling. Firstly, the annotation of RESTful design style interfaces in each module is scanned, after relevant information is obtained, the relevant information is firstly divided into different data objects according to different class names, the relevant information is separated, then the relevant information is analyzed in each data object, and generally, each data object represents an interface. The specific steps of generating the interface data model according to the relevant information are as follows: analyzing the related information; and then generating an interface data model according to the analyzed related information. The parameters of the class annotation in the related information comprise path information, and the parameters of the method annotation comprise path information and a request mode. Then parsing the relevant information includes: 1. analyzing the path information on the class annotation and the method annotation into an interface path; 2. analyzing the request mode of the method annotation into the request mode of the interface; 3. analyzing the parameters of the method into request parameters of the interface; 4. analyzing the parameter type of the method into a request parameter type of an interface; 5. the return value type of the method is parsed into the return value type of the interface. That is, the parsed relevant information generally includes: the method comprises the following steps of (1) interface path, interface request mode, interface request parameter type and interface return value type; according to the information, an interface data model can be generated, interface documents with different formats can be exported during specific application, and developers can know the relevant information of the service interface accurately, quickly and intuitively.
After the interface data model is generated according to the relevant information, the interface data model can be tested, specifically, parameter values of a method are added in the interface data model for testing; in the above embodiment, when logging in, the prompt information such as the account number, the password, the verification code, and the like is equivalent to the parameters of the method, the account number, the password, and the verification code that are actually input are the parameter values, the interface data model can be tested after the input, and if the test result represents that the interface data model does not meet the requirements, the interface data model is regenerated. If the models generated for multiple times do not meet the requirements, the obtained relevant information is possibly wrong, and the information can be obtained again. The embodiment of the application tests the generated interface data model to prevent the interface data model from being unavailable.
In the foregoing embodiments, a method for constructing a micro service interface metadata model for service adaptation is described in detail, and the present application also provides embodiments corresponding to a device for constructing a micro service interface metadata model for service adaptation. It should be noted that the present application describes the embodiments of the apparatus portion from two perspectives, one from the perspective of the function module and the other from the perspective of the hardware.
Based on the angle of the functional module, this embodiment provides a device for constructing a metadata model of a micro service interface facing service adaptation, fig. 2 is a structural diagram of the device for constructing a metadata model of a micro service interface facing service adaptation provided in this embodiment, as shown in fig. 2, the device includes:
a scanning module 10 for scanning the interface to record the package structure and program name annotated in the interface;
a classification module 11, configured to classify the annotations into class annotations and method annotations according to the package structure and the program name;
the obtaining module 12 is configured to obtain relevant information of an interface in the class annotation and the method annotation, where the relevant information includes at least one of: class name, method name, parameters of class annotation, parameters of method, parameter type of method, and return value type of method.
Since the embodiments of the apparatus portion and the method portion correspond to each other, please refer to the description of the embodiments of the method portion for the embodiments of the apparatus portion, which is not repeated here.
The apparatus for constructing a metadata model of a microservice interface oriented to service adaptation provided by this embodiment corresponds to the above method, and therefore has the same beneficial effects as the above method.
Based on the hardware angle, the present embodiment provides another micro service interface metadata model construction device facing service adaptation, fig. 3 is a structural diagram of the micro service interface metadata model construction device facing service adaptation provided in another embodiment of the present application, and as shown in fig. 3, the micro service interface metadata model construction device facing service adaptation includes: a memory 20 for storing a computer program;
a processor 21, configured to implement the steps of the service-oriented adaptation microservice interface metadata model construction method as mentioned in the above embodiments when executing the computer program.
The device for constructing the metadata model of the microservice interface facing the service adaptation provided by the embodiment may include, but is not limited to, a smart phone, a tablet computer, a notebook computer or a desktop computer.
The processor 21 may include one or more processing cores, such as a 4-core processor, an 8-core processor, and the like. The Processor 21 may be implemented in hardware using at least one of a Digital Signal Processor (DSP), a Field-Programmable Gate Array (FPGA), and a Programmable Logic Array (PLA). The processor 21 may also include a main processor and a coprocessor, where the main processor is a processor for Processing data in an awake state, and is also called a Central Processing Unit (CPU); a coprocessor is a low power processor for processing data in a standby state. In some embodiments, the processor 21 may be integrated with a Graphics Processing Unit (GPU) which is responsible for rendering and drawing the content required to be displayed by the display screen. In some embodiments, the processor 21 may further include an Artificial Intelligence (AI) processor for processing computing operations related to machine learning.
The memory 20 may include one or more computer-readable storage media, which may be non-transitory. Memory 20 may also include high speed random access memory, as well as non-volatile memory, such as one or more magnetic disk storage devices, flash memory storage devices. In this embodiment, the memory 20 is at least used for storing a computer program 201, wherein the computer program is loaded and executed by the processor 21, and is capable of implementing relevant steps of the service adaptation oriented micro service interface metadata model construction method disclosed in any of the foregoing embodiments. In addition, the resources stored in the memory 20 may also include an operating system 202, data 203, and the like, and the storage manner may be a transient storage manner or a permanent storage manner. Operating system 202 may include, among others, Windows, Unix, Linux, and the like. The data 203 may include, but is not limited to, data related to a micro service interface metadata model construction method for service-oriented adaptation, and the like.
In some embodiments, the service-oriented micro-service interface metadata model constructing device may further include a display 22, an input/output interface 23, a communication interface 24, a power supply 25, and a communication bus 26.
Those skilled in the art will appreciate that the structures shown in the figures do not constitute a definition of a service-oriented microservice interface metadata model construction means and may include more or less components than those shown.
The micro-service interface metadata model construction device facing service adaptation provided by the embodiment of the application comprises a memory and a processor, wherein when the processor executes a program stored in the memory, the following method can be realized: a method for constructing a micro service interface metadata model facing service adaptation.
The apparatus for constructing a metadata model of a microservice interface oriented to service adaptation provided by this embodiment corresponds to the above method, and therefore has the same beneficial effects as the above method.
Finally, the application also provides a corresponding embodiment of the computer readable storage medium. The computer-readable storage medium has stored thereon a computer program which, when being executed by a processor, carries out the steps as set forth in the above-mentioned method embodiments.
It is to be understood that if the method in the above embodiments is implemented in the form of software functional units and sold or used as a stand-alone product, it can be stored in a computer readable storage medium. Based on such understanding, the technical solutions of the present application, which are essential or part of the prior art, or all or part of the technical solutions may be embodied in the form of a software product, which is stored in a storage medium and executes all or part of the steps of the methods described in the embodiments of the present application. And the aforementioned storage medium includes: various media capable of storing program codes, such as a usb disk, a removable hard disk, a Read-Only Memory (ROM), a Random Access Memory (RAM), a magnetic disk, or an optical disk.
The computer-readable storage medium provided by the embodiment corresponds to the method, and therefore has the same beneficial effects as the method.
The method, the apparatus, and the medium for constructing the metadata model of the service-oriented adaptive micro service interface provided by the present application are described in detail above. The embodiments are described in a progressive mode in the specification, the emphasis of each embodiment is on the difference from the other embodiments, and the same and similar parts among the embodiments can be referred to each other. The device disclosed by the embodiment corresponds to the method disclosed by the embodiment, so that the description is simple, and the relevant points can be referred to the method part for description. It should be noted that, for those skilled in the art, it is possible to make several improvements and modifications to the present application without departing from the principle of the present application, and such improvements and modifications also fall within the scope of the claims of the present application.
It is further noted that, in the present specification, relational terms such as first and second, and the like are used solely to distinguish one entity or action from another entity or action without necessarily requiring or implying any actual such relationship or order between such entities or actions. Also, the terms "comprises," "comprising," or any other variation thereof, are intended to cover a non-exclusive inclusion, such that a process, method, article, or apparatus that comprises a list of elements does not include only those elements but may include other elements not expressly listed or inherent to such process, method, article, or apparatus. Without further limitation, an element defined by the phrase "comprising an … …" does not exclude the presence of other like elements in a process, method, article, or apparatus that comprises the same element.
Claims (10)
1. A method for constructing a metadata model of a micro service interface facing service adaptation is characterized by comprising the following steps:
scanning an interface to record a package structure and a program name of an annotation in the interface;
classifying the annotations into class annotations and method annotations according to the package structure and the program name;
obtaining relevant information of the interface in the class annotation and the method annotation, wherein the relevant information comprises at least one of the following: class name, method name, parameters of the class annotation, parameters of the method, parameter type of the method, return value type of the method.
2. The method for constructing the metadata model of the micro service interface facing the service adaptation according to claim 1, wherein after the obtaining the relevant information of the interface in the class annotation and the method annotation, the method further comprises:
generating an interface data model according to the related information; the generating of the interface data model according to the relevant information specifically includes: and filling the related information into a pre-generated template.
3. The method for constructing the metadata model of the microservice interface oriented toward service adaptation according to claim 2, wherein the generating the interface data model according to the related information comprises:
analyzing the related information;
and generating the interface data model according to the analyzed related information.
4. The method of claim 3, wherein the parameters of the class annotation comprise: path information, parameters annotated by the method including: path information and request mode.
5. The method of claim 4, wherein the parsing the relevant information comprises:
analyzing the corresponding path information on the class annotation and the method annotation into an interface path;
analyzing the request mode of the method annotation into the request mode of the interface;
analyzing the parameters of the method into request parameters of the interface;
analyzing the parameter type of the method into a request parameter type of the interface;
and resolving the return value type of the method into the return value type of the interface.
6. The method for constructing the metadata model of the servlet-oriented micro service interface as claimed in claim 5, wherein before parsing the related information, the method further comprises:
dividing the related information into different data objects according to different class names;
the analyzing the related information specifically comprises:
and analyzing the related information in each data object.
7. The method for constructing the metadata model of the micro service interface facing the service adaptation according to any one of claims 2 to 6, wherein after the generating the interface data model according to the related information, the method further comprises:
adding parameter values of the method in the interface data model for testing;
and if the test result represents that the interface data model does not meet the requirements, regenerating the interface data model.
8. A device for constructing metadata model of micro service interface facing service adaptation, comprising:
the scanning module is used for scanning the interface to record the package structure and the program name of the annotation in the interface;
a classification module for classifying the annotations into class annotations and method annotations according to the package structure and the program name;
an obtaining module, configured to obtain relevant information of the interface in the class annotation and the method annotation, where the relevant information includes at least one of: class name, method name, parameters of the class annotation, parameters of the method, parameter types of the method, return value types of the method.
9. A service-oriented adaptation microservice interface metadata model construction apparatus comprising a memory for storing a computer program;
a processor for implementing the steps of the service-oriented adaptation microservice interface metadata model construction method according to any of claims 1 to 7 when executing said computer program.
10. A computer-readable storage medium, characterized in that a computer program is stored thereon, which computer program, when being executed by a processor, carries out the steps of the service-oriented adapted microservice interface metadata model construction method according to any of the claims 1 to 7.
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202210742972.2A CN115129363A (en) | 2022-06-28 | 2022-06-28 | Method for constructing metadata model of micro service interface facing service adaptation |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202210742972.2A CN115129363A (en) | 2022-06-28 | 2022-06-28 | Method for constructing metadata model of micro service interface facing service adaptation |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN115129363A true CN115129363A (en) | 2022-09-30 |
Family
ID=83379398
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202210742972.2A Pending CN115129363A (en) | 2022-06-28 | 2022-06-28 | Method for constructing metadata model of micro service interface facing service adaptation |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN115129363A (en) |
-
2022
- 2022-06-28 CN CN202210742972.2A patent/CN115129363A/en active Pending
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| US10705942B1 (en) | Simulated testing of API | |
| CN108415832B (en) | Interface automation test method, device, equipment and storage medium | |
| CN111639287A (en) | Page processing method and device, terminal equipment and readable storage medium | |
| US10228933B2 (en) | Resource deployment based on conditions | |
| WO2017162024A1 (en) | Method of developing component and template using visual expression, storage medium, and apparatus | |
| US10419568B2 (en) | Manipulation of browser DOM on server | |
| US20150089469A1 (en) | Computer-aided development of native mobile application code | |
| US9052845B2 (en) | Unified interface for meta model checking, modifying, and reporting | |
| CN106354483B (en) | Data processing method and device and electronic equipment | |
| CN110955409B (en) | Method and device for creating resources on cloud platform | |
| US20170054790A1 (en) | System and Method for Object Compression and State Synchronization | |
| CN111818175A (en) | Enterprise service bus configuration file generation method, device, equipment and storage medium | |
| US20140006000A1 (en) | Built-in response time analytics for business applications | |
| CN114594934A (en) | Visual page generation method, device, equipment and medium | |
| US10560524B2 (en) | System and method providing local development of executable content pages normally run on a server within a user session | |
| CN108595656B (en) | Data processing method and system | |
| CN114297700A (en) | Dynamic and static combined mobile application privacy protocol extraction method and related equipment | |
| CN116501415B (en) | Command execution method and device, electronic equipment and computer readable storage medium | |
| CN116628141B (en) | Information processing method, device, equipment and storage medium | |
| CN115129363A (en) | Method for constructing metadata model of micro service interface facing service adaptation | |
| CN115470152A (en) | Test code generation method, test code generation device, and storage medium | |
| CN114490578A (en) | Data model management method, device and equipment | |
| CN109597845B (en) | Report configuration method, report configuration device, computer equipment and storage medium | |
| CN114385722A (en) | Interface attribute consistency checking method and device, electronic equipment and storage medium | |
| CN114391151A (en) | Enhanced natural language generation platform |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination |