CN116303759A - Entity object information synchronization method, equipment and storage medium - Google Patents

Abstract

The invention discloses a method for synchronizing entity object information, which comprises the following steps: an original model is defined, which is a field/variable type including a base table, a page query, and a business meaning. An enhancement model is defined, which is the field/variable that needs to be added. Acquiring field/variable definition grammar tree nodes of the original model, scanning annotation of the enhancement model by an annotation processor, modifying the field/variable definition grammar tree nodes of the original model according to the attribute in the annotation of the enhancement model, and adding the modified field/variable definition grammar tree nodes into class definition grammar tree nodes of the enhancement model. The invention can solve the problem of field repetition of entity model, and when the field changes due to the change of business, other entity objects can synchronize the change of the original model field during compiling. The repeated codes and inconsistent fields can be reduced to a great extent, and meanwhile, the definition of the codes and the maintainability and expandability of the items can be improved.

Description

Entity object information synchronization method, equipment and storage medium

Technical Field

The present invention relates to the field of computer development technologies, and in particular, to a method, an apparatus, and a storage medium for synchronizing entity object information.

Background

With the increasing level of programming industrialization, various programming architectures (such as MVC, MVP, DDD, etc.) are layered, and when Java projects are developed, when the code is layered, the POJO has physical objects such as VO, BO, PO, DO, DTO, DP. There are two general types of conventional development processes: the fields under the corresponding entity object PO of the table are defined first, and then the field codes are copied into the entity object VO, BO, DTO and the like. By defining the base entity object, other entity objects inherit the base entity object, but because of the limitations of Java single inheritance, there still exists a duplicate field definition.

These entity objects have a large number of repeated fields to some extent, and when a service is changed to cause fields to be added, modified and deleted, multiple entity objects need to be modified synchronously. Otherwise, the field types are inconsistent or the field names are inconsistent, which is particularly prominent in the continuous change of the requirements. If consistency of model data cannot be maintained, dirty data appears in use, the Bug is usually hidden and difficult to check.

Currently, there is no perfect technical solution to the above problems. For example, mapSgluct starts from data and can solve the problem that when two objects have field inconsistencies, the data is converted by specifying a source model field and a target model field. But still cannot solve the problems of field repetition of the entity model itself, possible inconsistency of the fields, and the like.

Disclosure of Invention

The technical aim of the invention is to provide a method, equipment and a storage medium for synchronizing entity object information, so as to solve the technical problem that a large number of repeatedly defined fields exist in an entity object.

In order to solve the problems, the technical scheme of the invention is as follows:

a method for synchronizing entity object information comprises the following steps:

defining an original model, wherein the original model comprises a basic table, paging inquiry and a field/variable type with business meaning;

defining an enhancement model, wherein the enhancement model is a field/variable needing to be added;

acquiring field/variable definition grammar tree nodes of the original model, scanning annotation of the enhancement model by an annotation processor, modifying the field/variable definition grammar tree nodes of the original model according to the attribute in the annotation of the enhancement model, and adding the modified field/variable definition grammar tree nodes into class definition grammar tree nodes of the enhancement model.

Specifically, the base table field/variable types include creation user, update user, creation time, and update time; paging query field/variable types include page number, page size, and fuzzy search key; the field/variable types with business meaning include name, unique key, code and logical delete flags.

Preferably, three annotations, respectively @ Mode l, @ Mode l F i e l d and @ enhancement Mode l, are predefined before using the annotation processor;

when an original model is defined, annotating on the class of the original model by using @ Mode l, and labeling on the field of the original model by using @ Mode l F i e d;

when the enhancement model is defined, annotating the class of the enhancement model by using @ enhancement mode l; if the field name or table field name is needed in the self field of the enhancement model, the self field of the enhancement model is annotated by @ Mode l F i e l d.

Wherein, defining the enhancement model specifically comprises the following steps: defining field/variable types of the copy part original model; defining a field of the ignored part of the original model; defining a swagger annotation of whether to copy a field of the original model; JSR303 notes defining whether or not the fields of the original model are copied; the field notes defining the original model of the duplicated part are not duplicated.

Specifically, the annotator processor, when executing, comprises the following steps of

