CN117764034A - Method and system for realizing attribute verification by generating entity class based on FreeMarker template engine - Google Patents

Abstract

The invention provides a method and a system for realizing attribute verification based on generating entity class by a FreeMarker template engine, comprising the following steps: according to fields provided by the interface document and constraint conditions of the fields, an Excel worksheet is newly built; analyzing the Excel worksheet, reading the Excel worksheet according to the rows, and storing the read information into a column to obtain a mapping table classMap of field names and field types and a mapping table seqMap of field interlayer level relations; creating a FreeMarker template file according to the attribute of the Java class and the characteristic of the attribute annotation, and converting the FreeMarker template file into a required entity class code by a FreeMarker template engine; and defining annotation V, and uniformly checking the input parameters by taking constraint information in Excel as the annotated parameters. The invention is based on a FreeMarker template engine, and the Java entity class codes are rapidly generated through the FreeMarker template engine by configuring fields and field verification conditions in an Excel table, so that a large number of Java entity class codes are not required to be written, and verification of the attributes of each field is completed in an entity class by introducing notes.

Description

Method and system for realizing attribute verification by generating entity class based on FreeMarker template engine

Technical Field

The invention relates to the technical field of information and provides a method and a system for realizing attribute verification based on a FreeMarker template engine generation entity class.

Background

In system research and development, many messages interacted between systems are in XML format, and the XML messages generally have the characteristics of complex structure, multiple fields, fixed values of some fields, verification of most fields and the like. In the conventional development flow, a large amount of codes are required to be written to realize Java entity class codes and carry out basic data verification, so that a large amount of development time is required to be consumed.

The interface calling party assembles the XML message according to the field and format requirements of the interface document, then sends the XML message to the interface provider, and then the interface provider needs to analyze and check the format of the XML message sent by the interface calling party.

Disclosure of Invention

Aiming at the technical problems in the prior art, the invention provides a method and a system for realizing attribute verification based on a FreeMarker template engine generating entity class.

In order to achieve the above purpose, the present invention adopts the following technical scheme: a method for realizing attribute verification based on a FreeMarker template engine to generate entity class comprises the following steps:

step 1, newly building an Excel worksheet according to fields provided by an interface document and constraint conditions of the fields;

step 2, analyzing the Excel worksheet, reading the Excel worksheet according to rows, and storing the read information into a column to obtain a mapping table of field names and field types and a mapping table of field interlayer level relations;

step 3, creating a FreeMarker template file according to the attribute of the Java class and the characteristic of the attribute annotation, and converting the FreeMarker template file into a required entity class code by a FreeMarker template engine;

and 4, defining annotation V, and uniformly checking the input parameters by taking constraint information in Excel as the annotated parameters.

Preferably, the Excel worksheet includes a column for interface code value, sequence number, field name, field type, field description, whether a value range, maximum length, minimum length column must be entered.

Preferably, the step 2 includes the steps of:

step 2-1, initializing a mapping table named classMap, wherein the table stores data types in the form of key value pairs, the keys are type names, and the values are ClassModel objects with corresponding types;

step 2-2, initializing a mapping table named seqMap, wherein the table uses a serial number as a key and uses a ClassModel object corresponding to the serial number as a key value pair of values, and the mapping table helps track and manage ClassModel objects corresponding to different serial numbers;

and 2-3, traversing an Excel data list, checking whether a serial number field of each data contains "," and checking whether a class model object corresponding to the serial number exists in a classMap.

Preferably, in step 2-3, if the sequence number field does not contain "," and the class map does not have a class model object corresponding to the sequence number, a new class model object is created and a corresponding value is assigned to the attribute;

this ClassModel object is then saved to both classMap and seqMap for later use.

Preferably, in step 2-3, if the sequence number field does not contain "," and the ClassModel object corresponding to the sequence number already exists in the classMap, the ClassModel object is saved together with the sequence number in the seqMap, and the mapping relationship of the hierarchy is updated.

Preferably, in step 2-3, if the sequence number field contains "," and the ClassModel object corresponding to the sequence number does not exist in the classMap, creating a new ClassModel object, assigning a corresponding value to the attribute, and saving the ClassModel object in both the classMap and the seqMap;

in addition, the attribute is added to the attribute of the ClassModel object corresponding to the sequence number of the higher level of the sequence number.

