【Oracle与Mysql数据库用Screw螺丝钉一键生成数据库设计文档】

清疚 2024-03-24 10:52 72阅读 0赞

### Oracle与Mysql数据库用Screw螺丝钉一键生成数据库设计文档工具 ###

**今天使用了一款非常简单生成数据库文档的小工具，于是记录一下，这款工具就是screw（螺丝钉）**

gitee官网地址：[https://gitee.com/leshalv/screw][https_gitee.com_leshalv_screw]  
gitHub官网地址：[https://github.com/pingfangushi/screw][https_github.com_pingfangushi_screw]

### 第一步-项目中的pom文件导入依赖-此步如果你项目中本身含有下列依赖，可选择去掉 ###

<dependency>
          <groupId>cn.smallbun.screw</groupId>
          <artifactId>screw-core</artifactId>
          <version>1.0.4</version>
      	</dependency>
      		
      	<dependency>
          <groupId>com.zaxxer</groupId>
          <artifactId>HikariCP</artifactId>
          <version>2.5.1</version>
      	</dependency>
      	
      	<dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        
    	<dependency>
    	     <groupId>com.oracle.database.jdbc</groupId>
    	     <artifactId>ojdbc8</artifactId>
    	     <version>21.1.0.0</version>
    	</dependency>

**第二步-复制此处生成数据库设计文档代码**

package com.test;
    
    import java.util.ArrayList;
    
    import javax.sql.DataSource;
    
    import com.zaxxer.hikari.HikariConfig;
    import com.zaxxer.hikari.HikariDataSource;
    
    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;
    
    public class Test{
    	public static void main(String[] args) {
    		HikariConfig hikariConfig = new HikariConfig();
    //	    hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");//项目中使用的DriverClassName
    //	    hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/test");//项目中使用的jdbcUrl
    	    hikariConfig.setDriverClassName("oracle.jdbc.driver.OracleDriver");//项目中使用的DriverClassName
    	    hikariConfig.setJdbcUrl("jdbc:oracle:thin:@192.168.1.151:1521:orcl");//项目中使用的jdbcUrl
    	    hikariConfig.setUsername("test_uesrname");
    	    hikariConfig.setPassword("test_password");
    	    //设置可以获取tables remarks信息
    	    hikariConfig.addDataSourceProperty("useInformationSchema", "true");
    	    hikariConfig.setMinimumIdle(2);
    	    hikariConfig.setMaximumPoolSize(5);
    	    DataSource dataSource = new HikariDataSource(hikariConfig);
    	    //生成配置
    	    EngineConfig engineConfig = EngineConfig.builder()
    	            //生成文件路径
    	            .fileOutputDir("E:\\项目文档")
    	            //打开目录
    	            .openOutputDir(true)
    	            //文件类型-可枚举选择
    	            .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();
    	}
    }

### 第三步-运行main函数 ###

总结  
最后直接运行main方法即可生成数据库设计文档。注：国产的一些数据库暂不支持生成，如：达梦等

[https_gitee.com_leshalv_screw]: https://gitee.com/leshalv/screw
[https_github.com_pingfangushi_screw]: https://github.com/pingfangushi/screw