screw快速导出数据库表结构文档
引入依赖
<!-- freemarker -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
<!-- screw -->
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.5</version>
</dependency>
<!-- HikariCP -->
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>3.4.5</version>
</dependency>
<!--mysql driver-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.20</version>
</dependency>
编写代码
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 javax.sql.DataSource;
import java.util.ArrayList;
public class DbExport {
public static final String host = "192.168.2.111";
public static final String db_name = "health_card_investigation";
public static final String file_path = "E:\\2";
public static void main(String[] args) {
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
hikariConfig.setJdbcUrl("jdbc:mysql://" + host +
":3306/" + db_name + "?serverTimezone=UTC&useUnicode=true" +
"&zeroDateTimeBehavior=convertToNull&autoReconnect=true&characterEncoding=utf-8");
hikariConfig.setUsername("root");
hikariConfig.setPassword("admin");
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
hikariConfig.setMinimumIdle(2);
hikariConfig.setMaximumPoolSize(5);
DataSource dataSource = new HikariDataSource(hikariConfig);
Configuration config = Configuration.builder()
.version("1.0.0")
.description("数据库设计文档生成")
.dataSource(dataSource)
.engineConfig(getEngineConfig())
.produceConfig(getProcessConfig())
.build();
new DocumentationExecute(config).execute();
}
public static EngineConfig getEngineConfig() {
return EngineConfig.builder()
.fileOutputDir(file_path)
.openOutputDir(true)
.fileType(EngineFileType.WORD)
.produceType(EngineTemplateType.freemarker)
.build();
}
public static ProcessConfig getProcessConfig() {
ArrayList<String> ignoreTableName = new ArrayList<>();
ArrayList<String> ignorePrefix = new ArrayList<>();
ArrayList<String> ignoreSuffix = new ArrayList<>();
return ProcessConfig.builder()
.designatedTableName(new ArrayList<>())
.designatedTablePrefix(new ArrayList<>())
.designatedTableSuffix(new ArrayList<>())
.ignoreTableName(ignoreTableName)
.ignoreTablePrefix(ignorePrefix)
.ignoreTableSuffix(ignoreSuffix).build();
}
}
参考
https://gitee.com/leshalv/screw