Preferably, in step 2-3, further comprising: if the sequence number field contains ", and a class model object corresponding to the sequence number already exists in the classMap, the class model object is obtained from the classMap, the class model object and the sequence number are stored in the seqMap, the attribute is added into the attribute of the class model object corresponding to the sequence number of the upper level of the sequence number, and the mapping relation of the hierarchy is updated.

Preferably, the step 3 includes the steps of:

step 3-1, creating a FreeMark template, and creating a FreeMark template file according to the attribute of the Java class and the characteristic of the attribute annotation; the FreeMark template exists in the form of a text file, and comprises a plurality of placeholders which are replaced by dynamic data;

step 3-2, preparing a data source: the data sources are two mapping tables obtained in the step 2;

step 3-3, loading and analyzing the template: using the FreeMarker API to load and parse templates; creating an parsed template object in the memory by the FreeMarker, wherein the object comprises the parsing result of each part of the template and the position information of each part in the template;

step 3-4, filling data and generating output: and providing the data source for a template object of a FreeMarker, and generating a finally required entity class code by the FreeMarker template engine according to the template and the data source.

Preferably, in step 4, the checking logic comprises:

whether the field is needed to be input as a comment V, if yes, the field representing the comment is needed to be input, so that whether the field is needed to be input is checked;

if the annotation value of the value range is not null, according to the annotation value, dividing, and verifying whether the field of the annotation is in the allowed range;

if the maximum length annotation value is not null, verifying whether the field length of the annotated field meets the requirement;

if the minimum length annotation value is not null, verifying whether the field length of the annotated field meets the requirement.

According to a second aspect of the present invention, a system for generating entity class based on a FreeMarker template engine to implement attribute verification is provided, including:

the Excel building module is used for building an Excel worksheet according to the fields provided by the interface document and the constraint conditions of the fields;

the Excel analysis module is used for analyzing the Excel worksheet, reading the Excel worksheet according to the rows, and storing the read information into a column to obtain a mapping table of field names and field types and a mapping table of field interlayer level relations;

the template conversion module is used for creating a FreeMark template file according to the attribute of the Java class and the characteristic of the attribute annotation, and converting the FreeMark template file into a required entity class code by the FreeMark template engine;

and the parameter verification module is used for defining annotation V, taking constraint information in Excel as parameters of the annotation, and uniformly verifying the input parameters.

Because the invention adopts the technical scheme, the invention has the following beneficial effects:

the invention discloses a method and a system for realizing attribute verification based on generating entity class by a FreeMarker template engine, which aim to solve the problem that a large number of other system interface services are required to be called in the process of software research and development, especially in the process of new project construction, and a developer needs to write a large number of codes to realize the verification of entity class and related attributes. By applying the scheme of the invention, the research and development efficiency can be greatly improved, the development period is shortened, the workload of developers is lightened, and the research and development cost is also reduced.

Drawings

FIG. 1 is a flowchart of the overall business of a method for verifying the attributes of entity class generation based on a FreeMarker template engine according to the embodiment of the invention;

fig. 2 is a schematic hardware structure of a possible electronic device according to an embodiment of the present invention.

Detailed Description

Hereinafter, embodiments of the present invention will be described in detail. While the invention will be described and illustrated in conjunction with certain specific embodiments, it will be understood that it is not intended to limit the invention to these embodiments alone. On the contrary, the invention is intended to cover modifications and equivalent arrangements included within the scope of the appended claims.

It can be appreciated that, based on the defects in the background technology, the embodiment of the invention provides a method for realizing attribute verification based on generating entity class by a FreeMarker template engine, specifically as shown in fig. 1, the method comprises the following steps:

step 1, newly building an Excel worksheet according to fields provided by an interface document and constraint conditions of the fields;

in the above technical solution, the Excel worksheet includes a column, where the column includes an interface code value, a serial number, a field name, a field type, a field description, whether an input is necessary, a value range, a maximum length, and a minimum length column.

It should be noted that, in the embodiment of the present invention, an Excel table is created, where the table has 8 columns, which are respectively a serial number, a field name, a field type, a field description, a value range, a maximum length and a minimum length.

The sequence numbers indicate the hierarchical relationship of fields, e.g., 1, 2 and 3 in the table are the same layer attributes of the created class, 1.1 and 1.2 are attributes of a class FieldList, 1.2 field type ARRAY indicates an ArrayList, and 1.2.1 and 1.2.2 are contained in the class FieldList1.

The field types ARRAY, STRING, DOUBLE respectively represent three types of data, namely an array, a character string and a floating point number.

