CN111488143A

CN111488143A - Automatic code generation device and method based on Springboot2

Info

Publication number: CN111488143A
Application number: CN202010294338.8A
Authority: CN
Inventors: 詹俊飞; 徐阳光
Original assignee: Nanjing Yiwu Intelligent Technology Co ltd
Current assignee: Nanjing Yiwu Intelligent Technology Co ltd
Priority date: 2020-04-15
Filing date: 2020-04-15
Publication date: 2020-08-04

Abstract

The invention provides a device and a method for automatically generating codes based on a Springboot2, wherein the codes are divided into four layers: the system comprises a Controller layer, a Service layer, a Mapper layer and a Po layer, wherein program engineering catalogues respectively correspond to catalogues such as a Controller, a Service, a Mapper and a Po. Based on the code framework, modules such as a code framework loader, a table parser, a code generator and the like are introduced. The table analysis module is used for reading the table definition information from the database for analysis, and acquiring the table basic information: the table field list comprises a field name, a data type, a field comment, whether the field name can be null and the like; the code generator module is divided into four generators: a Controller type generator, a Service type generator, a Mapper type and Xml generator and a Po type generator; each generator is responsible for acquiring the analyzed table definition information from the table analysis module, generating codes based on expert knowledge base rules, adding a code frame of the Springboot2, and automatically writing the generated code files into appointed directories such as a controller, a service, a mapper and a po.

Description

Automatic code generation device and method based on Springboot2

Technical Field

The invention relates to a device and a method for automatically generating codes based on a Springboot2, and belongs to the field of computer software.

Background

With the technological development and application popularization of the Web and mobile internet, more and more companies and enterprises adopt a J2 EE-based scheme to build own business middleboxes and business backgrounds, wherein the most popular and widely-used open source J2EE technical framework for software development is a Spring framework, in recent years, the latest framework of Spring has been shifted from Spring mvc to Spring boot and Spring closed, a micro-service framework is built based on Spring closed, and a micro-service module is built based on Spring boot, which has gradually become a mainstream technical scheme in the current and future years.

In the development process of software projects, how to improve software development efficiency is a problem which is continuously concerned, and before, some automatic code generation devices and methods appear, which are more concentrated under an old code framework, although the popularization of the new framework and the micro-service framework of the Springboot and springclosed described above changes the code generation automation work, the invention provides a code automation generation technology in micro-service modular construction based on the Springboot. In addition, the invention also introduces a Springboot code frame as a premise and a basis for constructing the automatic code generation, so that the code generated by the automatic construction is directly stored in the pre-constructed code frame, and the code frame constructed by experienced architects and programmers can be immediately loaded with the automatically generated code to run, and a RESTful service interface is provided for the outside.

Disclosure of Invention

A device and a method for automatically generating codes based on a Springboot2 comprise a code framework of Springboot2, wherein the framework integrates basic capabilities required in the web application development process, including cross-domain processing, log processing, transaction processing, paging query, a security module, a timing task, redis cache, distributed locks, message queues, international support and other basic capabilities. The Springboot2 code framework provided by the invention appoints code directories into four major categories: the Controller layer, the Service layer, the Mapper layer and the Po layer respectively correspond to the Controller directory, the Service directory, the Mapper directory and the Po directory on the program engineering directory structure.

Based on the Springboot2 code framework provided by the invention, modules such as a code framework loader, a database (table) parser, a code generator and the like are introduced. The database table analysis module is used for reading database table definition information from a database table definition file or database connection for analysis, and analyzing the basic information of one database table: table name, table comment, table field list, table primary key name, wherein each table field in the table field list contains a field name, a data type, a field comment, whether it can be null, etc.; the code generator module is subdivided into four sub-generators: a Controller type generator, a Service type generator, a Mapper type and Xml generator and a Po type generator; each generator is responsible for acquiring the analyzed table definition information from the table analysis module, generating a function according to the expert knowledge base rule of an experienced architect, adding a code frame of the Springboot2, and automatically writing the generated file into an appointed controller directory, service directory, mapper directory and po directory.

