spring-boot test 使用screw 生成数据库文档

新建一个springboot项目

然后在pom.xml 中引入依赖

 <!--数据库文档核心依赖-->
  <dependency>
      <groupId>cn.smallbun.screw</groupId>
      <artifactId>screw-core</artifactId>
      <version>1.0.5</version>
  </dependency>

当然也需要引入数据库驱动

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

直接写一个测试类添加测试方法

    @Test
    public void shouldAnswerWithTrue() {
        // 数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://192.168.0.103:3306/backups");
//      hikariConfig.setJdbcUrl("jdbc:mysql://192.168.0.103:3306/zc_order");
//      hikariConfig.setJdbcUrl("jdbc:mysql://192.168.0.103:3306/data");
//      hikariConfig.setJdbcUrl("jdbc:mysql://192.168.0.103:3306/zc_manager");
//      hikariConfig.setJdbcUrl("jdbc:mysql://192.168.0.103:3306/zc_security");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("Root@123");
        // 设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        // 生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径
                .fileOutputDir("sqldoc/")
                // 打开目录
                .openOutputDir(true)
                // 文件类型 HTML，WORD，MD
                .fileType(EngineFileType.HTML)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker).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()
                // 忽略表名
                .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();
    }

执行测试方法 在“sqldoc/”中得到生成的文件 "数据库名描述版本.type"

word效果

image.png

md效果

image.png

html效果

image.png