当前位置: 首页 > news >正文

JAVA-文档工具screw-gui

前言

为什么萌生了写文档工具得想法,因为在项目开发得过程中,经常需要补充一些文档,比如数据库文档、详细设计文档等等,文档与项目相绑定,在项目需求新增或变更时,文档也需要反反复复得修改。
在这里插入图片描述

1. 数据库文档工具

Screw 是个不错sdk, 可以方便得生成数据库文档 。

  • 支持maven插件方式构建文档
  • 支持main方法方式生成文档

不管什么方式,还是跟项目相绑定,有时候想写文档得时候,不太关注程序。不想单独启动IDE只是为了运行生成文档。 不想使用Navicat 特意查看数据库信息,所以构建了该小工具。

1.1 功能简介

目前只支持 mysql和sqlite3
常用信息默认已经初始化,只需要修改保存目录和文件名称即可
连接测试:验证数据库信息是否正确
预览库: 查看数据表信息和表结构
备份: 保存数据库连接信息
历史备份:加载历史数据库连接信息,内置删除和编辑功能

ps: 第二次生成时 ,文件目录和名称未修改,若文件已在word或wps打开,因为文件被占用所以生成失败

1.2 使用示例

在这里插入图片描述

1.3 补充说明

  • QA: screw 支持多个数据库, 为什么工具不支持
  1. 因为平时工作只用mysql, 而且版本为5.7,所以maven依赖中只添加了mysql依赖
      <dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.29</version></dependency>
  1. 增加screw支持的数据库, screw-swing -->pom.xml 添加依赖, 打包即可

2. swagger文档工具

在开发时经常使用swagger 文档,比较好用得算 Knife4j。swagger2 后来又升级迭代为openApi3,常用注解变更挺大,所以需要写2种方式parser转换器,该工具得初衷也只是本地不启动服务得同时,直接访问测试环境得API接口就可以生成文档。

2.1 功能简介

  1. 选择API类型
  2. 修改保存目录和文件名称
  3. 填写swagger地址,http开头则使用get方法请求json信息 或直接填写json信息。
  4. 生成即可

    ps: 第二次生成时 ,文件目录和名称未修改,若文件已在word或wps打开,因为文件被占用所以生成失败

2.2 使用示例

在这里插入图片描述

1.3 补充说明

  • QA: 文档格式不喜欢,怎么自定义
    模板基于beetl 设置, 找到screw-swing–>resources–>templates–>word.btl . 在这里插入图片描述

3.如何下载

3.1 项目地址

项目已上传至码云:码云screw-gui

  • build 目录可以下载可执行jar和exe (免安装)
    在这里插入图片描述

3.2 模块依赖关系

依赖
依赖
依赖
screw-gui
note-swing-db
note-service-toolkit
note-swing-core

3.3 补充说明

QA: 为什么简单的工具, 但是项目这么臃肿
note-开头的工程 ,都是个人项目基础依赖, 因为有时候在写其他的工具的时候用到. 但是如果不提供这些工程,你无法在IDE中顺利编译. 当然可以使用lib形式引用, 使项目看起来更简洁。

4. 其他说明

  • QA: 本地安装java环境但是无法运行
    该程序基于jdk1.8+和swing开发,java版本可能过低。 exe4j打包时寻找环境变量顺序如图,找不到环境变量则无法运行。
    在这里插入图片描述

  • QA: 是否可以本地不安装java环境并运行工具
    下载jar包,使用exe4j 打包exe时内嵌jre ,可以在未安装java环境的系统中运行,但是因为jre的大小,文件大小会从6MB -->160MB左右

  • QA: 非windows系统如何使用
    java -jar screw-gui.jar 或者使用工具打包为相应系统可执行程序

相关文章:

JAVA-文档工具screw-gui

前言 为什么萌生了写文档工具得想法&#xff0c;因为在项目开发得过程中&#xff0c;经常需要补充一些文档&#xff0c;比如数据库文档、详细设计文档等等&#xff0c;文档与项目相绑定&#xff0c;在项目需求新增或变更时&#xff0c;文档也需要反反复复得修改。 1. 数据库…...

