数据库表结构文档生成导出神器——Screw(螺丝钉)插件springboot集成实例

秒速五厘米 2022-12-25 04:59 311阅读 0赞

**本文所有实例代码下载地址： [https://github.com/ImOk520/myspringcloud][https_github.com_ImOk520_myspringcloud]**

> # 一、说明 #

Screw(螺丝钉)是一款简洁好用的数据库表结构文档生成工具，它的特点是：简洁、轻量、设计良好、多数据库支持、多种格式文档、灵活扩展以及支持自定义模板，对于有经常要进行数据库设计、评审、文档整理等需求的人来说就是福音~。

Screw支持的数据库有：

*  MySQL
 *  MariaDB
 *  TIDB
 *  Oracle
 *  SqlServer
 *  PostgreSQL
 *  Cache DB

Screw支持的导出文档类型有：

*  html
 *  word
 *  markdwon

> # 二、SpringBoot集成Screw #

Screw的使用方式有两种：**pom插件运行** 和 **代码运行**。

## 2.1 导入依赖 ##

无论哪种方式都要先导入screw相关依赖：

<dependency>
                <groupId>cn.smallbun.screw</groupId>
                <artifactId>screw-core</artifactId>
                <version>1.0.3</version>
            </dependency>
            
            <dependency>
                <groupId>com.zaxxer</groupId>
                <artifactId>HikariCP</artifactId>
                <version>3.4.5</version>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.20</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-jdbc</artifactId>
            </dependency>

## 2.2 pom插件运行 ##

pom增加插件配置：

<build>
            <plugins>
                <plugin>
                    <groupId>cn.smallbun.screw</groupId>
                    <artifactId>screw-maven-plugin</artifactId>
                    <version>1.0.3</version>
                    <dependencies>
                        
                        <dependency>
                            <groupId>com.zaxxer</groupId>
                            <artifactId>HikariCP</artifactId>
                            <version>3.4.5</version>
                        </dependency>
                        
                        <dependency>
                            <groupId>mysql</groupId>
                            <artifactId>mysql-connector-java</artifactId>
                            <version>8.0.20</version>
                        </dependency>
                    </dependencies>
                    <configuration>
                        
                        <username>root</username>
                        
                        <password>123456</password>
                        
                        <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
                        
                        <jdbcUrl>jdbc:mysql://localhost:3306/prescription-new?serverTimezone=UTC</jdbcUrl>
                        
                        <fileType>HTML</fileType>
                        
                        <openOutputDir>false</openOutputDir>
                        
                        <produceType>freemarker</produceType>
                        
                        
                        
                        <description>医保新处方数据库文档生成</description>
                        
                        <version>${project.version}</version>
                        
                        <title>医保新处方数据库文档</title>
                    </configuration>
                    <executions>
                        <execution>
                            <phase>compile</phase>
                            <goals>
                                <goal>run</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>

以上数据库相关信息修改好后，点击maven--》plugins--》screw --》run

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTIzMTkyOA_size_16_color_FFFFFF_t_70][]

## 2.3 代码运行 ##

public class DataSourceOutDemo {
    
        @Test
        public void test() {
    //        DataSource dataSourceMysql = SpringContextUtil.getBean(DataSource.class);
            HikariConfig hikariConfig = new HikariConfig();
            hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
            hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/prescription-new?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8");
            hikariConfig.setUsername("root");
            hikariConfig.setPassword("123456");
            HikariDataSource dataSourceMysql = new HikariDataSource(hikariConfig);
    
            // 生成文件配置
            EngineConfig engineConfig = EngineConfig.builder()
                    // 生成文件路径
                    .fileOutputDir("D:/")
                    // 打开目录
                    .openOutputDir(true)
                    // 文件类型
                    .fileType(EngineFileType.HTML)
                    // 生成模板实现
                    .produceType(EngineTemplateType.freemarker).build();
            // 生成文档配置（包含以下自定义版本号、描述等配置连接）
            Configuration config = Configuration.builder()
                    .version("V1")
                    .description("生成文档信息描述")
                    .dataSource(dataSourceMysql)
                    .engineConfig(engineConfig)
                    .produceConfig(getProcessConfig())
                    .build();
            // 执行生成
            new DocumentationExecute(config).execute();
        }
    
        /**
         * 配置想要生成的表+ 配置想要忽略的表
         *
         * @return 生成表配置
         */
        public static ProcessConfig getProcessConfig() {
            // 忽略表名
            List<String> ignoreTableName = Arrays.asList("dept", "dept1");
            // 忽略表前缀，如忽略a开头的数据库表
            List<String> ignorePrefix = Arrays.asList("dept", "dept1");
            // 忽略表后缀
            List<String> ignoreSuffix = Arrays.asList("dept", "dept1");
            return ProcessConfig.builder()
                    //根据名称指定表生成
                    .designatedTableName(Arrays.asList("tb_his_prescription_record_extend", "tb_his_prescription_detail_extend"))
                    //根据表前缀生成
                    .designatedTablePrefix(new ArrayList<>())
                    //根据表后缀生成
                    .designatedTableSuffix(new ArrayList<>())
                    //忽略表名
                    .ignoreTableName(ignoreTableName)
                    //忽略表前缀
                    .ignoreTablePrefix(ignorePrefix)
                    //忽略表后缀
                    .ignoreTableSuffix(ignoreSuffix).build();
        }
    }

## 2.4 运行结果 ##

以上两种方式运行后，会在项目下生成doc文件及对应的数据库导出文件：

![20201201092632950.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTIzMTkyOA_size_16_color_FFFFFF_t_70 1][]

[https_github.com_ImOk520_myspringcloud]: https://github.com/ImOk520/myspringcloud
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTIzMTkyOA_size_16_color_FFFFFF_t_70]: /images/20221120/6199fc955caa4a28af775c8529b1fa14.png
[20201201092632950.png]: /images/20221120/72135f8333484109b87644c32bf04fba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTIzMTkyOA_size_16_color_FFFFFF_t_70 1]: /images/20221120/1664431bc09040ebb8d640dab9f4bdde.png