springboot+screw 轻松生成数据库设计文档

一、效果展示

1.1 WORD格式

1.2 HTML格式

还有一种格式是Markdown文件，这里就不展示了，感兴趣的小伙伴可以根据下面的方式去生成。

二、数据库设计文档

2.1 数据库设计文档是什么？

数据库设计文档的主要用途是记录和传达数据库的结构和设计细节。它包含了数据库的表结构、关系图、数据类型、主键、外键等信息，同时还可以包含一些额外的设计决策和约束。

2.2 使用它有什么好处？

1. 传达设计意图：数据库设计文档可以帮助开发人员、数据库管理员以及其他相关人员理解数据库的设计意图，包括表之间的关系、数据流、数据约束等。
2. 指导开发过程：数据库设计文档可以作为项目开发的指导，让开发人员按照预定的设计规范和准则进行开发，避免不必要的重复设计和数据冗余。
3. 维护和修改数据库：数据库设计文档可以作为维护和修改数据库的重要参考，开发人员可以根据文档了解数据库的结构和约束，从而快速进行修改、添加或删除表、字段等操作。
4. 数据库性能优化：数据库设计文档可以帮助开发人员识别潜在的性能问题，例如通过分析关系图和查询语句，进行索引优化、表分区等操作。
5. 数据库安全性：数据库设计文档可以用于审计和安全性评估，通过检查设计是否遵循安全性最佳实践，确保数据的安全性和合规性。

三、screw （螺丝钉）数据表结构文档生成工具

screw作者gitee

3.1 特点

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

3.2 数据库支持

• MySQL
• MariaDB
• TIDB
• Oracle
• SqlServer
• PostgreSQL
• Cache DB（2016）

四、SpringBoot整合screw使用

4.1 maven依赖

<dependencies>
		<!--SpringBoot相关依赖-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<!--screw 数据库文档生成-->
		<dependency>
			<groupId>cn.smallbun.screw</groupId>
			<artifactId>screw-core</artifactId>
			<version>1.0.5</version>
		</dependency>
		<!--mysql 驱动-->
		<dependency>
			<groupId>com.mysql</groupId>
			<artifactId>mysql-connector-j</artifactId>
			<version>8.0.33</version>
		</dependency>
		<!--连接池-->
		<dependency>
			<groupId>com.zaxxer</groupId>
			<artifactId>HikariCP</artifactId>
			<version>3.4.5</version>
		</dependency>
</dependencies>

4.2 测试代码

import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

@SpringBootTest
public class ScrewTest {

   @Test
   void generate() {
      // 生成文件配置
      EngineConfig engineConfig = EngineConfig.builder()
            // 生成文件路径，自己mac本地的地址，这里需要自己更换下路径
            .fileOutputDir("G:\\数据库字典")
            // 打开目录
            .openOutputDir(false)
            // 文件类型 HTML/WORD/MD 三种格式
            .fileType(EngineFileType.WORD)
            // 生成模板实现
            .produceType(EngineTemplateType.freemarker).build();
     
      //数据库名称
      String[] dbNames = {"admin"};
      for (String dbName : dbNames) {
      	 HikariDataSource hikariDataSource = new HikariDataSource();
         //设置数据库连接
         hikariDataSource.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/"+dbName+"?characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8&allowMultiQueries=true&allowPublicKeyRetrieval=true");
         hikariDataSource.setUsername("root");
         hikariDataSource.setPassword("root");
         // 生成文档配置（包含以下自定义版本号、描述等配置连接）
         Configuration config = Configuration.builder()
                 .version("1.0.1")
                 .description("数据库设计文档")
                 .dataSource(hikariDataSource)
                 .engineConfig(engineConfig)
                 .produceConfig(getProcessConfig())
                 .build();

         // 执行生成
         new DocumentationExecute(config).execute();
      }

   }

   /**
    * 配置想要生成的表+ 配置想要忽略的表
    * @return 生成表配置
    */
   public static ProcessConfig getProcessConfig(){
      // 忽略表名
      List<String> ignoreTableName = Arrays.asList("testa_testa","testb_testb");
      // 忽略表前缀
      List<String> ignorePrefix = Arrays.asList("testa","testb");
      // 忽略表后缀
      List<String> ignoreSuffix = Arrays.asList("_testa","_testb");
      return ProcessConfig.builder()
            //根据名称指定表生成 我需要生成所有表 这里暂时不设置
            .designatedTableName(new ArrayList<>())
            //根据表前缀生成 我需要生成所有表 这里暂时不设置
            .designatedTablePrefix(new ArrayList<>())
            //根据表后缀生成 我需要生成所有表 这里暂时不设置
            .designatedTableSuffix(new ArrayList<>())
            //忽略表名
            .ignoreTableName(ignoreTableName)
            //忽略表前缀
            .ignoreTablePrefix(ignorePrefix)
            //忽略表后缀
            .ignoreTableSuffix(ignoreSuffix).build();
   }
}

4.3 运行结果

感谢您的观看！如本文章对您有帮助，还请您给个三连，您的支持就是作者前进的最大动力！再次感谢！