A field note method and device, electronic equipment and storage medium

Abstract

The application discloses a field note method and device suitable for the field of financial technology or other related technologies, electronic equipment and a storage medium, and the method comprises the following steps: establishing a connection with a target database and binding with the target database; in response to a field note request, acquiring a data structure of the target database; according to the data structure of the target database, acquiring a field note of a code corresponding to the target database; associating the field note of the code corresponding to the target database with the data structure of the target database to generate a field note of the target database. The application solves the technical problem that the field note of the data table of the database cannot be efficiently and accurately generated and maintained in the prior art.

Description

Technical Field

[0001] This invention relates to the field of data testing technology, specifically to a method, apparatus, electronic device, and storage medium for field annotation. Background Technology

[0002] During testing, it's common to compare data returned by the API with fields in the database tables. Database field comments are particularly important in testing, as the different values ​​they represent are crucial data for testers. For example, in fintech, the different statuses of a consumer loan receipt are represented by different values ​​in a single field. The accuracy of this synchronized information is vital for the testing system and forms the basis for various tests and development processes.

[0003] The main problems currently are: 1. Manual maintenance of field comments in the database. This is costly and relies on human memory to remember the meaning of field values, resulting in poor maintainability; 2. Confirmation of the correctness of field comments requires manual verification between developers. When staff turnover occurs, new developers cannot rely on experience to understand the meaning of different field states and can only determine the values ​​by checking the code logic. This incurs additional time for maintaining field meanings; 3. Manual maintenance by developers may lead to untimely maintenance, resulting in incorrect field meanings. If testers discover discrepancies during testing, additional investigation time is required.

[0004] Due to the existence of the above problems, how to accurately and efficiently generate and maintain the field comments of database tables is an urgent problem to be solved. Summary of the Invention

[0005] The purpose of this invention is to overcome the above-mentioned technical deficiencies and provide a field annotation method, device, electronic device and storage medium applicable to financial technology or other related technical fields, solving the technical problem that existing technologies cannot efficiently and accurately generate and maintain field annotations for database tables.

[0006] To achieve the above-mentioned technical objectives, the present invention adopts the following technical solution:

[0007] In a first aspect, the present invention provides a field annotation method, comprising the following steps:

[0008] Establish a connection to the target database and bind to the target database;

[0009] Respond to the field annotation request and obtain the data structure of the target database;

[0010] Based on the data structure of the target database, obtain the field comments of the code corresponding to the target database;

[0011] The field comments of the code corresponding to the target database are associated with the data structure of the target database to generate the field comments of the target database.

[0012] In some embodiments, the target database is any type of database.

[0013] In some embodiments, the response field memo request, obtaining the data structure of the target database, includes:

[0014] In response to a field annotation request, the system accesses the target database based on the field annotation request and generates a call interface for the data structure of the target database.

[0015] Based on the calling structure of the target database's data structure, the data structure of the target database is obtained; wherein, the granularity of the target database's data structure is fields.

[0016] In some embodiments, obtaining field comments for the code corresponding to the target database based on the data structure of the target database includes:

[0017] Based on the data structure of the target database, obtain the class of the data structure of the target database;

[0018] Based on the data structure class of the target database, find the code corresponding to the data structure of the target database;

[0019] Based on the code corresponding to the data structure of the target database, obtain the field comments of the code corresponding to the target database.

[0020] In some embodiments, associating the field notes of the code corresponding to the target database with the data structure of the target database to generate the field notes of the target database includes:

[0021] The field comments of the code corresponding to the target database are matched with the fields of the data structure of the target database to generate field comments for each field of the data structure of the target database.

[0022] In some embodiments, the field annotation method further includes:

[0023] If the target database already contains field comments, a prompt message will be issued asking whether to overwrite the existing field comments.

[0024] In some embodiments, the notification message is sent via a pop-up window.

[0025] Secondly, the present invention also provides a field annotation device, comprising:

[0026] The binding module is used to establish a connection with the target database and bind to the target database;

[0027] The response module is used to respond to field annotation requests and obtain the data structure of the target database;

[0028] The code field annotation acquisition module is used to acquire field annotations of the code corresponding to the target database based on the data structure of the target database.

