Screw 针对Oracle11g\MySQL8\SQLServer2008 数据库文档生成总结(运行环境说明)

1、Screw + Oracle11g 数据库文档生成版本说明：

1.1、 运行环境

Java = JDK8

Oracle = Oracle 11g

1.2、pom.xml 依赖

	<!-- 数据库文档自动生成 -->
		<dependency>
			<groupId>cn.smallbun.screw</groupId>
			<artifactId>screw-core</artifactId>
			<version>1.0.5</version>
		</dependency>
		<!-- Oracle -->
		<dependency>
			<groupId>com.oracle</groupId>
			<artifactId>ojdbc8 </artifactId>
			<version>12.2.0.1</version>
		</dependency>

1.3、核心功能代码

package com.zzg.test;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.sql.DataSource;
import org.junit.Test;
import org.springframework.boot.test.context.SpringBootTest;
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;


@SpringBootTest
public class ScrewApplicationTest {
	

	
	@Test
	public void screwGenerate() throws Exception {
		 //数据源
        HikariConfig hikariConfig = new HikariConfig();
        
        
        // Oracle 数据库
        hikariConfig.setDriverClassName("oracle.jdbc.driver.OracleDriver");
        hikariConfig.setJdbcUrl("jdbc:oracle:thin:@127.0.0.1:1521:orcl");
        hikariConfig.setUsername("gx_test");
        hikariConfig.setPassword("gx_test");

		DataSource hikariDataSource = new HikariDataSource(hikariConfig);
		  
		// 生成文件配置
		EngineConfig engineConfig = EngineConfig.builder()
				// 生成文件路径，自己mac本地的地址，这里需要自己更换下路径
				.fileOutputDir("D:\\doc")
				// 打开目录
				.openOutputDir(false)
				// 文件类型
				.fileType(EngineFileType.HTML)
				// 生成模板实现
				.produceType(EngineTemplateType.freemarker).build();

		// 生成文档配置（包含以下自定义版本号、描述等配置连接）
		Configuration config = Configuration.builder().version("1.0.0").description("生成文档信息描述")
				.dataSource(hikariDataSource).engineConfig(engineConfig).produceConfig(getProcessConfig()).build();

		// 执行生成
		new DocumentationExecute(config).execute();
	}

	/**
	 * 配置想要生成的表+ 配置想要忽略的表
	 * 
	 * @return 生成表配置
	 */
	public static ProcessConfig getProcessConfig() {
		// 忽略表名
		List<String> ignoreTableName = Arrays.asList("aa", "test_group");
		// 忽略表前缀，如忽略a开头的数据库表
		List<String> ignorePrefix = Arrays.asList("a", "t");
		// 忽略表后缀
		List<String> ignoreSuffix = Arrays.asList("_test", "czb_");

		return ProcessConfig.builder()
				// 根据名称指定表生成
				.designatedTableName(new ArrayList<>())
				// 根据表前缀生成
				.designatedTablePrefix(new ArrayList<>())
				// 根据表后缀生成
				.designatedTableSuffix(new ArrayList<>())
				// 忽略表名
				.ignoreTableName(new ArrayList<>())
				// 忽略表前缀
				.ignoreTablePrefix(new ArrayList<>())
				// 忽略表后缀
				.ignoreTableSuffix(new ArrayList<>()).build();
	}
}

2、Screw + MySQL8数据库文档生成版本说明：

2.1、 运行环境

Java = JDK8

MySQL= MySQL 8

2.2、pom.xml 依赖

<!-- 数据库文档自动生成 -->
		<dependency>
			<groupId>cn.smallbun.screw</groupId>
			<artifactId>screw-core</artifactId>
			<version>1.0.5</version>
		</dependency>
<!--mysql 驱动程序 -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>8.0.13</version>
		</dependency>

2.3、核心功能代码

package com.zzg.test;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.sql.DataSource;
import org.junit.Test;
import org.springframework.boot.test.context.SpringBootTest;
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;


@SpringBootTest
public class ScrewApplicationTest {
	

	
	@Test
	public void screwGenerate() throws Exception {
		 //数据源
        HikariConfig hikariConfig = new HikariConfig();
        // MySQL8 数据库
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/zh102?serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true&allowMultiQueries=true");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("123456");
        
     

		DataSource hikariDataSource = new HikariDataSource(hikariConfig);
		  
		// 生成文件配置
		EngineConfig engineConfig = EngineConfig.builder()
				// 生成文件路径，自己mac本地的地址，这里需要自己更换下路径
				.fileOutputDir("D:\\doc")
				// 打开目录
				.openOutputDir(false)
				// 文件类型
				.fileType(EngineFileType.HTML)
				// 生成模板实现
				.produceType(EngineTemplateType.freemarker).build();

		// 生成文档配置（包含以下自定义版本号、描述等配置连接）
		Configuration config = Configuration.builder().version("1.0.0").description("生成文档信息描述")
				.dataSource(hikariDataSource).engineConfig(engineConfig).produceConfig(getProcessConfig()).build();

		// 执行生成
		new DocumentationExecute(config).execute();
	}

