CN117492824A

CN117492824A - Interface component generation method and device

Info

Publication number: CN117492824A
Application number: CN202310447201.5A
Authority: CN
Inventors: 邓林凡; 赫胜男; 蒋宁; 曾琳铖曦; 苏超
Original assignee: Mashang Xiaofei Finance Co Ltd
Current assignee: Mashang Xiaofei Finance Co Ltd
Priority date: 2023-04-23
Filing date: 2023-04-23
Publication date: 2024-02-02

Abstract

The present disclosure provides a method and an apparatus for generating an interface component, where the method includes: acquiring a coded file to be processed, wherein the type of an interface in the coded file is a declarative calling type; analyzing the coded file based on a preset interface document generation tool to obtain an interface description information set and a data transmission object description information set; respectively carrying out coding rendering processing on interface description information in the interface description information set and data transmission object description information in the data transmission object description information set to generate an interface calling coding file and a data transmission object coding file corresponding to the coding file; and generating a target interface component corresponding to the encoded file according to the interface calling encoded file and the data transmission object encoded file. According to the embodiment of the disclosure, the generation efficiency of the target interface component can be improved.

Description

Interface component generation method and device

Technical Field

The disclosure relates to the field of computer technology, and in particular, to a method and device for generating an interface component, electronic equipment, and a computer readable storage medium.

Background

In the micro-service architecture, declarative calling is widely used, and service calling is performed between micro-services based on interfaces of declarative calling types, so that the remote method can be called just as conveniently as a local method when HTTP is used for requesting the remote service, and a developer cannot feel the called remote method completely.

Currently, when a remote service, such as a service provided by a micro service 2, is requested by the micro service 1, it is generally required to send a remote call request to the micro service 2 based on an interface component provided by the micro service 2, i.e., an API SDK. In the related art, an interface component is generally created by a developer after the interface is implemented by encoding, and an engineering module is additionally created, and an interface definition code and a code of a data transmission object (DTO, data Transfer Object) corresponding to the interface are additionally copied in the engineering module, and the additionally written interface definition code and DTO code are packaged to generate the interface component.

In the method for generating the interface component in the related art, after the interfaces are realized by the codes, developers are required to manually copy the definition codes of the interfaces and the corresponding DTOs in the engineering module for packaging the interface component again, and the method for generating the interface component is time-consuming and labor-consuming, and can cause the unavailability of the interface component due to manual copying errors, so that the problem of low efficiency exists.

Disclosure of Invention

The disclosure provides a method and a device for generating an interface component, electronic equipment and a computer readable storage medium.

In a first aspect, the present disclosure provides a method for generating an interface component, where the method for generating an interface component includes:

Acquiring a coded file to be processed, wherein the type of an interface in the coded file is a declarative call type;

analyzing the encoded file based on a preset interface document generation tool to obtain an interface description information set and a data transmission object description information set, wherein the interface description information in the interface description information set corresponds to interfaces in the encoded file one by one, each interface description information is used for describing a corresponding interface in the encoded file, the data transmission object description information in the data transmission object description information set corresponds to data transmission objects in the encoded file one by one, each data transmission object description information is used for describing a corresponding data transmission object in the encoded file, and each data transmission object corresponds to one parameter of the interface in the encoded file;

respectively carrying out coding rendering processing on the interface description information in the interface description information set and the data transmission object description information in the data transmission object description information set to generate an interface calling coding file and a data transmission object coding file corresponding to the coding file;

and calling the coding file and the data transmission object coding file according to the interface to generate a target interface component corresponding to the coding file.

In a second aspect, the present disclosure provides a generating apparatus of an interface component, the generating apparatus of the interface component including:

the device comprises an acquisition unit, a processing unit and a processing unit, wherein the acquisition unit is used for acquiring an encoded file to be processed, and the type of an interface in the encoded file is a declarative call type;

the analysis unit is used for analyzing the encoded file based on a preset interface document generation tool to obtain an interface description information set and a data transmission object description information set, wherein the interface description information in the interface description information set corresponds to interfaces in the encoded file one by one, each interface description information is used for describing the corresponding interfaces in the encoded file, the data transmission object description information in the data transmission object description information set corresponds to data transmission objects in the encoded file one by one, each data transmission object description information is used for describing the corresponding data transmission objects in the encoded file, and each data transmission object corresponds to one parameter of the interfaces in the encoded file;

the coding rendering unit is used for respectively carrying out coding rendering processing on the interface description information in the interface description information set and the data transmission object description information in the data transmission object description information set to generate an interface calling coding file and a data transmission object coding file corresponding to the coding file;

And the generating unit is used for generating a target interface component corresponding to the encoded file according to the interface calling encoded file and the data transmission object encoded file.

In a third aspect, the present disclosure provides an electronic device comprising: at least one processor; and a memory communicatively coupled to the at least one processor; wherein the memory stores one or more computer programs executable by the at least one processor, one or more of the computer programs being executable by the at least one processor to enable the at least one processor to perform the method of generating an interface component as described above.

In a fourth aspect, the present disclosure provides a computer readable storage medium having stored thereon a computer program, wherein the computer program, when executed by a processor, implements the method of generating an interface component described above.

According to the embodiment provided by the disclosure, when the interface component is generated, after the coded file to be processed is acquired, the coded file is analyzed based on the preset interface document generation tool, so that an interface description information set formed by interface description information for describing interfaces of all declarative calling types in the coded file and a data transmission object description information set formed by data transmission object description information for describing each data transmission object are rapidly and accurately obtained; then, the interface calling coding file and the data transmission object coding file corresponding to the coding file can be accurately obtained by respectively carrying out coding rendering processing on the interface description information in the interface description information set and the data transmission object information in the data transmission object information set; and packaging the interface calling coding file and the data transmission object coding file, so that a target interface component corresponding to the coding file can be obtained efficiently.

