Skip to content

Commit 6096299

Browse files
committed
更新说明文档
1 parent ab5fcbf commit 6096299

1 file changed

Lines changed: 32 additions & 60 deletions

File tree

README.md

Lines changed: 32 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,17 @@
44

55
**腾讯云开发平台地址:**[xJavaFxTool](https://dev.tencent.com/u/xwintop/p/xJavaFxTool)
66

7-
<p align="center">
8-
<a target="_blank" href="https://www.apache.org/licenses/LICENSE-2.0.html">
9-
<img src="https://img.shields.io/:license-apache-blue.svg" ></img>
10-
</a>
11-
<a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
12-
<img src="https://img.shields.io/badge/JDK-1.8+-green.svg" ></img>
13-
</a>
14-
<a target="_blank" href="https://gitee.com/xwintop/xJavaFxTool/stargazers">
15-
<img src='https://gitee.com/xwintop/xJavaFxTool/badge/star.svg?theme=dark' alt='gitee star'></img>
16-
</a>
17-
<a target="_blank" href='https://github.com/864381832/xJavaFxTool'>
18-
<img src="https://img.shields.io/github/stars/864381832/xJavaFxTool.svg?style=social" alt="github star"></img>
19-
</a>
20-
</p>
7+
::: hljs-center
8+
![](https://img.shields.io/:license-apache-blue.svg) ![](https://img.shields.io/badge/JDK-1.8+-green.svg) ![](https://gitee.com/xwintop/xJavaFxTool/badge/star.svg?theme=dark) ![](https://img.shields.io/github/stars/864381832/xJavaFxTool.svg?style=social)
9+
:::
2110

2211
[英文说明/English Documentation](README_EN.md)
2312

2413
**xJavaFxTool交流QQ群:== [387473650](https://jq.qq.com/?_wv=1027&k=59UDEAD) ==**
2514
**xJavaFxTool吐个槽:== [进来吐槽](https://support.qq.com/product/127577) ==**
2615

2716
#### 项目简介:
28-
xJavaFxTool是使用javaFx开发的实用小工具集,利用业余时间把工作中遇到的一些问题总结起来,打包进小工具集中,供大家参考和使用,里面包含了javaFx的一些功能的示例,如布局、国际化、第三方UI库([controlsfx](http://fxexperience.com/controlsfx/)[JFoenix](http://www.jfoenix.com/))、外部jar包加载(插件机制)等一些常用功能,想学习javaFx的同学可以参考参考,学习javaFx的资料参考[www.javafxchina.net](http://www.javafxchina.net/main/)
17+
xJavaFxTool是使用javaFx开发的实用小工具集,利用业余时间把工作中遇到的一些问题总结起来,打包进小工具集中,供大家参考和使用,里面包含了javaFx的一些功能的示例,如布局、国际化、第三方UI库[controlsfx](http://fxexperience.com/controlsfx/)[JFoenix](http://www.jfoenix.com/)等、外部jar包加载(插件机制)等一些常用功能,想学习javaFx的同学可以参考参考,学习javaFx的资料参考[www.javafxchina.net](http://www.javafxchina.net/main/)
2918

3019
由于SpringBoot的火热,项目已经出SpringBoot-javafx版本,[xJavaFxTool-spring](https://gitee.com/xwintop/xJavaFxTool-spring) 欢迎参考,谢谢。
3120

@@ -40,87 +29,79 @@ xJavaFxTool是使用javaFx开发的实用小工具集,利用业余时间把工
4029
- 腾讯微云链接:[https://share.weiyun.com/5T6FPLW](https://share.weiyun.com/5T6FPLW) 提取码:java
4130

4231
#### 支持插件开发:
43-
将插件jar包放至根目录libs下即可自动加载(插件开发示例见[开源项目xJavaFxTool-plugin](https://gitee.com/xwintop/xJavaFxTool-plugin),后续准备将小工具拆分至各插件中按需加载,目前插件功能暂不完善,后续将各功能拆分至各模块按需加载,减小jar包的大小);
32+
将插件jar包放至根目录libs下即可自动加载,插件开发示例见[开源项目xJavaFxTool-plugin](https://gitee.com/xwintop/xJavaFxTool-plugin),后续准备将小工具拆分至各插件中按需加载,目前插件功能暂不完善,后续将各功能拆分至各模块按需加载,减小jar包的大小;
4433

4534
#### 环境搭建说明:
4635
- 开发环境为jdk1.8,基于maven构建
47-
- 使用eclipase或Intellij Idea开发(推荐使用[Intellij Idea](https://www.jetbrains.com/idea/))
36+
- 使用eclipase或Intellij Idea开发,推荐使用[Intellij Idea](https://www.jetbrains.com/idea/)
4837
- 本项目使用了[lombok](https://projectlombok.org/),在查看本项目时如果您没有下载lombok 插件,请先安装,不然找不到get/set等方法
4938
- 依赖的[xcore包](https://gitee.com/xwintop/xcore)已上传至git托管的maven平台,git托管maven可参考教程(若无法下载请拉取项目自行编译)。[教程地址:点击进入](http://blog.csdn.net/u011747754/article/details/78574026)
5039
- 使用[javafx-maven-plugin](https://github.com/javafx-maven-plugin/javafx-maven-plugin)插件进行打包操作(可打包windows、Linux、Mac安装包)
5140
- 使用[exe4j](https://www.ej-technologies.com/download/exe4j/files)将jar包转成exe执行文件(仅供参考,可使用其它程序打包)
5241
- 使用[InnoSetup](http://www.jrsoftware.org/)可进行制作windows安装包
5342

5443
#### 目前集成的小工具有:
55-
1. FileCopy:文件复制(支持自动调度拷贝功能)(使用[quartz](https://www.quartz-scheduler.org/)工具)
44+
1. FileCopy:文件复制(支持自动调度拷贝功能) 使用[quartz](https://www.quartz-scheduler.org/)工具
5645
2. CronExpBuilder:Cron表达式生成器
5746
3. CharacterConverter:编码转换
58-
4. EncryptAndDecrypt:加密解密(Ascii、Hex、Base64、Base32、URL、MD5、SHA、AES、DES、文件加密DM5、文件加密SHA1、摩斯密码、Druid加密)(使用[commons-codec](http://commons.apache.org/codec/)工具)
47+
4. EncryptAndDecrypt:加密解密(Ascii、Hex、Base64、Base32、URL、MD5、SHA、AES、DES、文件加密DM5、文件加密SHA1、摩斯密码、Druid加密)使用[commons-codec](http://commons.apache.org/codec/)工具
5948
5. TimeTool:Time转换(常用格式转换(含时区)、计算时间差、时间叠加计算)
6049
6. LinuxPathToWindowsPath:路径转换(使用[oshi](https://github.com/oshi/oshi)工具)
61-
7. QRCodeBuilder:二维码生成工具(自动生成、加入logo、截图识别、自定义格式)(使用[google.zxing](https://github.com/zxing/zxing)[jkeymaster](https://github.com/tulskiy/jkeymaster)等工具)
50+
7. QRCodeBuilder:二维码生成工具(自动生成、加入logo、截图识别、自定义格式),使用[google.zxing](https://github.com/zxing/zxing)[jkeymaster](https://github.com/tulskiy/jkeymaster)等工具
6251
8. IdCardGenerator:ID证生成器
6352
9. RegexTester:正则表达式生成工具
6453
10. ShortURL:网址缩短(目前支持百度、新浪、缩我等短网址缩短)
65-
11. EscapeCharacter:转义字符(支持Html、XML、Java、JavaScript、CSV、Sql)(使用[commons-lang3](https://commons.apache.org/lang)工具)
66-
12. ZHConverter:字符串转换(使用[hanlp](http://hanlp.com/)开源工具,实现拼音、简体-繁体、简体-臺灣正體、简体-香港繁體、繁體-臺灣正體、繁體-香港繁體、香港繁體-臺灣正體、数字金额-大写金额等直接的转换)
54+
11. EscapeCharacter:转义字符(支持Html、XML、Java、JavaScript、CSV、Sql) 使用[commons-lang3](https://commons.apache.org/lang)工具
55+
12. ZHConverter:字符串转换 使用[hanlp](http://hanlp.com/)开源工具,实现拼音、简体-繁体、简体-臺灣正體、简体-香港繁體、繁體-臺灣正體、繁體-香港繁體、香港繁體-臺灣正體、数字金额-大写金额等直接的转换
6756
13. ActiveMqTool:Mq调试工具(目前仅支持[ActiveMq](http://activemq.apache.org))
6857
14. HttpTool:Http调试工具(支持自定义发送数据、header和cookie)(使用[okhttp](https://square.github.io/okhttp/))
6958
15. jsonEditor:json格式化编辑工具
70-
16. IconTool:图标生成工具(使用[thumbnailator](https://github.com/coobird/thumbnailator)工具)
71-
17. RedisTool:Redis连接工具(使用[jedis](https://github.com/xetorthio/jedis)工具)
59+
16. IconTool:图标生成工具 使用[thumbnailator](https://github.com/coobird/thumbnailator)工具
60+
17. RedisTool:Redis连接工具 使用[jedis](https://github.com/xetorthio/jedis)工具
7261
18. WebSourcesTool:网页源码下载工具
73-
19. SwitchHostsTool:切换Hosts工具(使用[richtextfx](https://github.com/FXMisc/RichTextFX)工具)
62+
19. SwitchHostsTool:切换Hosts工具使用[richtextfx](https://github.com/FXMisc/RichTextFX)工具
7463
20. FtpServer:Ftp服务器(快速搭建本地Ftp服务)(基于[apache.ftpserver](https://mina.apache.org/ftpserver-project))
7564
21. CmdTool:Cmd调试工具
76-
22. FtpClientTool:Ftp(s)/Sftp客户端调试工具(批量上传、下载、删除文件及文件夹)(implicit/explicit SSL/TLS)(使用[jsch](http://www.jcraft.com/jsch)[commons-io](http://commons.apache.org/io/)等工具)
77-
23. PdfConvertTool:Pdf转换工具(目前仅支持pdf转图片、pdf转text功能)(使用[pdfbox](https://pdfbox.apache.org/)工具)
65+
22. FtpClientTool:Ftp(s)/Sftp客户端调试工具(批量上传、下载、删除文件及文件夹)(implicit/explicit SSL/TLS),使用[jsch](http://www.jcraft.com/jsch)[commons-io](http://commons.apache.org/io/)等工具
66+
23. PdfConvertTool:Pdf转换工具(目前仅支持pdf转图片、pdf转text功能)使用[pdfbox](https://pdfbox.apache.org/)工具
7867
24. DirectoryTreeTool:文件列表生成器
7968
25. ImageTool:图片压缩工具(批量压缩、修改尺寸、转换格式)
8069
26. AsciiPicTool:图片转码工具(包括图片生成banner码、图片转Base64码、图片转Excel表)
8170
27. KafkaTool:Kafka调试工具(未完善)(使用了[kafka-clients](http://kafka.apache.org/))
82-
28. EmailTool:Email群发工具(支持自定义群发模版)(使用[commons-email](https://commons.apache.org/email)工具)
71+
28. EmailTool:Email群发工具(支持自定义群发模版)使用[commons-email](https://commons.apache.org/email)工具
8372
29. ColorCodeConverterTool:颜色代码转换工具(包括16进制、RGB、ARGB、RGBA、HSL、HSV等代码之间转换)
8473
30. SmsTool:短信群发工具(目前支持中国移动、中国电信、腾讯云、阿里云、梦网云通讯等平台)
85-
31. ScriptEngineTool:脚本引擎调试工具(目前支持JavaScript、Groovy、Python、Lua等脚本)(使用[groovy](http://groovy-lang.org)[jython](https://jython.org)[luaj](http://www.luaj.org/luaj.html)等工具)
74+
31. ScriptEngineTool:脚本引擎调试工具(目前支持JavaScript、Groovy、Python、Lua等脚本)使用[groovy](http://groovy-lang.org)[jython](https://jython.org)[luaj](http://www.luaj.org/luaj.html)等工具
8675
32. FileRenameTool:文件重命名工具
8776
33. JsonConvertTool:Json转换工具(目前支持Json转Xml、Json转Java实体类、Json转C#实体类、Json转Excel、Json转Yaml、Properties转Yaml、Yaml转Properties)(使用[fastjson](https://github.com/alibaba/fastjson)[snakeyaml](https://bitbucket.org/asomov/snakeyaml)[dom4j](https://dom4j.github.io)等工具)
8877
34. WechatJumpGameTool:微信跳一跳助手
8978
35. TextToSpeechTool:语音转换工具(调用[百度语音](https://ai.baidu.com/tech/speech/tts)转换api)
9079
36. 2048:小游戏2048
91-
37. SocketTool:Socket调试工具(使用[Apache Mina](http://mina.apache.org)实现Tcp、Udp服务端和Client端)
80+
37. SocketTool:Socket调试工具,使用[Apache Mina](http://mina.apache.org)实现Tcp、Udp服务端和Client端
9281
38. ImageAnalysisTool:图片解析工具(1、.atlas文件反解析2、图片快速拆分工具)
9382
39. DecompilerWxApkgTool:微信小程序反编译工具(一键反编译微信小程序包)
94-
40. ZookeeperTool:Zookeeper工具(方便对zookeeper的一系列操作,包括新增、修改、删除(包括子文件)、重命名、复制、添加变更通知)(使用[zkclient](https://github.com/sgroschupf/zkclient)工具)
95-
41. ExcelSplitTool:Excel拆分工具(支持对xls、xlsx、csv及文件进行拆分操作)(使用[commons-csv](http://commons.apache.org/csv)工具)
83+
40. ZookeeperTool:Zookeeper工具(方便对zookeeper的一系列操作,包括新增、修改、删除(包括子文件)、重命名、复制、添加变更通知)使用[zkclient](https://github.com/sgroschupf/zkclient)工具
84+
41. ExcelSplitTool:Excel拆分工具(支持对xls、xlsx、csv及文件进行拆分操作)使用[commons-csv](http://commons.apache.org/csv)工具
9685
42. PathWatchTool:文件夹监控工具
97-
43. CharsetDetectTool:文件编码检测工具(使用[juniversalchardet](https://github.com/albfernandez/juniversalchardet)工具)
86+
43. CharsetDetectTool:文件编码检测工具(使用[juniversalchardet]https://github.com/albfernandez/juniversalchardet)工具
9887
44. TransferTool:传输工具(集成各种传输协议,使用自定义定时任务(简单模式、cron表达式模式),分为Receiver接收器、Filter处理器、Sender发送器)
9988
45. ScanPortTool:端口扫描工具
100-
46. FileMergeTool:文件合并工具(支持对xls、xlsx、csv及文件进行合并操作)(使用[apache.poi](http://poi.apache.org/)工具)
89+
46. FileMergeTool:文件合并工具(支持对xls、xlsx、csv及文件进行合并操作)使用[apache.poi](http://poi.apache.org/)工具
10190
47. SedentaryReminderTool:久坐提醒工具
102-
48. RandomGeneratorTool:随机数生成工具(使用[hutool](https://hutool.cn)工具)
91+
48. RandomGeneratorTool:随机数生成工具,使用[hutool](https://hutool.cn)工具
10392
49. ClipboardHistoryTool:剪贴板历史工具
104-
50. FileSearchTool:文件搜索工具(使用[lucene](https://lucene.apache.org/)搜索引擎)
105-
51. Mp3ConvertTool:Mp3转换工具(目前支持网易云音乐.ncm、QQ音乐.qmc转换为mp3格式)(使用[jaudiotagger](http://www.jthink.net/jaudiotagger/)工具)
93+
50. FileSearchTool:文件搜索工具使用[lucene](https://lucene.apache.org/)搜索引擎
94+
51. Mp3ConvertTool:Mp3转换工具(目前支持网易云音乐.ncm、QQ音乐.qmc转换为mp3格式)使用[jaudiotagger](http://www.jthink.net/jaudiotagger)工具
10695
52. SealBuilderTool:印章生成工具
10796
53. BullsAndCowsGame:猜数字小游戏
10897
54. FileUnicodeTransformationTool:文件编码转换工具
10998
55. FileCompressTool:文件解压缩工具(目前支持ar、zip、tar、jar、cpio、7z、gz、bzip2、xz、lzma、pack200、deflate、snappy-framed、lz4-block、lz4-framed、zstd等格式解压缩)
110-
56. IdiomDataTool:成语字典工具(使用[h2](http://www.h2database.com)数据库存储数据字典)
99+
56. IdiomDataTool:成语字典工具,使用[h2](http://www.h2database.com)数据库存储数据字典
111100
57. Sudoku:数独游戏
112101
58. LiteappCode:小程序码生成工具
113102

114103
项目开发中,以后会陆续添加新工具,欢迎大家参与其中,多提提意见,谢谢。
115104

116-
计划添加功能:
117-
118-
- [ ] 监控功能(文件夹深度、Ftp/Ftps/sftp文件数量、mq深度)
119-
- [ ] 转换excel为sql插入语句
120-
- [ ] 记录键盘使用情况小工具
121-
- [ ] 随机文件生成器(带模版引擎)
122-
- [ ] OCR小工具
123-
124105
#### 项目结构
125106

126107
```
@@ -166,24 +147,15 @@ xJavaFxTool
166147
+ [李柱](https://gitee.com/loyalty521)
167148
+ [luming](https://gitee.com/jeeweb)
168149
+ [码志](https://gitee.com/dazer1992)
169-
+ 你的女神
170150
+ [三叔](https://gitee.com/bejson)
171151

172152
#### 后续计划
173153
不定期添加汇总开发过程中需求的痛点工具,大家有工作上的痛点处可进群讨论,后期可能就会出相应的工具解决方案,谢谢大家的支持。
174154

175155
#### 项目截图如下:
176156

177-
![输入图片说明](images/传输工具.gif "传输工具.gif")
178-
![输入图片说明](images/邮件发送工具.gif "邮件发送工具.png")
179-
![输入图片说明](images/Cron表达式生成器.gif "Cron表达式生成器.gif")
180-
![输入图片说明](images/加密解密.gif "加密解密.png")
181-
![输入图片说明](images/正则表达式生成工具.gif "正则表达式生成工具.png")
182-
![输入图片说明](images/二维码生成工具.gif "二维码生成工具.png")
183-
![输入图片说明](images/随机数生成工具.gif "随机数生成工具.png")
184-
![输入图片说明](images/Redis连接工具.gif "Redis连接工具.png")
185-
![输入图片说明](images/图片压缩工具.gif "图片压缩工具.png")
186-
![输入图片说明](images/图片转码工具.gif "图片转码工具.png")
187-
![输入图片说明](images/短信群发工具.gif "短信群发工具.png")
188-
![输入图片说明](images/文件重命名工具.gif "文件重命名工具.png")
189-
![输入图片说明](images/成语字典工具.gif "成语字典工具.png")
157+
![传输工具.gif](images/传输工具.gif)
158+
![Cron表达式生成器](images/Cron表达式生成器.gif)
159+
![加密解密](images/加密解密.gif)
160+
![正则表达式生成工具](images/正则表达式生成工具.gif)
161+
![二维码生成工具](images/二维码生成工具.gif)

0 commit comments

Comments
 (0)