WO2022002030A1

WO2022002030A1 - Data processing method, apparatus, and device, and computer readable storage medium

Info

Publication number: WO2022002030A1
Application number: PCT/CN2021/103024
Authority: WO
Inventors: 李东卫; 杨洋; 朱孝瑾; 都业广; 冯硕
Original assignee: 北京沃东天骏信息技术有限公司; 北京京东世纪贸易有限公司
Priority date: 2020-06-29
Filing date: 2021-06-29
Publication date: 2022-01-06
Also published as: CN113760359A

Abstract

Provided in the embodiments of the present application are a data processing method, apparatus, and device, and a computer readable storage medium. The method comprises: during a compilation process, parsing interface annotation information in program code to obtain interface information; and, on the basis of the interface information, automatically generating a data model file. The method of the present invention implements automatic generation of interface information and data model files by means of parsing interface annotation information in program code during a compilation process to obtain interface information and automatically generating a data model file on the basis of the interface information; when the interface changes, interface information and data model files can be automatically updated in a timely manner for recompiling, increasing efficiency and overcoming the technical problems of abnormalities such as front end pages being inaccessible and data errors being returned as a result of the front end being unable to accurately acquire backend data due to omissions easily occurring and the updating of interface documents not being timely.

Description

Data processing method, apparatus, device, and computer-readable storage medium

This application claims the priority of the Chinese patent application with the application number 202010605484.8 and the application name "Data Processing Method, Apparatus, Equipment and Computer-readable Storage Medium" filed with the China Patent Office on June 29, 2020, the entire content of which is approved by Reference is incorporated in this application.

technical field

The present application relates to the field of computer technology, and in particular, to a data processing method, apparatus, device, and computer-readable storage medium

Background technique

In the existing software development process, front-end developers need to obtain back-end data through interface programs written by back-end developers, and the front-end and back-end connections have been completed.

At present, back-end developers usually manually record the interface information into the interface document to describe the back-end interface to a certain extent. Front-end developers can view the json format of the data returned by the interface in the interface document, and customize the data model to parse the returned data and put it into use. In the process of use, the interface document needs to be referred to.

If the interface changes, the back-end developers need to manually modify the interface documents, and notify all front-end involved personnel to modify the corresponding data model. Due to the heavy tasks of the back-end developers, the update of the interface documents is often not timely, and it is easy to be missed. In this case, the front-end cannot accurately obtain the back-end data, which leads to exceptions such as inaccessibility of the front-end page and incorrect data returned.

SUMMARY OF THE INVENTION

The embodiments of the present application provide a data processing method, apparatus, device, and computer-readable storage medium, which are used to solve the problem that in the prior art, the front-end cannot accurately obtain background data due to the untimely update of interface documents and easy omissions. , resulting in abnormal problems such as inaccessibility of the front-end page and return of data errors.

On the one hand, an embodiment of the present application provides a data processing method, including:

During the compilation process, the interface annotation information in the program code is parsed to obtain the interface information;

A data model file is automatically generated according to the interface information.

In a possible design, after the data model file is automatically generated according to the interface information, the method further includes:

The data model file is automatically submitted to the preset code repository.

In a possible design, the data model file is automatically generated according to the interface information, including:

According to the interface information, the target interface identifier and the designated operating system type, a data model file of the target interface is automatically generated, and the data model file corresponds to the designated operating system type.

In a possible design, before the data model file of the target interface is automatically generated according to the interface information, the target interface identifier and the specified operating system type, the method further includes:

The target interface identifier and the specified operating system type sent by the front-end are received, and the specified operating system type is input by the user through the front-end page.

In a possible design, after the data model file of the target interface is automatically generated according to the interface information, the target interface identifier and the specified operating system type, the method further includes:

Submit the data model file of the target interface to the specified code repository.

In a possible design, before submitting the data model file of the target interface to the specified code repository, the method further includes:

The address information of the designated code warehouse sent by the front-end is received, where the address information of the designated code warehouse is input by the user through the front-end page.

In a possible design, in the compilation process, the interface annotation information in the program code is parsed, and after the interface information is obtained, the method further includes:

An interface document is generated according to the interface information.

In a possible design, during the compilation process, the interface annotation information in the program code is parsed, and after the interface information is obtained, it also includes:

The interface information is sent to the front end to display the interface information through the front end page.

In a possible design, the interface annotation information includes an entry parameter annotation and an exit parameter annotation of the interface; the interface annotation information in the parsing program code is obtained to obtain the interface information, including:

Scan each class in the program code, if any class contains the exit parameter annotation, then save the information of the exit parameter annotation on all member variables in the class into the first MAP set;

If the class is a Controller class, scan whether each method in the class contains an entry parameter annotation, and if at least one method of the class contains an entry parameter annotation, annotate the entry parameter of the at least one method The information is saved into the first MAP set.

In a possible design, the entry parameter annotation includes a first attribute and a second attribute, the value of the first attribute is the interface name, and the value of the second attribute is description information of each entry parameter of the interface; the exit parameter The annotation includes a third attribute and a fourth attribute, the value of the third attribute is the interface name, and the value of the fourth attribute is the description information of each exit parameter, wherein the number of the fourth attribute in the annotation of the exit parameter of the interface is related to the exit of the interface The number of parameters is the same.

In a possible design, if the at least one method of the class contains an entry parameter annotation, the information of the entry parameter annotation of the at least one method is stored in the first MAP set, including:

If at least one method in the class contains an entry parameter annotation, the value of the first attribute of the entry parameter annotation of each method is used as the key, and the value of the second attribute of the entry parameter annotation of the method is used as value. , and stored in the first MAP set.

In a possible design, if the class contains an exit parameter annotation, the information of the exit parameter annotation on all member variables in the class is stored in the first MAP set, including:

If the class contains an exit parameter annotation, the field name of any member variable in the class is used as the key, and the value of the fourth attribute of the exit parameter annotation corresponding to the member variable is used as the value to form the member variable The key-value pairs, the key-value pairs corresponding to all member variables in the class constitute a second MAP set; the value of the third attribute of the exit parameter annotation is used as the key, and the second MAP set is used as the value, Save to the first MAP set.

In a possible design, the method further includes:

If the class includes a member variable of a preset data type, the information of the exit parameter annotation of the defined class corresponding to the member variable of the preset data type is stored in the first MAP set in a recursive manner, and the The first MAP set contains nested model information.

In a possible design, the method further includes:

If the interface information includes nested model information, a recursive manner is used to generate a data model file including the nested model according to the interface information.

On the other hand, an embodiment of the present application provides a data processing apparatus, including:

The annotation parsing module is used to parse the interface annotation information in the program code during the compilation process to obtain the interface information;

An information processing module, configured to automatically generate a data model file according to the interface information.

In a possible design, the device further includes:

The sending module is used for automatically submitting the data model file to the preset code warehouse.

In a possible design, the information processing module is also used for:

In a possible design, the device further includes:

The receiving module is configured to receive the target interface identifier and the specified operating system type sent by the front-end, where the specified operating system type is input by the user through the front-end page.

In a possible design, the sending module is also used for:

In a possible design, the receiving module is also used for:

In a possible design, the information processing module is also used for:

An interface document is generated according to the interface information.

In a possible design, the sending module is also used for:

In a possible design, the interface annotation information includes an entry parameter annotation and an exit parameter annotation of the interface; the annotation parsing module is further used to:

Scan each class in the program code, if any class contains an exit parameter annotation, save the information of the exit parameter annotation on all member variables in the class into the first MAP set; if the class is a control Controller class, scan whether each method in the class contains entry parameter annotations, if at least one method of the class contains entry parameter annotations, save the entry parameter annotation information of the at least one method to the first MAP in the collection.

In a possible design, the annotation parsing module is also used to:

If the class contains an exit parameter annotation, the field name of any member variable in the class is used as the key, and the value of the fourth attribute of the exit parameter annotation corresponding to the member variable is used as the value to form the member variable The key-value pairs corresponding to all member variables in the class form a second MAP set; the value of the third attribute of the exit parameter annotation is used as the key, and the second MAP set is used as the value, Save to the first MAP set.

In a possible design, the annotation parsing module is also used to:

In a possible design, the information processing module is also used for:

On the other hand, an embodiment of the present application provides a data processing device, including:

a processor, a memory, and a computer program stored on the memory and executable on the processor;

Wherein, the above-mentioned data processing method is implemented when the processor runs the computer program.

On the other hand, an embodiment of the present application provides a computer-readable storage medium, where a computer program is stored in the computer-readable storage medium, and when the computer program is executed by a processor, the data transmission method described above is implemented.

The data processing method, device, device, and computer-readable storage medium provided by the embodiments of the present application have the following advantages or beneficial effects: by parsing the interface annotation information in the program code during the compilation process, the interface information is obtained; according to the interface The information automatically generates data model files, which realizes the automatic generation of interface information and data model files. When the interface changes, recompilation can complete the automatic update of interface information and data model files in time, which improves the efficiency and overcomes the The interface documents are not updated in a timely manner and are prone to omissions, resulting in the inability of the front-end to obtain the back-end data accurately, resulting in abnormal technical problems such as inaccessibility of the front-end pages and errors in the returned data.

Description of drawings

1 is a schematic diagram of a software development platform system architecture provided by an embodiment of the present application;

2 is a flowchart of a data processing method provided in Embodiment 1 of the present application;

3 is a flowchart of a data processing method provided in Embodiment 2 of the present application;

4 is a schematic diagram of an entry parameter annotation provided in Embodiment 2 of the present application;

FIG. 5 is a schematic diagram of an annotation of an exit parameter provided in Embodiment 2 of the present application;

FIG. 6 is a schematic diagram of the overall flow of parsing annotations provided by Embodiment 2 of the present application;

7 is a schematic diagram of an interface information display interface provided by Embodiment 2 of the present application;

FIG. 8 is a schematic structural diagram of a data processing apparatus provided in Embodiment 3 of the present application;

9 is a schematic structural diagram of a data processing apparatus provided in Embodiment 4 of the present application;

FIG. 10 is a schematic structural diagram of a data processing device according to Embodiment 5 of the present application.

Specific embodiments of the present application have been shown by the above-mentioned drawings, and will be described in more detail hereinafter. These drawings and written descriptions are not intended to limit the scope of the concepts of the present application in any way, but to illustrate the concepts of the present application to those skilled in the art by referring to specific embodiments.

detailed description

Exemplary embodiments will be described in detail herein, examples of which are illustrated in the accompanying drawings. Where the following description refers to the drawings, the same numerals in different drawings refer to the same or similar elements unless otherwise indicated. The implementations described in the illustrative examples below are not intended to represent all implementations consistent with this application. Rather, they are merely examples of apparatus and methods consistent with some aspects of the present application as recited in the appended claims.