In the embodiment provided by the disclosure, the interface calling coding file and the data transmission object coding file corresponding to the coding file can be obtained quickly and accurately without relying on manual generation of the interface calling coding file and the data transmission object coding file, but the electronic equipment can firstly analyze the coding file by using a preset interface document generation tool to obtain an interface description information set and a data transmission object description information set, and then code and render the interface description information set and the data transmission object description information set, so that the generation efficiency of the target interface component is improved.

It should be understood that the description in this section is not intended to identify key or critical features of the embodiments of the disclosure, nor is it intended to be used to limit the scope of the disclosure. Other features of the present disclosure will become apparent from the following specification.

Drawings

The accompanying drawings are included to provide a further understanding of the disclosure, and are incorporated in and constitute a part of this specification, illustrate embodiments of the disclosure and together with the description serve to explain the disclosure, without limitation to the disclosure. The above and other features and advantages will become more readily apparent to those skilled in the art by describing in detail exemplary embodiments with reference to the attached drawings, in which:

FIG. 1 is a block diagram of a related art interface component for generating an interface;

FIG. 2 is a flowchart of a method for generating an interface component according to an embodiment of the present disclosure;

FIG. 3 is a flow chart for parsing an encoded file provided by an embodiment of the present disclosure;

FIG. 4 is a flowchart of generating an interface call encoded file provided by an embodiment of the present disclosure;

FIG. 5 is a block diagram provided by an embodiment of the present disclosure for generating an interface component;

FIG. 6 is a block diagram of a generating device of an interface component provided by an embodiment of the present disclosure;

fig. 7 is a block diagram of an electronic device according to an embodiment of the present disclosure.

Detailed Description

For a better understanding of the technical solutions of the present disclosure, exemplary embodiments of the present disclosure will be described below with reference to the accompanying drawings, in which various details of the embodiments of the present disclosure are included to facilitate understanding, and they should be considered as merely exemplary. Accordingly, one of ordinary skill in the art will recognize that various changes and modifications of the embodiments described herein can be made without departing from the scope and spirit of the present disclosure. Also, descriptions of well-known functions and constructions are omitted in the following description for clarity and conciseness.

Embodiments of the disclosure and features of embodiments may be combined with each other without conflict.

As used herein, the term "and/or" includes any and all combinations of one or more of the associated listed items.

The terminology used herein is for the purpose of describing particular embodiments only and is not intended to be limiting of the disclosure. As used herein, the singular forms "a," "an," and "the" are intended to include the plural forms as well, unless the context clearly indicates otherwise. It will be further understood that the terms "comprises" and/or "comprising," when used in this specification, specify the presence of stated features, integers, steps, operations, elements, and/or components, but do not preclude the presence or addition of one or more other features, integers, steps, operations, elements, components, and/or groups thereof. The terms "connected" or "connected," and the like, are not limited to physical or mechanical connections, but may include electrical connections, whether direct or indirect.

Unless otherwise defined, all terms (including technical and scientific terms) used herein have the same meaning as commonly understood by one of ordinary skill in the art. It will be further understood that terms, such as those defined in commonly used dictionaries, should be interpreted as having a meaning that is consistent with their meaning in the context of the relevant art and the present disclosure, and will not be interpreted in an idealized or overly formal sense unless expressly so defined herein.

Referring to fig. 1, a block diagram of a related art interface component is shown. As shown in fig. 1, in the related art, for an encoded file of any micro service, an interface of each declarative call type is included in the encoded file to encode a specific implementation of the interface, that is, in the encoded file of the micro service, not only declarative notes, interface names, parameters, and the like of the interface, but also specific logic codes executed in the interface are included; when the interface component of the micro service, i.e. the API SDK, is generated for use by other micro services, the developer manually copies the interface call code of each interface and the data transfer object (DTO, data Transfer Object) code corresponding to each interface from the code file into the newly-built engineering module for packaging the interface component for packaging. In the method for generating the interface component, when the interfaces are newly added or deleted in the microservices, developers are required to copy the interfaces into the interface component again, so that the problems of time and labor waste and low efficiency exist, and meanwhile, under the condition that the number of the interfaces is large, the interface component is not available due to manual copying errors.

For example, when the number of interfaces to be duplicated is small, for example, 1 or 2, there is usually no omission when the interface call code of each interface and the data transfer object code corresponding to each interface are duplicated manually. However, in the case where the number of interfaces that need to be duplicated is large, the following may occur when the manual duplication is performed: 1. all interface calling codes of all interfaces to be copied are copied into an interface component, but data transmission object codes corresponding to all interfaces are not copied into the interface component; 2. the interface call coding part of the interface needing to be copied is copied into the interface component; 3. the interface call code of each interface to be copied and the data transmission object code corresponding to each interface are partially copied into the interface component, and the interface call code of the part of the interface copied into the interface component does not correspond to the part of the data transmission object code copied into the interface component.

In the first case, since part of the data transmission object code is missing in the code of the interface component, when the application service 1 calls the service provided by the corresponding application service 2 based on the interface component, on one hand, a compiling error may occur at the application compiling stage, so that the application service 1 cannot be started normally, and on the other hand, even if the application service 1 is started normally, when the application service 1 calls the service provided by the corresponding application service 2 of the interface component based on a certain interface of the interface component, which is missing the corresponding data transmission object code, a problem that parameters in the interface cannot be resolved normally occurs. For the second case above, since the interface component only duplicates the interface call code of part of the interfaces, this will make the calling end, e.g. application service 1, unable to use all the services provided by the called end, e.g. application service 2 corresponding to the interface component, based on the interface component, in which case the interface component will normally be rendered completely unusable.

