# screwTest

**Repository Path**: wei_dongdong/screw-test

## Basic Information

- **Project Name**: screwTest
- **Description**: 一键生成数据库文档小工具
- **Primary Language**: Java
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-08-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# screwTest

#### 介绍
一件生成数据库文档小工具

#### 软件架构
软件架构说明


#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1. 依赖

   ```xml
   <dependency>
       <groupId>cn.smallbun.screw</groupId>
       <artifactId>screw-core</artifactId>
       <version>1.0.3</version>
   </dependency>
   ```

2. 代码(src/test/java目录下)

   ```java
   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 org.junit.jupiter.api.Test;
   
   import javax.sql.DataSource;
   import java.util.ArrayList;
   
   public class ScrewTest {
     
     @Test
     void testScrew()  {
       //数据源
       HikariConfig hikariConfig = new HikariConfig();
       hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
       hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database");
       hikariConfig.setUsername("db-username");
       hikariConfig.setPassword("db-password");
       //设置可以获取tables remarks信息
       hikariConfig.addDataSourceProperty("useInformationSchema", "true");
       hikariConfig.setMinimumIdle(2);
       hikariConfig.setMaximumPoolSize(5);
       DataSource dataSource = new HikariDataSource(hikariConfig);
   
       //生成配置
       EngineConfig engineConfig = EngineConfig.builder()
               //生成文件路径
               .fileOutputDir("d://")
               //打开目录
               .openOutputDir(true)
               //生成文件类型：HTML
               .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()
               //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
               //根据名称指定表生成
               .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();
   
     }
   }
   ```

   

3. xxxx

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 码云特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)