怎么一键生成数据库文档

发布时间：2021-10-29 15:07:46 阅读：175 作者：iii 栏目：编程语言

亿速云云数据库,读写分离，安全稳定，弹性扩容，低至0.3元/天！！点击查看>>

本篇内容介绍了“怎么一键生成数据库文档”的有关知识，在实际案例的操作过程中，不少人都会遇到这样的困境，接下来就让小编带领大家学习一下如何处理这些情况吧！希望大家仔细阅读，能够学有所成！

数据库文档图

MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB

引入screw核心包，HikariCP数据库连接池，HikariCP号称性能最出色的数据库连接池。

<!-- screw核心 --><dependency>    <groupId>cn.smallbun.screw</groupId>    <artifactId>screw-core</artifactId>    <version>1.0.3</version></dependency><!-- 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>8.0.20</version></dependency>

配置数据源，设置 useInformationSchema 可以获取tables注释信息。

spring.datasource.url=jdbc:mysql://45.93.1.5:3306/fire?useUnicode=true&characterEncoding=UTF-8&useSSL=falsespring.datasource.username=rootspring.datasource.password=123456spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.xa.properties.useInformationSchema=true

screw有两种执行方式，第一种是pom文件配置，另一种是代码执行。

 <build>    <plugins>        <plugin>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-maven-plugin</artifactId>        </plugin>        <plugin>            <groupId>cn.smallbun.screw</groupId>            <artifactId>screw-maven-plugin</artifactId>            <version>1.0.3</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>8.0.20</version>                </dependency>            </dependencies>            <configuration>                <!--username-->                <username>root</username>                <!--password-->                <password>123456</password>                <!--driver-->                <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>                <!--jdbc url-->                <jdbcUrl>jdbc:mysql://41.92.6.5:3306/fire</jdbcUrl>                <!--生成文件类型-->                <fileType>HTML</fileType>                <!--打开文件输出目录-->                <openOutputDir>false</openOutputDir>                <!--生成模板-->                <produceType>freemarker</produceType>                <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->                <!--<docName>测试文档名称</docName>-->                <!--描述-->                <description>数据库文档生成</description>                <!--版本-->                <version>${project.version}</version>                <!--标题-->                <title>fire数据库文档</title>            </configuration>            <executions>                <execution>                    <phase>compile</phase>                    <goals>                        <goal>run</goal>                    </goals>                </execution>            </executions>        </plugin>    </plugins></build>

配置完以后在 maven project->screw 双击执行ok。

在这里插入图片描述

代码生成方式也非常简单。

@SpringBootTestpublic class ScrewApplicationTests {    @Autowired    ApplicationContext applicationContext;    @Test    void contextLoads() {        DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);        // 生成文件配置        EngineConfig engineConfig = EngineConfig.builder()                // 生成文件路径，自己mac本地的地址，这里需要自己更换下路径                .fileOutputDir("D:/")                // 打开目录                .openOutputDir(false)                // 文件类型                .fileType(EngineFileType.HTML)                // 生成模板实现                .produceType(EngineTemplateType.freemarker).build();        // 生成文档配置（包含以下自定义版本号、描述等配置连接）        Configuration config = Configuration.builder()                .version("1.0.3")                .description("生成文档信息描述")                .dataSource(dataSourceMysql)                .engineConfig(engineConfig)                .produceConfig(getProcessConfig())                .build();        // 执行生成        new DocumentationExecute(config).execute();    }    /**     * 配置想要生成的表+ 配置想要忽略的表     *     * @return 生成表配置     */    public static ProcessConfig getProcessConfig() {        // 忽略表名        List<String> ignoreTableName = Arrays.asList("a", "test_group");        // 忽略表前缀，如忽略a开头的数据库表        List<String> ignorePrefix = Arrays.asList("a", "t");        // 忽略表后缀        List<String> ignoreSuffix = Arrays.asList("_test", "czb_");        return ProcessConfig.builder()                //根据名称指定表生成                .designatedTableName(Arrays.asList("fire_user"))                //根据表前缀生成                .designatedTablePrefix(new ArrayList<>())                //根据表后缀生成                .designatedTableSuffix(new ArrayList<>())                //忽略表名                .ignoreTableName(ignoreTableName)                //忽略表前缀                .ignoreTablePrefix(ignorePrefix)                //忽略表后缀                .ignoreTableSuffix(ignoreSuffix).build();    }}