In order to solve the problems of inefficiency and possible errors in generating an interface component in the related art, an embodiment of the disclosure provides a method for generating an interface component, please refer to fig. 2, which is a flowchart of a method for generating an interface component according to an embodiment of the disclosure. The method may be applied to an electronic device, which may be a server, or may also be a terminal device, for example, may be a personal computer, a tablet computer, or the like, which is not limited herein.

As shown in fig. 2, the method for generating an interface component according to the embodiment of the present disclosure includes the following steps S201 to S204, which are described in detail below.

Step S201, obtaining an encoded file to be processed, wherein the type of an interface in the encoded file is a declarative call type.

The declarative call type interface is generally an application programming interface capable of defining information such as parameters, formats, addresses, etc. of HTTP requests by writing simple interfaces and inserting declarative annotations. In the embodiment of the disclosure, the interface of the declarative calling type can be an interface based on the declarative calling component Feign coding implementation; of course, in actual implementation, this type of interface may also be implemented based on other types of declarative calling components, which are not particularly limited herein.

In general, when implementing interfaces of a declarative call type based on declarative call component Feign coding, implementation coding of the interfaces is typically in a control layer coding file of an application service, i.e., a controller coding file, and thus, in an embodiment of the present disclosure, the coding file may refer to a controller coding file corresponding to the application service.

Step S202, analyzing the encoded file based on a preset interface document generating tool to obtain an interface description information set and a data transmission object description information set, wherein the interface description information in the interface description information set corresponds to the interfaces in the encoded file one by one, each interface description information is used for describing the corresponding interfaces in the encoded file, the data transmission object description information in the data transmission object description information set corresponds to the data transmission objects in the encoded file one by one, each data transmission object description information is used for describing the corresponding data transmission objects in the encoded file, and each data transmission object corresponds to one parameter of the interfaces in the encoded file.

A data transfer object (DTO, data Transfer Object) is an object used to transfer data, and typically when remote calls are made, multiple data may be packaged into one data transfer object so that more data may be transferred with one call.

The preset interface document generating tool is used for automatically analyzing the interface source codes in the coded file and generating the description document of the interface source codes. The preset interface document generating tool may be, for example, a smart-doc, swagger, etc. in the embodiment of the present disclosure, it is preferable that the preset interface document generating tool is a smart-doc, considering that the smart-doc does not need to use any additional annotation intrusion service encoding when generating the interface document.

The interface description information can be information which is obtained by analyzing the interface source code in the encoded file based on a preset interface document generation tool and used for describing each interface. The interface description information may include information such as an interface name (or may also be referred to as an interface path or an interface entry) of an interface, a call type of the interface, a description text of an interface function, and a parameter name, a parameter type, a parameter description text of each parameter in the interface.

The interface name of the interface can be http://10. Xx.xx.1:8080/logic, the calling type of the interface can be post or get, the interface function description text is text information for describing the function of the interface, for example, the interface can be text similar to a user login interface, the parameters can comprise input parameters and output parameters, the type of the parameters can be basic data types in an encoding language, for example, the types of int, string and the like, and the type of the parameters can be data transmission objects customized by a user.

The data transmission object description information may be information for describing each data transmission object obtained by analyzing each data transmission object in the encoded file based on a preset interface document generation tool. The data transmission object description information may include information such as a name of the data transmission object, a name of each parameter in the data transmission object, a parameter data type, and a parameter description text.

And step S203, respectively performing coding rendering processing on the interface description information in the interface description information set and the data transmission object description information in the data transmission object description information set, and generating an interface calling coding file and a data transmission object coding file corresponding to the coding file.

The interface calling code file is a file containing codes for calling each interface, and the interface calling code file can generally contain codes such as interface names, interface parameters, parameter types and the like of each interface; the data transmission object code file is a file containing definition codes of the respective data transmission objects.

After the step S202 is performed, the encoded file is parsed by using the preset interface document generating tool to obtain the data transmission object description information composed of the interface description information set composed of the interface description information of each interface and the data transmission object description information of each DTO, since each interface description information includes detailed information such as the name, the input parameter, the output parameter, and the like of each interface, and each DTO also includes detailed information of each parameter defined by the basic data type in the programming language, the encoded file and the data transmission object encoded file can be quickly and accurately generated by the electronic device through encoding and rendering each interface description information and each data transmission object description information respectively.

In the embodiment of the disclosure, the encoding and rendering are performed on each interface description information and each data transmission object description information respectively, which may be performing encoding and conversion on the interface name, the interface call type, the parameter name and the parameter type of each parameter of the interface according to the interface name, the interface call type, and the like in the interface description information, so as to obtain an interface call code for remotely calling the corresponding interface.

Step S204, according to the interface call coding file and the data transmission object coding file, generating a target interface component corresponding to the coding file.

After the interface call code file and the data transmission object code file are obtained in step S203, the code file may be packaged, for example, a preset project management tool maven may be used to package the code file to generate a target interface component corresponding to the code file, after the target interface component is generated, the target interface component may be provided to a calling end, that is, to other application services, and other application services may add the target interface component in their own codes, and in the running process, send a remote call request to the application service corresponding to the target interface component based on the target interface component.

The encoded file may be, for example, an encoded file of a first application service; after generating the target interface component corresponding to the encoded file based on the method provided by the embodiment of the present disclosure, the second application service may send a remote call request to the first application service based on the target interface component, and receive a response message returned by the first application service in response to the remote call request.