[0029] The database field annotation module is used to associate the field annotations of the code corresponding to the target database with the data structure of the target database to generate the field annotations of the target database.

[0030] Thirdly, the present invention also provides an electronic device, comprising: a processor and a memory;

[0031] The memory stores computer programs that can be executed by the processor;

[0032] When the processor executes the computer program, it implements the steps in the field annotation method described above.

[0033] Fourthly, the present invention also provides a computer-readable storage medium storing one or more programs that can be executed by one or more processors to implement the steps in the field annotation method described above.

[0034] Compared with existing technologies, the field annotation method, apparatus, electronic device, and storage medium provided by this invention first establish a connection with and bind to a target database; then, responding to a field annotation request, obtain the data structure of the target database; next, based on the data structure of the target database, obtain the field annotations of the code corresponding to the target database; finally, associate the field annotations of the code corresponding to the target database with the data structure of the target database to generate the field annotations of the target database. This allows for the connection between database tables and system code, matching the classes implemented in the code annotations with the data fields in the database, automatically synchronizing the code annotations to the database, improving field annotation efficiency, and reducing the cost of manually maintaining field annotations in the database; it also reduces the time spent manually querying code to obtain field attributes. Furthermore, the consistency between code annotations and the database avoids potential inconsistencies caused by manual maintenance, and field annotations can be automatically modified after code changes, avoiding manual maintenance. Additionally, it avoids test errors caused by untimely maintenance or referencing incorrect field annotations. Using automated field annotation generation tools reduces the probability of defects caused by unclear or incorrect field meanings, improving the accuracy of field annotations. Attached Figure Description

[0035] Figure 1 This is a flowchart of an embodiment of the field annotation method provided by the present invention;

[0036] Figure 2 This is a flowchart of step S200 in the field annotation method provided by the present invention;

[0037] Figure 3 This is a flowchart of step S300 in the field annotation method provided by the present invention;

[0038] Figure 4 This is a schematic diagram of the functional modules of the field annotation device provided by the present invention;

[0039] Figure 5 This is a schematic diagram of the hardware structure of the electronic device provided by the present invention. Detailed Implementation

[0040] To make the objectives, technical solutions, and advantages of this invention clearer, the invention will be further described in detail below with reference to the accompanying drawings and embodiments. It should be understood that the specific embodiments described herein are merely illustrative and not intended to limit the invention.

[0041] During testing, it's common to compare data returned by an API with fields in a database table. Database field annotations are particularly important in testing, as the different values ​​they represent are crucial for testers. For example, in the fintech field, the different states of a consumer loan receipt are represented by different values ​​in a single field. The accuracy of this synchronized information is vital for the testing system and forms the basis for various tests and development processes.

[0042] Please see Figure 1 , Figure 1 This is a flowchart illustrating a field annotation method provided by an embodiment of the present invention. The field annotation method of the present invention can be used for field annotation in databases in the financial field to efficiently and accurately perform field annotation. The field annotation method of the present invention can be executed by an electronic device capable of receiving or sending data, and can be various electronic devices with a display screen and supporting web browsing, including but not limited to smartphones, tablets, laptops, and desktop servers. Figure 1 As shown, the method specifically includes the following steps S100 to S400.

[0043] S100. Establish a connection with the target database and bind to the target database.

[0044] In this embodiment, to annotate fields in the target database and establish a connection with it, the field annotation device is bound to the target database. The field annotation device can support access to different types of databases using a general interface. Specifically, the field annotation device can be placed within the target system's code package, and the corresponding database (i.e., the target database) can be configured within the field annotation device, thus achieving the binding with the target database.

[0045] S200, respond to the field remarks request and obtain the data structure of the target database.

[0046] In this embodiment, after receiving a field annotation request, the field annotation device accesses the target database. That is, the parameter passed by the field annotation device is the target database bound above, and the corresponding result is the data structure of the target database. By obtaining the data structure of the target database, the fields of the target database can be obtained, and then the fields can be annotated.

[0047] S300. Based on the data structure of the target database, obtain the field comments of the code corresponding to the target database.

[0048] In this embodiment, after obtaining the data structure of the target database, the class of the data structure of the target database is referenced, and the comments on the code level are found through the class of the data structure. Therefore, the comments in the code and the fields of the target database can be linked. This correspondence is the basis for the field comments generated by the field commenting device.