The invention also provides sentences which are specially operated in a time-consuming manner by using orderby and groupby when the total number of returned data needs to be calculated and are detected by automatic paging query and automatically removed based on a plug-in interceptor, mybatis is taken as an example, a plugintecterator of mybatis is used for intercepting database function call at the end of a ByPage character string, after interception, an intercepted original SQ L sentence syntax tree is analyzed by using an SQ L analysis technology, then, the orderby and groupby sentences are deleted if the original SQ L sentences carry time-consuming operations of orderby, groupby and the like, the deleted syntax tree reconstructs a new SQ L, and the total number of data of the query interface is counted by adding a select operation on the basis of the new SQ L.

Drawings

Fig. 1 is a diagram of an automatic generation device based on Springboot code.

Fig. 2 is a flowchart of generating a Po class file.

FIG. 3 is a flow chart for generating a Mapper level class file and xml.

Fig. 4 is a flowchart of generating a Service layer class file.

Fig. 5 is a flowchart for generating a Controller layer class file.

FIG. 6 is a call relationship diagram for when generating code.

FIG. 7 is a call relationship diagram for when generating code.

FIG. 8 illustrates an example code snippet for a table definition.

FIG. 9 is a table defining code fragments for generating Mapper level xml.

FIG. 10 is a diagram of an optimized paging query record count for a code fragment.

Detailed Description

As shown in fig. 1, an automatic code generation device based on a Springboot2 includes a Springboot2 code framework, a code framework loader, a database (table) parser, a code generator, and so on. The Springboot2 code framework is a basic code framework constructed by experienced architects or programmers, and has built-in general basic capabilities of general projects, including: cross-domain processing, log processing, transaction processing, paging query, security module, timing task, redis cache, distributed lock, message queue, international support and other basic capabilities.

The cross-domain processing refers to requesting a resource of another domain name from one domain name, and a cross-domain situation often exists in actual work development, because a company has many projects and sub-domain names, resources of the other side need to be called mutually among the projects or websites, and the cross-domain request cannot be avoided. The present invention provides the current technical situation that the separation of front-end development and back-end development becomes a mainstream development mode, the front-end is usually packed and independently deployed independently, the back-end resource is accessed through an interface, and the cross-domain becomes a very popular and common technical problem. The Springboot2 code framework integrates solutions based on the Springboot cross-domain mechanism.

The invention provides a Springboot2 code frame which integrates an open source log frame of log4j2 and supports rolling writing of log files according to error levels and dates.

The invention provides a Springboot2 code framework, which adopts an AOP (active Springboot) section interception mode to configure a function id name matching rule according to a service layer based on an open source Springboot, and performs transaction processing on functions conforming to the rule, such as updateXXX supporting transactions, while getXXX does not need transactions.

The invention provides a Springboot2 code frame, which is judged by an interface id name rule of an access database based on paging inquiry realized by an interceptor, and automatically performs paging processing if the code frame is a function at the end of a ByPage character string, thereby shielding negative complex paging processing logic and ensuring that the service interface is developed very simply without relational paging processing.

The invention provides a Springboot2 code framework based on JWT authentication mechanism integrated with Shiro framework to support web interface access security, JWT

Interface access identity authentication is provided, and Shiro provides interface access right control.

The timing task is used for performing service processing on tasks which need to be executed at certain specific frequency intervals or specific time frequently, the invention provides that a spring boot2 code frame integrates a Quartz timing task frame, and the distributed timing task under a single-node or cluster environment can be conveniently realized by matching with a distributed lock.

The Redis cache also becomes a mainstream data cache scheme of current web development, the invention provides that a Springboot2 code framework integrates a Redis access interface and configuration, a service layer can conveniently place hot spot data into the Redis, and data is read from the Redis to provide high IOPS for a service system.

