一键生成数据库文档（持续更新）

一、简介

我们经常会有编写数据库表结构文档的时间付出，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐,此工具可以一键生成数据库文档。

二、特点

简洁、轻量、设计良好
多数据库支持
多种格式文档
灵活扩展
支持自定义模板

三、文档生成支持

html
word
markdown

四、文档截图

html


word

markdwon

五、使用方式

5.1、普通方式

5.1.1、 引入依赖

<dependency>    
    <groupId>cn.smallbun.screwgroupId>    
    <artifactId>screw-coreartifactId>    
    <version>${lastVersion}version>    
 dependency>  

5.1.2、编写代码

/**    
 * 文档生成    
 */    
void documentGeneration() {    
   //数据源    
   HikariConfig hikariConfig = new HikariConfig();    
   hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");    
   hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database");    
   hikariConfig.setUsername("root");    
   hikariConfig.setPassword("password");    
   //设置可以获取tables remarks信息    
   hikariConfig.addDataSourceProperty("useInformationSchema", "true");    
   hikariConfig.setMinimumIdle(2);    
   hikariConfig.setMaximumPoolSize(5);    
   DataSource dataSource = new HikariDataSource(hikariConfig);    
   //生成配置    
   EngineConfig engineConfig = EngineConfig.builder()    
         //生成文件路径    
         .fileOutputDir(fileOutputDir)    
         //打开目录    
         .openOutputDir(true)    
         //文件类型    
         .fileType(EngineFileType.HTML)    
         //生成模板实现    
         .produceType(EngineTemplateType.freemarker)    
         //自定义文件名称    
         .fileName("自定义文件名称").build();    
    
   //忽略表    
   ArrayList<String> ignoreTableName = new ArrayList<>();    
   ignoreTableName.add("test_user");    
   ignoreTableName.add("test_group");    
   //忽略表前缀    
   ArrayList<String> ignorePrefix = new ArrayList<>();    
   ignorePrefix.add("test_");    
   //忽略表后缀        
   ArrayList<String> ignoreSuffix = new ArrayList<>();    
   ignoreSuffix.add("_test");    
   ProcessConfig processConfig = ProcessConfig.builder()    
         //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置     
   //根据名称指定表生成    
   .designatedTableName(new ArrayList<>())    
   //根据表前缀生成    
   .designatedTablePrefix(new ArrayList<>())    
   //根据表后缀生成     
   .designatedTableSuffix(new ArrayList<>())    
         //忽略表名    
         .ignoreTableName(ignoreTableName)    
         //忽略表前缀    
         .ignoreTablePrefix(ignorePrefix)    
         //忽略表后缀    
         .ignoreTableSuffix(ignoreSuffix).build();    
   //配置    
   Configuration config = Configuration.builder()    
         //版本    
         .version("1.0.0")    
         //描述    
         .description("数据库设计文档生成")    
         //数据源    
         .dataSource(dataSource)    
         //生成配置    
         .engineConfig(engineConfig)    
         //生成配置    
         .produceConfig(processConfig)    
         .build();    
   //执行生成    
   new DocumentationExecute(config).execute();    
}

5.1.3、Maven 插件

<build>    
    <plugins>    
        <plugin>    
            <groupId>cn.smallbun.screwgroupId>    
            <artifactId>screw-maven-pluginartifactId>    
            <version>${lastVersion}version>    
            <dependencies>    
                    
                <dependency>    
                    <groupId>com.zaxxergroupId>    
                    <artifactId>HikariCPartifactId>    
                    <version>3.4.5version>    
                dependency>    
                    
                <dependency>    
                    <groupId>mysqlgroupId>    
                    <artifactId>mysql-connector-javaartifactId>    
                    <version>8.0.20version>    
                dependency>    
            dependencies>    
            <configuration>    
                    
                <username>rootusername>    
                    
                <password>passwordpassword>    
                    
                <driverClassName>com.mysql.cj.jdbc.DriverdriverClassName>    
                    
                <jdbcUrl>jdbc:mysql://127.0.0.1:3306/xxxxjdbcUrl>    
                    
                <fileType>HTMLfileType>    
                    
                <openOutputDir>falseopenOutputDir>    
                    
                <produceType>freemarkerproduceType>    
                    
                <fileName>测试文档名称fileName>    
                    
                <description>数据库文档生成description>    
                    
                <version>${project.version}version>    
                    
                <title>数据库文档title>    
            configuration>    
            <executions>    
                <execution>    
                    <phase>compilephase>    
                    <goals>    
                        <goal>rungoal>    
                    goals>    
                execution>    
            executions>    
        plugin>    
    plugins>    