First, the terms involved in this application are explained:

JSON format: JSON is a lightweight data exchange format.

vo(value object): It is a business object in java and lives in the business layer.

git: is an open source distributed version control system for agile and efficient handling of large or small projects.

Annotation: java annotation, also known as java annotation, is an annotation mechanism introduced by jdk5.0.

Bootstrap: It is a front-end framework launched by Twitter. It is flexible and makes web development faster.

Shell script: Shell is a program written in C language, it is a bridge for users to use Linux, it accepts user commands, and then invokes the corresponding application.

In addition, the terms "first", "second", "third", etc. are only used for descriptive purposes and should not be construed as indicating or implying relative importance or implying the number of indicated technical features. In the description of the following embodiments, the meaning of "plurality" is two or more, unless otherwise expressly and specifically defined.

The data processing method provided by the embodiment of the present application can be applied to the schematic diagram of the system architecture of the software development platform shown in FIG. 1 . As shown in Figure 1, the system architecture includes a data acquisition module, a client model module, an interface document display module, and a client code repository.

Among them, the data acquisition module is located on the server side of the system. During the coding phase, the back-end developers add custom interface annotations to the request method and the returned data VO class. During the compilation phase, the back-end automatically parses the interface annotations to obtain the interface. information, and save the interface information to realize the collection function of the data information required by the interface document.

The interface document display module means that the interface information obtained by the back-end is displayed through the front-end display interface, and also provides an interactive interface with the front-end user, so that the user can submit information to the back-end through the front-end interface.

The client model module is located on the server side of the system, and is used to automatically generate the data model file required by the client user according to the interface information, which can be the model file required by iOS and Android. Exemplarily, the user may select an interface to generate the data model file through the front-end interface, input the name of the data model file to be generated, input the address information of the code repository to which the generated data model file is submitted, and so on.

The client code base provides the function of automatically submitting the generated data model files to the git code repository, which is convenient for front-end clerks to use directly.

The data processing method provided by the embodiment of the present application can automatically parse the interface annotation information in the code to obtain the interface information during the compilation process, automatically generate the data model file, and automatically submit the data model file to the code warehouse. The end developer only needs to modify the annotation of the interface, and the interface information will be automatically updated, the data model file will be regenerated, and automatically updated to the code warehouse during compilation, which reduces the communication cost of front-end and back-end personnel, improves efficiency, and overcomes the The interface documents are not updated in a timely manner, and are prone to omissions, resulting in the inability of the front-end to obtain the back-end data accurately, resulting in abnormal technical problems such as inaccessibility of the front-end pages and errors in the returned data.

The technical solutions of the present application and how the technical solutions of the present application solve the above-mentioned technical problems will be described in detail below with specific examples. The following specific embodiments may be combined with each other, and the same or similar concepts or processes may not be repeated in some embodiments. The embodiments of the present application will be described below with reference to the accompanying drawings.

FIG. 2 is a flowchart of the data processing method provided in Embodiment 1 of the present application. The method in this embodiment is applied to the server device in the background of the software development platform. As shown in Figure 2, the specific steps of the method are as follows:

Step S101 , in the compiling process, parse the interface annotation information in the program code to obtain interface information.

The interface annotation information includes an entry parameter annotation and an exit parameter annotation.

In this embodiment, the back-end developer adds custom annotations to the request method and the returned data VO in the coding phase to complete the writing of the interface annotation information.

In the compilation stage, the server device can automatically parse the interface annotation information in the program code to obtain the interface information required in the interface document.

The interface information includes at least ingress parameter information and egress parameter information, and the ingress parameter information includes at least an interface name and description information of the ingress parameter. The egress parameter information at least includes interface name and description information of egress parameters.

Step S102, a data model file is automatically generated according to the interface information.

In this embodiment, after parsing out the interface information, a data model file is generated by calling a shell script according to the interface information.

Exemplarily, the operating system types usually include IOS and Android. For different operating system types, the server device can call different shell scripts to generate data model files applied to different operating system types.

Optionally, if the user specifies that the operating system type is IOS, a shell script suitable for IOS is invoked to generate a data model file suitable for IOS.

Optionally, if the user specifies that the operating system type is Android, a shell script suitable for Android is invoked to generate a data model file suitable for Android.

Optionally, if the user does not specify the operating system type, the shell script suitable for IOS and the shell script suitable for Android can be respectively called to generate data model files suitable for IOS and Android respectively.

The embodiment of the present application obtains the interface information by parsing the interface annotation information in the program code during the compilation process; automatically generates the data model file according to the interface information, and realizes the automatic generation of the interface information and the data model file. When the interface changes, Recompilation can complete the automatic update of interface information and data model files in a timely manner, which improves efficiency, and overcomes the fact that the interface documents are not updated in time and are prone to omissions, resulting in the front-end unable to accurately obtain background data, thus Causes abnormal technical problems such as inaccessibility of front-end pages and returned data errors.

FIG. 3 is a flowchart of the data processing method provided in Embodiment 2 of the present application. On the basis of the above-mentioned first embodiment, in this embodiment, the data model file is automatically generated according to the interface information, including: according to the interface information, the target interface identifier and the specified operating system type, the data model file of the target interface is automatically generated, the data model file Corresponds to the specified operating system type. Further, after the data model file is automatically generated according to the interface information, the method further includes: automatically submitting the data model file to the preset code warehouse. As shown in Figure 3, the specific steps of the method are as follows:

Step S201 , in the compiling process, parse the interface annotation information in the program code to obtain interface information.

The interface annotation information includes an entry parameter annotation and an exit parameter annotation of the interface.

The entry parameter annotation includes a first attribute and a second attribute, the value of the first attribute is the interface name, and the value of the second attribute is description information of each entry parameter of the interface.

Exemplarily, the entry parameter annotation can be represented by "DocReqValue", the first attribute of the entry parameter annotation can be represented by name, the value of the first property can be represented by the interface name, the second property can be represented by value, and the value of the second property includes each The description information of the entry parameters, the description information of different parameters is separated by a semicolon, and the order of the description information is the same as that of the entry parameters. In addition, this embodiment does not specifically limit the identifiers used for the entry parameter annotation and the first attribute and the second attribute.

For example, in the program code shown in Figure 4, there are two entry parameters in the request function getShopList, namely pin and uuid, the entry parameter annotation "@DocReqValue" is added to the request function getShopList, and the value of the first attribute name is The interface name is "obtaining the watch list interface", the value of the second attribute value includes the description information of the pin and uuid separated by semicolons, the description information of the entry parameter pin is "automatically obtained by the gateway after login", and the description information of the entry parameter uuid It is "must be passed (Note: the unique code of the machine - android is uuid, ios is openudid)".

In this embodiment, the egress parameter annotation includes a third attribute and a fourth attribute, the value of the third attribute is the interface name, and the value of the fourth attribute is the description information of each egress parameter, wherein the value of the fourth attribute in the egress parameter annotation of the interface is The number is the same as the number of egress parameters for this interface.

Exemplarily, "DocValue" can be used to indicate the exit parameter annotation, the third attribute of the exit parameter annotation can be expressed as name, the value of the third attribute can be expressed as the interface name, the fourth attribute can be expressed as key, and the value of the fourth attribute includes the exit Description of the parameter. For an interface with multiple exit parameters, each exit parameter can correspond to a key. In addition, this embodiment does not specifically limit the identifiers used for the exit parameter annotation and the third attribute and the fourth attribute.

For example, in the program code shown in Figure 5, the export parameter annotation "@DocValue" is added to the data VO class ShopResponseVO, the value of the third attribute name is the interface name "obtaining the watch list interface", the member variables "allFollowed", The fourth attribute is annotated on "haveFollowed" and "shopNum" respectively, and the values of the corresponding fourth attribute key are "false: not all followed true: all followed", "the number of followed shops" and "the total number of shops in the pot" eye".

It should be noted that the interface name in the exit parameter annotation of a data VO class should be the same as the interface name in the entry parameter annotation of the request method corresponding to the data VO class, that is, the first attribute name of the exit parameter annotation of the data VO class is the same as the name of the interface. The third attribute name of the entry parameter annotation of the request method corresponding to the data VO class is the same.

As a possible implementation manner, in order to realize the automatic parsing of annotations, the overall process of parsing annotations is shown in Figure 6, which may include the following steps:

Step S1, scan the custom annotation.

By registering the rules for custom annotations in the annotation class, the custom scanning class is used to scan which positions in the code are added with custom annotations.

Step S2, adding custom annotations to the sping container.

By extending the ImportBeanDefinitionRegistrar interface, the annotation class is added to the spring container to prepare for the subsequent parsing of the annotation.

Step S3, the bean post-processing method parses the annotation.

By extending the BeanPostProcessor interface, the annotations are resolved in the bean post-processing method.

Step S4, save the interface information.

The interface information required by the interface document can be obtained by parsing the annotation through the bean post-processing method, and the interface information can be saved.

As a possible implementation manner, the process of parsing annotations by the bean post-processing method in the above step 3 can be specifically implemented through the processing of the following steps S2011-S2013:

Step S2011, scan each class in the program code, and perform the following processing on the currently scanned class:

Step S2012, judging whether the class contains the export parameter annotation.

If the class contains an exit parameter annotation, step S2013 is executed to parse the exit parameter annotation in the class to obtain corresponding exit parameter information.

If the class does not contain the exit parameter annotation, step S2014 is executed to continue parsing the entry parameter annotation in the class to obtain entry parameter information in the class.

For example, based on the example of the exit parameter annotation shown in Figure 5, it can be judged whether the class contains the exit parameter annotation by judging whether the identifier "@DocValue" of the exit parameter annotation is added to the class, if the "@DocValue" is added to the class ", it can be determined that the class contains exit parameter annotations; if "@DocValue" is not added to the class, it can be determined that the class does not contain exit parameter annotations. For the example in FIG. 5 , the exit parameter annotation "@DocValue" is added to the data VO class ShopResponseVO, and it can be determined that the data VO class ShopResponseVO contains the exit parameter annotation.

Step S2013: If the class contains the exit parameter annotation, save the information of the exit parameter annotation on all member variables in the class into the first MAP set.

Specifically, if the class contains an exit parameter annotation, then by traversing each member variable in the class, the field name of each member variable in the class and the value of the fourth attribute of the corresponding exit parameter annotation can be used as the key and The value constitutes a key-value pair, and the key-value pairs corresponding to all member variables in the class constitute a second MAP set; the value of the third attribute of the exit parameter annotation is used as the key, and the second MAP set is used as the value, which is stored in the first MAP in the collection.

