Spring Boot集成screw实现数据库文档生成-工具盒子

1.什么是screw？

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

数据库支持

MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB（2016）
H2 （开发中）
DB2 （开发中）
HSQL （开发中）
SQLite（开发中）

2.环境准备

参考之前springboot对接mysql的教程里面的mysql环境搭建 http://www.liuhaihua.cn/archives/710165.html

3.代码工程

实验目的

生成mysql数据库的word文档

pom.xml

<?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">    <parent>        <artifactId>springboot-demo</artifactId>        <groupId>com.et</groupId>        <version>1.0-SNAPSHOT</version>    </parent>    <modelVersion>4.0.0</modelVersion>
    <artifactId>Screw</artifactId>
    <properties>        <maven.compiler.source>8</maven.compiler.source>        <maven.compiler.target>8</maven.compiler.target>    </properties>    <dependencies>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-web</artifactId>        </dependency>
        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-autoconfigure</artifactId>        </dependency>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-test</artifactId>            <scope>test</scope>        </dependency>        <dependency>            <groupId>cn.smallbun.screw</groupId>            <artifactId>screw-core</artifactId>            <version>1.0.5</version>        </dependency>        <dependency>            <groupId>mysql</groupId>            <artifactId>mysql-connector-java</artifactId>            <scope>runtime</scope>        </dependency>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-data-jdbc</artifactId>        </dependency>    </dependencies></project>

生成类

package com.et.screw;
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 org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.ApplicationArguments;import org.springframework.boot.ApplicationRunner;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.context.ApplicationContext;
import javax.sql.DataSource;import java.util.ArrayList;import java.util.Arrays;import java.util.List;
@SpringBootApplicationpublic class Application implements ApplicationRunner {
    @Autowired    ApplicationContext applicationContext;
    public static void main(String[] args) {        SpringApplication.run(Application.class, args);    }
    @Override    public void run(ApplicationArguments args) throws Exception {
        DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);
        //模板引擎配置 生成文件配置        EngineConfig engineConfig = EngineConfig.builder()                // 生成文件路径                .fileOutputDir("D://tmp/")                // 打开目录                .openOutputDir(false)                // 文件类型                .fileType(EngineFileType.WORD)                // 生成模板实现                .produceType(EngineTemplateType.freemarker).build();
        // 生成文档配置（包含以下自定义版本号、描述等配置连接），文档名称拼接：数据库名_描述_版本.扩展名        Configuration config = Configuration.builder()                .title("数据库文档")                // 版本号                .version("1.0.0")                // 描述                .description("数据库设计文档")                // 数据源                .dataSource(dataSourceMysql)                // 模板引擎配置                .engineConfig(engineConfig)                // 加载配置：想要生成的表、想要忽略的表                .produceConfig(getProcessConfig())                .build();        // 执行生成        new DocumentationExecute(config).execute();    }
    /**     * 配置想要生成的表+ 配置想要忽略的表     *     * @return 生成表配置     */    public static ProcessConfig getProcessConfig() {        // 忽略表名        List<String> ignoreTableName = Arrays.asList("");
        return ProcessConfig.builder()                //根据名称指定表生成                .designatedTableName(new ArrayList<>())                //根据表前缀生成                .designatedTablePrefix(new ArrayList<>())                //根据表后缀生成                .designatedTableSuffix(new ArrayList<>())                //忽略表名                .ignoreTableName(ignoreTableName)                .build();    }
}

application.properties

spring.datasource.driverClassName=com.mysql.cj.jdbc.Driverspring.datasource.url=jdbc:mysql://127.0.0.1:3306/jwordpress?useUnicode=true&characterEncoding=utf-8&autoReconnect=true&failOverReadOnly=false&useSSL=false&serverTimezone=Asia/Shanghaispring.datasource.username=rootspring.datasource.password=123456

以上只是一些关键代码，所有代码请参见下面代码仓库