一键生成数据库文档大利器

征尘bjajmd

已于 2024-09-11 17:04:06 修改

阅读量917

点赞数 12

文章标签： mysql

于 2024-09-11 17:01:55 首次发布

本文链接：https://blog.youkuaiyun.com/y19910825/article/details/142144800

版权

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人，于是萌生了要自己写一个插件工具的想法。

关于名字，想一个太难了，好在我这个聪明的小脑瓜灵感一现，怎么突出它的小，但重要呢？从小就学过雷锋的螺丝钉精神，摘自雷锋日记：虽然是细小的螺丝钉，是个细微的小齿轮，然而如果缺了它，那整个的机器就无法运转了，慢说是缺了它，即使是一枚小螺丝钉没拧紧，一个小齿轮略有破损，也要使机器的运转发生故障的...

感觉自己写的这个工具，很有这意味，虽然很小、但是开发中缺了它还不行，于是便起名为screw（螺丝钉）。

特点

简洁、轻量、设计良好
多数据库支持
多种格式文档
灵活扩展
支持自定义模板

文档生成支持

html
word
markdown

文档截图

html

图片

word

markdwon

图片

使用方式

普通方式

引入依赖

    
    cn.smallbun.screw    
    screw-core    
    ${lastVersion}

编写代码

/**    
 * 文档生成    
 */    
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 ignoreTableName = new ArrayList<>();    
   ignoreTableName.add("test_user");    
   ignoreTableName.add("test_group");    
   //忽略表前缀    
   ArrayList ignorePrefix = new ArrayList<>();    
   ignorePrefix.add("test_");    
   //忽略表后缀        
   ArrayList 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();    
}

Maven 插件

    
        
            
            cn.smallbun.screw    
            screw-maven-plugin    
            ${lastVersion}    
                
                    
                    
                    com.zaxxer    
                    HikariCP    
                    3.4.5    
                    
                    
                    
                    mysql    
                    mysql-connector-java    
                    8.0.20    
                    
                
                
                    
                root    
                    
                password    
                    
                com.mysql.cj.jdbc.Driver    
                    
                jdbc:mysql://127.0.0.1:3306/xxxx    
                    
                HTML    
                    
                false    
                    
                freemarker    
                    
                测试文档名称    
                    
                数据库文档生成    
                    
                ${project.version}    
                    
                    
                
                
                    
                    compile    
                        
                        run

扩展模块

pojo生成功能

功能简介

pojo生成功能是基于screw延伸出的扩展模块,目前处于初步开发的状态。在日常的开发中,经过需求分析、建模之后,往往会先在数据库中建表,其次在进行代码的开发。

那么pojo生成功能在这个阶段就可以帮助大家节省一些重复劳动了。使用pojo生成功能可以直接根据数据库生成对应的java pojo对象。这样后续的修改，开发都会很方便。

数据库支持

MySQL

使用方式

引入依赖

    
    cn.smallbun.screw    
    screw-extension    
    ${lastVersion}

编写代码

/**    
 * pojo生成    
 */    
void pojoGeneration() {    
    //数据源    
    HikariConfig hikariConfig = new HikariConfig();    
    hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");    
    hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/screw");    
    hikariConfig.setUsername("screw");    
    hikariConfig.setPassword("screw");    
    //设置可以获取tables remarks信息    
    hikariConfig.addDataSourceProperty("useInformationSchema", "true");    
    hikariConfig.setMinimumIdle(2);    
    hikariConfig.setMaximumPoolSize(5);    
    DataSource dataSource = new HikariDataSource(hikariConfig);    
    
    ProcessConfig processConfig = ProcessConfig.builder()    
        //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置    
        //根据名称指定表生成    
        .designatedTableName(new ArrayList<>())    
        //根据表前缀生成    
        .designatedTablePrefix(new ArrayList<>())    
        //根据表后缀生成    
        .designatedTableSuffix(new ArrayList<>()).build();    
    
    //设置生成pojo相关配置    
    PojoConfiguration config = new PojoConfiguration();    
    //设置文件存放路径    
    config.setPath("/cn/smallbun/screw/");    
    //设置包名    
    config.setPackageName("cn.smallbun.screw");    
    //设置是否使用lombok    
    config.setUseLombok(false);    
    //设置数据源    
    config.setDataSource(dataSource);    
    //设置命名策略    
    config.setNameStrategy(new HumpNameStrategy());    
    //设置表过滤逻辑    
    config.setProcessConfig(processConfig);    
    //执行生成    
    new PojoExecute(config).execute();    
}

常见问题

1.生成后文档乱码？

MySQL：URL加入?characterEncoding=UTF-8。

2.Caused by: java.lang.NoSuchFieldError: VERSION_2_3_30？

检查项目freemarker依赖，这是由于版本过低造成的，升级版本为2.3.30即可。

3.java.lang.AbstractMethodError: oracle.jdbc.driver.T4CConnection.getSchema()Ljava/lang/String;

这是因为oracle驱动版本过低造成的，删除或屏蔽目前驱动版本，驱动添加升级为以下版本：

    
   com.oracle.ojdbc    
   ojdbc8    
   19.3.0.0    
    
    
   cn.easyproject    
   orai18n    
   12.1.0.2.0

4.MySQL数据库表和列字段有说明、生成文档没有说明？

URL链接加入useInformationSchema=true即可。

5.java.lang.AbstractMethodError: com.mysql.jdbc.JDBC4Connection.getSchema()Ljava/lang/String;

这是因为mysql驱动版本过低造成的，升级mysql驱动版本为最新即可。

项目地址

转自

https://jishu.proginn.com/doc/791964778bacc1b5e

https://gitee.com/leshalv/screw