For example, based on the example of the exit parameter annotation shown in Figure 5, annotation information is added to the three member variables in the data VO class ShopResponseVO. By traversing each member variable, the field name of each member variable in the ShopResponseVO class and the corresponding The value of the fourth attribute of the exit parameter annotation is used as key and value to form a key-value pair, and the second MAP set contains the following 3 key-value pairs: key="allFollowed", value="false: not all concerned true: already Follow all"; key="haveFollowed", value="Number of followed shops"; key="shopNum", value="Total number of shops in the pot". The value of the third attribute of the exit parameter annotation "obtaining the interest list interface" is used as the key, and the second MAP set is used as the value, which is stored in the first MAP set.

Exemplarily, when traversing each member variable in the class, if an annotation is added to the member variable, the field name of the member variable and the value of the fourth attribute of the corresponding exit parameter annotation can be used as key and value respectively to form a key. Value pair; if there is no annotation added to the member variable, the field name and field type of the member variable can be used as key and value respectively to form a key-value pair; the key-value pairs corresponding to all member variables in the class form a second MAP set.

For example, based on the example of the exit parameter annotation shown in Figure 5, there are a total of 4 member variables in the data VO class ShopResponseVO, of which 3 member variables are added with annotation information, and by traversing each member variable, the second MAP set contains the following 4 key-value pairs: key="shopList", value="List<ShopInfo>"; key="allFollowed", value="false: not all followed true: all followed"; key="haveFollowed", value=" The number of shops that have been followed"; key = "shopNum", value = "the total number of shops in the pot".

Further, if the class contains a member variable of a preset data type, the information of the exit parameter annotation of the defined class corresponding to the member variable of the preset data type is stored in the first MAP set in a recursive manner. contains nested model information.

Wherein, the preset data type includes at least a generic type, an array and a mapping MAP.

For example, taking a class containing a generic member variable as an example, the above steps S2012-2013 are recursively performed on the generic class used to define the generic member variable, so as to save the export parameter information of the generic class to the in the first MAP set. Further, if the generic class also includes a preset data type, then recursively perform the processing of the above steps S2012-2013 on the definition class used to define the preset data type, so that the export parameter information of the definition class is also Save to the first MAP set.

Step S2014, judging whether the class contains Controller annotations.

Among them, the Controller annotation is the annotation that comes with the spring framework.

If the class contains a Controller annotation, it means that the class is a Controller class, and this class may contain an entry parameter annotation. Step S2015 is continued to parse the entry parameter annotation in the class.

If the class does not contain the Controller annotation, it means that it is impossible to contain the entry parameter annotation in the class, then continue to scan the next class.

Step S2015, judging whether the method in the class contains the entry parameter annotation.

If at least one method in the class contains an entry parameter annotation, the entry parameter annotation is parsed by executing step S2016.

If none of the methods in this class contain entry parameter annotations, continue to scan the next class.

For example, based on the example of the entry parameter annotation shown in Figure 4, it can be judged whether the method contains the entry parameter annotation by judging whether the method in the class has added the entry parameter annotation identifier "@DocReqValue". "@DocReqValue", it can be determined that the method contains the entry parameter annotation; if "@DocReqValue" is not added to the method, it can be determined that the method does not contain the exit parameter annotation. For the example in Fig. 4, the entry parameter annotation "@DocValue" is added to the request function getShopList, and it can be determined that the request function getShopList contains the exit parameter annotation.

Step S2016: If at least one method in the class includes an entry parameter annotation, save the entry parameter annotation information of the at least one method into the first MAP set.

Specifically, if multiple methods in the class contain entry parameter annotations, for each method in the class that contains entry parameter annotations, the value of the first attribute of the entry parameter annotation of the method is used as the key, and the value of the first attribute of the entry parameter annotation of the method is used as the key. The value of the second attribute of the entry parameter annotation is value, which is stored in the first MAP set.

For example, based on the example of the entry parameter annotation shown in Figure 4, the entry parameter annotation "@DocValue" is added to the request function getShopList, and the value of the first attribute of the entry parameter annotation of the method "Get Watchlist Interface" is used as the key, and the The value of the second attribute of the entry parameter annotation of this method is "automatically obtained by the gateway after logging in; must be passed (Note: the unique code of the machine - android is uuid, ios is openudid)" is value, which is stored in the first MAP set.

In this embodiment, the egress parameter annotation and the entry parameter annotation can be parsed through one scan. Through steps S2012-S2013, the egress parameter annotations can be parsed to obtain egress parameter information; through steps S2014-S2016, entry parameter annotations can be parsed to obtain ingress parameter information.

It should be noted that when scanning each class, it is exemplified by parsing the exit parameter annotations in the class first, and then parsing the entry parameter annotations in the class. The entry parameter annotation in the class is parsed, and then the exit parameter annotation is parsed; or the parsing of the entry parameter annotation and the exit parameter annotation can be performed in parallel, which is not specifically limited in this embodiment.

In addition, the parsing process of the entry parameter annotation and the parsing process of the exit parameter annotation can be two independent processes, and one of the processes can be implemented by one scan, and the other process can be implemented by the second scan. There is no specific limitation.

In this embodiment, a unique interface name is uniformly defined by the interface entry parameters and exit parameters. After the parsing is completed, the information of the interface is completely recorded through the unique interface name, so as to obtain all the information required by the interface document.

Step S202: Receive the target interface identifier and the designated operating system type sent by the front end, and the designated operating system type is input by the user through the front end page.