The field description, whether it is necessary to input, the value range, the constraint condition, the maximum length, the minimum length and other table attributes are generated in the code as the notes of the field, so that we can uniformly check the self-definition of the fields through the notes.

And 2, analyzing the Excel worksheet, reading the Excel worksheet according to rows, and storing the read information into a column to obtain a mapping table classMap of field names and field types and a mapping table seqMap of field interlayer level relations.

In the above technical solution, the step 2 specifically includes the following steps:

step 2-1, initializing a mapping table named classMap, which stores data types in the form of key-value pairs, wherein keys are type names and values are ClassModel objects with corresponding types.

Step 2-2, initializing a mapping table named seqMap, which uses the sequence number as a key and uses the ClassModel object corresponding to the sequence number as a key value pair of values, wherein the mapping table helps track and manage ClassModel objects corresponding to different sequence numbers.

And 2-3, traversing an Excel data list, checking whether a serial number field of each data contains "," and checking whether a class model object corresponding to the serial number exists in a classMap. The purpose of this step is to determine if a new ClassModel object needs to be created or an existing ClassModel object is used.

If the sequence number field does not contain "," and the classMap does not have a ClassModel object corresponding to the sequence number, a new ClassModel object is created and the attribute (Java type, attribute name, annotation information) is given a corresponding value. This ClassModel object is then saved to both classMap and seqMap for later use.

If the sequence number field does not contain ", and a ClassModel object corresponding to the sequence number already exists in the classMap, the ClassModel object and the sequence number are saved together in the seqMap, and the mapping relation of the hierarchy is updated.

If the sequence number field contains "," and the classModel object corresponding to the sequence number does not exist in the classMap, a new classModel object is created, corresponding values are given to the attributes (Java type, attribute name and annotation information) of the new classModel object, and the classModel object is saved in the classMap and the seqMap simultaneously. In addition, the attribute is added to the attribute of the ClassModel object corresponding to the sequence number of the higher level of the sequence number. If the sequence number field contains ", and a class model object corresponding to the sequence number already exists in the classMap, the class model object is obtained from the classMap, the class model object and the sequence number are stored in the seqMap, the attribute is added into the attribute of the class model object corresponding to the sequence number of the upper level of the sequence number, and the mapping relation of the hierarchy is updated.

And step 3, creating a FreeMarker template file according to the attribute of the Java class and the characteristic of the attribute annotation, and converting the FreeMarker template file into a required entity class code by a FreeMarker template engine.

In the above technical solution, the step 3 specifically includes the following steps:

and 3-1, creating a FreeMark template, and creating a template file according to the attribute of the Java class and the characteristic of the attribute annotation. The FreeMark template is in the form of a text file, which contains placeholders that are replaced with dynamic data.

Step 3-2, preparing a data source: the data sources are the two mapping tables obtained in the step 2.

Step 3-3, loading and analyzing the template: the FreeMark API is used to load and parse templates. FreeMarker creates an parsed template object in memory that contains the parsing results of the various parts of the template and their location information in the template.

Step 3-4, filling data and generating output: and providing the data source for a template object of a FreeMarker, and generating a finally required entity class code by the FreeMarker template engine according to the template and the data source.

And 4, defining annotation V, and uniformly checking the input parameters by taking constraint information in Excel as the annotated parameters.

In the above technical solution, the check logic includes:

1. whether a field notNull as comment V is necessary, and if yes, the field indicating the comment is necessary, thereby checking whether the field is necessary.

2. If the value range annotation value is not null, the field annotated by the annotation is verified whether to be in the allowed range according to the annotation value with the segmentation.

3. If the maximum length annotation value is not null, verifying whether the field length of the annotated field meets the requirement.

4. If the minimum length annotation value is not null, verifying whether the field length of the annotated field meets the requirement.

Therefore, the embodiment of the invention designs a method for quickly generating Java entity class codes through an Excel document based on a FreeMarker template engine, can generate Java entity class codes with layers through configuring a field hierarchy structure, is compatible with XML with complex structures, can generate notes for each field through configuring constraint information of the Excel field, and can conveniently perform unified verification on the fields through the notes.

According to a second aspect of the present invention, an embodiment of the present invention further provides a system for generating an entity class based on a FreeMarker template engine to implement attribute verification, including:

the Excel building module is used for building an Excel worksheet according to the fields provided by the interface document and the constraint conditions of the fields;