Scanning a TypeE l element list with @ EnforceMode annotation, traversing the TypeE l element list, and sequentially processing the type annotation class with @ EnforceMode annotation;

based on the from attribute under the @ enhancement Mode l, obtaining a typeE l element of the original model, and obtaining a Var i ab l eE l ement list of the original model field from the typeE l element; filtering the ignored fields according to i gnoreF i e l ds attribute under @ enhancement Mode l; judging whether to ignore the swagger related annotation according to the enab l eSwagger attribute under the @ enhancement mode l; judging whether to ignore the JSR303 annotation according to the enab l eJSR attribute under @ enhancement mode l; ignoring part of the specified notes according to the d i sab l eAnnotat i on attribute under @ enhancement mode l; and generating a field name static variable and a table field name static variable according to the field definition @ Mode l F i e l d annotation.

If the modified field/variable definition grammar tree node is added into the class definition grammar tree node of the enhancement model, a field with the same name exists between the original model and the enhancement model, and if the enhancement model has the same field name, the field of the enhancement model is directly used; if the enhancement model does not have the same field name, an error is compiled, and the definition of the field is redundant for the enhancement model.

Further preferably, the method for synchronizing entity object information by adopting I nte l l i J I DEA external plug-in is supported, and the steps are as follows: acquiring an original model through a from attribute; acquiring a field with @ Mode l F i e l d in an original model; adding an original model field with @ Mode l F i e l d to the enhancement model; a field name static variable and a table field name static variable are added.

An electronic device comprising a processor and a memory having stored thereon computer instructions executable on the processor for invoking the computer instructions in the memory to perform a physical object information synchronization method as described above.

A storage medium, where the storage medium is configured to store computer instructions, where the computer instructions, when executed, control a device on which the storage medium resides to perform a method for synchronizing physical object information as described above.

By adopting the technical scheme, the invention has the following advantages and positive effects compared with the prior art:

the invention can solve the problem that the field of the entity model is repeated, and when the field is changed due to the change of the service, the developer only needs to concentrate on the original model without concern about other entity objects, and the other entity objects can synchronize the field change of the original model during compiling, thereby realizing the quick copying of the field of the original model into the enhancement model. The repeated codes and inconsistent fields can be reduced to a great extent, and meanwhile, the definition of the codes and the maintainability and expandability of the items can be improved. In addition, the method is applicable to all Java projects developed by IntelliJ IDE, is simple to use and can be used by adding a few notes.

Drawings

Various other advantages and benefits will become apparent to those of ordinary skill in the art upon reading the following detailed description of the preferred embodiments. The drawings are only for purposes of illustrating the preferred embodiments and are not to be construed as limiting the invention.

FIG. 1 is a flow chart of a method for synchronizing entity object information according to the present invention;

FIG. 2 is a flow chart of a definition model of the present invention;

FIG. 3 is a flow diagram of an annotation processor implementation of the present invention;

FIG. 4 is a flow chart of a plug-in implementation of the present invention;

FIG. 5 is a schematic diagram of a business model of the present invention;

fig. 6 is a schematic diagram of another business model of the present invention.

Detailed Description

In order to more clearly illustrate the embodiments of the present invention or the technical solutions in the prior art, the following description will explain the specific embodiments of the present invention with reference to the accompanying drawings. It is evident that the drawings in the following description are only examples of the invention, from which other drawings and other embodiments can be obtained by a person skilled in the art without inventive effort.

For the sake of simplicity of the drawing, the parts relevant to the present invention are shown only schematically in the figures, which do not represent the actual structure thereof as a product. Additionally, in order to simplify the drawing for ease of understanding, components having the same structure or function in some of the drawings are shown schematically with only one of them, or only one of them is labeled. Herein, "a" means not only "only this one" but also "more than one" case.

The following describes in further detail a method, apparatus and storage medium for synchronizing entity object information according to the present invention with reference to the accompanying drawings and specific embodiments. Advantages and features of the invention will become more apparent from the following description and from the claims.

Examples

Referring to fig. 1 to 5, the present embodiment provides a method for synchronizing entity object information, so that an enhanced model can automatically copy fields of an original model. When the original model field changes, the changes can be synchronized without modifying the enhancement model. The method comprises the following steps:

first, referring to fig. 1 and 2, an original model needs to be defined, when the original model is defined, annotation is performed on the class of the original model by @ Mode l, and annotation is performed on the field of the original model by @ Mode l F i e l d. After addition of @ Mode l F i e l d, when the enhancement model depends on the original model, the field name and table field name static variables are generated in addition to copying the field. The original model is a defined basic class, which is itself a POJO, whose fields can be replicated by the enhancement model. Specifically, the fields within the original model may be some underlying table field type, including but not limited to: i d, createoser, updateoser, createDate, updateDate, etc. Page no (page number), page size (page size), search key (fuzzy search key), etc. at the time of paging the query data may also be contained. Meanwhile, some basic types with business meanings are also possible, including but not limited to: name, key (unique key), code, de l eteF l ag (logical delete flag), etc. In this embodiment, the original model may be any POJO type, and may be defined as the original model as long as the developer considers that the presence attribute can be multiplexed by other POJOs.

Next, referring to fig. 1 and 2, an enhancement model is defined, which is a field/variable that needs to be added, and is also a POJO, but the Abstract Syntax Tree (AST) can be modified by an Annotation Processor (APT) tool, and the field defined by the original model is copied into the enhancement model, while the original field of the enhancement model is not affected by compiling. When the enhancement model is defined, annotating the class of the enhancement model by using @ enhancement mode l; if the field name or table field name is needed in the self field of the enhancement model, the self field of the enhancement model is annotated by @ Mode l F i e l d.

The method specifically comprises the following steps: defining field/variable types of the copy part original model; defining a field of the ignored part of the original model; defining a swagger annotation of whether to copy a field of the original model; JSR303 notes defining whether or not the fields of the original model are copied; the field notes defining the original model of the duplicated part are not duplicated.

The @ Enhance Mode l attribute interpretation is shown in Table 1

TABLE 1

Referring to fig. 1 and 3, when an item is compiled, an annotation processor APT scans annotations of an enhancement model in a code, according to attributes in the annotations of the enhancement model, first obtains field/variable definition syntax tree nodes of an original model, then modifies the field/variable definition syntax tree nodes of the original model according to definitions of the annotation attributes, and finally adds the modified syntax tree nodes to class definition syntax tree nodes of the enhancement model. The newly added field after APT processing supports Lombok, mapStruct and other notes, for example, after the @ Getter and @ Setter notes of Lombrook are added, the newly added field also generates corresponding size ()' and size () methods, mapSstruct is the same, and after the @ map notes are added, the newly added field conversion is also generated during object data conversion.

The original model and the enhancement model can come from different modules as long as the enhancement model can be dependent through maven, if a homonym field exists between the original model and the enhancement model in the process of adding the modified field/variable definition grammar tree node into the class definition grammar tree node of the enhancement model, the field of the enhancement model is directly used without copying the field from the original model if the enhancement model has the same field name. If the enhancement model does not have the same field name, but the multiple original models that rely have the same field name, then an error is compiled and the user can redundancy the definition of the field for the enhancement model.

In particular, referring to fig. 3, apt may be used to scan, compile and process annotations at compile time. The detailed steps are as follows: scanning a TypeE l element list with @ EnforceMode annotation, traversing the TypeE l element list, and sequentially processing the type annotation class with @ EnforceMode annotation; based on the from attribute under the @ enhancement Mode l, obtaining a typeE l element of the original model, and obtaining a Var i ab l eE l ement list of the original model field from the typeE l element; filtering the ignored fields according to the i gniorefi e l ds attribute under @ enhancement Mode l; judging whether to ignore the swagger related annotation according to the enab l eSwagger attribute under the @ enhancement mode l; judging whether to ignore the JSR303 annotation according to the enab l eJSR attribute under @ enhancement mode l; ignoring part of the specified notes according to the d i sab l eAnnotat ion attribute under @ enhancement mode l; and generating a field name static variable and a table field name static variable according to the field definition @ Mode l Fie l d annotation.

