1.引入MAVEN依赖
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.5</version>
</dependency>
2.配置相关常量
// 可以设置 Word 或者 Markdown 格式
private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;
private static final String DOC_VERSION = "V1.0.0";
private static final String DOC_DESCRIPTION = "数据库表设计描述";
private static final String DB_URL = "jdbc:mysql://127.0.0.1:3306";
private static final String DB_USERNAME = "root";
private static final String DB_PASSWORD = "password";
private static final String DB_NAME = "test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8";
private static final String FILE_OUTPUT_DIR = "C:\\Users\\Public\\Desktop";
private static final String DOC_FILE_NAME = "数据库表设计文档";
3.创建数据源
/**
* 创建数据源
*/
private static DataSource buildDataSource() {
// 创建 HikariConfig 配置类
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("com.mysql.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);
}
4.创建 screw 的引擎配置
/**
* 创建 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();
}
5.创建 screw 的处理配置
/**
* 创建 screw 的处理配置,一般可忽略
* 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时,将生成指定表,其余表不生成、并跳过忽略表配置
*/
private static ProcessConfig buildProcessConfig() {
return ProcessConfig.builder()
// 根据名称指定表生成
.designatedTableName(Collections.<String>emptyList())
// 根据表前缀生成
// .designatedTablePrefix(Arrays.asList(new String[]{"xxx_"}))
// 根据表后缀生成
.designatedTableSuffix(Collections.<String>emptyList())
// 忽略表名
// .ignoreTableName(Arrays.asList("test", "mytable", "role", "t_role", "t_user"))
// 忽略表前缀
.ignoreTablePrefix(Collections.singletonList("gen_"))
// 忽略表后缀
//.ignoreTableSuffix(Collections.singletonList("_test"))
.build();
}
6.调用
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();
}
标签:screw,String,DB,数据库,一键,private,文档,static,final
From: https://blog.csdn.net/itwen_666/article/details/140460827