SpringBoot 集成 screw 数据库文档生成工具

Bertha 。 2022-11-30 12:24 193阅读 0赞

### SpringBoot 集成 screw 数据库文档生成工具 ###

*  添加依赖
 *  配置数据源
 *  代码
 *  参考资料

使用非常简单，按官方引导，一次成功。  
我当前是 `Springboot 2.3.3.RELEASE`

# 添加依赖 #

官网的教程中还引用了`freemarker` 可能是教程比较旧。我用的时候只引用这个就够了

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

[最新版本查看：https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core][https_mvnrepository.com_artifact_cn.smallbun.screw_screw-core]

# 配置数据源 #

从后面的代码中可以看出，它是从`Spring上下文`中取的`数据源`信息，如果你的项目已经配置好了可以跳过。  
`application.yml`

spring:
      #数据库连接配置
      datasource:
        driverClassName: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=GMT%2B8
        username: root
        password: root

# 代码 #

创建个test类把以下代码复制过去执行即可。  
注释很详细，不多说了。  
直接执行 test方法 `contextLoads()`即可。

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 org.junit.jupiter.api.Test;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.context.ApplicationContext;
    
    import javax.sql.DataSource;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.List;
    
    @SpringBootTest
    class ScrewApplicationTests { 
    
        @Autowired
        ApplicationContext applicationContext;
    
        @Test
        void contextLoads() { 
        	// 数据源
            DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);
    
            // 生成文件配置
            EngineConfig engineConfig = EngineConfig.builder()
                    // 生成文件路径。与官方的例子不同，我是win10系统，就先放E盘根目录吧。
                    .fileOutputDir("E://")
                    // 打开目录
                    .openOutputDir(false)
                    // 文件类型
                    .fileType(EngineFileType.WORD)
                    // 生成模板实现
                    .produceType(EngineTemplateType.freemarker).build();
    
            // 生成文档配置（包含以下自定义版本号、描述等配置连接），文档名称拼接：数据库名_描述_版本.扩展名
            Configuration config = Configuration.builder()
                    .version("1.0.3") // 版本
                    .description("数据库设计文档") // 描述
                    .dataSource(dataSourceMysql) // 数据源
                    .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("a", "t");
            // 忽略表后缀
            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();
        }
    }

# 参考资料 #

[官网：gitee][gitee]  
[官网：github][github]  
[官网教程：SpringBoot整合screw生成数据库文档][gitee]

[Demo源码，直接改下`application.yml`中的数据库配置就能跑了][Demo_application.yml]

[https_mvnrepository.com_artifact_cn.smallbun.screw_screw-core]: https://mvnrepository.com/artifact/cn.smallbun.screw/screw-core
[gitee]: https://toscode.gitee.com/leshalv/screw
[github]: https://github.com/pingfangushi/screw
[Demo_application.yml]: https://gitee.com/jerryjin0630/screw-demo