For example, the first application service may be micro service 1, the second application service may be micro service 2, after generating a target interface component of micro service 1, that is, an API SDK, according to the method provided by the embodiment of the present disclosure, micro service 2 may load the target interface component of micro service 1 in its own code file, so that when the service provided by micro service 2 needs to be used, a remote call request may be sent to micro service 2 as if a local method is called based on each interface of declarative call types in the interface component, and a response message returned by micro service 2 in response to the remote call request is received.

According to the above description, according to the method for generating the interface component provided by the embodiment of the disclosure, the interface calling coding file and the data transmission object coding file corresponding to the coding file do not need to be generated manually, but the electronic device can firstly analyze the coding file by using the preset interface document generating tool to obtain the interface description information set and the data transmission object description information set, and then code and render the interface description information set and the data transmission object description information set, so that the interface calling coding file and the data transmission object coding file can be obtained quickly and accurately, and the generating efficiency of the target interface component is improved; in addition, compared with the problem of possible copying errors when the manual copying interface generates the interface call coding file and the data transmission object coding file for packaging, the embodiment of the disclosure obtains the two files by coding and rendering the interface description information set and the data transmission object description information set, which are obtained by analyzing the coding file based on the preset interface document generating tool, so that the problem of possible errors in manual copying can be avoided, and the accuracy of the obtained target interface assembly is improved.

In some embodiments, the interface of the declarative call type and the data transmission object corresponding to the interface are marked in the encoded file through a first preset annotation or a second preset annotation.

For example, in the case of an interface that defines the declarative call type using the declarative call component Feign, the first preset annotation may be "@ RestController" and the second preset annotation may be "@ Controller".

In this embodiment, as shown in fig. 3, the parsing of the encoded file based on the preset interface document generating tool in the above step S202, to obtain the interface description information set and the data transmission object description information set, includes the following steps S301 to S302:

step S301, analyzing each interface marked by the first preset annotation or the second preset annotation and each data transmission object in the encoded file based on the preset interface document generating tool to obtain interface description information of each interface and data transmission object description information of each data transmission object, wherein the interface description information comprises input parameter information, output parameter information and interface name information of the interface.

Taking a preset interface document generating tool as a smart-doc as an example, before analyzing the coded file, the smart-doc can be configured, for example, a storage path, a project name, a dependent software package, namely a dependent jar package and the like of the coded file are configured; after configuration is completed, the smart-doc can be operated to analyze the coded file, all interfaces with the first preset annotation or the second preset annotation in the coded file are scanned and analyzed, the information such as input parameters, output parameters, interface names and the like of the interfaces are analyzed, and interface description information of the interfaces is generated based on the information; and similarly, analyzing each data transmission object in the encoded file to obtain the description information of the data transmission object.

Step S302, according to the interface description information of each interface, an interface description information set is obtained, and according to the data transmission object description information of each data transmission object, a data transmission object description information set is obtained.

After the interface description information of each interface and the data transmission object description information of each data transmission object are obtained, an interface description information set data transmission object description information set corresponding to the encoded file can be generated.

It should be noted that, in the embodiment of the present disclosure, the interface description information set and the data transmission object description information set may be cached in a memory, for example, may be stored in a redis database, or may also be stored in a file, which is not limited herein.

Because the preset interface document generating tool, such as smart-doc, can automatically analyze the interface of the declaration type marked by the preset annotation, such as the first preset annotation and the second preset annotation, in the code file quickly and accurately based on the configuration item, the interface description information set and the data transmission object description information set corresponding to the code file can be accurately generated, the code file and the data transmission object code file can be called by the interface generating interface based on the two information sets, and the accuracy of the two obtained code files can be improved, so that the problems of low efficiency and inaccurate performance possibly existing when the two code files are generated by manual copying are solved.

In some embodiments, in the step S203, encoding rendering processing is performed on the data transmission object description information in the data transmission object description information set and each interface in the interface description information set, so as to generate an interface call encoding file and a data transmission object encoding file corresponding to the encoding file, which includes: performing coding rendering processing on each interface description information in the interface description information set based on a first preset template to generate an interface calling coding file; performing coding rendering processing on each data transmission object description information in the data transmission object description information set based on a second preset template to generate a data transmission object coding file; the first preset template and the second preset template are both realized based on the general programming (Generic Programming) idea, the first preset template is at least used for generating synchronous interface calling codes of interfaces, and the second preset template is used for generating codes of data transmission objects.

The generic programming concept means that by implementing a generic standard container library that can store all possible types of objects, based on generic programming, a developer can write fully generalized and reusable algorithms; the generic meaning is similar to templates in that it is operable over a wide variety of data types.

In the embodiment of the disclosure, the first preset template and the second preset template may be generic types implemented based on a generic programming idea, and the form of the first preset template and the second preset template may be a form of "public class name < T >", where T represents a type parameter, and the number of parameters may be 1 or may be multiple, and commas are used to divide between the multiple parameters; the first preset template comprises a generic code for rendering and generating interface calling codes, specifically, the generic code can predefine interface names, input parameters, output parameters and the like by using generic type parameters, and then, actual values are respectively filled into the generic type parameters based on interface description information of each interface so as to generate the interface calling codes of the corresponding interfaces; similarly, a second preset template can be designed and realized, and codes of all data transmission objects can be automatically generated based on the second preset template.