Preferably, referring to FIG. 4, because APT performs scanning, compiling and processing Java annotations during compilation, annotations such as @ Mode l, @ Mode l F iel d, @ enhancement Model, etc., cannot be recognized and processed when code is written using Intel l iJ IDEA. In order to support normal development of a developer at I nte l l i J IDEA, the patent provides a plug-in and issues the plug-in to the plug-in market, and the developer only needs to download and install the plug-in to I nte l l i J I DEA of the developer. When the plug-in is installed I nte l l i J IDEA, the processing logic of the plug-in is as follows: acquiring an original model through a from attribute; acquiring a field with @ Mode l F ie l d in an original model; adding an original model field with @ Mode l Fie l d to the enhancement model; a field name static variable and a table field name static variable are added. Meanwhile, to support the developer seeing the corresponding POJO field and variable at structure Too l wi ndow of I nte l l i J I DEA, we implement the StructureVi ewExtensi on interface of I nte l l i JI DEA, with processing logic consistent with the plug-in processing logic described above.

Referring to fig. 5 and 6, a practical application of the present embodiment will be illustrated, for example, in the e-commerce industry, parameters need to send multiple services such as goods, orders, instances, etc. during use, so there are a large number of repeated parameters, and there are also a large number of operations of parameter assignment because entity object conversion is needed between different fields. As shown in fig. 5, the detailed description of the commodity and the like are separately stored, so as to improve the inquiry performance, and in such a scenario, the commodity details need to include the fields of the commodity basic information and the commodity extension information. As shown in fig. 6, when querying data, paging basic information may be required in addition to fields derived from commodity basic information and commodity extension information, and thus, fields supporting an enhancement model of the present embodiment may be derived from a plurality of original models.

First, the original model is defined, which commodity fields can be used as original model field information is determined:

1. commodity basic information: the commodity exists commodity id (itemI d), commodity title (t it l e), and commodity price (pr ice) information, and these basic information may exist on the commodity surface and inside.

2. Merchandise expansion information: to improve query performance, some large fields such as commodity descriptions are stored separately, and this information may be stored in a commodity extension table.

Thus, a developer can define two original models of the commodity, respectively: commodity basic original model ItemBas ic and commodity extended original model itemcxtra.

In addition, the user needs paging information when querying, so that a paging primitive model BasePage needs to be defined.

Then, for the enhancement model definition and processing, when developing commodity business, the developer needs to use the corresponding DTO entity object, which is defined as ItemDTO. And ItemDTO requires field information under ItemBas i c and ItemExtra, does not require corresponding annotation information of swagger, corresponding annotation information of JSR303, and @ Length annotation information on the field, and does not require extra F ie l d information under ItemExtra. When a user initiates a query request, a defined ItemQuery query entity needs field information under ItemBas i c and ItemExtra and corresponding paging information. In developing an order service, the DTO entity object OrderDTO of an order may require field information under ItemBas i c, but it also has some field information itself, such as an order number, an order name, etc.

As exemplified above, when a field needs to be changed, it is needed to change it to name; or the demand is changed, the unique number itemNO of the commodity is required to be added, and meanwhile, the order is also required to synchronously record the commodity number. In this embodiment, only the original model ItemBas i c needs to be modified to modify it i e into name, and an itemNo field is newly added, and the enhancement model automatically synchronizes the field changes.

In this embodiment, the fields generated by the enhancement model support both the functions of the Lombrook and MapStruct, so that the developer can also apply when the enhancement model defines annotations of the Lombrook and MapStruct. The method is applicable to Lombrook: on the ItemDeta i lQuery enhancement model, an @ Data annotation is added. The MapS structure is applicable, namely, the field generated by the enhancement model can be used for carrying out attribute assignment by using the MapS structure, and then, if the field names are inconsistent, the static variable acquisition field name can be generated by the embodiment.

If there is a need now, the user will want to assign the commodity name to the order name when placing the order, since the order name is not entered locally. When MapStruct performs data conversion, the data conversion needs to be completed by writing codes, and when the codes are written, the field names can be obtained through ItemDTO.itemName_fie l d and OrderDTO.orderName_f ie l d.

