Entity Generator

Firstly, generate a cache file based on the database file. Then, developers refer to the cache file to configure the annotation file, and finally generate classes according to the annotations.

中文文档

Configuration

database file:

jdbc.driverClassName=oracle.jdbc.OracleDriver
jdbc.url=jdbc:oracle:thin:@127.0.0.1:1521:data
jdbc.username=user
jdbc.password=qwe123

Setting Output Directory Set the output directory to specify where the generated class files will be stored:

entityGenerator {
	output 'generated/po'
}

In addition, you need to include the output directory in classes so that the project can use the generated class files, for example:

dependencies {
    implementation files("build/generated/po")
}

If the generated class files are not needed at runtime and are only used after compilation, the above configuration is not necessary.

Table Identification

_spec:
  - exclude
_pre:
  - TEST_
_items:
  - TEMP_LOG

This configuration imports all tables from the database by default, and then excludes tables that start with TEST_ and the TEMP_LOG table. For example, TEST_A, TEST_1, and TEMP_LOG will not generate entity classes, but TEMP_LOG2 will not be excluded.

Excluding Fields

Use the following two configurations to exclude fields, and these fields will not be generated in all tables:

• _default_exclude_fields: Used to exclude ordinary fields.
• _default_log_exclude_fields: Used to exclude log-related fields.

Parent Class Configuration

Use the following two configurations for parent classes, and the generated Entity will inherit these parent classes:

• _default_super: Configure the parent class for ordinary Entities.
• _default_log_super: Configure the parent class for log-related Entities. Please note that during the generation process, it is necessary to create false temporary parent classes with the same name in memory (not output). The reasons are as follows:

A classloader to load the user's classes has not been found temporarily. There is no suitable timing to load these parent classes.

Sequence Configuration

Use the following two configurations for sequences:

• _default_seq: Configure the sequence for ordinary Entities.
• _default_log_seq: Configure the sequence for log-related Entities.

Type Revision

The generation of entity classes can be more flexibly controlled through the configuration of custom column attributes. Specify additional attribute information in the configuration file:

TableName:
    - ColumnName
    - DataType

• TableName: Database table name
• ColumnName: Column name in the table
• DataType: The specified column type (DataType is currently limited to java.lang.* types) These custom attributes will be reflected in the generated entity classes in corresponding forms, such as adding annotations, generating specific code, etc., thereby achieving more fine-grained code generation.

Plan Supplements

Optimization of Cache File Generation Objective: Improve the efficiency and accuracy of cache file generation. Measures: Analyze the structure of the database file and optimize the generation algorithm to reduce unnecessary calculations and data processing. Add version management for cache files. When the database file is updated, only update the changed parts of the cache file to avoid full regeneration. Provide a validation function for cache files to ensure that the generated cache files are consistent with the database files.