In one embodiment, as shown in fig. 4, the encoding rendering process is performed on each interface description information in the interface description information set based on the first preset template, and generating an interface call encoding file includes: step S401, constructing an initial interface template object based on a first preset template; step S402, interface description information of each interface in the interface description information set is respectively used as parameters of an interface template object to obtain interface calling codes respectively corresponding to each interface; step S403, generating an interface call code file according to the interface call codes respectively corresponding to the interfaces.

For example, the generic code used for rendering the interface call code in the first preset template may be the following code:

the above generic code is only used to schematically illustrate how the interface call code of each interface is generated, and the generic code may be set as needed in actual implementation.

When an interface call code file is generated based on the first preset template rendering, an initial interface template object can be instantiated by calling the first preset template, and then the interface description information set can be transmitted to the interface template object as transmission, so that interface call codes of all interfaces can be obtained.

Therefore, according to the method provided by the embodiment of the disclosure, after the interface description information set and the data transmission object description information set are obtained by designing the preset template based on the generic programming idea, the interface calling coding file and the data transmission object coding file can be efficiently and accurately generated based on the preset template.

In the embodiment of the disclosure, in the process of generating the synchronous interface call code of each interface according to the interface description information, the synchronous interface call code of each interface can be generated based on the example code of the first preset template, and meanwhile, the asynchronous interface call code of each interface can be generated, so that the problem that when the interfaces need to be subjected to asynchronous call, the call code of one-time interface needs to be copied again is solved.

For example, the following generic code for generating asynchronous call code of the interface may be added to the first preset template.

Of course, the above generic code is also merely an asynchronous interface call code for schematically describing how to generate each interface, and the generic code may be set as needed in actual implementation, and is not particularly limited herein.

In some embodiments, the generating the target interface component corresponding to the encoded file according to the interface calling encoded file and the data transmission object encoded file in step S204 includes: acquiring a preset component construction template, wherein the preset component construction template is used for constructing a target interface component, and comprises component identification information and software dependency information of the target interface component; and constructing templates according to the preset components, and constructing and processing the interface calling coding file and the data transmission object coding file based on a preset project management tool to obtain the target interface component.

In the embodiment of the disclosure, the preset project management tool may be maven, and the corresponding preset component building template may be a project object model (POM, project Object Model) template; the preset component building template may include component identification information and software dependency information of the target interface component, where the component identification information may be formed by a group identifier (groupId), an item identifier (artifactId), and a version number (version), and the software dependency information may be information of a software package, for example, jar package, on which the target interface component needs to depend.

In some embodiments, the building a template according to the preset component, building the interface call encoding file and the data transmission object encoding file based on the preset project management tool to obtain a target interface component, including: creating a project for constructing the target interface component by taking the preset component construction template as a configuration file of a preset project management tool, wherein the project contains a software dependency package identified in the software dependency information; in the project, according to the software dependent package and the component identification information, the component construction processing is carried out on the interface calling coding file and the data transmission object coding file based on the first preset instruction, and the target interface component is obtained.

In the embodiment of the present disclosure, the first preset instruction may be obtained by creating a sdk-package Mojo class and implementing an execute method inside the sdk-package Mojo class to package the first preset instruction "mvn app-api: sdk-package"; and compiling, unit testing, packaging and other component construction processes of the interface calling coding file and the data transmission object coding file can be realized based on the first preset instruction so as to generate a target interface component.

That is, in the embodiment of the present disclosure, a maven-based item in which software dependency information configured in a preset component build template is imported into each software dependency package may be created; and then, according to the component identification information corresponding to the software dependent packages and the target interface components, the interface call coding files and the data transmission object coding files corresponding to the coding files are subjected to component construction, namely packaging processing, so that the target interface components can be conveniently constructed.

Additionally, in some embodiments, after obtaining the target interface component, in order to facilitate the caller, i.e., other micro-service use, the method provided by the embodiments of the present disclosure further includes: uploading the target interface component to a local component warehouse based on a second preset instruction; and/or uploading the target interface component to a remote component repository based on the third preset instructions.

In the embodiment of the present disclosure, the local component repository may be a local maven repository; the remote component repository may be a remote maven private service.

The second preset instruction may be a second preset instruction "mvn app-api: sdk-instrument" obtained by creating a sdk-instrument Mojo class and inheriting sdk-package Mojo class, and then implementing an execute method inside the created sdk-instrument Mojo class, so as to implement a function of uploading the packaged target interface component to the local component repository.

The third preset instruction may be a third preset instruction "mvn app-api: sdk-reply" obtained by creating a sdk-reply Mojo class and inheriting sdk-install Mojo class, and then implementing an execute method inside the created sdk-reply Mojo class, so as to implement a function of uploading the packaged target interface component to a remote component repository.

It should be noted that, in some embodiments, in order to further improve the convenience of generating the target interface component, in practical implementation, the processing performed in steps S201 to S202 may be integrated into the project for constructing the target interface component, that is, in some embodiments, the preset component construction template may further include configuration information of a preset interface document generating tool, configuration information of parsing an encoding file based on the preset interface document generating tool, and the encoding rendering process.

In the implementation mode, in the project created based on a preset project management tool, namely maven, firstly, analyzing a coding file based on a preset interface document generating tool to obtain an interface description information set and a data transmission object description information set, and then performing coding rendering processing on the interface description information set and the data transmission object description information set through a fourth preset instruction obtained by pre-packaging to obtain an interface calling coding file and a data transmission object coding file; and then, respectively realizing the construction processing of the target interface component, the uploading processing of the local component warehouse and the uploading processing of the remote component warehouse through the first preset instruction, the second preset instruction and the third preset instruction.

