引入依赖

  1. <dependency>
  2. <groupId>cn.smallbun.screw</groupId>
  3. <artifactId>screw-core</artifactId>
  4. <version>1.0.3</version>
  5. </dependency>

请自行配置好数据源

目前screw支持的数据库

  • MySQL
  • MariaDB
  • TIDB
  • Oracle
  • SqlServer
  • PostgreSQL
  • Cache DB
  • H2 (开发中)
  • DB2 (开发中)
  • HSQL (开发中)
  • SQLite(开发中)
  • 瀚高(开发中)
  • 达梦 (开发中)
  • 虚谷 (开发中)
  • 人大金仓(开发中)

在SpringBoot中编写测试类

  1. package com.landimc.sbs;
  2.  
  3. import javax.sql.DataSource;
  4. import cn.smallbun.screw.core.Configuration;
  5. import cn.smallbun.screw.core.engine.EngineConfig;
  6. import cn.smallbun.screw.core.engine.EngineFileType;
  7. import cn.smallbun.screw.core.engine.EngineTemplateType;
  8. import cn.smallbun.screw.core.execute.DocumentationExecute;
  9. import cn.smallbun.screw.core.process.ProcessConfig;
  10. import org.junit.jupiter.api.Test;
  11. import org.springframework.beans.factory.annotation.Autowired;
  12. import org.springframework.boot.test.context.SpringBootTest;
  13. import org.springframework.context.ApplicationContext;
  14.  
  15. import javax.sql.DataSource;
  16. import java.util.ArrayList;
  17. import java.util.Arrays;
  18. import java.util.List;
  19.  
  20. @SpringBootTest
  21. class SbsApplicationTests {
  22.  
  23. @Autowired
  24. ApplicationContext applicationContext;
  25.  
  26. @Test
  27. void contextLoads() {
  28. DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);
  29.  
  30. // 生成文件配置
  31. EngineConfig engineConfig = EngineConfig.builder()
  32. // 生成文件路径
  33. .fileOutputDir("E:\\doc\\zqt")
  34. // 打开目录
  35. .openOutputDir(false)
  36. // 文件类型(目前支持html、doc、MD格式,个人体验后还是html格式生成后看起来比较舒服,建议使用)
  37. .fileType(EngineFileType.HTML)
  38. // 生成模板实现
  39. .produceType(EngineTemplateType.freemarker).build();
  40.  
  41. // 生成文档配置(包含以下自定义版本号、描述等配置连接)
  42. Configuration config = Configuration.builder().version("1.0.0").description("文档描述").dataSource(dataSourceMysql).engineConfig(engineConfig).produceConfig(getProcessConfig()).build();
  43.  
  44. // 执行生成
  45. new DocumentationExecute(config).execute();
  46. }
  47.  
  48. /**
  49. * 配置想要生成的表+ 配置想要忽略的表
  50. *
  51. * @return 生成表配置
  52. */
  53. public static ProcessConfig getProcessConfig() {
  54. // 忽略表名,需要忽略的表将表名放到list中即可
  55. //List<String> ignoreTableName = Arrays.asList("aa", "test_group");
  56. // 忽略表前缀,如忽略a开头的数据库表
  57. //List<String> ignorePrefix = Arrays.asList("a", "t");
  58. // 忽略表后缀
  59. //List<String> ignoreSuffix = Arrays.asList("_test", "czb_");
  60.  
  61. return ProcessConfig.builder()
  62. // 根据名称指定表生成
  63. .designatedTableName(new ArrayList<>())
  64. // 根据表前缀生成
  65. .designatedTablePrefix(new ArrayList<>())
  66. // 根据表后缀生成
  67. .designatedTableSuffix(new ArrayList<>()).build();
  68.  
  69. }
  70.  
  71. }

