1、背景

我们在做项目时，表设计文档都是非常重要的，可以让开发人员快速了解表与业务的关系、表之间的关系。

产品在不停迭代的过程中，表的结构也会有相应的变化，我们需要将变化更新的表设计文档中。以前我们是人工方式更新文档，效率是比较慢的，慢慢的我们通过工具来维护表设计文档。

我们一般存档的文件是Word文件，所以本文讲的是生成word的工具。

2、生成文档

2.1 工具

工具名称：screw

代码地址：https://github.com/pingfangushi/screw

2.2 使用

2.2.1 引入依赖

    cn.smallbun.screw    screw-core    1.0.5

2.2.2 表结构

-- ------------------------------ Table structure for person-- ----------------------------DROP TABLE IF EXISTS `person`;CREATE TABLE `person`  (  `id` bigint UNSIGNED NOT NULL AUTO_INCREMENT,  `name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '姓名',  `age` int NOT NULL COMMENT '年龄',  PRIMARY KEY (`id`) USING BTREE) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci COMMENT = '个人' ROW_FORMAT = Dynamic;-- ------------------------------ Records of person-- ------------------------------ ------------------------------ Table structure for user-- ----------------------------DROP TABLE IF EXISTS `user`;CREATE TABLE `user`  (  `id` bigint UNSIGNED NOT NULL AUTO_INCREMENT,  `name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '姓名',  `age` int NOT NULL COMMENT '年龄',  PRIMARY KEY (`id`) USING BTREE) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci COMMENT = '用户' ROW_FORMAT = Dynamic;

2.2.3 编写代码

package com.ybw.export.doc.generate;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;public class GenerateDocument {    public static void main(String[] args) {        String fileOutputDir = "D:/";        documentGeneration(fileOutputDir);    }        static void documentGeneration(String fileOutputDir) {        //数据源        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("123456");        //设置可以获取tables remarks信息        hikariConfig.aDDDataSourceProperty("useInformationSchema", "true");        hikariConfig.setMinimumIdle(2);        hikariConfig.setMaximumPoolSize(5);        DataSource dataSource = new HikariDataSource(hikariConfig);        //生成配置        EngineConfig engineConfig = EngineConfig.builder()                //生成文件路径                .fileOutputDir(fileOutputDir)                //打开目录                .openOutputDir(true)                //文件类型                .fileType(EngineFileType.WORD)                //生成模板实现                .produceType(EngineTemplateType.freemarker)                //自定义文件名称                .fileName("测试库").build();        //忽略表        ArrayList ignoreTableName = new ArrayList<>();        ignoreTableName.add("test_user");        ignoreTableName.add("test_group");        //忽略表前缀        ArrayList ignorePrefix = new ArrayList<>();        ignorePrefix.add("test_");        //忽略表后缀        ArrayList 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();    }}

2.2.4 生成word文档

执行2.2.3后，生成word文档

3、示例代码地址

https://gitee.com/xixingzhe2/share/tree/master/database/export-doc-demo

4、生成其他格式的文档

这个工具支持三种格式：word、html、markdown。修改代码的枚举类即可改变文档的生成类型

来源地址：https://blog.csdn.net/xixingzhe2/article/details/128984999