# gui-tool

**Repository Path**: mrpanyu/gui-tool

## Basic Information

- **Project Name**: gui-tool
- **Description**: This is a simple framework for quickly building java swing based gui tools.

Useful when you need to create some simple gui tool for colleages but do not know(or care) how to write swing code.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-08-28
- **Last Updated**: 2025-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Swing

## README

# GUI-TOOL

这是一个可以用java语言快速开发简单的桌面图形化工具的框架。

当你需要用java做一个个性化的小工具提供给人用，比如包含一些自己算法的密码加密工具等，但做成命令行工具用起来诸多不便，想要提供个图形化的界面，确又不想从头研究图形界面该怎么编程的时候，这个框架可以帮你快速实现。

无需Swing等图形界面组件的相关知识，只需要java编程能力即可。

## 使用方法

开发和使用的人都需要有 JDK/JRE 8 以上。开发需要会使用maven。

整个工程源码下载到本地后，使用 `mvn install` 命令安装到本地repository。

安装后，可以到 `tools/all-tools/target` 目录下，执行 `java -jar all-tools-1.0.0.jar` 来看现有示例工具的运行效果。

>注：all-tools是我把我做的常用工具全放一起打了一个整包，因此打出来的jar包比较大。单独功能的工具也可以独立打包，打包大小基本是取决于依赖的其他三方jar包有多少。

## 程序结构

其中 `gui-tool-base` 是框架代码，会以 maven dependency 的方式嵌入你的工具程序里面，其他如 `gui-tool-example` 以及 `tools` 目录下的，全是已做成的工具的示例。你可以拷贝 `gui-tool-example` 或 `tools` 里面任意一个工程，来开发你自己的工具。

所有例子工程都是若干自定义标注过的工具类加上一个Main方法类的形式。每个工具类只是一个普通java类，在其属性/方法上加上一些标注后，就能被框架解析成图形界面表单来使用。Main方法则负责将这些工具类传给框架做初始化。

所有例子工程的pom.xml文件都配置过maven-shade-plugin，进行 `mvn package` 后，会产生一个含所有依赖的完整jar包。只需要提供这个完整jar包给需要的人，直接使用 `java -jar xxx-tool-1.0.0.jar` 即可使用。