数据库文档生成工具- screw

2020-09-15 10:07:51 浏览数 (1)

简洁好用的数据库表结构文档工具 gitee: https://gitee.com/sanri/sanri-tools-maven cnblog:https://www.cnblogs.com/sanri1993/p/13303630.html

简介

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

特点

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

数据库支持

  • MySQL
  • MariaDB
  • TIDB
  • Oracle
  • SqlServer
  • PostgreSQL
  • Cache
  • H2
  • DB2

文档生成支持

  • html
  • word
  • markdwon

例子

这里以 oracle 数据库为例子

添加依赖

代码语言：javascript复制
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>sql-document</artifactId>
    <version>1.0-SNAPSHOT</version>

    <description>screw 数据库文档生成工具示例</description>

    <dependencies>
        <!--数据库文档核心依赖-->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.4</version>
        </dependency>

        <!-- HikariCP -->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>

        <!-- Oracle -->
        <dependency>
            <groupId>com.oracle</groupId>
            <artifactId>ojdbc8</artifactId>
            <version>12.2.0.1</version>
        </dependency>

        <!-- 模板 -->
        <dependency>
            <groupId>freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.8</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!-- 指定jdk -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

配置文档生成

代码语言：javascript复制
package com.ray.document;

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.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import javax.sql.DataSource;
import java.util.ArrayList;

/**
 * @Description: 生成文档
 * @Author Ray
 * @Date 2020/8/17 0017 11:03
 * @Version 1.0
 */
public class GenDocument {

    public static void main(String[] args) {
        GenDocument genDocument = new GenDocument();
        genDocument.documentGeneration();
    }

    /**
     * 文档生成
     */
    void documentGeneration() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("oracle.jdbc.driver.OracleDriver");
        hikariConfig.setJdbcUrl("jdbc:oracle:thin:@127.0.0.1:1521:orcl");
        hikariConfig.setUsername("ztfx_0903");
        hikariConfig.setPassword("ztfx_0903");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("D:\document")
                //打开目录
                .openOutputDir(true)
                //文件类型，这里指定 HTML、WORD、 MD
                .fileType(EngineFileType.HTML) 
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                //.fileName("自定义文件名称").build();
                .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");
        //指定表前缀 designatedTablePrefix
        ArrayList<String> designatedPrefix = new ArrayList<>();
        designatedPrefix.add("DQJT_"); // 注意区分大小写

        ProcessConfig processConfig = ProcessConfig.builder()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
                .designatedTableName(new ArrayList<>())
                //根据表前缀生成
                .designatedTablePrefix(designatedPrefix) // 指定List
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(new ArrayList<>())
                //忽略表前缀
                .ignoreTablePrefix(new ArrayList<>())
                //忽略表后缀
                .ignoreTableSuffix(new ArrayList<>())
                .build();
        //配置
        Configuration config = Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("数据库设计文档生成")
                //数据源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
            	// 生成
                .build();
        
        //执行生成
        new DocumentationExecute(config).execute();
    }
}

生成结果

遇到问题

oracle.jdbc.driver.T4CConnection.isValid(I)Z

问题：spring boot oracle jdbc连接失败

报错：java.lang.AbstractMethodError: oracle.jdbc.driver.T4CConnection.isValid(I)Z

原因：之前用的jdbc是 ojdbc14，同事提供的，在spring boot学习的时候 发现无法连接oracle。看了maven，发现其实这个jar只能支持JDK1.4。于是重新在官网下载jar。

环境：IDEA、 JDK1.8、 MAVEN 3.1.1

操作：

  1. 下载 ojdbc8 https://www.oracle.com/database/technologies/jdbc-ucp-122-downloads.html
  1. 放到指定目录，这里放到项目的lib包下
  1. 打开 IDEA 的命令控制台 Terminal，在lib目录下输入命令
代码语言：javascript复制
mvn install:install-file -Dfile=ojdbc8.jar -DgroupId=com.oracle -DartifactId=ojdbc8 -Dversion=12.2.0.1 -Dpackaging=jar

注意：检查该目录是否项目MAVEN的仓库，如果不是，复制该文件夹到MAVEN仓库即可。

  1. 添加依赖
代码语言：javascript复制
<!-- Oracle -->
<dependency>
    <groupId>com.oracle</groupId>
    <artifactId>ojdbc8</artifactId>
    <version>12.2.0.1</version>
</dependency>
jdbc https 网络安全 数据库 maven

0 人点赞