build>

六、扩展模块

6.1、pojo生成功能

6.1.1、功能简介

pojo生成功能是基于screw延伸出的扩展模块,目前处于初步开发的状态。在日常的开发中,经过需求分析、建模之后,往往会先在数据库中建表,其次在进行代码的开发。
那么pojo生成功能在这个阶段就可以帮助大家节省一些重复劳动了。使用pojo生成功能可以直接根据数据库生成对应的java pojo对象。这样后续的修改，开发都会很方便。

数据库支持 ： MySQL
使用方式：引入依赖

<dependency>    
    <groupId>cn.smallbun.screwgroupId>    
    <artifactId>screw-extensionartifactId>    
    <version>${lastVersion}version>    
 dependency>

6.1.2、编写代码

/**    
 * pojo生成    
 */    
void pojoGeneration() {    
    //数据源    
    HikariConfig hikariConfig = new HikariConfig();    
    hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");    
    hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/screw");    
    hikariConfig.setUsername("screw");    
    hikariConfig.setPassword("screw");    
    //设置可以获取tables remarks信息    
    hikariConfig.addDataSourceProperty("useInformationSchema", "true");    
    hikariConfig.setMinimumIdle(2);    
    hikariConfig.setMaximumPoolSize(5);    
    DataSource dataSource = new HikariDataSource(hikariConfig);    
    
    ProcessConfig processConfig = ProcessConfig.builder()    
        //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置    
        //根据名称指定表生成    
        .designatedTableName(new ArrayList<>())    
        //根据表前缀生成    
        .designatedTablePrefix(new ArrayList<>())    
        //根据表后缀生成    
        .designatedTableSuffix(new ArrayList<>()).build();    
    
    //设置生成pojo相关配置    
    PojoConfiguration config = new PojoConfiguration();    
    //设置文件存放路径    
    config.setPath("/cn/smallbun/screw/");    
    //设置包名    
    config.setPackageName("cn.smallbun.screw");    
    //设置是否使用lombok    
    config.setUseLombok(false);    
    //设置数据源    
    config.setDataSource(dataSource);    
    //设置命名策略    
    config.setNameStrategy(new HumpNameStrategy());    
    //设置表过滤逻辑    
    config.setProcessConfig(processConfig);    
    //执行生成    
    new PojoExecute(config).execute();    
}    

6.2、常见问题

1.生成后文档乱码？
MySQL：URL加入?characterEncoding=UTF-8。
2.Caused by: java.lang.NoSuchFieldError: VERSION_2_3_30？
检查项目freemarker依赖，这是由于版本过低造成的，升级版本为2.3.30即可
3.java.lang.AbstractMethodError: oracle.jdbc.driver.T4CConnection.getSchema()Ljava/lang/String;
这是因为oracle驱动版本过低造成的，删除或屏蔽目前驱动版本，驱动添加升级为以下版本：

<dependency>    
   <groupId>com.oracle.ojdbcgroupId>    
   <artifactId>ojdbc8artifactId>    
   <version>19.3.0.0version>    
dependency>    
<dependency>    
   <groupId>cn.easyprojectgroupId>    
   <artifactId>orai18nartifactId>    
   <version>12.1.0.2.0version>    
dependency>  

4.MySQL数据库表和列字段有说明、生成文档没有说明？
URL链接加入useInformationSchema=true即可。
5.java.lang.AbstractMethodError: com.mysql.jdbc.JDBC4Connection.getSchema()Ljava/lang/String;
这是因为mysql驱动版本过低造成的，升级mysql驱动版本为最新即可。

七、项目地址

https://gitee.com/leshalv/screw