数据库逆向一键生成数据字典/数据库设计文档

数据库逆向一键生成数据字典

效果图

废话不多说，先放效果图

html

word

markdown

简介与支持

使用screw开源项目帮助我们完成此任务

🚀 screw (螺丝钉) 英:[skruː] ~ 简洁好用的数据库表结构文档生成工具

简介

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人，于是萌生了要自己写一个插件工具的想法，但由于自己前期在程序设计上没有很多造诣，且能力偏低，有想法并不能很好实现，随着工作阅历的增加，和知识的不断储备，终于在2020年的3月中旬开始进行编写，4月上旬完成初版，想完善差不多在开源，但由于工作太忙，业余时间不足，没有在进行完善，到了6月份由于工作原因、频繁设计和更改数据库、经常使用自己写的此插件、节省了很多时间，解决了很多问题 ，在仅有且不多的业余时间中、进行开源准备，于2020年6月22日，开源，欢迎大家使用、建议、并贡献。
  关于名字，想一个太难了，好在我这个聪明的小脑瓜灵感一现，怎么突出它的小，但重要呢？从小就学过雷锋的螺丝钉精神，摘自雷锋日记：虽然是细小的螺丝钉，是个细微的小齿轮，然而如果缺了它，那整个的机器就无法运转了，慢说是缺了它，即使是一枚小螺丝钉没拧紧，一个小齿轮略有破损，也要使机器的运转发生故障的…，感觉自己写的这个工具，很有这意味，虽然很小、但是开发中缺了它还不行，于是便起名为screw（螺丝钉）。

特点

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

数据库支持

文档生成支持

使用步骤

• 创建springboot项目

  • 添加依赖包
    • spring web
    • jdbc
    • Mysql driver
    • Oracle driver

• 引入依赖

  • pom.xml

  <dependency>
      <groupId>cn.smallbun.screw</groupId>
      <artifactId>screw-core</artifactId>
      <version>1.0.3</version>
  </dependency>
  

• 修改数据库连接配置

  • application.properties

  spring.datasource.url=jdbc:mysql://localhost:3306/dbname?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
  spring.datasource.username=root
  spring.datasource.password=root
  

• 编写代码

  • screw_dbdic_gen/src/test/java/com/example/demo/TestdbfileApplicationTests.java

    @SpringBootTest
    public class TestdbfileApplicationTests {
        @Autowired
        ApplicationContext applicationContext;
        @Test
        void contextLoads() {
            DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);
    
            // 生成文件配置
            EngineConfig engineConfig = EngineConfig.builder()
                    // 生成文件路径
                    .fileOutputDir("/Users/seafyliang/DEV/Code_projects/Java_projects/screw_dbdic_gen/src/test/java/com/example/result")
                    // 打开目录
                    .openOutputDir(false)
                    // 文件类型(目前支持html、word、MD格式，个人体验后还是html格式生成后看起来比较舒服，建议使用)
                    .fileType(EngineFileType.WORD)
                    // 生成模板实现
                    .produceType(EngineTemplateType.freemarker).build();
    
            // 生成文档配置（包含以下自定义版本号、描述等配置连接）
            Configuration config = Configuration.builder()
                    .version("1.0.0")
                    .description("生成文档信息描述")
                    .dataSource(dataSourceMysql)
                    .engineConfig(engineConfig)
                    .produceConfig(getProcessConfig())
                    .build();
    
            // 执行生成
            new DocumentationExecute(config).execute();
        }
    
    
        /**
         * 配置想要生成的表+ 配置想要忽略的表
         * @return 生成表配置
         */
        public static ProcessConfig getProcessConfig(){
            // 忽略表名，需要忽略的表将表名放到list中即可
            List<String> ignoreTableName = Arrays.asList("aa","test_group");
            // 忽略表前缀，如忽略a开头的数据库表
            List<String> ignorePrefix = Arrays.asList("a","t");
            // 忽略表后缀
            List<String> ignoreSuffix = Arrays.asList("_test","czb_");
    
            return ProcessConfig.builder()
                    //根据名称指定表生成
                    .designatedTableName(new ArrayList<>())
                    //根据表前缀生成
                    .designatedTablePrefix(new ArrayList<>())
                    //根据表后缀生成
                    .designatedTableSuffix(new ArrayList<>())
                    //忽略表名
                    .ignoreTableName(ignoreTableName)
                    //忽略表前缀
                    .ignoreTablePrefix(ignorePrefix)
                    //忽略表后缀
                    .ignoreTableSuffix(ignoreSuffix).build();
        }
    }
    

• 运行代码

  • 运行测试类，即可成功在对应目录生成文档

源码

screw源码地址-码云

springboot-demo直接运行版

直接运行版下载后需要调整：1.数据库连接配置 2.生成文件目录