南阳专业网站建设价格,网站建设费用 优帮云,哪里需要人做钓鱼网站,忻州网站建设求职简历前言
为什么萌生了写文档工具得想法#xff0c;因为在项目开发得过程中#xff0c;经常需要补充一些文档#xff0c;比如数据库文档、详细设计文档等等#xff0c;文档与项目相绑定#xff0c;在项目需求新增或变更时#xff0c;文档也需要反反复复得修改。
1. 数据库…前言
为什么萌生了写文档工具得想法因为在项目开发得过程中经常需要补充一些文档比如数据库文档、详细设计文档等等文档与项目相绑定在项目需求新增或变更时文档也需要反反复复得修改。
1. 数据库文档工具
Screw 是个不错sdk, 可以方便得生成数据库文档 。
支持maven插件方式构建文档支持main方法方式生成文档
不管什么方式还是跟项目相绑定有时候想写文档得时候不太关注程序。不想单独启动IDE只是为了运行生成文档。 不想使用Navicat 特意查看数据库信息所以构建了该小工具。
1.1 功能简介
目前只支持 mysql和sqlite3 常用信息默认已经初始化只需要修改保存目录和文件名称即可 连接测试验证数据库信息是否正确 预览库 查看数据表信息和表结构 备份 保存数据库连接信息 历史备份加载历史数据库连接信息内置删除和编辑功能 ps: 第二次生成时 文件目录和名称未修改若文件已在word或wps打开因为文件被占用所以生成失败 1.2 使用示例 1.3 补充说明
QA: screw 支持多个数据库, 为什么工具不支持
因为平时工作只用mysql, 而且版本为5.7,所以maven依赖中只添加了mysql依赖 dependencygroupIdmysql/groupIdartifactIdmysql-connector-java/artifactIdversion8.0.29/version/dependency增加screw支持的数据库, screw-swing --pom.xml 添加依赖, 打包即可
2. swagger文档工具
在开发时经常使用swagger 文档比较好用得算 Knife4j。swagger2 后来又升级迭代为openApi3常用注解变更挺大所以需要写2种方式parser转换器该工具得初衷也只是本地不启动服务得同时直接访问测试环境得API接口就可以生成文档。
2.1 功能简介
选择API类型修改保存目录和文件名称填写swagger地址http开头则使用get方法请求json信息 或直接填写json信息。生成即可 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 模块依赖关系
#mermaid-svg-ajSFs9zQJmkV4vN4 {font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;fill:#333;}#mermaid-svg-ajSFs9zQJmkV4vN4 .error-icon{fill:#552222;}#mermaid-svg-ajSFs9zQJmkV4vN4 .error-text{fill:#552222;stroke:#552222;}#mermaid-svg-ajSFs9zQJmkV4vN4 .edge-thickness-normal{stroke-width:2px;}#mermaid-svg-ajSFs9zQJmkV4vN4 .edge-thickness-thick{stroke-width:3.5px;}#mermaid-svg-ajSFs9zQJmkV4vN4 .edge-pattern-solid{stroke-dasharray:0;}#mermaid-svg-ajSFs9zQJmkV4vN4 .edge-pattern-dashed{stroke-dasharray:3;}#mermaid-svg-ajSFs9zQJmkV4vN4 .edge-pattern-dotted{stroke-dasharray:2;}#mermaid-svg-ajSFs9zQJmkV4vN4 .marker{fill:#333333;stroke:#333333;}#mermaid-svg-ajSFs9zQJmkV4vN4 .marker.cross{stroke:#333333;}#mermaid-svg-ajSFs9zQJmkV4vN4 svg{font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;}#mermaid-svg-ajSFs9zQJmkV4vN4 .label{font-family:"trebuchet ms",verdana,arial,sans-serif;color:#333;}#mermaid-svg-ajSFs9zQJmkV4vN4 .cluster-label text{fill:#333;}#mermaid-svg-ajSFs9zQJmkV4vN4 .cluster-label span{color:#333;}#mermaid-svg-ajSFs9zQJmkV4vN4 .label text,#mermaid-svg-ajSFs9zQJmkV4vN4 span{fill:#333;color:#333;}#mermaid-svg-ajSFs9zQJmkV4vN4 .node rect,#mermaid-svg-ajSFs9zQJmkV4vN4 .node circle,#mermaid-svg-ajSFs9zQJmkV4vN4 .node ellipse,#mermaid-svg-ajSFs9zQJmkV4vN4 .node polygon,#mermaid-svg-ajSFs9zQJmkV4vN4 .node path{fill:#ECECFF;stroke:#9370DB;stroke-width:1px;}#mermaid-svg-ajSFs9zQJmkV4vN4 .node .label{text-align:center;}#mermaid-svg-ajSFs9zQJmkV4vN4 .node.clickable{cursor:pointer;}#mermaid-svg-ajSFs9zQJmkV4vN4 .arrowheadPath{fill:#333333;}#mermaid-svg-ajSFs9zQJmkV4vN4 .edgePath .path{stroke:#333333;stroke-width:2.0px;}#mermaid-svg-ajSFs9zQJmkV4vN4 .flowchart-link{stroke:#333333;fill:none;}#mermaid-svg-ajSFs9zQJmkV4vN4 .edgeLabel{background-color:#e8e8e8;text-align:center;}#mermaid-svg-ajSFs9zQJmkV4vN4 .edgeLabel rect{opacity:0.5;background-color:#e8e8e8;fill:#e8e8e8;}#mermaid-svg-ajSFs9zQJmkV4vN4 .cluster rect{fill:#ffffde;stroke:#aaaa33;stroke-width:1px;}#mermaid-svg-ajSFs9zQJmkV4vN4 .cluster text{fill:#333;}#mermaid-svg-ajSFs9zQJmkV4vN4 .cluster span{color:#333;}#mermaid-svg-ajSFs9zQJmkV4vN4 div.mermaidTooltip{position:absolute;text-align:center;max-width:200px;padding:2px;font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:12px;background:hsl(80, 100%, 96.2745098039%);border:1px solid #aaaa33;border-radius:2px;pointer-events:none;z-index:100;}#mermaid-svg-ajSFs9zQJmkV4vN4 :root{--mermaid-font-family:"trebuchet ms",verdana,arial,sans-serif;}依赖依赖依赖screw-guinote-swing-dbnote-service-toolkitnote-swing-core3.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 或者使用工具打包为相应系统可执行程序
