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

最新推荐文章于 2024-09-11 17:01:55 发布

book多得

最新推荐文章于 2024-09-11 17:01:55 发布

阅读量837

点赞数 1

分类专栏：学习日记文章标签： java 数据库 mybatis mysql 后端

本文链接：https://blog.csdn.net/qq_63815371/article/details/126346416

版权

学习日记专栏收录该内容

45 篇文章 0 订阅

订阅专栏

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

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

Gitee地址：
screw: 简洁好用的数据库表结构文档工具，支持MySQL/MariaDB/SqlServer/Oracle/PostgreSQL/TIDB/CacheDB 数据库。https://gitee.com/leshalv/screw

话不多说直接上代码

一、必备依赖

        <!-- 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>
        
        <!-- HikariCP -->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>

        <!--mysql driver-->
        <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;
    }