[0049] S400. Associate the field notes of the code corresponding to the target database with the data structure of the target database to generate the field notes of the target database.

[0050] In this embodiment, when field notes need to be generated, the field note tool retrieves the code @startCreateNote and @endCreateNote, retrieves the referenced field (the referenced field of the class), and the corresponding note (starting with the note symbol in different languages). Thus, the field note device can establish a connection and automatically add notes to the fields of the database table.

[0051] This invention provides a field annotation method, apparatus, electronic device, and storage medium. First, a connection is established with a target database, and the connection is bound to the target database. Then, in response to a field annotation request, the data structure of the target database is obtained. Next, based on the data structure of the target database, field annotations for the corresponding code in the target database are obtained. Finally, the field annotations for the code in the target database are associated with the data structure of the target database to generate field annotations for the target database. This allows for the connection between database tables and system code, matching the classes implemented in the code annotations with the data fields in the database, automatically synchronizing the code annotations to the database, improving field annotation efficiency, and reducing the cost of manually maintaining field annotations in the database. It also reduces the time spent manually querying code to obtain field attributes. Furthermore, the consistency between code annotations and the database avoids potential inconsistencies caused by manual maintenance. When the code is modified, field annotations can be automatically modified, avoiding manual maintenance. Additionally, it avoids test errors caused by untimely maintenance or referencing incorrect field annotations. Using automated field annotation generation tools reduces the probability of defects caused by unclear or incorrect field meanings, improving the accuracy of field annotations.

[0052] In some embodiments, the target database is any type of database.

[0053] In this embodiment, the field annotation device can support access to different types of databases through a public interface, such as mainstream databases like Oracle and MySQL, thereby improving the versatility of the field annotation device.

[0054] In some embodiments, please refer to Figure 2 Step S200 specifically includes:

[0055] S210. Respond to the field annotation request, access the target database according to the field annotation request, and generate a call interface for the data structure of the target database;

[0056] S220. Based on the calling structure of the data structure of the target database, obtain the data structure of the target database; wherein, the granularity of the data structure of the target database is fields.

[0057] In this embodiment, the field annotation device requests system code and code related to data fields. The response received by the field annotation device is the database data structure, with granularity at the field level. The field annotation device can support access to different types of databases through a public interface, such as mainstream databases like Oracle and MySQL, thereby improving the tool's versatility. The field annotation device can generate an API for the database data structure; accessing this API will retrieve the data structure of the database tables. The data structure is similar to the structure: "table_name": "list of field names", for example, {"LoanTable": "{LoanStatus,applyID,applyName,applyTime…}", "{ContractTable}", "{contactType,applyName…}"}.

[0058] In some embodiments, please refer to Figure 3 Step S300 specifically includes:

[0059] S310. Obtain the class of the data structure of the target database according to the data structure of the target database;

[0060] S320. Based on the class of the data structure of the target database, find the code corresponding to the data structure of the target database;

[0061] S330. Based on the code corresponding to the data structure of the target database, obtain the field comments of the code corresponding to the target database.

[0062] In this embodiment, when developers add field comments to the code, they reference the tool's class for accessing the database table structure. At the code level, when adding comments, the tool's class is automatically loaded, and the corresponding database, table, and field are selected. This establishes a link between the code comments and the database fields, forming the basis for the tool's automatic generation of field comments.

[0063] Therefore, once the data structure of the target database is obtained, developers can create field notes for the target database according to the requirements of the field note device, using @startCreateNote and @endCreateNote.

[0064] For example, a code block:

[0065] @importtool.DBLoan.LoanTable.LoanStatus

[0066] PublichandleLoan()

[0067] A reference class that points to a specific field.

[0068] @startCreateNote=tool.DBLoan.LoanTable.LoanStatus

[0069] --Note. LoanStatus=1 represents meaning 1...; LoanStatus=2 represents meaning 2...; LoanStatus=3 represents meaning 3...

[0070] @endCreateNote.

[0071] The above dialog can link the code to be commented and the data field, making it easier to comment on the target database field later.

[0072] In some embodiments, step S400 specifically includes:

[0073] The field comments of the code corresponding to the target database are matched with the fields of the data structure of the target database to generate field comments for each field of the data structure of the target database.

[0074] In this embodiment, when adding field comments in the code, developers reference the class of the field comment device to access the database table structure. At the code level, the class of the field comment device is automatically loaded when adding comments, and the corresponding database, table, and field are selected. When the field comment device is run, the system matches the classes implemented in the code comments with the data fields in the database, automatically synchronizing the code comments to the database, thus enabling efficient and accurate implementation of database field comments.

[0075] In some embodiments, the field annotation method further includes:

[0076] If the target database already contains field comments, a prompt message will be issued asking whether to overwrite the existing field comments.

[0077] In this embodiment, to avoid a field being commented repeatedly, when a field comment exists in the target database, a prompt will be made asking whether to overwrite the previous comment. If the developer chooses to overwrite, the comment of the field in the database table will be modified, thereby ensuring the uniqueness and accuracy of the field comment.

[0078] In some embodiments, the notification message is sent as a pop-up window. A pop-up window provides a direct and prominent notification to staff, enabling them to respond quickly.

[0079] The technical solution provided by this invention first establishes a connection with a target database and binds to it; then, responding to a field annotation request, it obtains the data structure of the target database; next, based on the data structure of the target database, it obtains the field annotations of the code corresponding to the target database; finally, it associates the field annotations of the code corresponding to the target database with the data structure of the target database to generate the field annotations of the target database. This allows for the connection between the database tables and the system code, matching the classes implemented in the code annotations with the data fields in the database, automatically synchronizing the code annotations to the database, improving field annotation efficiency, and reducing the cost of manually maintaining field annotations in the database; it also reduces the time spent manually querying code to obtain field attributes. Furthermore, the code annotations are consistent with the database, avoiding potential inconsistencies caused by manual maintenance. When the code is modified, the field annotations can be automatically modified, avoiding manual maintenance. Additionally, it avoids test errors caused by untimely maintenance or referencing incorrect field annotations. Using an automated field annotation generation tool reduces the probability of defects caused by unclear or incorrect field meanings, improving the accuracy of field annotations.

[0080] Another embodiment of the present invention provides a field annotation device; please refer to [link / reference]. Figure 4 The field annotation device includes a binding module 11, a response module 12, a code field annotation acquisition module 13, and a database field annotation module 14.

[0081] The binding module 11 is used to establish a connection with the target database and bind to the target database.

[0082] The response module 12 is used to respond to field annotation requests and obtain the data structure of the target database.

[0083] The code field annotation acquisition module 13 is used to acquire field annotations for the code corresponding to the target database based on the data structure of the target database.

[0084] The database field annotation module 14 is used to associate the field annotations of the code corresponding to the target database with the data structure of the target database to generate the field annotations of the target database.

[0085] In this embodiment, a connection to the target database is first established and the system is bound to the target database. Then, in response to a field annotation request, the data structure of the target database is obtained. Next, based on the data structure of the target database, the field annotations for the corresponding code in the target database are obtained. Finally, the field annotations for the code in the target database are associated with the data structure of the target database to generate the field annotations for the target database. This allows the database tables and system code to be linked, matching the classes implemented in the code annotations with the data fields in the database, automatically synchronizing the code annotations to the database, improving field annotation efficiency, and reducing the cost of manually maintaining field annotations in the database. It also reduces the time spent manually querying code to obtain field attributes. Furthermore, the consistency between code annotations and the database avoids potential inconsistencies caused by manual maintenance. When the code is modified, field annotations can be automatically modified, avoiding manual maintenance. Additionally, it avoids test errors caused by untimely maintenance or referencing incorrect field annotations. Using an automated field annotation generation tool reduces the probability of defects caused by unclear or incorrect field meanings, improving the accuracy of field annotations.

[0086] It should be noted that the module referred to in this invention refers to a series of computer program instruction segments that can perform specific functions. It is more suitable than a program for describing the execution process of field notes. For the specific implementation of each module, please refer to the corresponding method embodiments above, which will not be repeated here.

[0087] In some embodiments, the target database is any type of database.

[0088] In some embodiments, the response module 12 is specifically used for:

[0089] In response to a field annotation request, the system accesses the target database based on the field annotation request and generates a call interface for the data structure of the target database.

[0090] Based on the calling structure of the target database's data structure, the data structure of the target database is obtained; wherein, the granularity of the target database's data structure is fields.

[0091] In some embodiments, the code field annotation acquisition module 13 is specifically used for:

[0092] Based on the data structure of the target database, obtain the class of the data structure of the target database;

[0093] Based on the data structure class of the target database, find the code corresponding to the data structure of the target database;

[0094] Based on the code corresponding to the data structure of the target database, obtain the field comments of the code corresponding to the target database.

[0095] In some embodiments, the database field annotation module 14 is specifically used for:

[0096] The field comments of the code corresponding to the target database are matched with the fields of the data structure of the target database to generate field comments for each field of the data structure of the target database.

[0097] In some embodiments, the field annotation device further includes a prompting module, which is used to issue a prompting message on whether to overwrite the existing field annotation when the target database already has a field annotation.

[0098] In some embodiments, the notification message is sent via a pop-up window.

[0099] Another embodiment of the present invention provides an electronic device, such as... Figure 5 As shown, the electronic device 10 includes:

[0100] One or more processors 110 and memory 120, Figure 5 The following description uses a processor 110 as an example. The processor 110 and the memory 120 can be connected via a bus or other means. Figure 5 Taking the example of a connection between China and Israel via a bus.

[0101] Processor 110 is used to perform various control logics of electronic device 10. It can be a general-purpose processor, digital signal processor (DSP), application-specific integrated circuit (ASIC), field-programmable gate array (FPGA), microcontroller, ARM (AcornRISC), or other programmable logic device, discrete gate or transistor logic, discrete hardware components, or any combination of these components. Furthermore, processor 110 can also be any conventional processor, microprocessor, or state machine. Processor 110 can also be implemented as a combination of computing devices, such as a combination of DSP and microprocessor, multiple microprocessors, one or more microprocessors combined with DSP and / or any other such configuration.

[0102] The memory 120, as a non-volatile computer-readable storage medium, can be used to store non-volatile software programs, non-volatile computer-executable programs, and modules, such as the program instructions corresponding to the field annotation method in the embodiments of the present invention. The processor 110 executes various functional applications and data processing of the electronic device 10 by running the non-volatile software programs, instructions, and units stored in the memory 120, thereby implementing the field annotation method in the above method embodiments.

[0103] The memory 120 may include a program storage area and a data storage area. The program storage area may store applications required for the operating platform and at least one function; the data storage area may store data created based on the use of the electronic device 10. Furthermore, the memory 120 may include high-speed random access memory and may also include non-volatile memory, such as at least one disk storage device, flash memory device, or other non-volatile solid-state storage device. In some embodiments, the memory 120 may optionally include memory remotely located relative to the processor 110, and these remote memories may be connected to the electronic device 10 via a network. Examples of such networks include, but are not limited to, the Internet, corporate intranets, local area networks, mobile communication networks, and combinations thereof.

[0104] One or more units are stored in memory 120. When executed by one or more processors 110, they perform the field annotation method in any of the above method embodiments, for example, the method described above. Figure 1 The method steps S100 to S400.

[0105] Another embodiment of the present invention provides a computer-readable storage medium storing computer-executable instructions that are executed by one or more processors, for example, to perform the above-described instructions. Figure 1 The method steps S100 to S400.

[0106] As an example, computer-readable storage media can include read-only memory (ROM), programmable ROM (PROM), electrically programmable ROM (EPROM), electrically erasable ROM (EEPROM), or flash memory. Volatile memory can include random access memory (RAM) as external cache memory. By way of illustration and not limitation, RAM can be obtained in many forms such as synchronous RAM (SRAM), dynamic RAM (DRAM), synchronous DRAM (SDRAM), dual data rate SDRAM (DDRSDRAM), enhanced SDRAM (ESDRAM), Synchlink DRAM (SLDRAM), and direct Rambus RAM (DRRAM). The memory components or memories disclosed in the operating environment described herein are intended to include one or more of these and / or any other suitable types of memory.