	/**
	 * 配置想要生成的表+ 配置想要忽略的表
	 * 
	 * @return 生成表配置
	 */
	public static ProcessConfig getProcessConfig() {
		// 忽略表名
		List<String> ignoreTableName = Arrays.asList("aa", "test_group");
		// 忽略表前缀，如忽略a开头的数据库表
		List<String> ignorePrefix = Arrays.asList("a", "t");
		// 忽略表后缀
		List<String> ignoreSuffix = Arrays.asList("_test", "czb_");

		return ProcessConfig.builder()
				// 根据名称指定表生成
				.designatedTableName(new ArrayList<>())
				// 根据表前缀生成
				.designatedTablePrefix(new ArrayList<>())
				// 根据表后缀生成
				.designatedTableSuffix(new ArrayList<>())
				// 忽略表名
				.ignoreTableName(new ArrayList<>())
				// 忽略表前缀
				.ignoreTablePrefix(new ArrayList<>())
				// 忽略表后缀
				.ignoreTableSuffix(new ArrayList<>()).build();
	}
}

3、Screw + SQLServer2008数据库文档生成版本说明：

3.1、 运行环境

Java = JDK8

SQLServer=SQLServer2008

3.2、pom.xml 依赖

        <!-- 数据库文档自动生成 -->
		<dependency>
			<groupId>cn.smallbun.screw</groupId>
			<artifactId>screw-core</artifactId>
			<version>1.0.5</version>
		</dependency>
		<!-- sqlserver2008 驱动 -->
		<dependency>
			<groupId>com.microsoft.sqlserver</groupId>
			<artifactId>sqljdbc6</artifactId>
			<version>4.2</version>
		</dependency>

3.3、核心功能代码

package com.zzg.test;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.sql.DataSource;
import org.junit.Test;
import org.springframework.boot.test.context.SpringBootTest;
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;


@SpringBootTest
public class ScrewApplicationTest {
	

	
	@Test
	public void screwGenerate() throws Exception {
		 //数据源
        HikariConfig hikariConfig = new HikariConfig();
        
        // SQLServer2008 数据库
        hikariConfig.setDriverClassName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
            hikariConfig.setJdbcUrl("jdbc:sqlserver://127.0.0.1:1433;databasename=baoan_check");
        hikariConfig.setUsername("sa");
        hikariConfig.setPassword("123456");

		DataSource hikariDataSource = new HikariDataSource(hikariConfig);
		  
		// 生成文件配置
		EngineConfig engineConfig = EngineConfig.builder()
				// 生成文件路径，自己mac本地的地址，这里需要自己更换下路径
				.fileOutputDir("D:\\doc")
				// 打开目录
				.openOutputDir(false)
				// 文件类型
				.fileType(EngineFileType.HTML)
				// 生成模板实现
				.produceType(EngineTemplateType.freemarker).build();

		// 生成文档配置（包含以下自定义版本号、描述等配置连接）
		Configuration config = Configuration.builder().version("1.0.0").description("生成文档信息描述")
				.dataSource(hikariDataSource).engineConfig(engineConfig).produceConfig(getProcessConfig()).build();

		// 执行生成
		new DocumentationExecute(config).execute();
	}

	/**
	 * 配置想要生成的表+ 配置想要忽略的表
	 * 
	 * @return 生成表配置
	 */
	public static ProcessConfig getProcessConfig() {
		// 忽略表名
		List<String> ignoreTableName = Arrays.asList("aa", "test_group");
		// 忽略表前缀，如忽略a开头的数据库表
		List<String> ignorePrefix = Arrays.asList("a", "t");
		// 忽略表后缀
		List<String> ignoreSuffix = Arrays.asList("_test", "czb_");

		return ProcessConfig.builder()
				// 根据名称指定表生成
				.designatedTableName(new ArrayList<>())
				// 根据表前缀生成
				.designatedTablePrefix(new ArrayList<>())
				// 根据表后缀生成
				.designatedTableSuffix(new ArrayList<>())
				// 忽略表名
				.ignoreTableName(new ArrayList<>())
				// 忽略表前缀
				.ignoreTablePrefix(new ArrayList<>())
				// 忽略表后缀
				.ignoreTableSuffix(new ArrayList<>()).build();
	}
}