The target interface refers to at least one interface designated by the user to generate the data model file, and the designated operation type refers to the operating system type specified by the user to generate the data model file. The specified operating system type can be IOS or Android.

In this embodiment, the user can input the name of the data model file to be generated and the operating system type to be applied on the interactive interface displayed on the front end, and submit it to the back-end server, where the user names the data model file and specifies The operating system type of the data model file.

Exemplarily, the user selects the interface for which the corresponding data model file is to be generated as the target interface through the front-end page, and specifies the operating system type applicable to the data model file to be generated,

Step S203: Automatically generate a data model file of the target interface according to the interface information, the target interface identifier and the designated operating system type, where the data model file corresponds to the designated operating system type.

After the server receives the target interface identifier and the specified operating system type sent by the front end, this step can automatically generate a data model file of the operating system type specified by the user and named by the user, which is more flexible and has a better user experience.

Specifically, by invoking the data model file interface for generating the client provided by the background server, it is judged that the data model file to be generated is iOS or Android, and different shell scripts are called according to different operating system types.

In addition, in this embodiment, if some classes contain member variables of the preset data type, the information of the export parameter annotation of the defined class corresponding to the member variables of the preset data type is saved to the first MAP set in a recursive manner. middle. Then, the first MAP set includes nested model information, that is, the parsed interface information includes nested model information.

In this step, if the interface information includes nested model information, a recursive manner is used to generate a data model file including the nested model according to the interface information.

Exemplarily, in order to generate a data model file containing nested models, multiple model classes need to be generated at both ends of iOS and Android, and corresponding shell scripts are generated by using a recursive parsing method. At the same time, for the iOS platform, the code required to process and parse the nested model is added by default when the shell script is generated.

In this embodiment, multiple nested data models can be parsed in a recursive manner, and a recursive method is used to generate scripting languages suitable for different operating system platforms when the data model files are generated, and the data model files are associated with the code repository to simplify the front end purpose of human development.

Step S204: Receive the address information of the designated code warehouse sent by the front end, where the address information of the designated code warehouse is input by the user through the front end page.

In this embodiment, the user can input the address information of the code warehouse where the generated data model file is stored on the interactive interface displayed on the front end. For example, the specified code repository can be a git repository.

Step S205, submit the data model file of the target interface to the designated code repository.

The server receives the address information of the specified code warehouse sent by the front end, and submits the generated data model file to the specified code warehouse according to the address information of the specified code warehouse, so that the user can easily obtain the data model file.

Step S206, generating an interface document according to the interface information.

In this embodiment, after the interface information is obtained, the interface document can also be generated according to the interface information and according to the preset format of the interface document, so that the automatic generation of the interface document can be completed and the time-consuming of writing the interface document can be reduced.

Optionally, the generated interface document can also be displayed through the front-end interface.

Step S207: Send the interface information to the front end, so as to display the interface information through the front end page.

In this embodiment, after the interface information is obtained, the interface information may also be displayed through the front-end interface, so as to facilitate the user to view the interface information.

Exemplarily, the interface information may be displayed through the front-end interface information display interface. As shown in Figure 7, different interface information can be displayed through the user's selection, and at the same time, the interface information display interface provides an operation area for the user to switch and select different interfaces, and the user specifies the operating system type of the data model file to be generated. operating area.

Optionally, the front-end interface information display interface may be written in javaScript, and the front-end style is implemented by bootstrap.

Optionally, as shown in FIG. 7 , in this embodiment, the code of the interface can also be displayed on the interface information display interface, and the conversion of different languages is supported. For example, conversion of Objective-C and Java code can be supported.

The embodiment of the present application obtains the interface information by parsing the interface annotation information in the program code during the compilation process; automatically generates the data model file according to the interface information, and realizes the automatic generation of the interface information and the data model file. When the interface changes, Only need to change the value in the annotation, recompile to complete the automatic update of interface information and data model file in time, and associate the data model file with the code warehouse. Front-end personnel only need to pull the code, and do not need to care about the generation of the data model file. , which greatly simplifies the man-hours for back-end developers to write interface documents and the workflow for front-end developers to generate data model files, while reducing the communication costs between front-end and back-end developers, and greatly improving efficiency.

FIG. 8 is a schematic structural diagram of a data processing apparatus according to Embodiment 3 of the present application. The data processing apparatus provided by the embodiments of the present application may execute the processing procedures provided by the data processing method embodiments. As shown in FIG. 8 , the data processing apparatus 30 includes: an annotation parsing module 301 and an information processing module 302 .

Specifically, the annotation parsing module 301 is used for parsing the interface annotation information in the program code during the compilation process to obtain the interface information.

The information processing module 302 is configured to automatically generate a data model file according to the interface information.

The apparatus provided in this embodiment of the present application may be specifically used to execute the method embodiment provided in the foregoing embodiment 1, and the specific functions will not be repeated here.

FIG. 9 is a schematic structural diagram of a data processing apparatus according to Embodiment 4 of the present application. On the basis of the third embodiment above, in this embodiment, as shown in FIG. 9 , the data processing apparatus 30 further includes: a sending module 303 . The sending module 303 is used for automatically submitting the data model file to the preset code repository.

In a possible design, the information processing module 302 is also used to:

According to the interface information, the target interface identifier and the specified operating system type, the data model file of the target interface is automatically generated, and the data model file corresponds to the specified operating system type.

