相信大家会有数据库文档的需求,就是我们在开发中需要知道数据库中某个表的情况,我们可能会去数据库中查找,但是如果表非常多,而且表的字段也非常多的时候,这个是一个非常不明智的选择,我们可以生成一个数据库开发文档随时查阅
1、引入依赖
jdbc这个依赖不能少,HikariConfig这个类的包需要这个依赖,import com.zaxxer.hikari.HikariConfig; import com.zaxxer.hikari.HikariDataSource;
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- screw核心 -->
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.3</version>
</dependency>
2、配置数据源
设置 useInformationSchema
可以获取tables
注释信息。
spring.datasource.url=jdbc:mysql://45.93.1.5:3306/fire?useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.xa.properties.useInformationSchema=true
3、screw 核心配置
screw有两种执行方式,第一种是pom文件配置,另一种是代码执行。
pom:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-maven-plugin</artifactId>
<version>1.0.3</version>
<dependencies>
<!-- 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>
</dependencies>
<configuration>
<!--username-->
<username>root</username>
<!--password-->
<password>123456</password>
<!--driver-->
<driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
<!--jdbc url-->
<jdbcUrl>jdbc:mysql://41.92.6.5:3306/fire</jdbcUrl>
<!--生成文件类型-->
<fileType>HTML</fileType>
<!--打开文件输出目录-->
<openOutputDir>false</openOutputDir>
<!--生成模板-->
<produceType>freemarker</produceType>
<!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
<!--<docName>测试文档名称</docName>-->
<!--描述-->
<description>数据库文档生成</description>
<!--版本-->
<version>${project.version}</version>
<!--标题-->
<title>fire数据库文档</title>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
配置完以后在 maven project->screw 双击执行ok。
代码生成方式也非常简单。↓↓↓help me click open AD,thanks!!
@Test
void contextLoads() {
//数据源:HikariCP 线程池, SpringBoot 2.0开始内置了HikariCP,2.0之前的版本需要引入依赖
HikariConfig hikariConfig = new HikariConfig();
// com.mysql.jdbc.Driver MySQL5驱动;com.mysql.cj.jdbc.Driver MySQL6之后的驱动
hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/shrio?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC");
hikariConfig.setUsername("root");
hikariConfig.setPassword("123456");
//设置可以获取tables remarks信息
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
hikariConfig.setMinimumIdle(2);
hikariConfig.setMaximumPoolSize(5);
DataSource dataSource = new HikariDataSource(hikariConfig);
// 1、生成文件配置
EngineConfig engineConfig = EngineConfig.builder()
//生成文件路径(改成自己的生成路径)
.fileOutputDir("C:\\Users\\use\\Desktop")
//生成后是否立即打开目录
.openOutputDir(true)
//文件类型 有HTML、WORD、MD三种枚举选择
.fileType(EngineFileType.WORD)
//生成模板实现
.produceType(EngineTemplateType.freemarker).build();
// 忽略表名(可选)
List<String> ignoreTableName = Arrays.asList("aa", "test_group");
// 忽略表前缀(可选)
List<String> ignorePrefix = Collections.singletonList("czb_");
// 忽略表后缀(可选)
List<String> ignoreSuffix = Arrays.asList("_test", "_test1");
// 2、配置想要忽略的表(可选)
ProcessConfig processConfig = ProcessConfig.builder()
.ignoreTableName(ignoreTableName)
.ignoreTablePrefix(ignorePrefix)
.ignoreTableSuffix(ignoreSuffix)
.build();
// 3、生成文档配置(包含以下自定义版本号、标题、描述(数据库名 + 描述 = 文件名)等配置连接)
Configuration config = Configuration.builder()
.version("1.0.0")
.title("数据库文档")
.description("数据库设计文档生成")
.dataSource(dataSource)
.engineConfig(engineConfig)
.produceConfig(processConfig).build();
// 4、执行生成
new DocumentationExecute(config).execute();
}
我这边生成的是word格式的文档,大家可以看效果