一：介绍

将数据库的表和字段的设计，专程doc,md,html等文档,
此工具已经在miniprogram项目中做了示例，test/DataBaseDoc.java

• gitee工具介绍

二：使用

2.1 pom.xml引入

<!-- 生成数据库表字段文档的工具 -->
<dependency>
	<groupId>cn.smallbun.screw</groupId>
	<artifactId>screw-core</artifactId>
	<version>1.0.5</version>
</dependency>

2.2 实例代码

package com.tohours.miniprogram.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;

/**
 * @desc 生成数据库文档 gitee文档： https://gitee.com/leshalv/screw
 * @author RenJie
 * @date 2023-01-12
 *
 */
public class DataBaseDoc {
	
	//驱动名称
	public static final String DRIVER_CLASS_NAME = "com.mysql.cj.jdbc.Driver";
	//jdbcurl地址
	public static final String JDBC_URL = "jdbc:mysql://localhost:3306/miniprogram";
	//数据库用户名
	public static final String USER_NAME = "develop";
	//数据库密码
	public static final String PASSWORD = "123456";
	//输出文件的路径
	public static final String FILE_OUTPUT_DIR = "C:\\Users\\Administrator\\Desktop\\doc";
	//输出文件的格式
	public static EngineFileType FILE_TYPE = EngineFileType.HTML;
	//输出文件的名称
	public static String FILE_NAME = "miniprogram_数据文档";
	//文档版本号
	public static String VERSION = "1.0.0";
	//文档描述文字
	public static String DESCRIPTION = "MiniProgram数据库";
	
	public static void main(String[] args) {
		documentGeneration();
	}
	/**
	 * 文档生成
	 */
	public static void documentGeneration() {
	   //数据源
	   HikariConfig hikariConfig = new HikariConfig();
	   hikariConfig.setDriverClassName(DRIVER_CLASS_NAME);
	   hikariConfig.setJdbcUrl(JDBC_URL);
	   hikariConfig.setUsername(USER_NAME);
	   hikariConfig.setPassword(PASSWORD);
	   //设置可以获取tables remarks信息
	   hikariConfig.addDataSourceProperty("useInformationSchema", "true");
	   hikariConfig.setMinimumIdle(2);
	   hikariConfig.setMaximumPoolSize(5);
	   DataSource dataSource = new HikariDataSource(hikariConfig);
	   //生成配置
	   EngineConfig engineConfig = EngineConfig.builder()
	         //生成文件路径
	         .fileOutputDir(FILE_OUTPUT_DIR)
	         //打开目录
	         .openOutputDir(true)
	         //文件类型
	         .fileType(FILE_TYPE)
	         //生成模板实现
	         .produceType(EngineTemplateType.freemarker)
	         //自定义文件名称
	         .fileName(FILE_NAME).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(VERSION)
	         //描述
	         .description(DESCRIPTION)
	         //数据源
	         .dataSource(dataSource)
	         //生成配置
	         .engineConfig(engineConfig)
	         //生成配置
	         .produceConfig(processConfig)
	         .build();
	   //执行生成
	   new DocumentationExecute(config).execute();
	}
}

2.3 文档截图