JAVA一键生成数据库（ HTML、DOC、MD）文档

偏执的太偏执、 2024-04-08 08:44 67阅读 0赞

日常的开发工作中，经常会和数据库打交道，在某些场景可能会需要数据库表结构的文档，今天分享个简洁好用的数据库表结构文档生成工具screw。

screw目前支持MySQL、Oracle、SqlServer、MariaDB、PostgreSQL等数据库，生成文档目前支持html、word、markdown文档格式。

Gitee地址：  
[screw: 简洁好用的数据库表结构文档工具，支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB 数据库。![favicon-9007bd527d8a7851c8330e783151df58.ico][]https://gitee.com/leshalv/screw][screw_ _MySQL_MariaDB_SqlServer_Oracle_PostgreSQL_TIDB_CacheDB _favicon-9007bd527d8a7851c8330e783151df58.ico_https_gitee.com_leshalv_screw]

话不多说直接上代码

## 一、必备依赖 ##

<dependency>
                <groupId>cn.smallbun.screw</groupId>
                <artifactId>screw-core</artifactId>
                <version>1.0.3</version>
            </dependency>
    
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
                <version>2.3.30</version>
            </dependency>
            
            
            <dependency>
                <groupId>com.zaxxer</groupId>
                <artifactId>HikariCP</artifactId>
                <version>3.4.5</version>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.20</version>
            </dependency>

## 二、使用代码 ##

public void contextLoads() {
            HikariDataSource hikariDataSource = getHikariDataSource();
            // 生成文件配置
            EngineConfig engineConfig = EngineConfig.builder()
                    // 生成文件路径，自己mac本地的地址，这里需要自己更换下路径
                    .fileOutputDir("D:/test/")
                    // 打开目录
                    .openOutputDir(false)
                    // 文件类型
                    .fileType(EngineFileType.WORD)
                    // 生成模板实现
                    .produceType(EngineTemplateType.freemarker).build();
            // 生成文档配置（包含以下自定义版本号、描述等配置连接）
            Configuration config = Configuration.builder()
                    .version("1.0.3")
                    .description("生成文档信息描述")
                    .dataSource(hikariDataSource)
                    .engineConfig(engineConfig)
                    .produceConfig(getProcessConfig())
                    .build();
            // 执行生成
            new DocumentationExecute(config).execute();
        }
    
        /**
         * 配置想要生成的表+ 配置想要忽略的表
         *
         * @return 生成表配置
         */
        public static ProcessConfig getProcessConfig() {
            // 忽略表名
            List<String> ignoreTableName = Arrays.asList("a", "test_group");
            // 忽略表前缀，如忽略a开头的数据库表
            List<String> ignorePrefix = Arrays.asList("a", "t");
            // 忽略表后缀
            List<String> ignoreSuffix = Arrays.asList("_test", "czb_");
            return ProcessConfig.builder()
    //                //根据名称指定表生成
    //                .designatedTableName(Arrays.asList("fire_user"))
    //                //根据表前缀生成
    //                .designatedTablePrefix(new ArrayList<>())
    //                //根据表后缀生成
    //                .designatedTableSuffix(new ArrayList<>())
    //                //忽略表名
    //                .ignoreTableName(ignoreTableName)
    //                //忽略表前缀
    //                .ignoreTablePrefix(ignorePrefix)
    //                //忽略表后缀
    //                .ignoreTableSuffix(ignoreSuffix)
                    .build();
        }
    
        private HikariDataSource getHikariDataSource() {
            HikariDataSource hikariDataSource = new HikariDataSource();
            hikariDataSource.setDriverClassName("com.mysql.jdbc.Driver");
            hikariDataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/hesb_v2.0?useUnicode=true&characterEncoding=UTF-8&useSSL=false");
            hikariDataSource.setUsername("root");
            hikariDataSource.setPassword("root");
    
            return hikariDataSource;
        }

## 三、成果展示 ##

### 1.html ###

![04f2ea115c4249a6b3df9233a1a75540.png][]

### 2.markdown ###

![1b487524a0d84caa912d36042556cb34.png][]

### 3.word ###

![fb2f5420544c4b38be62a697c791f0da.png][]

[favicon-9007bd527d8a7851c8330e783151df58.ico]: https://cn-assets.gitee.com/assets/favicon-9007bd527d8a7851c8330e783151df58.ico
[screw_ _MySQL_MariaDB_SqlServer_Oracle_PostgreSQL_TIDB_CacheDB _favicon-9007bd527d8a7851c8330e783151df58.ico_https_gitee.com_leshalv_screw]: https://gitee.com/leshalv/screw
[04f2ea115c4249a6b3df9233a1a75540.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/aa49f1edd0d745279f81153306f300a9.png
[1b487524a0d84caa912d36042556cb34.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d6557ac919ea4c1db7d99bc0a6c8287c.png
[fb2f5420544c4b38be62a697c791f0da.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/982ba0f37ec14a949b583b627fd2b8e7.png