java如何实现⾃动⽣成数据库设计⽂档
⽬录
前⾔
实现步骤
main⽅法类全部代码
表qrtz_blob_triggers
表qrtz_calendars
表qrtz_cron_triggers
前⾔
以前我们还需要⼿写数据库设计⽂档、现在可以通过引⼊screw核⼼包来实现Java 数据库⽂档⼀键⽣成。话不多说、直接上代码演⽰。
⽀持的数据库列表：
MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
这些主流的数据库都⽀持的。
实现步骤
引⼊ l核⼼配置screw包
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.5</version>
</dependency>
java连接sqlserver数据库main⽅法类全部代码
package ller;
/**
* Created by LiYangYong on 2021/11/11
*/
import cn.Configuration;
import cn.ngine.EngineConfig;
import cn.ngine.EngineFileType;
import cn.ngine.EngineTemplateType;
import cn.xecute.DocumentationExecute;
import cn.process.ProcessConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import javax.sql.DataSource;
import java.util.Arrays;
import java.util.Collections;
/**
* Created by LiYangYong on 2021/11/11.
*/
public class TestScrewMain {
private static final String DB_URL = "jdbc:mysql://localhost:3307";
private static final String DB_NAME = "renren_fast?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai";
private static final String DB_USERNAME = "root";
private static final String DB_PASSWORD = "crit@2019";
private static final String FILE_OUTPUT_DIR = "C:\\Users\\Administrator\\Desktop\\java\\";
// 可以设置 Word 或者 Markdown 格式
private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;
private static final String DOC_FILE_NAME = "数据库表设计⽂档";
private static final String DOC_VERSION = "V1.0.0";
private static final String DOC_DESCRIPTION = "数据库表设计描述";
public static void main(String[] args) {
// 创建 screw 的配置
Configuration config = Configuration.builder()
// 版本
.version(DOC_VERSION)
// 描述
.description(DOC_DESCRIPTION)
// 数据源
.dataSource(buildDataSource())
// 引擎配置
.engineConfig(buildEngineConfig())
/
/ 处理配置
.produceConfig(buildProcessConfig())
.build();
// 执⾏ screw，⽣成数据库⽂档
new DocumentationExecute(config).execute();
}
/**
* 创建数据源
*/
private static DataSource buildDataSource() {
// 创建 HikariConfig 配置类
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("sql.jdbc.Driver");
hikariConfig.setJdbcUrl(DB_URL + "/" + DB_NAME);
hikariConfig.setUsername(DB_USERNAME);
hikariConfig.setPassword(DB_PASSWORD);
// 设置可以获取 tables remarks 信息
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
// 创建数据源
return new HikariDataSource(hikariConfig);
}
/**
* 创建 screw 的引擎配置
*/
private static EngineConfig buildEngineConfig() {
return EngineConfig.builder()
// ⽣成⽂件路径
.fileOutputDir(FILE_OUTPUT_DIR)
// 打开⽬录
.openOutputDir(false)
// ⽂件类型
.fileType(FILE_OUTPUT_TYPE)
// ⽂件类型
.
produceType(EngineTemplateType.freemarker)
// ⾃定义⽂件名称
.fileName(DOC_FILE_NAME)
.build();
}
/**
* 创建 screw 的处理配置，⼀般可忽略
* 指定⽣成逻辑、当存在指定表、指定表前缀、指定表后缀时，将⽣成指定表，其余表不⽣成、并跳过忽略表配置    */
private static ProcessConfig buildProcessConfig() {
return ProcessConfig.builder()
// 根据名称指定表⽣成
.designatedTableName(Collections.<String>emptyList())
// 根据表前缀⽣成
.designatedTablePrefix(Collections.<String>emptyList())
// 根据表后缀⽣成
.designatedTableSuffix(Collections.<String>emptyList())
// 忽略表名
.ignoreTableName(Arrays.asList("test", "mytable","role","t_role","t_user"))
// 忽略表前缀
//.ignoreTablePrefix(Collections.singletonList("t_"))
// 忽略表后缀
//.ignoreTableSuffix(Collections.singletonList("_test"))
.
build();
}
}
⽣成的数据库设计⽂档演⽰
表qrtz_blob_triggers
表qrtz_calendars
表qrtz_cron_triggers
这样就解放双⼿拉。
到此这篇关于java如何实现⾃动⽣成数据库设计⽂档的⽂章就介绍到这了，更多相关java⾃动⽣成数据库⽂档内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持！