The fourth preset instruction may be obtained by: a sdk-source Mjo class is created, an execution method is internally realized, and the execution method is packaged to obtain the fourth preset instruction 'mvn app-api: sdk-source' by calling a method for coding rendering processing.

For ease of understanding, please refer to fig. 5, which is a block diagram for generating an interface component provided by an embodiment of the present disclosure. As shown in fig. 5, according to the method for generating an interface component provided by the embodiment of the present disclosure, for any micro-service encoded file, it may be unnecessary to copy the encoded files manually, but a template package maven plug-in may be constructed based on maven and a preset component, then, based on the maven plug-in, by executing the fourth preset instruction, the encoded file may be parsed by using smart-doc to obtain an interface description information set data transmission object information set, and encoding rendering processing is performed based on the first preset template and the second preset template to obtain an interface call encoded file and a data transmission object encoded file; then, the target interface component is obtained by executing the first preset instruction, and the API SDK corresponding to the coded file is obtained; and then, the target interface component can be uploaded to a local component warehouse and/or a remote component warehouse by executing the second preset instruction and/or the third preset instruction. Compared with the method that the interface call codes of the interfaces and the data transmission object (DTO, data Transfer Object) codes corresponding to the interfaces are required to be manually copied to a newly-built engineering module for packaging the interface components for packaging in the related art, the method provided by the embodiment of the disclosure can avoid the problem that the generated interface components are unavailable due to the subjective reason of copying errors when the codes are manually copied, and improves the generation efficiency of the interface components.

In the embodiment of the present disclosure, the description is given by taking the Java language as the programming language used for the code file and the Feign as the component for defining the interface of the declarative call type as an example, and in the actual implementation, when the programming language used for implementing the code file is another language, specific settings may be made according to the characteristics of the used code language, which is not particularly limited herein.

It will be appreciated that the above-mentioned method embodiments of the present disclosure may be combined with each other to form a combined embodiment without departing from the principle logic, and are limited to the description of the present disclosure. It will be appreciated by those skilled in the art that in the above-described methods of the embodiments, the particular order of execution of the steps should be determined by their function and possible inherent logic.

In addition, the disclosure further provides a generating device, an electronic device and a computer readable storage medium of an interface component, where the generating device, the electronic device and the computer readable storage medium can be used to implement any one of the generating methods of the interface component provided in the disclosure, and corresponding technical schemes and descriptions and corresponding descriptions of method parts are omitted.

Fig. 6 is a block diagram of a generating device of an interface component according to an embodiment of the disclosure.

Referring to fig. 6, an embodiment of the present disclosure provides a generating apparatus of an interface component, the generating apparatus 600 of the interface component including: an acquisition unit 601, a parsing unit 602, an encoding rendering unit 603, and a generation unit 604.

The obtaining unit 601 is configured to obtain an encoded file to be processed, where a type of an interface in the encoded file is a declarative call type.

The parsing unit 602 is configured to parse the encoded file based on a preset interface document generating tool to obtain an interface description information set and a data transmission object description information set, where the interface description information in the interface description information set corresponds to interfaces in the encoded file one by one, each interface description information is used for describing a corresponding interface in the encoded file, the data transmission object description information in the data transmission object description information set corresponds to data transmission objects in the encoded file one by one, each data transmission object description information is used for describing a corresponding data transmission object in the encoded file, and each data transmission object corresponds to a parameter of the interface in the encoded file.

The encoding rendering unit 603 is configured to perform encoding rendering processing on the interface description information in the interface description information set and the data transmission object description information in the data transmission object description information set, and generate an interface call encoding file and a data transmission object encoding file corresponding to the encoding file.

The generating unit 604 is configured to generate a target interface component corresponding to the encoded file according to the interface call encoded file and the encoded file of the data transmission object.

In some embodiments, the interface of the declarative calling type and the data transmission object corresponding to the interface are marked in the encoded file through a first preset annotation or a second preset annotation; the parsing unit 602, when parsing the encoded file based on a preset interface document generating tool to obtain an interface description information set and a data transmission object description information set, may be used to: analyzing each interface marked by the first preset annotation or the second preset annotation and each data transmission object in the coded file based on a preset interface document generating tool to obtain interface description information of each interface and data transmission object description information of each data transmission object, wherein the interface description information comprises input parameter information, output parameter information and interface name information of the interface; according to the interface description information of each interface, an interface description information set is obtained, and according to the data transmission object description information of each data transmission object, a data transmission object description information set is obtained.

In some embodiments, when performing encoding and rendering processing on the data transmission object description information in the interface and data transmission object description information set respectively, the encoding and rendering unit 603 may be configured to: performing coding rendering processing on each interface description information in the interface description information set based on a first preset template to generate an interface calling coding file; performing coding rendering processing on each data transmission object description information in the data transmission object description information set based on a second preset template to generate a data transmission object coding file; the first preset template and the second preset template are both realized based on the general programming idea, the first preset template is at least used for generating synchronous interface calling codes of interfaces, and the second preset template is used for generating codes of data transmission objects.

In some embodiments, the encoding and rendering unit 603 performs encoding and rendering processing on each interface description information in the interface description information set based on the first preset template, and when generating an interface call encoding file, may be used to: constructing an initial interface template object based on a first preset template; respectively taking the interface description information of each interface in the interface description information set as the parameters of the interface template object to obtain interface calling codes respectively corresponding to each interface; and generating an interface call code file according to the interface call codes respectively corresponding to the interfaces.

In some embodiments, when generating the target interface component corresponding to the encoded file according to the interface call encoded file and the data transmission object encoded file, the generating unit 604 may be configured to: acquiring a preset component construction template, wherein the preset component construction template is used for constructing a target interface component, and comprises component identification information and software dependency information of the target interface component; and constructing templates according to the preset components, and constructing and processing the interface calling coding file and the data transmission object coding file based on a preset project management tool to obtain the target interface component.

