springboot导出MYSQL数据库文档 screw集成

仓廪实则知礼节，衣食足则知荣辱。这篇文章主要讲述springboot导出MYSQL数据库文档 screw集成相关的知识，希望能为你提供帮助。
先上结果图

生成的结果数据排版格式都是嘎嘎板正
目前支持html，word，和md格式，可自定义配置
操作流程
1.pom依赖引入

< dependency> < groupId> cn.smallbun.screw< /groupId> < artifactId> screw-core< /artifactId> < version> 1.0.3< /version> < /dependency>

2.test代码接在test运行

代码

package com.yssy.shop;

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;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

@SpringBootTest(classes = DateExcel.class)
class DateExcel
@Test
void contextLoads()
//数据源
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");
hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/cdw_ds?useUnicode=true& characterEncoding=UTF-8& useSSL=false& serverTimezone=Asia/Shanghai");
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("E:/screwTest")
// 打开目录
.openOutputDir(false)
// 文件类型有HTMLWORDMD三种枚举
.fileType(EngineFileType.WORD)
// 生成模板实现
.produceType(EngineTemplateType.freemarker).build();

// 生成文档配置（包含以下自定义版本号、描述等配置连接）
Configuration config = Configuration.builder()
.version("1.0.4")
.description("生成文档信息描述")
.dataSource(dataSource)
.engineConfig(engineConfig)
.produceConfig(getProcessConfig())
.build();

// 执行生成
new DocumentationExecute(config).execute();

/**
* 配置想要生成的表+ 配置想要忽略的表
*
* @return 生成表配置
*/
public static ProcessConfig getProcessConfig()
// 忽略表名
List< String> ignoreTableName = Arrays.asList("aa", "test_group");
// 忽略表前缀，如忽略a开头的数据库表
List< String> ignorePrefix = Arrays.asList("mail", "scm", "sys", "api");
// 忽略表后缀
List< String> ignoreSuffix = Arrays.asList("_test", "czb_");

return ProcessConfig.builder()
//根据名称指定表生成
.designatedTableName(new ArrayList< > ())
//根据表前缀生成
.designatedTablePrefix(new ArrayList< > ())
//根据表后缀生成
.designatedTableSuffix(new ArrayList< > ())
//忽略表名
.ignoreTableName(ignoreTableName)
//忽略表前缀
.ignoreTablePrefix(ignorePrefix)
//忽略表后缀
.ignoreTableSuffix(ignoreSuffix).build();