Database generates HTML document

Today, I found a good database to generate documents. The code is recorded

Add a dependency

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.my</groupId>
    <artifactId>mysqldocument</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>

        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Code implementation

import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.util.ArrayList;

@SpringBootTest
class MysqldocumentApplicationTests {
    

    @Test
    void documentGeneration() {
    
        // data source 
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://xxx.xxx.xxx.xxx:3306/xxx_xx?characterEncoding=UTF-8");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("xxx");
        // Set to get tables remarks Information 
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        // Generate configuration 
        EngineConfig engineConfig = EngineConfig.builder()
                // Generate file path 
                .fileOutputDir("/cn/")
                // Open Directory 
                .openOutputDir(true)
                // file type 
                .fileType(EngineFileType.HTML)
                // Generate template implementation 
                .produceType(EngineTemplateType.freemarker)
                // Custom file name 
                .fileName(" Test generation database document ").build();

        // Ignore table 
        ArrayList<String> ignoreTableName = new ArrayList<>();
        ignoreTableName.add("xxl_job_group");
        ignoreTableName.add("xxl_job_info");
        // Ignore table prefix 
// ArrayList<String> ignorePrefix = new ArrayList<>();
// ignorePrefix.add("xxl_");
// // Ignore table suffix 
// ArrayList<String> ignoreSuffix = new ArrayList<>();
// ignoreSuffix.add("_user");
        ProcessConfig processConfig = ProcessConfig.builder()
                // Specify the generation logic 、 When there is a specified table 、 Specify table prefix 、 When specifying the table suffix , The specified table will be generated , The rest of the tables do not generate 、 And skip ignoring table configuration 
                // Specify a table by name to generate 
                .designatedTableName(new ArrayList<>())
                // Generate according to the table prefix 
                .designatedTablePrefix(new ArrayList<>())
                // Generate from table suffix 
                .designatedTableSuffix(new ArrayList<>())
                // Ignore table name 
                .ignoreTableName(ignoreTableName).build();
        // Ignore table prefix 
// .ignoreTablePrefix(ignorePrefix)
// // Ignore table suffix 
// .ignoreTableSuffix(ignoreSuffix).build();
        // To configure 
        Configuration config = Configuration.builder()
                // edition 
                .version("1.0.0")
                // describe 
                .description(" Database design document generation ")
                // data source 
                .dataSource(dataSource)
                // Generate configuration 
                .engineConfig(engineConfig)
                // Generate configuration 
                .produceConfig(processConfig)
                .build();
        // Perform build 
        new DocumentationExecute(config).execute();
    }
}