🍬A set of tools that keep Java sweet.
👉 https://hutool.cn/ 👈
🌎English Documentation
📚简介
Hutool
是一个功能丰富且易用的Java工具库,通过诸多实用工具类的使用,旨在帮助开发者快速、便捷地完成各类开发任务。
这些封装的工具涵盖了字符串、数字、集合、编码、日期、文件、IO、加密、数据库JDBC、JSON、HTTP客户端等一系列操作,
可以满足各种不同的开发需求。
🎁Hutool名称的由来
Hutool = Hu tool,是原公司项目底层代码剥离后的开源库,“Hu”是公司名称的表示,tool表示工具。Hutool谐音“糊涂”,一方面简洁易懂,一方面寓意“难得糊涂”。
🍺Hutool理念
Hutool
既是一个工具集,也是一个知识库,我们从不自诩代码原创,大多数工具类都是搬运而来,因此:
- 你可以引入使用,也可以拷贝和修改使用,而不必标注任何信息,只是希望能把bug及时反馈回来。
- 我们努力健全中文注释,为源码学习者提供良好地学习环境,争取做到人人都能看得懂。
🛠️包含组件
一个Java基础工具类,对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装,组成各种Util工具类,同时提供以下组件:
可以根据需求对每个模块单独引入,也可以通过引入hutool-all
方式引入所有模块。
📝文档
📘中文文档
📘中文备用文档
📙参考API
🎬视频介绍
🪙支持Hutool
💳捐赠
如果你觉得Hutool不错,可以捐赠请维护者吃包辣条~,在此表示感谢^_^。
Gitee上捐赠
👕周边商店
你也可以通过购买Hutool的周边商品来支持Hutool维护哦!
我们提供了印有Hutool Logo的周边商品,欢迎点击购买支持:
👉 Hutool 周边商店 👈
📦安装
🍊Maven
在项目的pom.xml的dependencies中加入以下内容:
<dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.8.20</version> </dependency>
🍐Gradle
implementation 'cn.hutool:hutool-all:5.8.20'
📥下载jar
点击以下链接,下载hutool-all-X.X.X.jar
即可:
- Maven中央库
🔔️注意 Hutool 5.x支持JDK8 ,对Android平台没有测试,不能保证所有工具类或工具方法可用。 如果你的项目使用JDK7,请使用Hutool 4.x版本(不再更新)
🚽编译安装
访问Hutool的Gitee主页:https://gitee.com/dromara/hutool 下载整个项目源码(v5-master或v5-dev分支都可)然后进入Hutool项目目录执行:
./hutool.sh install
然后就可以使用Maven引入了。
🏗️添砖加瓦
🎋分支说明
Hutool的源码分为两个分支,功能如下:
🐞提供bug反馈或建议
提交问题反馈请说明正在使用的JDK版本呢、Hutool版本和相关依赖库版本。
- Gitee issue
- Github issue
🧬贡献代码的步骤
- 在Gitee或者Github上fork项目到自己的repo
- 把fork过去的项目也就是你的项目clone到你的本地
- 修改代码(记得一定要修改v5-dev分支)
- commit后push到自己的库(v5-dev分支)
- 登录Gitee或Github在你首页可以看到一个 pull request 按钮,点击它,填写一些说明信息,然后提交即可。
- 等待维护者合并
📐PR遵照的原则
Hutool欢迎任何人为Hutool添砖加瓦,贡献代码,不过维护者是一个强迫症患者,为了照顾病人,需要提交的pr(pull request)符合一些规范,规范如下:
- 注释完备,尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息,必要时请添加单元测试,如果愿意,也可以加上你的大名。
- Hutool的缩进按照Eclipse(
不要跟我说IDEA多好用,维护者非常懒,学不会,IDEA真香,改了Eclipse快捷键后舒服多了)默认(tab)缩进,所以请遵守(不要和我争执空格与tab的问题,这是一个病人的习惯)。 - 新加的方法不要使用第三方库的方法,Hutool遵循无依赖原则(除非在extra模块中加方法工具)。
- 请pull request到
v5-dev
分支。Hutool在5.x版本后使用了新的分支:v5-master
是主分支,表示已经发布中央库的版本,这个分支不允许pr,也不允许修改。 - 我们如果关闭了你的issue或pr,请不要诧异,这是我们保持问题处理整洁的一种方式,你依旧可以继续讨论,当有讨论结果时我们会重新打开。