Screw数据库文档生成神器的更多相关文章

  1. 【C#附源码】数据库文档生成工具支持(Excel+Html)

    [2015] 很多时候,我们在生成数据库文档时,使用某些工具,可效果总不理想,不是内容不详细,就是表现效果一般般.很多还是word.html的.看着真是别扭.本人习惯用Excel,所以闲暇时,就简单的 ...

  2. 【C#附源码】数据库文档生成工具支持(Excel+Htm)

    数据库文档生成工具是用C#开发的基于NPOI组件的小工具.软件源码大小不到10MB.支持生成Excel 和Html 两种文档形式.了解更多,请访问:http://www.oschina.net/cod ...

  3. 基于Mybatis的Mysql数据库文档生成工具,支持生成docx(原创)

    今天不写android--也写写数据库相关的东西 -------------------- 今日老夫闲来无事,设计了一款数据库文档生成工具 眼下仅仅支持mysql 主要是生成docx的 下载链接:下载 ...

  4. DBCHM -最简单、最实用的数据库文档生成工具

    项目介绍 DBCHM 是一款数据库文档生成工具! 该工具从最初支持chm文档格式开始,通过开源,集思广益,不断改进,又陆续支持word.excel.pdf.html.xml.markdown等文档格式 ...

  5. 数据库文档生成工具——word2chm,SqlSpec

    首先使用代码生成器可以生成word版本的数据库文档. 转成chm格式的更加小巧和方便~ SqlSpec是个好工具,可以生成所有数据库相关的信息 之后可以一键生成chm文档.

  6. 求你别再用swagger了,给你推荐几个在线文档生成神器

    前言 最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的 能够实时生成在线文档 支持全文搜索 支持在线调试功能 界面优美 说实话,这个需求看起来简 ...

  7. 【转】Jsduck一个纯净的前端文档生成神器

    让前端程序更具可维护性,是一个老生常谈的问题,大多数时候我们都关注于应用层面的代码可维护性,如:OO.模块化.MVC,编码规范.可扩展和复用性,但这都是属于设计层面需要考虑的事情,可维护性还应包含另一 ...

  8. vs开发nodejs api文档生成神器-apidoc

    直接生成文档的神器 apidoc 1 win+R 输入 cmd 回车 然后进入 nodejs 项目目录 例如 D:\NodeTest\newApp1 2  用npm安装 apidoc 直接输入 npm ...

  9. 生成 Visual Studio 中的代码的文档生成神器

    当我们在团队开发中的时候,经常要给别人提供文档,有了这个工具,设置一下,一键生成.前提是你要写好xml注释. 这也是开源项目: https://sandcastle.codeplex.com/ 它就是 ...

  10. 再见丑陋的 SwaggerUI,这款开源的API文档生成神器界面更炫酷,逼格更高!

    一般在使用 Spring Boot 开发前后端分离项目的时候,都会用到 Swagger.Swagger 是一个规范和完整的框架,用于生成.描述.调试和可视化 RESTful 风格的 Web API 服 ...

随机推荐

  1. idea-lombok使用

    一.添加 lombok 插件 file -- setting  -- plugins - 输入 Lombok 搜索,进行安装 二.引入依赖 <dependency> <groupId ...

  2. 02. C语言基础知识

    一.注释   注释 就是对代码进行解释说明的文字,注释的内容不会参与编译和运行,仅仅是对代码的解释说明.在 C语言 中注释主要分为以下两类: 单行注释://,注释内容从 // 始到本行和结尾 多行注释 ...

  3. JMeter压力测试之环境搭建、脚本调试及报错解决方法(Linux版)

    一.环境部署 后续往服务器上传文件,本文中使用的是xftp,因其不是本文所要讲述的重点,这里不做详解. 第一步:安装所需要版本的JDK,本次使用的是JDK 1.8 下载地址:http://www.or ...

  4. netmiko批量操作网络设备_pandas版

    from concurrent.futures import ThreadPoolExecutor import netmiko import os from threading import Loc ...

  5. 靶机练习5: Sar

    靶机地址 https://www.vulnhub.com/entry/sar-1,425/ 信息收集阶段 进行全端口扫描,枚举目标的端口和服务 nmap -n -v -sS --max-retries ...

  6. Unity C#for和foreach效率比较

    下面是代码自己测试一下即可 using System.Collections; using System.Collections.Generic; using UnityEngine; public ...

  7. Route路径

  8. 当win7遭遇蓝屏代码0x0000006b

    转载请注明来源:https://www.cnblogs.com/Sherlock-L/p/15069877.html 关键词:win7.蓝屏.0x0000006b 事发 话说在某个周末,当我打开电脑, ...

  9. Spring @aspect

    在 开发过程中,需要对每个 方法 执行时 进行日志 记录, 故而 整理一下, 有关 AOP 的 相关 知识点. 1. 切面类: @Aspect :   定义切面类, 加上 @Aspect,@Compo ...

  10. moduleNotFoundError:No module named 'exceptions'

    如果pip install docx 过请先卸载,输入如下指令: pip uninstall docx 方法一: pip install python-docx 方法二: 下载: python_doc ...