first commit

.gitignore

@@ -0,0 +1,33 @@
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/

pom.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.7.15</version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+    <groupId>com.chinaitop</groupId>
+    <artifactId>depot-database-document</artifactId>
+    <version>0.0.1-SNAPSHOT</version>
+    <name>depot-database-document</name>
+    <description>生成数据库文档</description>
+    <properties>
+        <skipTests>true</skipTests>
+        <java.version>1.8</java.version>
+        <spring-cloud.version>2021.0.8</spring-cloud.version>
+    </properties>
+    <dependencies>
+        <!-- Screw Core -->
+        <dependency>
+            <groupId>cn.smallbun.screw</groupId>
+            <artifactId>screw-core</artifactId>
+            <version>1.0.2</version>
+        </dependency>
+        <!-- HikariCP -->
+        <dependency>
+            <groupId>com.zaxxer</groupId>
+            <artifactId>HikariCP</artifactId>
+            <version>3.4.5</version>
+        </dependency>
+        <!-- Mysql Driver -->
+        <dependency>
+            <groupId>mysql</groupId>
+            <artifactId>mysql-connector-java</artifactId>
+            <version>8.0.20</version>
+        </dependency>
+    </dependencies>
+</project>

src/main/java/com/chinaitop/generate/GenerateDatabaseDocument.java

@@ -0,0 +1,62 @@
+package com.chinaitop.generate;
+
+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 javax.sql.DataSource;
+import java.util.Arrays;
+import java.util.List;
+
+public class GenerateDatabaseDocument {
+
+	public static void main(String[] args) {
+		// 数据源
+		HikariConfig hikariConfig = new HikariConfig();
+		hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
+		hikariConfig.setJdbcUrl("jdbc:mysql://101.36.160.140:10311/test?serverTimezone=UTC");
+		hikariConfig.setUsername("root");
+		hikariConfig.setPassword("admin@1234");
+		// 设置可以获取tables remarks信息
+		hikariConfig.addDataSourceProperty("useInformationSchema", "true");
+		hikariConfig.setMinimumIdle(2);
+		hikariConfig.setMaximumPoolSize(5);
+		DataSource dataSource = new HikariDataSource(hikariConfig);
+        //生成文件路径，到本项目下
+		String put = System.getProperty("user.dir") + "/depot-database-document/src/main/java";
+		// 1、生成文件配置
+		EngineConfig engineConfig = EngineConfig.builder()
+		// 生成文件路径
+				.fileOutputDir(put)
+				// 打开目录
+				.openOutputDir(false)
+				// 文件类型
+				.fileType(EngineFileType.WORD)
+				// 生成模板实现
+				.produceType(EngineTemplateType.freemarker).build();
+
+		// 忽略表名
+		List<String> ignoreTableName = Arrays.asList("test");
+		// 忽略表前缀
+		List<String> ignorePrefix = Arrays.asList("test_", "test");
+		// 忽略表后缀
+		List<String> ignoreSuffix = Arrays.asList("_test", "test");
+
+		// 2、配置想要忽略的表
+		ProcessConfig processConfig = ProcessConfig.builder().ignoreTableName(ignoreTableName)
+				.ignoreTablePrefix(ignorePrefix).ignoreTableSuffix(ignoreSuffix).build();
+
+		// 3、生成文档配置（包含以下自定义版本号、描述等配置连接）
+		Configuration config = Configuration.builder().version("1.0.0").description("数据库文档").dataSource(dataSource)
+				.engineConfig(engineConfig).produceConfig(processConfig).build();
+
+		// 4、执行生成
+		new DocumentationExecute(config).execute();
+	}
+
+}