前言

我们在开发的时候,花费太多时间来编写数据库表结构文档,关于数据库表结构文档状态就是要么没有,要么有、但那都是手写,后期运维开发,需要手动进行维护到文档中,非常繁琐,如果忘记一次维护,就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人,于是我们可以用 screw 插件工具来维护。感谢大佬的无私奉献

特点

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

使用

这里以 MySQL 5.7 为例子

screw 它有两种方式生成

第一种

也是最普通的一种

  1. 首先引入依赖

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
    </dependency>

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

    <dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>3.4.5</version>
    </dependency>
  2. 以代码的方式配置文档生成

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    @Test
    public void generateDocs() {
    // 数据源
    HikariConfig hikariConfig = new HikariConfig();
    hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");
    hikariConfig.setJdbcUrl("jdbc:mysql:///spring");
    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("C:\\Users\\garvey\\Desktop\\Demo")
    // 生成完成之后是否打开目录
    .openOutputDir(true)
    // 生成的文件类型(HTML、WORD、MD)
    .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();
    }
  3. 运行( HTML

    HTML

    WORD

    WORD

    Markdown

    Markdown

第二种

则是以 maven 插件的方式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<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>5.1.47</version>
</dependency>
</dependencies>
<configuration>
<!--username-->
<username>root</username>
<!--password-->
<password>root</password>
<!--driver-->
<driverClassName>com.mysql.jdbc.Driver</driverClassName>
<!--jdbc url-->
<jdbcUrl>jdbc:mysql:///spring</jdbcUrl>
<!--生成文件类型-->
<fileType>HTML</fileType>
<!--文件输出目录-->
<fileOutputDir>C:\Users\garvey\Desktop\Demo</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>

配置完成后点击 compile

compile

常见问题

  1. 生成后文档如果乱码在 URL 加入 ?characterEncoding=UTF-8

  2. 如果报错信息为 Caused by: java.lang.NoSuchFieldError: VERSION_2_3_30,请检查项目 freemarker 依赖,这是由于版本过低造成的,升级版本为 2.3.30 即可

  3. java.lang.AbstractMethodError:oracle.jdbc.driver.T4CConnection.getSchema()java.lang.String

    Oracle 驱动版本过低造成的,删除或屏蔽目前驱动版本,驱动添加升级为以下版本

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    <dependency>
    <groupId>com.oracle.ojdbc</groupId>
    <artifactId>ojdbc8</artifactId>
    <version>19.3.0.0</version>
    </dependency>
    <dependency>
    <groupId>cn.easyproject</groupId>
    <artifactId>orai18n</artifactId>
    <version>12.1.0.2.0</version>
    </dependency>

项目地址:

images