开源鸿蒙南向嵌入学习笔记——NAPI框架学习(一)

开源鸿蒙南向嵌入学习笔记——NAPI框架学习&#xff08;一&#xff09; 前言——系列介绍 本系列文章主要是记录笔者在鸿蒙南向的学习与工作中的知识点笔记记录&#xff0c;其中不止会针对鸿蒙中的学习问题进行思考与记录&#xff0c;也会对涉及到的一些嵌入式等其他领域知识&…...

Spring - Spring框架概述面试题总结

文章目录01. 什么是Spring&#xff1f;02. Spring框架的设计目标&#xff0c;设计理念&#xff0c;和核心是什么&#xff1f;03. Spring的优点是什么&#xff1f;04. Spring框架中都用到了哪些设计模式&#xff1f;05. Spring有哪些应用场景?06. Spring由哪些模块组成&#xf…...

学习python好就业么

Python的普及与数据挖掘、人工智能和数值计算等领域的蓬勃发展相关&#xff0c;但同时也与普遍编程需求的增加有关。 Python作为人工智能的头号语言&#xff0c;一方面会吸引大量计划从事人工智能的人来学习&#xff0c;另一方面自然也带动了网络上对这门“新语言”的关注和讨…...

瑞幸咖啡的最终目标并不是做国内市场大哥

出品 | 何玺 排版 | 叶媛 日前&#xff0c;瑞幸咖啡发布2022年第四季度及全年财报。数据显示&#xff0c;在刚刚过去的2022年&#xff0c;瑞幸咖啡首次实现了营收超百亿&#xff0c;门店规模也超越老对手星巴克&#xff0c;成为了国内第一连锁咖啡品牌。 那么&#xff0c;瑞幸…...

GPT 模型介绍 | GPT3 / GPT3.5 + Flask | Github源码链接

1. 模型介绍 Chatgpt 使用与 InstructGPT相同的方法&#xff0c;使用来自人类反馈的强化学习 (RLHF) 来训练该模型&#xff0c;但数据收集设置略有不同。我们使用监督微调训练了一个初始模型&#xff1a;人类 AI 训练员提供对话&#xff0c;他们在对话中扮演双方——用户和 AI…...

蓝桥杯入门即劝退(二十六)组合问题(回溯算法)

-----持续更新Spring入门系列文章----- 如果你也喜欢Java和算法&#xff0c;欢迎订阅专栏共同学习交流&#xff01; 你的点赞、关注、评论、是我创作的动力&#xff01; -------希望我的文章对你有所帮助-------- 专栏&#xff1a;蓝桥杯系列 一、题目描述 给定两个整数 n …...

现代卷积神经网络(ResNet)

专栏&#xff1a;神经网络复现目录 本章介绍的是现代神经网络的结构和复现&#xff0c;包括深度卷积神经网络&#xff08;AlexNet&#xff09;&#xff0c;VGG&#xff0c;NiN&#xff0c;GoogleNet&#xff0c;残差网络&#xff08;ResNet&#xff09;&#xff0c;稠密连接网络…...

PTA:L1-019 谁先倒、L1-020 帅到没朋友、L1-021 重要的话说三遍(C++)

目录 L1-019 谁先倒 问题描述&#xff1a; L1-020 帅到没朋友 问题描述&#xff1a; 实现代码&#xff08;只过了部分&#xff09;&#xff1a; L1-021 重要的话说三遍 问题描述&#xff1a; 实现代码&#xff1a; 无解析 L1-019 谁先倒 问题描述&#xff1a; 划拳是…...

STL常见容器之set/multiset、map/multimap

set/multiset—集合容器 特点 所有元素都会在插入时自动被排序 本质 set/multiset属于关联式容器&#xff0c;底层结构是二叉树实现 set和multiset区别 set不可以插入重复数据&#xff0c;而multiset可以set插入数据的同时会返回插入结果&#xff0c;表示插入是否成功multiset…...

ThreadLocal 实现原理

每个 Thread 中都存储着一个成员变量&#xff1a;ThreadLocalMap /** InheritableThreadLocal values pertaining to this thread. This map is* maintained by the InheritableThreadLocal class.*/ThreadLocal.ThreadLocalMap inheritableThreadLocals null; ThreadLocal 本…...

