数据库表结构文档生成工具-SCREW快速上手（详解）

客官°小女子只卖身不卖艺 2024-03-30 17:41 25阅读 0赞

### **简介** ###

简洁好用的数据库表结构文档生成工具

### **特点** ###

*  简洁、轻量、设计良好

*  多数据库支持

*  多种格式文档

*  灵活扩展

*  支持自定义模板

### **数据库支持** ###

MySQL

MariaDB

TIDB

Oracle

SqlServer

PostgreSQL

Cache DB（2016）

### **文档生成支持** ###

html

word

markdown

### **文档截图** ###

*  **html**

![f72469e90c84b2836515d47cb90a1c58.png][]

![745e55a266e36ae2115c56866416e050.png][]

*  **word**

![6bbfbf6e3ee35c4c18bc4c0b3cfc5597.png][]

*  **markdwon**

![72084ff4c2babf9f86d7e45faac04208.png][]

![5e49a9384710e4d897de811725446c11.png][]

### **使用方式** ###

*  **引入依赖**

<dependency>
        <groupId>cn.smallbun.screw</groupId>
        <artifactId>screw-core</artifactId>
        <version>${lastVersion}</version>
     </dependency>

*  **编写代码**

/**
     * 文档生成
     */
    void documentGeneration() {
       //数据源
       HikariConfig hikariConfig = new HikariConfig();
       hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
       hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database");
       hikariConfig.setUsername("root");
       hikariConfig.setPassword("password");
       //设置可以获取tables remarks信息
       hikariConfig.addDataSourceProperty("useInformationSchema", "true");
       hikariConfig.setMinimumIdle(2);
       hikariConfig.setMaximumPoolSize(5);
       DataSource dataSource = new HikariDataSource(hikariConfig);
       //生成配置
       EngineConfig engineConfig = EngineConfig.builder()
             //生成文件路径
             .fileOutputDir(fileOutputDir)
             //打开目录
             .openOutputDir(true)
             //文件类型
             .fileType(EngineFileType.HTML)
             //生成模板实现
             .produceType(EngineTemplateType.freemarker)
             //自定义文件名称
             .fileName("自定义文件名称").build();
    
       //忽略表
       ArrayList<String> ignoreTableName = new ArrayList<>();
       ignoreTableName.add("test_user");
       ignoreTableName.add("test_group");
       //忽略表前缀
       ArrayList<String> ignorePrefix = new ArrayList<>();
       ignorePrefix.add("test_");
       //忽略表后缀    
       ArrayList<String> ignoreSuffix = new ArrayList<>();
       ignoreSuffix.add("_test");
       ProcessConfig processConfig = ProcessConfig.builder()
             //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置    
             //根据名称指定表生成
             .designatedTableName(new ArrayList<>())
             //根据表前缀生成
             .designatedTablePrefix(new ArrayList<>())
             //根据表后缀生成    
             .designatedTableSuffix(new ArrayList<>())
             //忽略表名
             .ignoreTableName(ignoreTableName)
             //忽略表前缀
             .ignoreTablePrefix(ignorePrefix)
             //忽略表后缀
             .ignoreTableSuffix(ignoreSuffix).build();
       //配置
       Configuration config = Configuration.builder()
             //版本
             .version("1.0.0")
             //描述
             .description("数据库设计文档生成")
             //数据源
             .dataSource(dataSource)
             //生成配置
             .engineConfig(engineConfig)
             //生成配置
             .produceConfig(processConfig)
             .build();
       //执行生成
       new DocumentationExecute(config).execute();
    }

根据自己情况修改documentGeneration()方法：

1.  设置数据源

HikariConfig hikariConfig = new HikariConfig();hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/db_gjsp");hikariConfig.setUsername("root");hikariConfig.setPassword("root");

1.  自定义配置信息

EngineConfig engineConfig = EngineConfig.builder()                //生成文件路径                .fileOutputDir("E:\\")                //打开目录                .openOutputDir(true)                //文件类型                .fileType(EngineFileType.MD)                //生成模板实现                .produceType(EngineTemplateType.freemarker)                //自定义文件名称                .fileName("db_gjsp数据库文档").build();

1.  启动项目，生成文件！

[f72469e90c84b2836515d47cb90a1c58.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/75e199bc3b9847079eb9b93fac13fc85.png
[745e55a266e36ae2115c56866416e050.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/3e4add746ca74a199ba6cf955036738f.png
[6bbfbf6e3ee35c4c18bc4c0b3cfc5597.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/37634b114aeb4c0f8365df0e6268eb92.png
[72084ff4c2babf9f86d7e45faac04208.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/6bc4a56b6aa44759a6ffa4b071044690.png
[5e49a9384710e4d897de811725446c11.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/8c29f661ef5046c28afc3e5c1e28fc6a.png