# screw-demo

**Repository Path**: vv777/screw-demo

## Basic Information

- **Project Name**: screw-demo
- **Description**: 通过screw项目生成数据库文档的Demo，修改配置后，直接运行即可
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-09
- **Last Updated**: 2026-01-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# screw-demo

## 介绍
通过screw生成数据库文档的Demo，修改配置后，直接运行即可,不再因为没有数据库文档而烦恼

## 文档截图
![git2.png](img.png)

## 代码示例如下

```java
package com.screw.demo;

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 cn.smallbun.screw.core.util.CollectionUtils;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

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

public class Main {

    //文档格式
    final static EngineFileType FILE_TYPE = EngineFileType.HTML;

    /**
     * 将DataSourceConfig配置改成需要生成的数据库配置后 直接运行
     */
    public static void main(String[] args) {
        documentGeneration(getDataSourceConfig());
    }

    private static DataSourceConfig getDataSourceConfig() {
        return DataSourceConfig.builder()
                .jdbcUrl("jdbc:mysql://localhost:3306/demo")
                .userName("admin")
                .password("admin")
                .dataSourceName("demo")
                .ignoreTable(Collections.singletonList("test_demo1,test_demo2"))
                .ignoreTablePrefix(Collections.singletonList("test_"))
                .ignoreTableSuffix(Collections.singletonList("_demo"))
                .targetFileUrl("C:\\Users\\xxx\\Desktop")
                .build();
    }

    /**
     * 生成文档
     *
     * @param dataSourceConfig 数据源配置
     */
    public static void documentGeneration(DataSourceConfig dataSourceConfig) {
        //数据源
        DataSource dataSource = getDataSource(dataSourceConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir(dataSourceConfig.getTargetFileUrl())
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(FILE_TYPE)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName(dataSourceConfig.getDataSourceName()).build();

        //忽略表
        ArrayList<String> ignoreTableName = new ArrayList<>();
        if (CollectionUtils.isNotEmpty(dataSourceConfig.getIgnoreTable())) {
            ignoreTableName.addAll(dataSourceConfig.getIgnoreTable());
        }
        //忽略表前缀
        ArrayList<String> ignorePrefix = new ArrayList<>();
        if (CollectionUtils.isNotEmpty(dataSourceConfig.getIgnoreTablePrefix())) {
            ignorePrefix.addAll(dataSourceConfig.getIgnoreTablePrefix());
        }
        //忽略表后缀
        ArrayList<String> ignoreSuffix = new ArrayList<>();
        if (CollectionUtils.isNotEmpty(dataSourceConfig.getIgnoreTableSuffix())) {
            ignoreSuffix.addAll(dataSourceConfig.getIgnoreTableSuffix());
        }
        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();
    }

    private static DataSource getDataSource(DataSourceConfig dataSourceConfig) {
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl(dataSourceConfig.getJdbcUrl());
        hikariConfig.setUsername(dataSourceConfig.getUserName());
        hikariConfig.setPassword(dataSourceConfig.getPassword());
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        return new HikariDataSource(hikariConfig);
    }

    @Data
    @Builder
    @AllArgsConstructor
    @NoArgsConstructor
    public static class DataSourceConfig {
        
        /**
         * 数据源URL
         */
        private String jdbcUrl;

        /**
         * 用户名称
         */
        private String userName;

        /**
         * 密码
         */
        private String password;

        /**
         * 数据源名称
         */
        private String dataSourceName;

        /**
         * 忽略的表
         */
        private List<String> ignoreTable;

        /**
         * 忽略的表前缀
         */
        private List<String> ignoreTablePrefix;

        /**
         * 忽略的表后缀
         */
        private List<String> ignoreTableSuffix;

        /**
         * 生成文件后的存放的目标目录
         */
        private String targetFileUrl;
    }

}