The invention provides a Springboot2 code framework which integrates redis atomic operation semantics, realizes that the distributed lock is a simple function call, converts the complex problem of concurrent programming in a cluster environment into a simple function call, and greatly reduces the technical difficulty of cluster concurrent programming of service development.

The invention provides a scheme that a Springboot2 code framework integrates a kafka message queue, so that a service layer can conveniently use the capacity of the message queue and provide basic capacity for constructing a high-performance and high-concurrency service system.

Internationalization is mainly used for constructing a service system under a multi-language and multi-country environment, and in the face of the requirement of user systems of different countries for supporting the function of freely switching display languages of users, the invention provides a Springboot2 code frame which is internally provided for realizing multi-language support, so that a service layer does not need to pay attention to multi-language realization details, and development and application automatically have multi-language support capability.

The invention provides a Springboot2 code framework, which has the basic capability, also appoints the directory division of the whole engineering code, and divides the code into four levels: a Controller layer, a Service layer, a Mapper layer and a Po entity class.

As shown in fig. 2, the process of Po entity class generation on the Springboot2 code framework is proposed according to the present invention:

the table parsing module is responsible for parsing the table definition to obtain table base information including a table name, a table annotation, a table field list, a table primary key name, wherein each table field in the table field list contains a field name, a data type, a field annotation, whether the table field can be empty, and the like, and is an example of a table definition presented in the form of an SQ L statement of MySQ L, as shown in FIG. 8.

And secondly, constructing Java class codes of Po classes according to the table basic information obtained in the last step, wherein the class name of the Po class is named XXXPO, the generated source code file is named XXXPO.java, each field of the table field list generates a member variable of the XXXPO class, the member variable type generates a corresponding Java variable type according to the table field type, the table field annotation generates an annotation of the member variable, and in addition, a get/set member method is automatically generated for the XXXPO class.

And thirdly, generating a content character string of the source code file by the Po code generator according to the rule of the second step.

And fourthly, writing the character string into a file XXXPO.java by a file writing module, and automatically storing the file into a Po directory agreed by a Springboot2 code framework provided by the invention.

As shown in fig. 3, the present invention proposes a flow of creating Mapper class and Xml on the Springboot2 code framework:

the first step and the second step are the same as the step shown in figure 2;

and thirdly, constructing contents of the XXXMapple. java and XXXMapple. xml files according to fixed rules by the Mapper code generator according to the information acquired in the previous step. The specific generated file content is shown as 201 and Mybatis engine in fig. 7.

Fourthly, the file writing module writes the character strings into files named XXXMapple. java and XXXMapple. xml, and the files are automatically saved in a Mapper directory appointed by a Springboot2 code framework provided by the invention.

As shown in fig. 4, the present invention proposes a Service class generation process on a Springboot2 code framework:

the first step and the second step are the same as the step shown in figure 2;

and thirdly, the Service code generator constructs the contents of the XXXService. The specific generated file content is shown as 301 in fig. 7.

And fourthly, writing the character string into a XXXService. java file by a file writing module, and automatically storing the file into a Service directory appointed by a Springboot2 code framework provided by the invention.

As shown in fig. 5, based on the present invention, a flow of generating a Controller class on a Springboot2 code framework is proposed:

the first step and the second step are the same as the step shown in figure 2;

and thirdly, the Controller code generator constructs the content of the XXXController. The specific generated file content is shown as 301 in fig. 7.

After the Springboot2 code frame is started and operated, when a Restful interface from the outside or the front end is called, the Restful interface is distributed to the Controller class by a framework, a method of the Controller class calls a method of the Service class, the method of the Service class calls a method of the Mapper class, and the method of the Mapper class calls a method of the Mapper XM L to perform database operation.

FIG. 8 is an example of a table definition, presented in the form of the SQ L statement of MySQ L, with the table name system _ exception and the table annotation "Exception Table NG" in this embodiment, the table contains four fields, respectively:

1. the field name id, the field type integer, the field can not be empty, and the field comment is a self-adding main key;

