SpringBoot整合screw实现自动生成数据库设计文档

洛阳泰山 2022-11-25 我要评论

前言

最近因为工作的需要，让我写数据库设计文档，可是我最烦文档类的工作了，之前写过一篇文章（在下文补充内容中），使用的navicat工作，不过导出的格式是excel不符合格式，还得自己整理，现在用screw 工具包，整合到springboot的项目中便可以自动生成数据库设计文档，非常方便，下面就分享一下教程

提示：以下是本篇文章正文内容，下面案例可供参考

一、screw 是什么

screw是一个一键式生成数据库文档的开源工具包，目前screw可以生成word、md和html格式类的文档，支持freemarker和velocity两种模板引擎。数据源支持HikariDataSource，DruidDataSource可能会发生类型转换报错。

二、使用步骤

1.引入库

pom文件中引入jar依赖

<!--  数据库设计文档生成工具-->
<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.5</version>
</dependency>

2.代码示例

代码如下（下面用的是postgres数据库）：

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;
import java.util.List;
 
public class DatabaseDesignDocUtil {
 
    public static void main(String[] args) {
        documentGeneration();
    }
 
    /**
     * 文档生成
     */
    public static void documentGeneration() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("org.postgresql.Driver");
        hikariConfig.setJdbcUrl("jdbc:postgresql://39.164.52.80:5432/work_face");
        hikariConfig.setUsername("postgres");
        hikariConfig.setPassword("POSTGRES");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("C:\\Users\\tarzan\\Desktop\\doc")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.WORD)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("智能工作面数据库设计文档").build();
 
        //忽略表
        List<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()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
                .designatedTableName(new ArrayList<>())
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .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();
    }
 
}

需要改成mysql等别的数据库的，请在代码中改下驱动配置和连接配置。

三、使用方法

idea等编辑器里，运行main的主方法即可。

控制台输出示例

生成文档展示

补充

mysql数据库设计文档-导出字段设计

打开navicat，新建查询窗口

查询sql

SELECT
	TABLE_NAME 表名,
	COLUMN_NAME 字段名称,
	COLUMN_TYPE 字段类型,
IF
	( IS_NULLABLE = 'YES', '是', '否' ) 是否可为空,
IF
	( COLUMN_KEY = 'PRI', '是', '否' ) 是否主键,
	COLUMN_COMMENT 字段注释 
FROM
	INFORMATION_SCHEMA.COLUMNS 
WHERE
	TABLE_SCHEMA = '数据库名称' 
	-- 数据表名，可以不填写，查询全部表结构
	AND TABLE_NAME = '表名'

查询结果