• screw 一个简洁好用的数据库表结构文档生成工具

    目录

    一：基本概念

    名称由来：

    特点：  

    数据库支持

    文档生成支持类型

    二：使用操作

    方式一：普通方式

            ①：准备一个基本的maven项目

            ②：引入依赖

    方式二：Maven 插件

           在添加以上的依赖之后，再添加以下代码即可

    三：总结

    一：基本概念

         在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人，就对于这个问题，有一位程序猿大佬以此设置了一个开源的插件工具，来解决这些问题，并造福大家

        

    • 名称由来：

               从小就学过雷锋的螺丝钉精神，摘自雷锋日记：虽然是细小的螺丝钉，是个细微的小齿轮，然而如果缺了它，那整个的机器就无法运转了，慢说是缺了它，即使是一枚小螺丝钉没拧紧，一个小齿轮略有破损，也要使机器的运转发生故障的，这个工具，很有这意味，虽然很小、但是开发中缺了它还不行，于是便起名为screw（螺丝钉）

     

    • 特点：  

    1. 简洁、轻量、设计良好

    2. 多数据库支持

    3. 多种格式文档

    4. 灵活扩展

    5. 支持自定义模板

    • 数据库支持

    1. MySQL
    2. MariaDB
    3. TIDB
    4. Oracle
    5. SqlServer
    6. PostgreSQL


    • 文档生成支持类型

    1. html
    2. word
    3. markdown

    二：使用操作

    • 方式一：普通方式

            ①：准备一个基本的maven项目

            ②：引入依赖

    1.  
    2.     <dependency>
    3.       <groupId>cn.smallbun.screwgroupId>
    4.       <artifactId>screw-coreartifactId>
    5.       <version>1.0.4version>
    6.     dependency>

        ps：由于我在这里使用的是mysql数据库，所以还需要mysql的依赖

    1.  
    2.     <dependency>
    3.       <groupId>mysqlgroupId>
    4.       <artifactId>mysql-connector-javaartifactId>
    5.       <version>8.0.20version>
    6.     dependency>
    7.   dependencies>

       注意：普通方式实现需要引入以下依赖，方便测试代码中的方法功能可以实现

    1. <dependency>
    2.       <groupId>com.zaxxergroupId>
    3.       <artifactId>HikariCPartifactId>
    4.       <version>3.4.5version>
    5.     dependency>

                 HikariCP 是一个高性能的 JDBC 连接池组件，号称性能最好的后起之秀，是一个基于BoneCP做了不少的改进和优化的高性能JDBC连接池。

    完整pom.xml文件代码如下：

    1. "1.0" encoding="UTF-8"?>
    2.  
    3. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    5.   <modelVersion>4.0.0modelVersion>
    6.  
    7.   <groupId>com.tangyuangroupId>
    8.   <artifactId>code-generatorartifactId>
    9.   <version>1.0-SNAPSHOTversion>
    10.   <packaging>warpackaging>
    11.  
    12.   <name>code-generator Maven Webappname>
    13.   
    14.   <url>http://www.example.comurl>
    15.  
    16.   <properties>
    17.     <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
    18.     <maven.compiler.source>1.8maven.compiler.source>
    19.     <maven.compiler.target>1.8maven.compiler.target>
    20.     <tomcat.version>8.5tomcat.version>
    21.   properties>
    22.  
    23. <dependencies>
    24.     <dependency>
    25.       <groupId>junitgroupId>
    26.       <artifactId>junitartifactId>
    27.       <version>4.11version>
    28.       <scope>testscope>
    29.     dependency>
    30.     
    31.     <dependency>
    32.       <groupId>cn.smallbun.screwgroupId>
    33.       <artifactId>screw-coreartifactId>
    34.       <version>1.0.4version>
    35.     dependency>
    36.  
    37.     
    38.   <dependency>
    39.       <groupId>com.zaxxergroupId>
    40.       <artifactId>HikariCPartifactId>
    41.       <version>3.4.5version>
    42.     dependency>
    43.  
    44.     
    45.     <dependency>
    46.       <groupId>mysqlgroupId>
    47.       <artifactId>mysql-connector-javaartifactId>
    48.       <version>8.0.20version>
    49.     dependency>
    50.   dependencies>
    51.  
    52.   <build>
    53.     <plugins>
    54.       <plugin>
    55.         <groupId>org.apache.maven.pluginsgroupId>
    56.         <artifactId>maven-clean-pluginartifactId>
    57.         <version>3.0.0version>
    58.       plugin>
    59.       <plugin>
    60.         <groupId>cn.smallbun.screwgroupId>
    61.         <artifactId>screw-maven-pluginartifactId>
    62.         <version>1.0.4version>
    63.         <dependencies>
    64.           
    65.           <dependency>
    66.           <groupId>com.zaxxergroupId>
    67.           <artifactId>HikariCPartifactId>
    68.           <version>3.4.5version>
    69.         dependency>
    70.           
    71.           <dependency>
    72.             <groupId>mysqlgroupId>
    73.             <artifactId>mysql-connector-javaartifactId>
    74.             <version>8.0.20version>
    75.           dependency>
    76.           <dependency>
    77.             <groupId>cn.smallbun.screwgroupId>
    78.             <artifactId>screw-coreartifactId>
    79.             <version>1.0.4version>
    80.           dependency>
    81.         dependencies>
    82.       plugin>
    83.     plugins>
    84.   build>
    85. project>

        ③：编写一个测试代码，并设置好主程序入口

    1. package test;
    2.  
    3. import cn.smallbun.screw.core.Configuration;
    4. import cn.smallbun.screw.core.engine.EngineConfig;
    5. import cn.smallbun.screw.core.engine.EngineFileType;
    6. import cn.smallbun.screw.core.engine.EngineTemplateType;
    7. import cn.smallbun.screw.core.execute.DocumentationExecute;
    8. import cn.smallbun.screw.core.process.ProcessConfig;
    9. import com.zaxxer.hikari.HikariConfig;
    10. import com.zaxxer.hikari.HikariDataSource;
    11.  
    12. import javax.sql.DataSource;
    13. import java.util.ArrayList;
    14.  
    15. /**
    16.  * @author 唐渊
    17.  * @create  2022-08-01 11:38
    18.  */
    19. public class test {
    20.  
    21.     public static void main(String[] args) {
    22.             //数据源
    23.             HikariConfig hikariConfig = new HikariConfig();
    24.             hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
    25.             hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/medical?serverTimezone=GMT%2B8");
    26.             hikariConfig.setUsername("root");
    27.             hikariConfig.setPassword("1234");
    28.             //设置可以获取tables remarks信息
    29.             hikariConfig.addDataSourceProperty("useInformationSchema", "true");
    30.             hikariConfig.setMinimumIdle(2);
    31.             hikariConfig.setMaximumPoolSize(5);
    32.             DataSource dataSource = new HikariDataSource(hikariConfig);
    33.             //生成配置
    34.             EngineConfig engineConfig = EngineConfig.builder()
    35.                     //生成文件路径
    36.                     .fileOutputDir("C:\\Users\\Administrator\\Desktop\\数据表文档\\")//数据导出的地址
    37.                     //打开目录
    38.                     .openOutputDir(true)
    39.                     //文件类型
    40.                    // .fileType(EngineFileType.HTML)
    41.                     //.fileType(EngineFileType.WORD)
    42.                     .fileType(EngineFileType.MD)
    43.                     //生成模板实现
    44.                     .produceType(EngineTemplateType.freemarker).build();
    45.                     //自定义文件名称
    46.                     //.fileName("自定义文件名称").build();
    47.  
    48.             //忽略表
    49.             ArrayList ignoreTableName = new ArrayList<>();
    50.             ignoreTableName.add("test_user");
    51.             ignoreTableName.add("test_group");
    52.             //忽略表前缀
    53.             ArrayList ignorePrefix = new ArrayList<>();
    54.             ignorePrefix.add("test_");
    55.             //忽略表后缀
    56.             ArrayList ignoreSuffix = new ArrayList<>();
    57.             ignoreSuffix.add("_test");
    58.             ProcessConfig processConfig = ProcessConfig.builder()
    59.                     //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
    60.                     //根据名称指定表生成
    61.                     .designatedTableName(new ArrayList<>())
    62.                     //根据表前缀生成
    63.                     .designatedTablePrefix(new ArrayList<>())
    64.                     //根据表后缀生成
    65.                     .designatedTableSuffix(new ArrayList<>())
    66.                     //忽略表名
    67.                     .ignoreTableName(ignoreTableName)
    68.                     //忽略表前缀
    69.                     .ignoreTablePrefix(ignorePrefix)
    70.                     //忽略表后缀
    71.                     .ignoreTableSuffix(ignoreSuffix).build();
    72.             //配置
    73.             Configuration config = Configuration.builder()
    74.                     //版本
    75.                     .version("1.0.0")
    76.                     //描述
    77.                     .description("数据库设计文档生成")
    78.                     //数据源
    79.                     .dataSource(dataSource)
    80.                     //生成配置
    81.                     .engineConfig(engineConfig)
    82.                     //生成配置
    83.                     .produceConfig(processConfig)
    84.                     .build();
    85.             //执行生成
    86.             new DocumentationExecute(config).execute();
    87.     }
    88.  
    89.  
    90.         /**ps:
    91.          * java.sql.SQLException: The server time zone value
    92.          * 是由于我们默认的时区比东八区少了八个小时。
    93.          * 在使用的项目中，设计到数据库的信息时，在url中 加入：?serverTimezone=GMT%2B8
    94.          */
    95.  
    96.         /**
    97.          * screw - Exception during pool initialization.
    98.          */
    99. }

       

    测试结果：

    • html类型

    • word类型

     

    • markdwon类型

    • 方式二：Maven 插件

           在添加以上的依赖之后，再添加以下代码即可

    1.  
    2.  
    3.         
    4.   <build>
    5.     <plugins>
    6.       <plugin>
    7.         <groupId>cn.smallbun.screwgroupId>
    8.         <artifactId>screw-maven-pluginartifactId>
    9.         <version>1.0.4version>
    10.         <dependencies>
    11.           
    12.           <dependency>
    13.             <groupId>com.zaxxergroupId>
    14.             <artifactId>HikariCPartifactId>
    15.             <version>3.4.5version>
    16.           dependency>
    17.           
    18.           <dependency>
    19.             <groupId>mysqlgroupId>
    20.             <artifactId>mysql-connector-javaartifactId>
    21.             <version>8.0.20version>
    22.           dependency>
    23.         dependencies>
    24.         <configuration>
    25.           
    26.           <username>rootusername>
    27.           
    28.           <password>1234password>
    29.           
    30.           <driverClassName>com.mysql.cj.jdbc.DriverdriverClassName>
    31.           
    32.           <jdbcUrl>jdbc:mysql://127.0.0.1:3306/db_shopping?serverTimezone=GMT%2B8jdbcUrl>
    33.           
    34.           <fileType>WORDfileType>
    35.           
    36.           <openOutputDir>falseopenOutputDir>
    37.           
    38.           <produceType>freemarkerproduceType>
    39.           
    40.           <fileName>fileName>
    41.           
    42.           <description>数据库文档生成description>
    43.           
    44.           <version>${project.version}version>
    45.           
    46.           <title>数据库文档title>
    47.         configuration>
    48.         <executions>
    49.           <execution>
    50.             <phase>compilephase>
    51.             <goals>
    52.               <goal>rungoal>
    53.             goals>
    54.           execution>
    55.         executions>
    56.       plugin>
    57.     plugins>
    58.   build>

              与普通方式不同，maven插件的运行方式是不相同的，运行方式如下：

     

     

               可以点击，在当前面板查看，也可以找到项目的存放文件，进行查看

    三：总结

            screw是一个不错的插件，可以很轻松的解决数据库表结构文档文件，各位大佬如果有兴趣的话，可以阅读阅读探索探索，欢迎各位大佬前来斧正

        

     

  • 相关阅读:
    Android和Linux的开发差异
    HTML换行标签是什么 - 编程
    LINUX网络FTP服务
    【WINDOWS / DOS 批处理】关于标签的执行流程
    云原生平台，让边缘应用玩出花！
    当年的java考试：Java景区预约登记管理系统(maven整合servlet)
    数据结构-静态链表创建
    国家加快培育数据要素市场的重要意义是什么
    Kotlin学习笔记（1）-- 基础语法
    ros2与turtlebot3仿真教程-turtlebot3导航
  • 原文地址：https://blog.csdn.net/qq_61313896/article/details/126394205