数据库表结构文档生成工具-screw

数据库表结构文档生成工具-screw

screw-gitee地址

效果展示

使用方式

新建springboot项目，不需要其他操作

1.普通方式

pom.xml

<!-- 数据库文档核心依赖 -->
<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(我使用的是mysql)-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.25</version>
</dependency>

@SpringBootTest
public class ScrewApplicationTests {
    @Test
    public void shouldAnswerWithTrue() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/purchase");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("123456");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("F:/")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.HTML)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker).build();
		//忽略表
	    ArrayList<String> ignoreTableName = new ArrayList<>();
	    ignoreTableName.add("test_user");
	    ignoreTableName.add("test_group");
	    //忽略表前缀
	    ArrayList<String> ignorePrefix = new ArrayList<>();
	    ignorePrefix.add("test_");
	    //忽略表后缀
	    ArrayList<String> ignoreSuffix = new ArrayList<>();
	    ignoreSuffix.add("_test");
        ProcessConfig processConfig =ProcessConfig.builder()            	
        	//忽略表名
            .ignoreTableName(ignoreTableName)
            //忽略表前缀
            .ignoreTablePrefix(ignorePrefix)
            //忽略表后缀
            .ignoreTableSuffix(ignoreSuffix).build();
        //配置
        Configuration config = Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("采购管理数据库设计文档")
                //数据源
                .dataSource(dataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig).build();
        //执行生成
        new DocumentationExecute(config).execute();
    }
}

2.maven插件

pom.xml

<build>
   <plugins>
   		<plugin>...</plugin>
   		<plugin>...</plugin>
   		...
   </plugins>
</build>

<plugin>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-maven-plugin</artifactId>
    <version>1.0.5</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.25</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://127.0.0.1:3306/dynasty</jdbcUrl>
        <!--生成文件类型-->
        <fileType>HTML</fileType>
        <!--文件输出目录-->
        <fileOutputDir>F:/</fileOutputDir>
        <!--打开文件输出目录-->
        <openOutputDir>true</openOutputDir>
        <!--生成模板-->
        <produceType>freemarker</produceType>
        <!--描述-->
        <description>数据库设计文档</description>
        <!--版本-->
        <version>1.0.0</version>
        <!--标题-->
        <title>数据库文档</title>
    </configuration>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>run</goal>
            </goals>
        </execution>
    </executions>
</plugin>