[0107] In summary, the field annotation method, apparatus, electronic device, and storage medium provided by this invention first establish a connection with and bind to a target database; then, responding to a field annotation request, they obtain the data structure of the target database; next, based on the data structure of the target database, they obtain the field annotations for the code corresponding to the target database; finally, they associate the field annotations for the code corresponding to the target database with the data structure of the target database to generate the field annotations for the target database. This allows for the connection between database tables and system code, matching the classes implemented in the code annotations with the data fields in the database, automatically synchronizing the code annotations to the database, improving field annotation efficiency, and reducing the cost of manually maintaining field annotations in the database; it also reduces the time spent manually querying code to obtain field attributes. Furthermore, the consistency between code annotations and the database avoids potential inconsistencies caused by manual maintenance, and field annotations can be automatically modified after code changes, avoiding manual maintenance. Additionally, it avoids test errors caused by untimely maintenance or referencing incorrect field annotations. Using automated field annotation generation tools reduces the probability of defects caused by unclear or incorrect field meanings, improving the accuracy of field annotations.

[0108] The specific embodiments of the present invention described above do not constitute a limitation on the scope of protection of the present invention. Any other corresponding changes and modifications made in accordance with the technical concept of the present invention should be included within the scope of protection of the claims of the present invention.

Claims

1. A method for adding field comments, characterized in that, Includes the following steps: Establish a connection to the target database and bind to the target database; Respond to the field annotation request and obtain the data structure of the target database; Based on the data structure of the target database, obtain the field comments of the code corresponding to the target database; Associate the field comments of the code corresponding to the target database with the data structure of the target database to generate the field comments of the target database; The step of obtaining field comments for the code corresponding to the target database based on the data structure of the target database includes: Based on the data structure of the target database, obtain the class of the data structure of the target database; Based on the data structure class of the target database, find the code corresponding to the data structure of the target database; Based on the code corresponding to the data structure of the target database, obtain the field comments of the code corresponding to the target database; When adding field comments in the code, the tool references the class that accesses the database table structure. At the code level, the tool's class is automatically loaded when adding comments, allowing you to select the corresponding database, table, and field.

2. The field annotation method according to claim 1, characterized in that, The target database can be any type of database.

3. The field annotation method according to claim 1, characterized in that, The response field memo request obtains the data structure of the target database, including: In response to a field annotation request, the system accesses the target database based on the field annotation request and generates a call interface for the data structure of the target database. Based on the calling structure of the target database's data structure, the data structure of the target database is obtained; wherein, the granularity of the target database's data structure is fields.

4. The field annotation method according to claim 1, characterized in that, The step of associating the field comments of the code corresponding to the target database with the data structure of the target database to generate the field comments of the target database includes: The field comments of the code corresponding to the target database are matched with the fields of the data structure of the target database to generate field comments for each field of the data structure of the target database.

5. The field annotation method according to claim 1, characterized in that, Also includes: If the target database already contains field comments, a prompt message will be issued asking whether to overwrite the existing field comments.

6. The field annotation method according to claim 5, characterized in that, The notification message is sent via a pop-up window.

7. A field annotation device, characterized in that, include: The binding module is used to establish a connection with the target database and bind to the target database; The response module is used to respond to field annotation requests and obtain the data structure of the target database; The code field annotation acquisition module is used to acquire field annotations of the code corresponding to the target database based on the data structure of the target database. The database field annotation module is used to associate the field annotations of the code corresponding to the target database with the data structure of the target database to generate the field annotations of the target database. The code field annotation acquisition module is specifically used for: obtaining the class of the data structure of the target database according to the data structure of the target database; and finding the code corresponding to the data structure of the target database based on the class of the data structure of the target database. Based on the code corresponding to the data structure of the target database, obtain the field comments of the code corresponding to the target database; When adding field comments in the code, the tool references the class that accesses the database table structure. At the code level, the tool's class is automatically loaded when adding comments, allowing you to select the corresponding database, table, and field.

8. An electronic device, characterized in that, include: Processor and memory; The memory stores computer programs that can be executed by the processor; When the processor executes the computer program, it implements the steps in the field annotation method as described in any one of claims 1-6.

9. A computer-readable storage medium, characterized in that, The computer-readable storage medium stores one or more programs, which can be executed by one or more processors to implement the steps in the field annotation method as described in any one of claims 1-6.

Images