In a possible design, as shown in FIG. 9 , the data processing apparatus 30 further includes: a receiving module 304 . The receiving module 304 is used for:

Receive the target interface identifier and the specified operating system type sent by the front-end, and the specified operating system type is input by the user through the front-end page.

In a possible design, the sending module 303 is also used for:

In a possible design, the receiving module 304 is also used to:

Receive the address information of the specified code warehouse sent by the front-end, and the address information of the specified code warehouse is input by the user through the front-end page.

In a possible design, the information processing module 302 is also used to:

Generate interface documentation based on interface information.

In a possible design, the sending module 303 is also used for:

Send the interface information to the frontend to display the interface information through the frontend page.

In a possible design, the interface annotation information includes the entry parameter annotation and exit parameter annotation of the interface; the annotation parsing module 301 is further used for:

Scan each class in the program code, if the class contains exit parameter annotations, save the information of the exit parameter annotations on all member variables in the class to the first MAP set; if the class is a controller class, scan Whether each method in the class contains an entry parameter annotation, if at least one method of the class contains an entry parameter annotation, the information of the entry parameter annotation of the at least one method is stored in the first MAP set.

In a possible design, the entry parameter annotation includes a first attribute and a second attribute, the value of the first attribute is the interface name, and the value of the second attribute is description information of each entry parameter of the interface; the exit parameter annotation includes a third attribute and fourth attribute, the value of the third attribute is the interface name, and the value of the fourth attribute is the description information of each egress parameter, wherein the number of the fourth attribute in the egress parameter annotation of the interface is the same as the number of egress parameters of the interface.

In a possible design, the annotation parsing module 301 is also used to:

If at least one method in the class contains an entry parameter annotation, the value of the first attribute of the entry parameter annotation of each method is used as the key, and the value of the second attribute of the entry parameter annotation of the method is stored in the first attribute. in the MAP set.

In a possible design, the annotation parsing module 301 is also used to:

If the class contains an exit parameter annotation, the field name of each member variable in the class and the value of the fourth attribute of the corresponding exit parameter annotation are used as key and value respectively to form a key-value pair, and the keys corresponding to all member variables in the class The value pair constitutes a second MAP set; the value of the third attribute of the exit parameter annotation is used as the key, and the second MAP set is used as the value, and is stored in the first MAP set.

In a possible design, the annotation parsing module 301 is also used to:

If the class contains a member variable of a preset data type, the information of the exit parameter annotation corresponding to the member variable of the preset data type corresponding to the defined class is saved in the first MAP set, and the first MAP set contains embedded Set of model information.

In a possible design, the information processing module 302 is also used to:

If the interface information includes nested model information, a data model file including the nested model is generated in a recursive manner according to the interface information.

In one possible design, the preset data types include at least generics, arrays, and map MAPs.

The apparatus provided in this embodiment of the present application may be specifically used to execute the method embodiment provided in the foregoing embodiment 2, and the specific functions will not be repeated here.

FIG. 10 is a schematic structural diagram of a data processing device according to Embodiment 5 of the present application. As shown in FIG. 10 , the data processing apparatus 100 includes: a processor 1001 , a memory 1002 , and a computer program stored on the memory 1002 and executable on the processor 1001 .

The data processing method provided by any of the above method embodiments is implemented when the processor 1001 runs the computer program.

The embodiment of the present application obtains the interface information by parsing the interface annotation information in the program code during the compilation process; automatically generates the data model file according to the interface information, and realizes the automatic generation of the interface information and the data model file. When the interface changes, Recompilation can complete the automatic update of interface information and data model files in a timely manner, which improves efficiency and overcomes the fact that the interface documents are not updated in time and are prone to omissions, resulting in the front-end being unable to accurately obtain background data. Causes abnormal technical problems such as inaccessibility of front-end pages and returned data errors.

In addition, an embodiment of the present application further provides a computer-readable storage medium, where a computer program is stored in the computer-readable storage medium, and when the computer program is executed by a processor, the data processing method provided by any of the foregoing method embodiments is implemented.

In the several embodiments provided in this application, it should be understood that the disclosed apparatus and method may be implemented in other manners. For example, the apparatus embodiments described above are only illustrative. For example, the division of units is only a logical function division. In actual implementation, there may be other division methods, for example, multiple units or components may be combined or integrated. to another system, or some features can be ignored, or not implemented. On the other hand, the shown or discussed mutual coupling or direct coupling or communication connection may be through some interfaces, indirect coupling or communication connection of devices or units, and may be in electrical, mechanical or other forms.

Units described as separate components may or may not be physically separated, and components shown as units may or may not be physical units, that is, may be located in one place, or may be distributed to multiple network units. Some or all of the units may be selected according to actual needs to achieve the purpose of the solution in this embodiment.

In addition, each functional unit in each embodiment of the present application may be integrated into one processing unit, or each unit may exist physically alone, or two or more units may be integrated into one unit. The above-mentioned integrated unit may be implemented in the form of hardware, or may be implemented in the form of hardware plus software functional units.

The above-mentioned integrated units implemented in the form of software functional units can be stored in a computer-readable storage medium. The above-mentioned software function unit is stored in a storage medium, and includes several instructions to cause a computer device (which may be a personal computer, a server, or a network device, etc.) or a processor (processor) to execute some steps of the methods in the various embodiments of the present application. . The aforementioned storage medium includes: U disk, mobile hard disk, read-only memory (Read-Only Memory, ROM), random access memory (Random Access Memory, RAM), magnetic disk or optical disk and other media that can store program codes .

