还在手动整理数据库文档?试试这个工具

简介

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

screw 特点

  • 简洁、轻量、设计良好。不需要 powerdesigner 这种重量的建模工具
  • 多数据库支持 。支持市面常见的数据库类型 MySQL、Oracle、SqlServer
  • 多种格式文档。支持 MD、HTML、WORD 格式
  • 灵活扩展。支持用户自定义模板和展示样式

支持数据库类型

[✔️] MySQL
[✔️] MariaDB
[✔️] TIDB
[✔️] Oracle
[✔️] SqlServer
[✔️] PostgreSQL
[✔️] Cache DB

依赖

这里以 mysql8 数据库为例子

 <!--数据库文档核心依赖-->
  <dependency>
      <groupId>cn.smallbun.screw</groupId>
      <artifactId>screw-core</artifactId>
      <version>1.0.2</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>

1. 通过自定义代码配置文档生成

@Test
public void shouldAnswerWithTrue() {
    //数据源
    HikariConfig hikariConfig = new HikariConfig();
    hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
    hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/test");
    hikariConfig.setUsername("root");
    hikariConfig.setPassword("root");
    //设置可以获取tables remarks信息
    hikariConfig.addDataSourceProperty("useInformationSchema", "true");
    hikariConfig.setMinimumIdle(2);
    hikariConfig.setMaximumPoolSize(5);
    DataSource dataSource = new HikariDataSource(hikariConfig);
    //生成配置
    EngineConfig engineConfig = EngineConfig.builder()
            //生成文件路径
            .fileOutputDir("/Users/lengleng")
            //打开目录
            .openOutputDir(true)
            //文件类型
            .fileType(EngineFileType.HTML)
            //生成模板实现
            .produceType(EngineTemplateType.freemarker).build();

    //忽略表
    ArrayList<String> ignoreTableName = new ArrayList<>();
    ignoreTableName.add("test_user");
    ignoreTableName.add("test_group");
    //忽略表前缀
    ArrayList<String> ignorePrefix = new ArrayList<>();
    ignorePrefix.add("test_");
    //忽略表后缀
    ArrayList<String> ignoreSuffix = new ArrayList<>();
    ignoreSuffix.add("_test");
    ProcessConfig processConfig = ProcessConfig.builder()
            //忽略表名
            .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();
}

2. 通过插件的形式生成文档

<build>
    <plugins>
        <plugin>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-maven-plugin</artifactId>
            <version>1.0.2</version>
            <dependencies>
                <!-- 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>
            </dependencies>
            <configuration>
                <!--username-->
                <username>root</username>
                <!--password-->
                <password>root</password>
                <!--driver-->
                <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
                <!--jdbc url-->
                <jdbcUrl>jdbc:mysql://127.0.0.1:3306/test</jdbcUrl>
                <!--生成文件类型-->
                <fileType>HTML</fileType>
                <!--文件输出目录-->
                <fileOutputDir>/Users/lengleng</fileOutputDir>
                <!--打开文件输出目录-->
                <openOutputDir>false</openOutputDir>
                <!--生成模板-->
                <produceType>freemarker</produceType>
                <!--描述-->
                <description>数据库文档生成</description>
                <!--版本-->
                <version>${project.version}</version>
                <!--标题-->
                <title>数据库文档</title>
            </configuration>
            <executions>
                <execution>
                    <phase>compile</phase>
                    <goals>
                        <goal>run</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

