1、生成数据库设计文档
    screw
    1.新建Java应用程序
    2.引入依赖

    1. <dependency>
    2.     <groupId>cn.smallbun.screw</groupId>
    3.     <artifactId>screw-core</artifactId>
    4.     <version>1.0.3</version>
    5. </dependency>

    3.复制测试用例，并修改相关信息

    1. import cn.smallbun.screw.core.Configuration;
    2. import cn.smallbun.screw.core.engine.EngineConfig;
    3. import cn.smallbun.screw.core.engine.EngineFileType;
    4. import cn.smallbun.screw.core.engine.EngineTemplateType;
    5. import cn.smallbun.screw.core.execute.DocumentationExecute;
    6. import cn.smallbun.screw.core.process.ProcessConfig;
    7. import com.zaxxer.hikari.HikariConfig;
    8. import com.zaxxer.hikari.HikariDataSource;
    9. import org.junit.jupiter.api.Test;
    11. import javax.sql.DataSource;
    12. import java.util.ArrayList;
    14. private class ScrewTest {
    16.     @Test
    17.     private void testScrew() {
    18.         //数据源
    19.         HikariConfig hikariConfig = new HikariConfig();
    20.         hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
    21.         hikariConfig.setJdbcUrl("jdbc:mysql://192.168.1.7:3306/org");
    22.         hikariConfig.setUsername("dev");
    23.         hikariConfig.setPassword("Cqhz2020");
    24.         //设置可以获取tables remarks信息
    25.         hikariConfig.addDataSourceProperty("useInformationSchema", "true");
    26.         hikariConfig.setMinimumIdle(2);
    27.         hikariConfig.setMaximumPoolSize(5);
    28.         DataSource dataSource = new HikariDataSource(hikariConfig);
    30.         //生成配置
    31.         EngineConfig engineConfig = EngineConfig.builder()
    32.                 //生成文件路径
    33.                 .fileOutputDir("f://temp//成本数据库产品化数据库设计文档")
    34.                 //打开目录
    35.                 .openOutputDir(true)
    36.                 //生成文件类型：HTML(配置多个，只会执行最后一个，PS:MD)
    37.                 .fileType(EngineFileType.HTML)
    38.                 .fileType(EngineFileType.WORD)
    39.                 .fileType(EngineFileType.MD)
    40.                 //生成模板实现
    41.                 .produceType(EngineTemplateType.freemarker)
    42.                 .build();
    44.         //忽略表
    45.         ArrayList<String> ignoreTableName = new ArrayList<>();
    46.         ignoreTableName.add("test_user");
    47.         ignoreTableName.add("test_group");
    48.         //忽略表前缀
    49.         ArrayList<String> ignorePrefix = new ArrayList<>();
    50.         ignorePrefix.add("test_");
    51.         //忽略表后缀
    52.         ArrayList<String> ignoreSuffix = new ArrayList<>();
    53.         ignoreSuffix.add("_test");
    54.         ProcessConfig processConfig = ProcessConfig.builder()
    55.                 //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
    56.                 //根据名称指定表生成
    57.                 .designatedTableName(new ArrayList<>())
    58.                 //根据表前缀生成
    59.                 .designatedTablePrefix(new ArrayList<>())
    60.                 //根据表后缀生成
    61.                 .designatedTableSuffix(new ArrayList<>())
    62.                 //忽略表名
    63.                 .ignoreTableName(ignoreTableName)
    64.                 //忽略表前缀
    65.                 .ignoreTablePrefix(ignorePrefix)
    66.                 //忽略表后缀
    67.                 .ignoreTableSuffix(ignoreSuffix).build();
    68.         //配置
    69.         Configuration config = Configuration.builder()
    70.                 //版本
    71.                 .version("1.0.0")
    72.                 //描述,文档名称
    73.                 .description("数据库设计文档生成")
    74.                 //数据源
    75.                 .dataSource(dataSource)
    76.                 //生成配置
    77.                 .engineConfig(engineConfig)
    78.                 //生成配置
    79.                 .produceConfig(processConfig)
    80.                 .build();
    81.         //执行生成
    82.         new DocumentationExecute(config).execute();
    84.     }
    85. }