hikariconfig mysql_根据数据库生成数据库文档

数据库支持

MySQL

MariaDB

TIDB

Oracle

SqlServer

PostgreSQL

Cache DB(2016)

文档生成支持

html

word

markdown

步骤

导入依赖

com.zaxxer

HikariCP

3.1.0

mysql

mysql-connector-java

8.0.21

cn.smallbun.screw

screw-core

1.0.5

编写代码

public class ScrewTest {

/**

* 文档生成

*/

@Test

public void documentGeneration() {

//数据源

HikariConfig hikariConfig = new HikariConfig();

hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");

hikariConfig.setJdbcUrl("jdbc:mysql://192.1.2.3:3306/msmsys?useUnicode=true&characterEncoding=UTF-8&&serverTimezone=GMT%2B8");

hikariConfig.setUsername("root");

hikariConfig.setPassword("root");

//设置可以获取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)

//文件类型

.fileType(EngineFileType.MD)

//生成模板实现

.produceType(EngineTemplateType.freemarker)

//自定义文件名称

.fileName("自定义文件名称").build();

//忽略表

ArrayList ignoreTableName = new ArrayList<>();

ignoreTableName.add("test_user");

ignoreTableName.add("test_group");

//忽略表前缀

ArrayList ignorePrefix = new ArrayList<>();

ignorePrefix.add("test_");

//忽略表后缀

ArrayList 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();

}

}

标签：数据库,生成,忽略,文档,ignoreTableName,new,hikariConfig,ArrayList

来源： https://www.cnblogs.com/menghe123/p/14417400.html