In some embodiments, when the generating unit 604 builds a template according to a preset component, and builds the interface calling coding file and the data transmission object coding file based on the preset project management tool, the generating unit may be used to obtain the target interface component: creating a project for constructing the target interface component by taking the preset component construction template as a configuration file of a preset project management tool, wherein the project contains a software dependency package identified in the software dependency information; in the project, according to the software dependent package and the component identification information, the component construction processing is carried out on the interface calling coding file and the data transmission object coding file based on the first preset instruction, and the target interface component is obtained.

In some embodiments, the apparatus 600 further comprises an uploading unit configured to: after the target interface component is obtained, uploading the target interface component to a local component warehouse based on a second preset instruction; and/or uploading the target interface component to a remote component repository based on the third preset instructions.

Referring to fig. 7, an embodiment of the present disclosure provides an electronic device 700 including: at least one processor 701; at least one memory 702, and one or more I/O interfaces 703 connected between the processor 701 and the memory 702; the memory 702 stores one or more computer programs executable by the at least one processor 701, and the one or more computer programs are executed by the at least one processor 701 to enable the at least one processor 701 to perform the method of generating an interface component as described above.

The disclosed embodiments also provide a computer readable storage medium having a computer program stored thereon, wherein the computer program, when executed by a processor, implements the method of generating an interface component described above. The computer readable storage medium may be a volatile or nonvolatile computer readable storage medium.

Embodiments of the present disclosure also provide a computer program product comprising computer readable code, or a non-transitory computer readable storage medium carrying computer readable code, which when executed in a processor of an electronic device, performs the method of generating an interface component as described above.

Those of ordinary skill in the art will appreciate that all or some of the steps, systems, functional modules/units in the apparatus, and methods disclosed above may be implemented as software, firmware, hardware, and suitable combinations thereof. In a hardware implementation, the division between the functional modules/units mentioned in the above description does not necessarily correspond to the division of physical components; for example, one physical component may have multiple functions, or one function or step may be performed cooperatively by several physical components. Some or all of the physical components may be implemented as software executed by a processor, such as a central processing unit, digital signal processor, or microprocessor, or as hardware, or as an integrated circuit, such as an application specific integrated circuit. Such software may be distributed on computer-readable storage media, which may include computer storage media (or non-transitory media) and communication media (or transitory media).

The term computer storage media includes both volatile and nonvolatile, removable and non-removable media implemented in any method or technology for storage of information such as computer readable program instructions, data structures, program modules or other data, as known to those skilled in the art. Computer storage media includes, but is not limited to, random Access Memory (RAM), read Only Memory (ROM), erasable Programmable Read Only Memory (EPROM), static Random Access Memory (SRAM), flash memory or other memory technology, portable compact disc read only memory (CD-ROM), digital Versatile Discs (DVD) or other optical disc storage, magnetic cassettes, magnetic tape, magnetic disk storage or other magnetic storage devices, or any other medium which can be used to store the desired information and which can be accessed by a computer. Furthermore, as is well known to those of ordinary skill in the art, communication media typically embodies computer readable program instructions, data structures, program modules or other data in a modulated data signal such as a carrier wave or other transport mechanism and may include any information delivery media.

The computer readable program instructions described herein may be downloaded from a computer readable storage medium to a respective computing/processing device or to an external computer or external storage device over a network, such as the internet, a local area network, a wide area network, and/or a wireless network. The network may include copper transmission cables, fiber optic transmissions, wireless transmissions, routers, firewalls, switches, gateway computers and/or edge servers. The network interface card or network interface in each computing/processing device receives computer readable program instructions from the network and forwards the computer readable program instructions for storage in a computer readable storage medium in the respective computing/processing device.

Computer program instructions for performing the operations of the present disclosure can be assembly instructions, instruction Set Architecture (ISA) instructions, machine-related instructions, microcode, firmware instructions, state setting data, or source or object code written in any combination of one or more programming languages, including an object oriented programming language such as Smalltalk, c++ or the like and conventional procedural programming languages, such as the "C" programming language or similar programming languages. The computer readable program instructions may be executed entirely on the user's computer, partly on the user's computer, as a stand-alone software package, partly on the user's computer and partly on a remote computer or entirely on the remote computer or server. In the case of a remote computer, the remote computer may be connected to the user's computer through any kind of network, including a Local Area Network (LAN) or a Wide Area Network (WAN), or may be connected to an external computer (for example, through the Internet using an Internet service provider). In some embodiments, aspects of the present disclosure are implemented by personalizing electronic circuitry, such as programmable logic circuitry, field Programmable Gate Arrays (FPGAs), or Programmable Logic Arrays (PLAs), with state information of computer readable program instructions, which can execute the computer readable program instructions.

The computer program product described herein may be embodied in hardware, software, or a combination thereof. In an alternative embodiment, the computer program product is embodied as a computer storage medium, and in another alternative embodiment, the computer program product is embodied as a software product, such as a software development kit (Software Development Kit, SDK), or the like.

Various aspects of the present disclosure are described herein with reference to flowchart illustrations and/or block diagrams of methods, apparatus (systems) and computer program products according to embodiments of the disclosure. It will be understood that each block of the flowchart illustrations and/or block diagrams, and combinations of blocks in the flowchart illustrations and/or block diagrams, can be implemented by computer-readable program instructions.