Still further, the present embodiment further provides an electronic device, where the electronic device includes a processor and a memory, and the memory stores computer instructions executable on the processor, and the processor is configured to invoke the computer instructions in the memory to execute the entity object information synchronization method as described above.

In addition, the embodiment also provides a storage medium, which is used for storing computer instructions, wherein when the computer instructions run, the equipment where the storage medium is controlled to execute the entity object information synchronization method.

The embodiments of the present invention have been described in detail with reference to the drawings, but the present invention is not limited to the above embodiments. Even if various changes are made to the present invention, it is within the scope of the appended claims and their equivalents to fall within the scope of the invention.

Claims (9)

1. The entity object information synchronization method is characterized by comprising the following steps:

defining an original model, wherein the original model comprises a basic table, paging inquiry and field/variable types with business meanings;

defining an enhancement model, wherein the enhancement model is a field/variable which needs to be added;

and acquiring a field/variable definition grammar tree node of the original model, scanning the annotation of the enhancement model through an annotation processor, modifying the field/variable definition grammar tree node of the original model according to the attribute in the annotation of the enhancement model, and adding the modified field/variable definition grammar tree node into a class definition grammar tree node of the enhancement model.

2. The method for synchronizing physical object information according to claim 1, wherein,

the base table field/variable types include creation user, update user, creation time, and update time;

paging query field/variable types include page number, page size, and fuzzy search key;

the field/variable types with business meaning include name, unique key, code and logical delete flags.

3. The entity object information synchronization method of claim 1, further preferably, three annotations are predefined before using the annotation processor, namely @ Model, @ Model field and @ enhancement Model;

when the original Model is defined, annotating on the class of the original Model by using an @ Model, and marking on the field of the original Model by using an @ ModelField;

annotating classes of the enhancement model with @ enhancement model when the enhancement model is defined; if the enhancement model's own field requires a field name or table field name, then the enhancement model's own field is annotated with @ ModelField.

4. A method for synchronizing information of physical objects according to claim 3, wherein the definition enhancement model comprises the steps of

Defining a field/variable type of the original model of the duplicate part;

defining a field of the original model of which part is ignored;

defining a swagger annotation of whether to copy a field of the original model;

JSR303 notes defining whether or not to replicate the fields of the original model;

the field notes defining the original model of the duplicated part are not duplicated.

5. The method of claim 4, wherein the annotator processor when executing comprises the steps of

Scanning a TypeElement list with an @ enhancement mode annotation, traversing the TypeElement list, and sequentially processing the existing @ enhancement mode annotation class;

based on the from attribute under the @ enhancement Model, obtaining the TypeElement of the original Model, and obtaining a VariableElement list of an original Model field from the TypeElement; filtering the ignored fields according to the ignoreFields attribute under @ enhancement Model; judging whether to ignore the swagger related annotation according to the enableSwagger attribute under the @ enhancement model; judging whether to ignore the JSR303 annotation according to the enableJSR attribute under the @ enhancement model; ignoring part of the specified notes according to the disalloAnaction attribute under the @ enhancement model; a field name static variable and a table field name static variable are generated from the field definition @ ModelField annotation.

6. The method according to claim 1, wherein if a homonym field exists between the original model and the enhancement model in the process of adding the modified field/variable definition syntax tree node to the class definition syntax tree node of the enhancement model, determining that if the enhancement model has the same field name, directly using the field of the enhancement model; if the enhancement model does not have the same field name, compiling an error, and redundancy the definition of the field for the enhancement model.

7. The method for synchronizing physical object information according to claim 3, further preferably supporting implementation of the method for synchronizing physical object information using IntelliJ IDEA external plug-ins, comprising the steps of: acquiring the original model through a from attribute; acquiring a field with @ ModelField in the original model; adding the raw model field with @ ModelField to the enhancement model; a field name static variable and a table field name static variable are added.

8. An electronic device comprising a processor and a memory, the memory having stored thereon computer instructions executable on the processor, the processor for invoking the computer instructions in the memory to perform the entity object information synchronization method of any of claims 1-7.

9. A storage medium for storing computer instructions, wherein the computer instructions, when executed, control a device in which the storage medium is located to perform the method of entity object information synchronization of any one of claims 1-7.

Images