欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

springboot+screw 数据库文档生成

程序员文章站 2022-03-15 13:29:06
...

引入依赖 :cn.smallbun.screw

    /*
     * @Author jt
     * @Description //数据库文档生成
     * @Date 2020/8/6
     * @Param []
     * @return void
     **/

    @Autowired
    ApplicationContext applicationContext;
    
    @Test
    void test() {
        DataSource dataSource = applicationContext.getBean(DataSource.class);

        // 1、生成文件配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("C:\\Users\\htj\\Desktop")
                //打开目录
                .openOutputDir(false)
                //文件类型
                .fileType(EngineFileType.HTML)
                //生成模板实现
                .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")
                .description("数据库设计文档生成")
                .dataSource(dataSource)
                .engineConfig(engineConfig)
                .produceConfig(processConfig).build();

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

    }

 

相关标签: config