2. the field name is extacktrace, the field type character string is not empty, and the field is annotated as an abnormal stack;

3. the field name exmessage, the field type character string, the field can be empty, and the field comment is an abnormal message;

4. field name extime, field type character string, field nonemptability, and field comment as abnormal time;

fig. 9 is a MapperXM L code segment further generated according to the embodiment described in fig. 8, wherein in order to support optimization of paging query, a findExceptionsByPage interface in the map automatically triggers paging according to the paging mechanism implemented by the Springboot2 code framework proposed by the present invention, when paging query is performed, the total number of interface return data needs to be obtained first, and a query-related exception data that specifies exception time as query conditions is developed last as shown in fig. 10 102, to support paging query, a common method is to intercept the query interface and then automatically add corresponding statements back and forth as 202 in fig. 10, to calculate the total number of interface return data, but the method has a problem that if an original 102 statement contains operations such as orderbby or groupby, the total number of records is useless, and the orderbby and groupby operations are extremely time consuming, and the present invention proposes an improvement measure that when a mybatis uses behavior of mybandintis as an example, a bug interception rule is used to intercept a bug string to construct a new parsing statement such as a bysbackray, SQ 302, and delete a new parsing rule after a syntax is built, a query syntax is deleted, a query syntax is added, and a query syntax is added, so that when a query syntax is added, and a query syntax is added, which is added, and a query syntax is added, a query syntax.

Claims

1. An automatic generation device and method based on a Springboot2 code are characterized by comprising a Springboot2 code framework, a code framework loader, a database (table) parser, a code generator and the like.

2. The Springboot2 code framework of claim 1, having built-in generic project generic base capabilities, comprising: cross-domain processing, log processing, transaction processing, paging query, security module, timing task, redis cache, distributed lock, message queue, international support and other basic capabilities.

3. The Springboot2 code framework of claim 1, wherein code directories are specified into four broad categories: the Controller layer, the Service layer, the Mapper layer and the Po layer respectively correspond to the Controller directory, the Service directory, the Mapper directory and the Po directory on the program engineering directory structure.

4. The database table parsing module of claim 1, configured to read database table definition information from a database table definition file or a database connection for parsing, and parse basic information of a database table: table name, table comment, table field list, table primary key name, where for each table field in the table field list a field name, data type, field comment, whether it can be empty, etc.

5. The code generator module of claim 1, divided into four sub-generators: a Controller type generator, a Service type generator, a Mapper type and Xml generator and a Po type generator;

the Controller code generator acquires the analyzed table definition information from the table analysis module, generates a function according to the rule of the expert knowledge base of the experienced architect, adds a code frame of the Springboot2, and automatically writes the generated file into an appointed Controller directory;

the Service code generator acquires the analyzed table definition information from the table analysis module, generates a function according to the rule of the expert knowledge base of the experienced architect, adds a code frame of Springboot2, and automatically writes the generated file into an appointed Service directory;

the Mapper code generator acquires the parsed table definition information from the table parsing module, generates a function according to the rule of an expert knowledge base of an experienced architect, adds a code frame of a Springboot2, and automatically writes a generated file into an appointed Mapper directory;

the Po code generator acquires the analyzed table definition information from the table analysis module, generates a function according to the rule of the expert knowledge base of the experienced architect, adds a code frame of the Springboot2, and automatically writes the generated file into an appointed Po directory.

6. An automatic generation device and method based on a Springboot2 code are characterized by comprising the following steps:

intercepting database function call ending by a ByPage character string in a database access interceptor;

secondly, after interception, an intercepted original SQ L statement syntax tree is analyzed by using an SQ L analysis technology;

thirdly, judging that if the original SQ L statement carries time-consuming operations such as orderby and group by, deleting the orderby and group by statement;

fourthly, reconstructing a new SQ L by the deleted syntax tree;

and fifthly, adding a select count operation to count the total data of the query interface on the basis of the new SQ L.