java 利用 screw插件生成数据库文档

比眉伴天荒 2021-09-21 10:44 359阅读 0赞

数据库文档也是交付的重要内容，本文的工具可以帮助大家快速生成相应文档，并支持多种数据库

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、使用本插件可以实现文档生成。

screw 特点

*  简洁、轻量、设计良好。不需要 powerdesigner 这种重量的建模工具
 *  多数据库支持 。支持市面常见的数据库类型 MySQL、Oracle、SqlServer
 *  多种格式文档。支持 MD、HTML、WORD 格式
 *  灵活扩展。支持用户自定义模板和展示样式

数据库支持

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

文档生成支持

*   html
 *   word
 *   markdwon

文档示例  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VjaGl6YW8xODM5_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VjaGl6YW8xODM5_size_16_color_FFFFFF_t_70 1][]

实现

<plugin>
                    <groupId>cn.smallbun.screw</groupId>
                    <artifactId>screw-maven-plugin</artifactId>
                    <version>1.0.4</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:192.168.1.2:3306/test</jdbcUrl>
                        
                        <fileType>HTML</fileType>
                        
                        <openOutputDir>false</openOutputDir>
                        
                        <produceType>freemarker</produceType>
                        
                        <fileName>xx-db-name</fileName>
                        
                        <description>数据库文档生成</description>
                        
                        <version>${project.version}</version>
                        
                        <title>xxx数据库文档</title>
                    </configuration>
                    
                    
                    
                    
                    
                    
                    
                    
                </plugin>

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VjaGl6YW8xODM5_size_16_color_FFFFFF_t_70 2][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VjaGl6YW8xODM5_size_16_color_FFFFFF_t_70]: /images/20210920/3f3199266c024059bd3fe0fbe596907d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VjaGl6YW8xODM5_size_16_color_FFFFFF_t_70 1]: /images/20210920/72249c4666144f1d92243b34deda8272.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2VjaGl6YW8xODM5_size_16_color_FFFFFF_t_70 2]: /images/20210920/f44f4a7a4aea47a28d7839f6b168bc4f.png