image

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: 数据库设计文档自动生成工具.rar是一个能够自动化生成数据库设计文档工具。它能够根据数据库中的结构信息和各个表之间的关系,快速生成详细的文档,包括表结构、表之间的关系、索引、约束等信息。 通过这个工具,我们可以方便地查看和理解数据库的结构,了解各个表的字段定义和类型,以及它们之间的关系。这对于数据库管理员和开发人员来说非常有用,可以帮助他们更加系统地管理和开发数据库。 生成的文档可以以多种格式保存,例如HTML、PDF等,方便我们通过浏览器、微信等工具来查看和分享。而且这个工具还支持自定义模板,我们可以根据需要调整文档的样式和布局。 此外,生成的文档还可以包含一些辅助信息,例如表和字段的注释、最后修改时间等,方便我们更好地了解数据库的设计意图和变更历史。 总之,数据库设计文档自动生成工具.rar是一个方便实用的工具,能够帮助我们快速生成数据库设计文档,并提供了多种格式和自定义模板的支持,使得数据库的管理和开发更加高效和便捷。 ### 回答2: 数据库设计文档自动生成工具.rar是一种方便快捷的工具,用于自动生成数据库设计文档。当我们进行数据库设计时,通常需要编写相应的文档来记录数据库的结构、表的字段、关系等信息,以便后续的开发和维护工作。传统的编写文档方式相对繁琐,并且容易出错,因此这个自动生成工具的出现,可以大大提高我们的工作效率。 这个工具.rar的设计原理是通过解析数据库的元数据信息来生成文档。在使用之前,我们需要提供数据库的连接信息,包括数据库类型、地址、用户名和密码等。工具中内置了多种常见的数据库类型的解析器,因此可以应对各种不同类型的数据库。一旦连接成功,工具会自动读取数据库中的表、字段、约束等信息,并根据指定的模板生成相应的文档工具的使用非常简单,只需几个步骤即可完成生成。首先,我们需要选择合适的数据库类型,并填写相关的连接信息。然后,选择合适的文档模板,可以根据实际需求进行自定义。接下来,点击生成按钮,工具会自动解析数据库中的元数据,并根据模板生成文档。生成的文档可以导出为各种格式,如Word、PDF等,以方便我们进行查阅和共享。 使用这个自动生成工具,可以极大地简化我们编写数据库设计文档的工作。它不仅提高了工作效率,还减少了出错的可能性。另外,它还具有良好的可扩展性,可以根据实际需求进行定制和扩展,以满足不同项目的需求。 总之,数据库设计文档自动生成工具.rar是一款非常实用的工具,它的出现极大地方便了我们的工作,提高了工作效率,并使我们的数据库设计文档更加准确和规范。 ### 回答3: 数据库设计文档自动生成工具.rar是一个能够自动创建数据库设计文档的软件工具。该工具可帮助开发人员在数据库设计过程中节省时间和精力。 数据库设计是软件开发过程中非常重要的一环,通过将需求转化为数据库模型,能够有效地组织和存储数据,提高系统性能和可扩展性。然而,手动编写数据库设计文档通常是繁琐且易出错的。而这个自动生成工具的出现,可以极大地简化和加速这个过程。 使用数据库设计文档自动生成工具.rar,开发人员只需按照一定的规范和要求进行数据库模型的设计,然后通过工具选择所需的文档格式和样式,点击生成按钮,即可生成符合规范的数据库设计文档。这个工具会自动提取数据库模型中的各种信息,例如表名、字段名、数据类型、约束条件、索引等,并将其整理为表格、图表或者文本等形式,以便用户查阅和理解。 该工具具有以下主要特点和优势: 1. 灵活配置:用户可以根据自己的需求来配置生成文档的样式和格式,以及指定需要包含的信息。 2. 自动化生成:工具能够自动从数据库中提取数据模型,并根据预设的规则和模板生成文档,避免了手动编写的繁琐和出错的过程。 3. 统一规范:通过使用该工具,开发人员可以统一团队的数据库设计文档规范,便于不同开发人员之间的交流和协作。 4. 提高效率:相比手动编写文档,使用该工具能够大大提高数据库设计的效率,节省时间和精力。 综上所述,数据库设计文档自动生成工具.rar是一个功能强大且方便实用的工具,能够帮助开发人员在数据库设计过程中更高效地生成规范的设计文档,提高开发效率和质量。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值