BUUCTF [羊城杯 2020]easyre 题解

一.查壳 64位无壳 二.主函数逻辑 可以得知flag长度为38,然后进行三次加密 第一次加密是base64加密,得到code1 第二次加密是将code1拆成四段赋给code2 第三次加密是将code2内的数字和字母移3位,其他字符不变 str2保存的是最终的加密字符 三.encode_one_base64 看到主函数…...

网络协议(十二):HTTPS(SSL/TLS、TLS1.2的连接)

网络协议系列文章 网络协议(一)&#xff1a;基本概念、计算机之间的连接方式 网络协议(二)&#xff1a;MAC地址、IP地址、子网掩码、子网和超网 网络协议(三)&#xff1a;路由器原理及数据包传输过程 网络协议(四)&#xff1a;网络分类、ISP、上网方式、公网私网、NAT 网络…...

九九乘法表--课后程序(Python程序开发案例教程-黑马程序员编著-第3章-课后作业)

实例9&#xff1a;九九乘法表 乘法口诀是中国古代筹算中进行乘法、除法、开方等运算的基本计算规则&#xff0c;沿用至今已有两千多年。古代的乘法口诀与现在使用的乘法口诀顺序相反&#xff0c;自上而下从“九九八十一”开始到“一一如一”为止&#xff0c;因此&#xff0c;古…...

在超算上安装文件树命令tree

超算平台使用的centos系统没有内置tree命令&#xff0c;需要通过源码安装。记录安装流程如下。 1. 下载源码包 下载链接如下&#xff1a; http://mama.indstate.edu/users/ice/tree/ 选择“Download the latest version” 如本文下载了源码包“tree-2.1.0.tgz”. 2. 源码包…...

论文投稿指南——中文核心期刊推荐(经济管理)

【前言】 &#x1f680; 想发论文怎么办&#xff1f;手把手教你论文如何投稿&#xff01;那么&#xff0c;首先要搞懂投稿目标——论文期刊 &#x1f384; 在期刊论文的分布中&#xff0c;存在一种普遍现象&#xff1a;即对于某一特定的学科或专业来说&#xff0c;少数期刊所含…...

在vue中如果computed属性是一个异步操作怎么办?

在计算属性中使用异步方法时&#xff0c;可以使用async/await来处理异步操作。由于计算属性是基于它们的依赖缓存的&#xff0c;所以我们需要使用一个返回Promise的异步方法来确保计算属性能够正常运行。 下面是一个简单的示例&#xff0c;演示如何在计算属性中使用异步方法&am…...

SRP合批问题

1&#xff09;SRP合批问题 ​2&#xff09;多个Base相机渲染到同一个渲染目标&#xff0c;移动平台花屏的问题 3&#xff09;粒子系统对GPU Instancing的支持 4&#xff09;如何修改URP下场景和UI分辨率分离&#xff08;不需要改颜色空间&#xff09; 这是第327篇UWA技术知识分…...

蓝牙5.1低功耗SOC 私有协议2.4GHz芯片HS6621

HS6621CxC是一个优化功耗真正芯片系统&#xff08;SOC&#xff09;解决方案&#xff0c;适用于蓝牙低功耗和私有的2.4GHz应用场景。它集成了一个高性能、小功率的射频收发器&#xff0c;具有蓝牙基带和丰富的外围IO扩展。还集成了电源管理&#xff0c;以提供高效的电源管理。 …...

数据库连接池

数据库连接---执行完毕---释放 连接--释放 十分浪费系统资源 池化技术&#xff1a;准备一些预先的资源&#xff0c;过来就连接预先准备好的 最小连接数&#xff1a; 10 最大连接数&#xff1a;15 业务最高承载上限 排队等待&#xff0c; 等待超时&#xff1a;100…...

第19节 Node.js Express 框架

Express 是一个为Node.js设计的web开发框架&#xff0c;它基于nodejs平台。 Express 简介 Express是一个简洁而灵活的node.js Web应用框架, 提供了一系列强大特性帮助你创建各种Web应用&#xff0c;和丰富的HTTP工具。 使用Express可以快速地搭建一个完整功能的网站。 Expre…...

