当前位置:

首页 > 系统应用 > SpringBoot使用Screw自动生成数据库表结构文档工具

SpringBoot使用Screw自动生成数据库表结构文档工具

在企业级开发过程中,编写数据库表结构文档是一项常见的工作。我从业多年,也待过几家企业,发现数据库表结构文档的状态普遍不太理想:要么根本没有,要么有也是手写的。在后期运维开发时,还需要手动将变更维护到文档中,这是一件非常繁琐的事情。如果忘记了一次维护,就会给以后的工作带来很多麻烦,给自己和后来的同事都

本文目录

    在企业级开发过程中,编写数据库表结构文档是一项常见的工作。我从业多年,也待过几家企业,发现数据库表结构文档的状态普遍不太理想:要么根本没有,要么有也是手写的。在后期运维开发时,还需要手动将变更维护到文档中,这是一件非常繁琐的事情。如果忘记了一次维护,就会给以后的工作带来很多麻烦,给自己和后来的同事都挖了不少坑。所以,我们非常需要一个插件工具来帮助我们维护数据库表结构文档,这个工具就是screw。

    screw工具地址:https://gitee.com/leshalv/screw?utm_source=alading&utm_campaign=repo

    特点:

    • 简洁、轻量、设计良好

    • 多数据库支持

    • 多种格式文档

    • 灵活扩展

    • 支持自定义模板

    数据库支持:

    • MySQL
    • MariaDB
    • TIDB
    • Oracle
    • SqlServer
    • PostgreSQL
    • Cache DB(2016)

    使用方式:

    1、配置pom文件,添加依赖包。

    引入screw核心包,HikariCP数据库连接池,HikariCP号称性能最出色的数据库连接池。



    cn.smallbun.screw
    screw-core
    1.0.3




    com.zaxxer
    HikariCP
    3.4.5




    mysql
    mysql-connector-ja va
    8.0.20

    2、配置数据源

    ####  数据库配置  ####
    spring.datasource.url = jdbc:mysql://localhost:3306/PiaoDB?useUnicode=swater&characterEncoding=UTF-8
    spring.datasource.username = root
    spring.datasource.password = root
    spring.datasource.driver-class-name = com.mysql.jdbc.Driver

    3、screw 核心配置

    screw有两种执行方式,第一种是pom文件配置,另一种是代码执行。

    3.1、代码使用:

    @SpringBootTest
    public class ScrewApplicationTests {

    @Autowired
    ApplicationContext applicationContext;

    @Test
    void contextLoads() {
    DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);
    // 生成文件配置
    EngineConfig engineConfig = EngineConfig.builder()
    // 生成文件路径,自己mac本地的地址,这里需要自己更换下路径
    .fileOutputDir("D:/")
    // 打开目录
    .openOutputDir(false)
    // 文件类型
    .fileType(EngineFileType.HTML)
    // 生成模板实现
    .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 ignoreTableName = Arrays.asList("a", "test_group");
    // 忽略表前缀,如忽略a开头的数据库表
    List ignorePrefix = Arrays.asList("a", "t");
    // 忽略表后缀
    List ignoreSuffix = Arrays.asList("_test", "czb_");
    return ProcessConfig.builder()
    //根据名称指定表生成
    .designatedTableName(Arrays.asList("fire_user"))
    //根据表前缀生成
    .designatedTablePrefix(new ArrayList<>())
    //根据表后缀生成
    .designatedTableSuffix(new ArrayList<>())
    //忽略表名
    .ignoreTableName(ignoreTableName)
    //忽略表前缀
    .ignoreTablePrefix(ignorePrefix)
    //忽略表后缀
    .ignoreTableSuffix(ignoreSuffix).build();
    }
    }

    3.2、ma ven插件使用:

     


    org.springframework.boot
    spring-boot-ma ven-plugin


    cn.smallbun.screw
    screw-ma ven-plugin
    1.0.3



    com.zaxxer
    HikariCP
    3.4.5



    mysql
    mysql-connector-ja va
    8.0.20




    root

    root

    com.mysql.cj.jdbc.Driver

    jdbc:mysql://localhost:3306/PiaoDB?useUnicode=swater&characterEncoding=UTF-8

    HTML

    false

    freemarker



    数据库文档生成

    ${project.version}

    fire数据库文档



    compile

    run





    配置完以后在,我们只要点击screw:run就运行了。如下图:

    文档生成支持:

    • html
    • word
    • markdown

    代码中的修改:

    .fileType(EngineFileType.HTML)

    pom文件配置:

    MD

    文档截图:

    1、word文档样式

    2、html文档样式

    3、markdown文档样式:

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    系统应用
    相关文章 更多
    悟空浏览器怎么彻底清理浏览器配置文件
    悟空浏览器怎么彻底清理浏览器配置文件

    彻底清理悟空浏览器的数据,通常有三个路径:通过手机系统设置能一次性清除所有配置和用户信息;利用浏览器内置功能,可以只清理缓存而保留个性化设置;最彻底的则是卸载重装,让应用回到初始状态。 悟空浏览器用久了,是不是偶尔会感觉变慢,或者出现一些难以解释的小毛病?有时候,与其一个个排查问题,不如来一次彻底的

    漫蛙漫画官网首页登录入口
    漫蛙漫画官网首页登录入口

    漫蛙漫画首页登录入口https://www.manwamh.top/:一触即达的漫画世界核心枢纽 对于漫画迷而言,找到那个可靠的资源门户至关重要。漫蛙漫画的首页登录入口,正是这样一个核心渠道。通过它,你可以直接跳转到漫蛙2漫画APP的下载页面,轻松几步完成安装,马上就能投入到精彩纷呈的漫画之旅中。 漫蛙漫画首页登录入口: 官方入口地址已经为你备好

    漫蛙漫画官方入口
    漫蛙漫画官方入口

    漫蛙漫画官方入口与核心功能解析 寻找一个稳定、资源丰富的漫画在线阅读平台,是许多漫画爱好者的共同需求。其中,漫蛙漫画官方入口及其免费全集服务,受到了不少关注。那么,这个平台究竟如何?下面,我们就来深入了解一下它的具体信息与特色功能。 平台的官方访问地址是:https://www.manwa123.c

    漫蛙动漫APP最新版本下载
    漫蛙动漫APP最新版本下载

    对于动漫爱好者而言,找到一个资源全、体验佳的追番平台,常常是件头疼事。漫蛙动漫APP的定位很明确:就是要打造一个聚合全球正版动漫资源的专属乐园。无论是当季火爆的日漫新番、值得回味的经典国创,还是那些小众却精彩的优质动画,在这里基本都能一网打尽。平台底层采用了智能缓冲技术,最大程度保证了播放的流畅度,

    漫蛙官网入口免费下载最新版
    漫蛙官网入口免费下载最新版

    想要获取正版manwa漫蛙APP?官方指定下载渠道就是漫蛙官网入口。 对于漫画迷而言,找到一款心仪的阅读神器至关重要。漫蛙APP正是这样一款专为全球漫画爱好者打造的平台,它汇聚了从日韩人气连载到本土原创精品的海量资源。说它“应有尽有”毫不为过。更重要的是,其界面设计清爽直观,搭配智能检索功能,能让用

    漫蛙漫画在线观看入口
    漫蛙漫画在线观看入口

    想要畅享海量正版漫画资源?漫蛙漫画平台不容错过 对于漫画迷来说,找到一个资源丰富、体验流畅的正版平台实属幸事。漫蛙漫画凭借其优质的在线阅读服务,已经成为了许多资深读者的心头好。今天,我们就来详细拆解一下平台的访问方法与实用技巧,助你轻松开启漫画之旅。 漫蛙漫画网页入口页面指南 想立刻体验?官方在线观

    漫蛙如何下载最新版本
    漫蛙如何下载最新版本

    漫蛙漫画网APP官方下载方法全解析 对于资深漫画迷来说,找到一个资源全、更新快、体验佳的阅读平台,就像淘到了宝藏。漫蛙漫画网APP,正是这样一个专为爱好者打造的精品集散地。它汇聚了全球优质的正版漫画,从火爆的日漫连载到崛起的国创佳作,平台都能做到实时同步更新。当然,第一步得先把它装到设备上。接下来,

    漫蛙漫画APP最新版本下载
    漫蛙漫画APP最新版本下载

    漫蛙漫画APP:专业漫画阅读工具的全面革新 作为一款专业的漫画阅读工具,漫蛙漫画APP整合了全球优质漫画资源,其升级版漫蛙2在功能与体验上可谓全面革新。这款应用不仅囊括日漫经典与国漫新作,更通过简洁直观的界面设计和流畅操作,为用户打造沉浸式阅读环境,充分满足各类漫画爱好者的多样化需求。 漫蛙漫画特色

    卖茶叶妈妈3d漫蛙安卓版下载
    卖茶叶妈妈3d漫蛙安卓版下载

    当下动漫圈热议的卖茶叶妈妈3d漫蛙下载,凭借其突破性的3D视觉技术成为焦点 最近动漫爱好者们都在讨论一个现象级产品——卖茶叶妈妈3d漫蛙下载。这款由漫蛙漫画平台倾力打造的3D作品专区,用立体建模与动态分镜彻底颠覆了传统二维漫画的阅读模式。你猜怎么着?现在只需通过专区提供的便捷下载通道,无论是热血冒险

    漫蛙下载最新版本
    漫蛙下载最新版本

    漫蛙APP:资深漫画迷的移动图书馆与阅读利器 对于漫画爱好者来说,找到一个资源全、体验好的阅读平台,从来都不是件容易的事。而漫蛙APP,恰恰就是为这个需求而生的。它凭借海量的正版漫画库和极其便捷的离线下载功能,在圈内积累了相当不错的口碑。更重要的是,从经典的日本热血漫到新兴的国产原创作品,它几乎一网

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。