screw 的postgresql数据库使用教程

screw: https://gitee.com/leshalv/screw

在使用screw 1.0.5版本对postgresql进行生成文档时报了 空指针异常。

使用screw

 		<dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>

        <!-- Postgresql驱动包 这个驱动包版本大有说法 -->
        <dependency>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>42.2.11</version>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>

看了一下lssues后知道1.0.6版本已经解决该问题了 但是目前仓库没有1.0.6版本.
1.0.6版本解决办法跳转
lssues中有大神说将postgresql的版本降至42.2.11就可以解决该问题，亲测之后确实可以。

代码

package util;

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 com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import javax.sql.DataSource;
import java.util.ArrayList;

/**
 * @author: L
 * @description: 通过screw进行postgresql数据库设计文档生成
 * @date: 2023-10-18 13:40
 **/
public class DocUtils {
    /**
     *  生成数据库文档文件路径 可根据本机电脑自行配置
     */
    private static final String FILE_OUTPUT_DIR = "D:\\";

    /**
     * screw配置的文件名称，即数据库文档名称
     */
    private static final String DOC_FILE_NAME = "数据库设计文档";

    /**
     * 版本
     */
    private static final String DOC_VERSION = "1.0.0";
    /**
     * 描述
     */
    private static final String DOC_DESCRIPTION = "数据库设计文档";


    public static void main(String[] args) {
        run();
    }

    public static void run(){
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        //驱动
        hikariConfig.setDriverClassName("org.postgresql.Driver");
        // url
        hikariConfig.setJdbcUrl("jdbc:postgresql://127.0.0.1:5432/test");
        // 用户名
        hikariConfig.setUsername("root");
        // 密码
        hikariConfig.setPassword("root");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径 
                .fileOutputDir(FILE_OUTPUT_DIR)
                //打开目录
                .openOutputDir(true)
                //文件类型 md html
                .fileType(EngineFileType.WORD)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName(DOC_FILE_NAME).build();

        //忽略表
        ArrayList<String> ignoreTableName = new ArrayList<>();
        ignoreTableName.add("user");
        //忽略表前缀
        ArrayList<String> ignorePrefix = new ArrayList<>();
        ignorePrefix.add("gen_");
        ignorePrefix.add("qrtz_");
        ignorePrefix.add("sys_");
        //忽略表后缀
        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(DOC_VERSION)
                //描述
                .description(DOC_DESCRIPTION)
                //数据源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
                .build();
        //执行生成
        new DocumentationExecute(config).execute();
    }
}

生成效果：