1.引入依赖
<!-- screw 库,简洁好用的数据库表结构文档生成器 -->
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.5</version>
</dependency>
2.使用编码形式生成文档
/**
* 数据库文档生成类
* @author byChen
* @date 2021/10/8
*/
public class ScrewMain {
private static final String DB_URL = "jdbc:mysql://400-infra.server.iocoder.cn:3306";
private static final String DB_NAME = "mall_system";
private static final String DB_USERNAME = "root";
private static final String DB_PASSWORD = "3WLiVUBEwTbvAfsh";
private static final String FILE_OUTPUT_DIR = "/Users/yunai/screw_test";
// 可以设置 Word 或者 Markdown 格式
private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.HTML;
private static final String DOC_FILE_NAME = "数据库文档";
public static void main(String[] args) {
// 创建 screw 的配置
Configuration config = Configuration.builder()
// 版本
.version("1.0.0")
// 描述
.description("文档描述")
// 数据源
.dataSource(buildDataSource())
// 引擎配置
.engineConfig(buildEngineConfig())
// 处理配置
.produceConfig(buildProcessConfig())
.build();
// 执行 screw,生成数据库文档
new DocumentationExecute(config).execute();
}
/**
* 创建数据源
*/
private static DataSource buildDataSource() {
// 创建 HikariConfig 配置类
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
//数据库、表名称
hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/springcloudlearn");
//数据库账号密码
hikariConfig.setUsername("root");
hikariConfig.setPassword("root");
// 设置可以获取 tables remarks 信息
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
// 创建数据源
return new HikariDataSource(hikariConfig);
}
/**
* 创建 screw 的引擎配置
*/
private static EngineConfig buildEngineConfig() {
return EngineConfig.builder()
// 生成文件路径
.fileOutputDir("D:/screw")
// 打开目录
.openOutputDir(false)
// 文件类型
.fileType( EngineFileType.MD)
// 文件类型
.produceType(EngineTemplateType.freemarker)
// 自定义文件名称
.fileName("数据库文档")
.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_user", "test_group"))
// 忽略表前缀
.ignoreTablePrefix(Collections.singletonList("test_"))
// 忽略表后缀
.ignoreTableSuffix(Collections.singletonList("_test"))
.build();
}
}
3.文件生成
文档格式内容:
生成成功
具体可参考文档 : 参考文章