Those skilled in the art can clearly understand that, for the convenience and brevity of the description, only the division of the above functional modules is used for illustration. The internal structure is divided into different functional modules to complete all or part of the functions described above. For the specific working process of the apparatus described above, reference may be made to the corresponding process in the foregoing method embodiments, and details are not described herein again.

Other embodiments of the present application will readily occur to those skilled in the art upon consideration of the specification and practice of the invention disclosed herein. This application is intended to cover any variations, uses or adaptations of this application that follow the general principles of this application and include common knowledge or conventional techniques in the technical field not disclosed in this application . The specification and examples are to be regarded as exemplary only, with the true scope and spirit of the application being indicated by the following claims.

It is to be understood that the present application is not limited to the precise structures described above and illustrated in the accompanying drawings and that various modifications and changes may be made without departing from the scope thereof. The scope of the application is limited only by the appended claims.

Claims

A data processing method comprising:

During the compilation process, the interface annotation information in the program code is parsed to obtain the interface information;

A data model file is automatically generated according to the interface information.
The method according to claim 1, after the data model file is automatically generated according to the interface information, further comprising:

The data model file is automatically submitted to the preset code repository.
The method according to claim 1 or 2, wherein the automatically generating a data model file according to the interface information comprises:

According to the interface information, the target interface identifier and the designated operating system type, a data model file of the target interface is automatically generated, and the data model file corresponds to the designated operating system type.
The method according to claim 3, before automatically generating the data model file of the target interface according to the interface information, the target interface identifier and the specified operating system type, further comprising:

The target interface identifier and the specified operating system type sent by the front-end are received, and the specified operating system type is input by the user through the front-end page.
The method according to claim 4, after the data model file of the target interface is automatically generated according to the interface information, the target interface identifier and the specified operating system type, the method further comprises:

Submit the data model file of the target interface to the specified code repository.
The method according to claim 5, before submitting the data model file of the target interface to a designated code repository, further comprising:

The address information of the designated code warehouse sent by the front-end is received, where the address information of the designated code warehouse is input by the user through the front-end page.
The method according to claim 1, wherein in the compiling process, parsing the interface annotation information in the program code to obtain the interface information, further comprising:

An interface document is generated according to the interface information.
The method according to claim 1 or 7, in the compiling process, parsing the interface annotation information in the program code, and after obtaining the interface information, further comprising:

The interface information is sent to the front end to display the interface information through the front end page.
The method according to claim 1, wherein the interface annotation information includes an entry parameter annotation and an exit parameter annotation of the interface;

The interface annotation information in the parsing program code is obtained to obtain interface information, including:

Scan each class in the program code, if any one of the classes contains an exit parameter annotation, then save the information of the exit parameter annotation on all member variables in the class into the first MAP set;

If the class is a Controller class, scan whether each method in the class contains an entry parameter annotation, and if at least one method of the class contains an entry parameter annotation, annotate the entry parameter of the at least one method The information is saved into the first MAP set.
The method according to claim 9, wherein the entry parameter annotation includes a first attribute and a second attribute, the value of the first attribute is an interface name, and the value of the second attribute is description information of each entry parameter of the interface;

The egress parameter annotation includes a third attribute and a fourth attribute, the value of the third attribute is the interface name, and the value of the fourth attribute is the description information of each egress parameter, wherein the number of the fourth attribute in the egress parameter annotation of the interface is the same as all the parameters. The number of egress parameters of the interface described above is the same.
The method according to claim 10, wherein if at least one method of the class includes an entry parameter annotation, saving the entry parameter annotation information of the at least one method into the first MAP set, comprising:

If at least one method in the class contains an entry parameter annotation, the value of the first attribute of the entry parameter annotation of each method is used as the key, and the value of the second attribute of the entry parameter annotation of the method is used as value. , and stored in the first MAP set.
The method according to claim 10, wherein if the class contains an exit parameter annotation, the information of the exit parameter annotation on all member variables in the class is stored in the first MAP set, including:

If the class contains an exit parameter annotation, the field name of any member variable in the class is used as the key, and the value of the fourth attribute of the exit parameter annotation corresponding to the member variable is used as the value to form the member variable Corresponding key-value pairs, the key-value pairs corresponding to all member variables in the class form a second MAP set;

The value of the third attribute of the exit parameter annotation is used as the key, and the second MAP set is used as the value, and saved in the first MAP set.
The method of claim 12, further comprising:

If the class includes a member variable of a preset data type, the information of the exit parameter annotation of the defined class corresponding to the member variable of the preset data type is stored in the first MAP set in a recursive manner, and the The first MAP set contains nested model information.
The method of claim 13, further comprising:

If the interface information includes nested model information, a recursive manner is used to generate a data model file including the nested model according to the interface information.
A data processing device, comprising:

The annotation parsing module is used to parse the interface annotation information in the program code during the compilation process to obtain the interface information;

An information processing module, configured to automatically generate a data model file according to the interface information.
A data processing device comprising:

a processor, a memory, and a computer program stored on the memory and executable on the processor;

Wherein, when the processor runs the computer program, the method according to any one of claims 1 to 14 is implemented.
A computer-readable storage medium having a computer program stored in the computer-readable storage medium, the computer program implementing the method according to any one of claims 1 to 14 when executed by a processor.