the Excel analysis module is used for analyzing the Excel worksheet, reading the Excel worksheet according to rows, and storing the read information into a column to obtain a mapping table classMap of field names and field types and a mapping table seqMap of field interlayer level relations;

the template conversion module is used for creating a FreeMark template file according to the attribute of the Java class and the characteristic of the attribute annotation, and converting the FreeMark template file into a required entity class code by the FreeMark template engine;

and the parameter verification module is used for defining annotation V, taking constraint information in Excel as parameters of the annotation, and uniformly verifying the input parameters.

In summary, the embodiment of the invention aims to quickly generate Java entity class codes by configuring fields and field verification conditions in an Excel table by a user and quickly realize basic data verification by annotating.

It can be understood that the system for realizing attribute verification based on the FreeMarker template engine generating entity class provided by the invention corresponds to the method for realizing attribute verification based on the FreeMarker template engine generating entity class provided by the foregoing embodiments, and the related technical features of the system for realizing attribute verification based on the FreeMarker template engine generating entity class can refer to the related technical features of the method for realizing attribute verification based on the FreeMarker template engine generating entity class, which are not described herein.

The invention also provides a physical structure schematic diagram of an electronic device, as shown in fig. 2, the electronic device may include: processor 810, communication interface (Communications Interface) 820, memory 830, and communication bus 840, wherein processor 810, communication interface 820, memory 830 accomplish communication with each other through communication bus 840. The processor 810 may call logic instructions in the memory 830 to perform the steps of a method for performing attribute verification based on the FreeMarker template engine generating entity classes.

Further, the logic instructions in the memory 830 described above may be implemented in the form of software functional units and may be stored in a computer-readable storage medium when sold or used as a stand-alone product. Based on this understanding, the technical solution of the present invention may be embodied essentially or in a part contributing to the prior art or in a part of the technical solution, in the form of a software product stored in a storage medium, comprising several instructions for causing a computer device (which may be a personal computer, a server, a network device, etc.) to perform all or part of the steps of the method according to the embodiments of the present invention. And the aforementioned storage medium includes: a U-disk, a removable hard disk, a Read-Only Memory (ROM), a random access Memory (RAM, random Access Memory), a magnetic disk, or an optical disk, or other various media capable of storing program codes.

From the above description of the embodiments, it will be apparent to those skilled in the art that the embodiments may be implemented by means of software plus necessary general hardware platforms, or of course may be implemented by means of hardware. Based on this understanding, the foregoing technical solution may be embodied essentially or in a part contributing to the prior art in the form of a software product, which may be stored in a computer readable storage medium, such as ROM/RAM, a magnetic disk, an optical disk, etc., including several instructions for causing a computer device (which may be a personal computer, a server, or a network device, etc.) to execute the method described in the respective embodiments or some parts of the embodiments.

While preferred embodiments of the present invention have been described, additional variations and modifications in those embodiments may occur to those skilled in the art once they learn of the basic inventive concepts. It is therefore intended that the following claims be interpreted as including the preferred embodiments and all such alterations and modifications as fall within the scope of the invention.

Finally, it should be noted that: the above embodiments are only for illustrating the technical solution of the present invention, and are not limiting; although the invention has been described in detail with reference to the foregoing embodiments, it will be understood by those of ordinary skill in the art that: the technical scheme described in the foregoing embodiments can be modified or some technical features thereof can be replaced by equivalents; such modifications and substitutions do not depart from the spirit and scope of the technical solutions of the embodiments of the present invention.

Claims (10)

1. The method for realizing attribute verification by generating entity class based on FreeMark template engine is characterized by comprising the following steps:

step 1, newly building an Excel worksheet according to fields provided by an interface document and constraint conditions of the fields;

step 2, analyzing the Excel worksheet, reading the Excel worksheet according to rows, and storing the read information into a column to obtain a mapping table of field names and field types and a mapping table of field interlayer level relations;

step 3, creating a FreeMarker template file according to the attribute of the Java class and the characteristic of the attribute annotation, and converting the FreeMarker template file into a required entity class code by a FreeMarker template engine;

and 4, defining annotation V, and uniformly checking the input parameters by taking constraint information in Excel as the annotated parameters.

2. The method for realizing attribute verification based on the FreeMark template engine generation entity class according to claim 1, wherein the method is characterized in that: the Excel worksheet includes a column for interface code value, sequence number, field name, field type, field description, whether it must be entered, value range, maximum length, minimum length column.

3. The method for realizing attribute verification based on the FreeMark template engine generation entity class according to claim 1, wherein the method is characterized in that: the step 2 comprises the following steps:

step 2-1, initializing a mapping table named classMap, wherein the table stores data types in the form of key value pairs, the keys are type names, and the values are class model objects with corresponding types;

step 2-2, initializing a mapping table named seqMap, wherein the mapping table uses a serial number as a key and uses a ClassModel object corresponding to the serial number as a key value pair of values, and the mapping table helps track and manage ClassModel objects corresponding to different serial numbers;

and 2-3, traversing an Excel data list, checking whether a serial number field of each data contains "," and checking whether a class model object corresponding to the serial number exists in a classMap.

4. The method for realizing attribute verification based on the FreeMark template engine generation entity class according to claim 2, wherein the method is characterized in that: in step 2-3, if the sequence number field does not contain "," and the class map does not have a class model object corresponding to the sequence number, creating a new class model object, and assigning a corresponding value to the attribute;

this ClassModel object is then saved to both classMap and seqMap for later use.

5. The method for realizing attribute verification based on the FreeMark template engine generating entity class according to claim 4, wherein the method comprises the following steps: in step 2-3, if the sequence number field does not contain ", and a ClassModel object corresponding to the sequence number already exists in the classMap, the ClassModel object and the sequence number are saved together in the seqMap, and the mapping relation of the hierarchy is updated.

6. The method for realizing attribute verification based on the FreeMark template engine generating entity class according to claim 4, wherein the method comprises the following steps: in step 2-3, if the sequence number field contains "," and the class map does not have a class model object corresponding to the sequence number, creating a new class model object, assigning a corresponding value to the attribute, and storing the class model object in the class map and the seqMap simultaneously;

in addition, the attribute is added to the attribute of the ClassModel object corresponding to the sequence number of the higher level of the sequence number.

7. The method for realizing attribute verification based on the FreeMark template engine generating entity class according to claim 6, wherein the method comprises the following steps: in step 2-3, further comprising: if the sequence number field contains ", and a class model object corresponding to the sequence number already exists in the classMap, the class model object is obtained from the classMap, the class model object and the sequence number are stored in the seqMap, the attribute is added into the attribute of the class model object corresponding to the sequence number of the upper level of the sequence number, and the mapping relation of the hierarchy is updated.

8. The method for realizing attribute verification based on the FreeMark template engine generation entity class according to claim 1, wherein the method is characterized in that: the step 3 comprises the following steps:

step 3-1, creating a FreeMark template, and creating a FreeMark template file according to the attribute of the Java class and the characteristic of the attribute annotation; the FreeMark template exists in the form of a text file, and comprises a plurality of placeholders which are replaced by dynamic data;

step 3-2, preparing a data source; the data sources are two mapping tables obtained in the step 2;

step 3-3, loading and analyzing the template; using the FreeMarker API to load and parse templates; creating an parsed template object in the memory by the FreeMarker, wherein the object comprises the parsing result of each part of the template and the position information of each part in the template;

step 3-4, filling data and generating output; and providing the data source for a template object of a FreeMarker, and generating a finally required entity class code by the FreeMarker template engine according to the template and the data source.

9. The method for realizing attribute verification based on the FreeMark template engine generation entity class according to claim 1, wherein the method is characterized in that: in step 4, the verification logic comprises:

whether the field is needed to be input as a comment V, if yes, the field representing the comment is needed to be input, so that whether the field is needed to be input is checked;

if the annotation value of the value range is not null, according to the annotation value, dividing, and verifying whether the annotated field is in the allowed range;

if the maximum length annotation value is not null, verifying whether the field length of the annotated field meets the requirement;

if the minimum length annotation value is not null, verifying whether the field length of the annotated field meets the requirement.

10. The system for realizing attribute verification by generating entity class based on FreeMark template engine is characterized in that: comprising the following steps:

the Excel building module is used for building an Excel worksheet according to the fields provided by the interface document and the constraint conditions of the fields;

the Excel analysis module is used for analyzing the Excel worksheet, reading the Excel worksheet according to the rows, and storing the read information into a column to obtain a mapping table of field names and field types and a mapping table of field interlayer level relations;

the template conversion module is used for creating a FreeMark template file according to the attribute of the Java class and the characteristic of the attribute annotation, and converting the FreeMark template file into a required entity class code by the FreeMark template engine;

and the parameter verification module is used for defining annotation V, taking constraint information in Excel as parameters of the annotation, and uniformly verifying the input parameters.