oracle与MySQL数据库之间数据同步的技术要点

Oracle与MySQL数据库之间的数据同步是一个涉及多个技术要点的复杂任务。由于Oracle和MySQL的架构差异&#xff0c;它们的数据同步要求既要保持数据的准确性和一致性&#xff0c;又要处理好性能问题。以下是一些主要的技术要点&#xff1a; 数据结构差异 数据类型差异&#xff…...

论文浅尝 | 基于判别指令微调生成式大语言模型的知识图谱补全方法(ISWC2024)

笔记整理&#xff1a;刘治强&#xff0c;浙江大学硕士生&#xff0c;研究方向为知识图谱表示学习&#xff0c;大语言模型 论文链接&#xff1a;http://arxiv.org/abs/2407.16127 发表会议&#xff1a;ISWC 2024 1. 动机 传统的知识图谱补全&#xff08;KGC&#xff09;模型通过…...

【学习笔记】深入理解Java虚拟机学习笔记——第4章 虚拟机性能监控,故障处理工具

第2章 虚拟机性能监控&#xff0c;故障处理工具 4.1 概述 略 4.2 基础故障处理工具 4.2.1 jps:虚拟机进程状况工具 命令&#xff1a;jps [options] [hostid] 功能&#xff1a;本地虚拟机进程显示进程ID&#xff08;与ps相同&#xff09;&#xff0c;可同时显示主类&#x…...

ABAP设计模式之---“简单设计原则(Simple Design)”

“Simple Design”&#xff08;简单设计&#xff09;是软件开发中的一个重要理念&#xff0c;倡导以最简单的方式实现软件功能&#xff0c;以确保代码清晰易懂、易维护&#xff0c;并在项目需求变化时能够快速适应。 其核心目标是避免复杂和过度设计&#xff0c;遵循“让事情保…...

基于Java+MySQL实现(GUI)客户管理系统

客户资料管理系统的设计与实现 第一章 需求分析 1.1 需求总体介绍 本项目为了方便维护客户信息为了方便维护客户信息&#xff0c;对客户进行统一管理&#xff0c;可以把所有客户信息录入系统&#xff0c;进行维护和统计功能。可通过文件的方式保存相关录入数据&#xff0c;对…...

Windows安装Miniconda

一、下载 https://www.anaconda.com/download/success 二、安装 三、配置镜像源 Anaconda/Miniconda pip 配置清华镜像源_anaconda配置清华源-CSDN博客 四、常用操作命令 Anaconda/Miniconda 基本操作命令_miniconda创建环境命令-CSDN博客...

NPOI操作EXCEL文件 ——CAD C# 二次开发

缺点:dll.版本容易加载错误。CAD加载插件时&#xff0c;没有加载所有类库。插件运行过程中用到某个类库&#xff0c;会从CAD的安装目录找&#xff0c;找不到就报错了。 【方案2】让CAD在加载过程中把类库加载到内存 【方案3】是发现缺少了哪个库&#xff0c;就用插件程序加载进…...

【Elasticsearch】Elasticsearch 在大数据生态圈的地位 实践经验

Elasticsearch 在大数据生态圈的地位 & 实践经验 1.Elasticsearch 的优势1.1 Elasticsearch 解决的核心问题1.1.1 传统方案的短板1.1.2 Elasticsearch 的解决方案 1.2 与大数据组件的对比优势1.3 关键优势技术支撑1.4 Elasticsearch 的竞品1.4.1 全文搜索领域1.4.2 日志分析…...

SQL Server 触发器调用存储过程实现发送 HTTP 请求

文章目录 需求分析解决第 1 步:前置条件,启用 OLE 自动化方式 1:使用 SQL 实现启用 OLE 自动化方式 2:Sql Server 2005启动OLE自动化方式 3:Sql Server 2008启动OLE自动化第 2 步:创建存储过程第 3 步:创建触发器扩展 - 如何调试?第 1 步:登录 SQL Server 2008第 2 步…...