These computer readable program instructions may be provided to a processor of a general purpose computer, special purpose computer, or other programmable data processing apparatus to produce a machine, such that the instructions, which execute via the processor of the computer or other programmable data processing apparatus, create means for implementing the functions/acts specified in the flowchart and/or block diagram block or blocks. These computer readable program instructions may also be stored in a computer readable storage medium that can direct a computer, programmable data processing apparatus, and/or other devices to function in a particular manner, such that the computer readable medium having the instructions stored therein includes an article of manufacture including instructions which implement the function/act specified in the flowchart and/or block diagram block or blocks.

The computer readable program instructions may also be loaded onto a computer, other programmable data processing apparatus, or other devices to cause a series of operational steps to be performed on the computer, other programmable apparatus or other devices to produce a computer implemented process such that the instructions which execute on the computer, other programmable apparatus or other devices implement the functions/acts specified in the flowchart and/or block diagram block or blocks.

The flowcharts and block diagrams in the figures illustrate the architecture, functionality, and operation of possible implementations of systems, methods and computer program products according to various embodiments of the present disclosure. In this regard, each block in the flowchart or block diagrams may represent a module, segment, or portion of instructions, which comprises one or more executable instructions for implementing the specified logical function(s). In some alternative implementations, the functions noted in the block may occur out of the order noted in the figures. For example, two blocks shown in succession may, in fact, be executed substantially concurrently, or the blocks may sometimes be executed in the reverse order, depending upon the functionality involved. It will also be noted that each block of the block diagrams and/or flowchart illustration, and combinations of blocks in the block diagrams and/or flowchart illustration, can be implemented by special purpose hardware-based systems which perform the specified functions or acts, or combinations of special purpose hardware and computer instructions.

Example embodiments have been disclosed herein, and although specific terms are employed, they are used and should be interpreted in a generic and descriptive sense only and not for purpose of limitation. In some instances, it will be apparent to one skilled in the art that features, characteristics, and/or elements described in connection with a particular embodiment may be used alone or in combination with other embodiments unless explicitly stated otherwise. It will be understood by those skilled in the art that various changes in form and details may be made therein without departing from the scope of the disclosure as set forth in the appended claims.

Claims

1. A method for generating an interface component, comprising:

2. The method of claim 1, wherein the interface of the declarative call type and the data transfer object corresponding to the interface are marked in the encoded file by a first preset annotation or a second preset annotation;

the document generation tool based on the preset interface analyzes the coded file to obtain an interface description information set and a data transmission object description information set, and the method comprises the following steps:

analyzing each interface marked by the first preset annotation or the second preset annotation and each data transmission object in the coded file based on the preset interface document generating tool to obtain interface description information of each interface and data transmission object description information of each data transmission object, wherein the interface description information comprises input parameter information, output parameter information and interface name information of the interface;

And obtaining the interface description information set according to the interface description information of each interface, and obtaining the data transmission object description information set according to the data transmission object description information of each data transmission object.

3. The method according to claim 2, wherein the encoding rendering processing is performed on each interface in the interface description information set and the data transmission object description information in the data transmission object description information set, respectively, to generate an interface call encoding file and a data transmission object encoding file corresponding to the encoding file, and the method includes:

performing coding rendering processing on each interface description information in the interface description information set based on a first preset template to generate the interface calling coding file; the method comprises the steps of,

performing coding rendering processing on the description information of each data transmission object in the description information set of the data transmission object based on a second preset template to generate the coding file of the data transmission object;

the first preset template and the second preset template are both realized based on a general programming idea, the first preset template is at least used for generating synchronous interface calling codes of interfaces, and the second preset template is used for generating codes of data transmission objects.

4. The method according to claim 3, wherein the encoding rendering processing is performed on each interface description information in the interface description information set based on the first preset template, and generating the interface call encoding file includes:

constructing an initial interface template object based on the first preset template;

respectively taking the interface description information of each interface in the interface description information set as the parameters of the interface template object to obtain interface calling codes respectively corresponding to each interface;

and generating the interface call code file according to the interface call codes respectively corresponding to the interfaces.

5. The method according to any one of claims 1-4, wherein generating a target interface component corresponding to the encoded file according to the interface call encoded file and the data transmission object encoded file includes:

acquiring a preset component construction template, wherein the preset component construction template is used for constructing the target interface component, and the preset component construction template comprises component identification information and software dependency information of the target interface component;

and constructing a template according to the preset component, and constructing the interface calling coding file and the data transmission object coding file based on a preset project management tool to obtain the target interface component.

6. The method according to claim 5, wherein the constructing a template according to the preset component, performing construction processing on the interface call code file and the data transmission object code file based on a preset project management tool, to obtain the target interface component, includes:

creating a project for constructing the target interface component by taking the preset component construction template as a configuration file of the preset project management tool, wherein the project comprises a software dependent package identified in the software dependent information;

and in the project, according to the software dependency package and the component identification information, performing component construction processing on the interface calling coding file and the data transmission object coding file based on a first preset instruction to obtain the target interface component.

7. The method of any one of claims 1-4, wherein the encoded file is an encoded file of a first application service; and the second application service sends a remote call request to the first application service based on the target interface component, and receives a response message returned by the first application service in response to the remote call request.

8. An apparatus for generating an interface assembly, comprising:

9. An electronic device, comprising:

at least one processor; and

a memory communicatively coupled to the at least one processor; wherein,

the memory stores one or more computer programs executable by the at least one processor to enable the at least one processor to perform the method of generating an interface component according to any one of claims 1-7.

10. A computer readable storage medium, on which a computer program is stored, characterized in that the computer program, when being executed by a processor, implements a method of generating an interface component according to any of claims 1-7.