java-通过数据库生成-word的数据结构文档

第一步引入相关Maven依赖：

  <!--mysql连接-->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>8.0.16</version>
    </dependency>
 
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
    
    <dependency>
      <groupId>cn.smallbun.screw</groupId>
      <artifactId>screw-core</artifactId>
      <version>1.0.5</version>
    </dependency>
 
    <dependency>
      <groupId>org.freemarker</groupId>
      <artifactId>freemarker</artifactId>
      <version>2.3.30</version>
    </dependency>
 
    <!-- HikariCP:数据库连接池组件 -->
    <dependency>
      <groupId>com.zaxxer</groupId>
      <artifactId>HikariCP</artifactId>
      <version>3.4.5</version>
    </dependency>
 
  </dependencies>

 第二步：以下相关代码修改下对应的数据库配置直接运行就可以了

public class Test {
    /**
     * 路径
     */
    private static final String MYSQL_URL = "jdbc:mysql://localhost:3306/yzdx_vue?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8&autoReconnect=true&rewriteBatchedStatements=true";
    /**
     * 数据库名
     */
    private static final String MYSQL_NAME = "yzdx_vue";
    /**
     * mysql用户名
     */
    private static final String MYSQL_USERNAME = "root";
    /**
     * mysql密码
     */
    private static final String MYSQL_PASSWORD = "123456";
    /**
     * 文件输出目录
     */
    private static final String FILE_OUTPUT_DIR = "E:\\Word";

    /**
     * 可以设置 Word 或者 Markdown 格式
     */
    private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;
    private static final String DOC_FILE_NAME = "智慧消防管理系统-数据库表设计文档";
    private static final String DOC_VERSION = "V1.0.0";
    private static final String DOC_DESCRIPTION = "数据库表设计描述";

    public static void main(String[] args) {
        // 创建 screw 的配置
        Configuration config = Configuration.builder()
            // 版本
            .version(DOC_VERSION)
            // 描述
            .description(DOC_DESCRIPTION)
            // 数据源
            .dataSource(buildDataSource())
            // 引擎配置
            .engineConfig(buildEngineConfig())
            // 处理配置
            .produceConfig(buildProcessConfig())
            .build();

        // 执行 screw，生成数据库文档
        new DocumentationExecute(config).execute();
    }

    /**
     * 创建数据源
     */
    private static HikariDataSource buildDataSource() {
        // 创建 HikariConfig 配置类
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl(MYSQL_URL);
        hikariConfig.setUsername(MYSQL_USERNAME);
        hikariConfig.setPassword(MYSQL_PASSWORD);
        // 设置可以获取 tables remarks 信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        // 创建数据源
        HikariDataSource hikariDataSource = new HikariDataSource(hikariConfig);
        return hikariDataSource;
    }

    /**
     * 创建 screw 的引擎配置
     */
    private static EngineConfig buildEngineConfig() {
        return EngineConfig.builder()
            // 生成文件路径
            .fileOutputDir(FILE_OUTPUT_DIR)
            // 打开目录
            .openOutputDir(false)
            // 文件类型
            .fileType(FILE_OUTPUT_TYPE)
            // 文件类型
            .produceType(EngineTemplateType.freemarker)
            // 自定义文件名称
            .fileName(DOC_FILE_NAME)
            .build();
    }

    /**
     * 创建 screw 的处理配置，一般可忽略
     * 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
     */
    private static ProcessConfig buildProcessConfig() {
        return ProcessConfig.builder()
            // 根据名称指定表生成
            .designatedTableName(Collections.<String>emptyList())
            // 根据表前缀生成
            .designatedTablePrefix(Collections.<String>emptyList())
            // 根据表后缀生成
            .designatedTableSuffix(Collections.<String>emptyList())
            // 忽略数据库中address这个表名
            .ignoreTableName(Arrays.asList("ci_special_zone"))
            // 忽略表前缀，就是db1数据库中表名是t_开头的都不生产数据库文档(t_student,t_user这两张表)
//            .ignoreTablePrefix(Collections.singletonList("act_"))
            // 忽略表前缀,多张表
            .ignoreTablePrefix(Arrays.asList("act_","xxl_","zz_","gen_","flw"))
            // 忽略表后缀(就是db1数据库中表名是_teacher结尾的都不生产数据库文档：stu_teacher)
            .ignoreTableSuffix(Collections.singletonList("_teacher"))
            .build();
    }
}