hutool

Project Url: dromara/hutool
Introduction: 🍬A set of tools that keep Java sweet.
More: Author   ReportBugs   OfficialWebsite   
Tags:

🍬A set of tools that keep Java sweet.

👉 https://hutool.cn/ 👈

star github star



🌎English Documentation


Hutool 是一个小而全的 Java 工具类库,通过静态方法封装,降低相关 API 的学习成本,提高工作效率,使 Java 拥有函数式语言般的优雅,让 Java 语言也可以“甜甜的”。

Hutool 中的工具方法来自每个用户的精雕细琢,它涵盖了 Java 开发底层代码中的方方面面,它既是大型项目开发中解决小问题的利器,也是小型项目中的效率担当;

Hutool 是项目中“util”包友好的替代,它节省了开发人员对项目中公用类和公用工具方法的封装时间,使开发专注于业务,同时可以最大限度的避免封装不完善带来的 bug。

🎁Hutool 名称的由来

Hutool = Hu + tool,是原公司项目底层代码剥离后的开源库,“Hu”是公司名称的表示,tool 表示工具。Hutool 谐音“糊涂”,一方面简洁易懂,一方面寓意“难得糊涂”。

🍺Hutool 如何改变我们的 coding 方式

Hutool 的目标是使用一个工具方法代替一段复杂代码,从而最大限度的避免“复制粘贴”代码的问题,彻底改变我们写代码的方式。

以计算 MD5 为例:

  • 👴【以前】打开搜索引擎 -> 搜“Java MD5 加密” -> 打开某篇博客-> 复制粘贴 -> 改改好用
  • 👦【现在】引入 Hutool -> SecureUtil.md5()

Hutool 的存在就是为了减少代码搜索成本,避免网络上参差不齐的代码出现导致的 bug。


🛠️包含组件

一个 Java 基础工具类,对文件、流、加密解密、转码、正则、线程、XML 等 JDK 方法进行封装,组成各种 Util 工具类,同时提供以下组件:

模块 介绍
hutool-aop JDK 动态代理封装,提供非 IOC 下的切面支持
hutool-bloomFilter 布隆过滤,提供一些 Hash 算法的布隆过滤
hutool-cache 简单缓存实现
hutool-core 核心,包括 Bean 操作、日期、各种 Util 等
hutool-cron 定时任务模块,提供类 Crontab 表达式的定时任务
hutool-crypto 加密解密模块,提供对称、非对称和摘要算法封装
hutool-db JDBC 封装后的数据操作,基于 ActiveRecord 思想
hutool-dfa 基于 DFA 模型的多关键字查找
hutool-extra 扩展模块,对第三方封装(模板引擎、邮件、Servlet、二维码、Emoji、FTP、分词等)
hutool-http 基于 HttpUrlConnection 的 Http 客户端封装
hutool-log 自动识别日志实现的日志门面
hutool-script 脚本执行封装,例如 Javascript
hutool-setting 功能更强大的 Setting 配置文件和 Properties 封装
hutool-system 系统参数调用封装(JVM 信息等)
hutool-json JSON 实现
hutool-captcha 图片验证码实现
hutool-poi 针对 POI 中 Excel 和 Word 的封装
hutool-socket 基于 Java 的 NIO 和 AIO 的 Socket 封装
hutool-jwt JSON Web Token (JWT)封装实现

可以根据需求对每个模块单独引入,也可以通过引入hutool-all方式引入所有模块。


📝文档

📘中文文档

📘中文备用文档

📙参考 API

🎬视频介绍


🪙支持 Hutool

💳捐赠

如果你觉得 Hutool 不错,可以捐赠请维护者吃包辣条~,在此表示感谢^_^。

Gitee 上捐赠

捐赠给 Dromara 组织

👕周边商店

你也可以通过购买 Hutool 的周边商品来支持 Hutool 维护哦!

我们提供了印有 Hutool Logo 的周边商品,欢迎点击购买支持:

👉 Hutool 周边商店 👈


📦安装

🍊Maven

在项目的 pom.xml 的 dependencies 中加入以下内容:

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.11</version>
</dependency>

🍐Gradle

implementation 'cn.hutool:hutool-all:5.8.11'

📥下载 jar

点击以下链接,下载hutool-all-X.X.X.jar即可:

🔔️注意 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 的源码分为两个分支,功能如下:

分支 作用
v5-master 主分支,release 版本使用的分支,与中央库提交的 jar 一致,不接收任何 pr 或修改
v5-dev 开发分支,默认为下个版本的 SNAPSHOT 版本,接受修改或 pr

🐞提供 bug 反馈或建议

提交问题反馈请说明正在使用的 JDK 版本呢、Hutool 版本和相关依赖库版本。

🧬贡献代码的步骤

  1. 在 Gitee 或者 Github 上 fork 项目到自己的 repo
  2. 把 fork 过去的项目也就是你的项目 clone 到你的本地
  3. 修改代码(记得一定要修改 v5-dev 分支)
  4. commit 后 push 到自己的库(v5-dev 分支)
  5. 登录 Gitee 或 Github 在你首页可以看到一个 pull request 按钮,点击它,填写一些说明信息,然后提交即可。
  6. 等待维护者合并

📐PR 遵照的原则

Hutool 欢迎任何人为 Hutool 添砖加瓦,贡献代码,不过维护者是一个强迫症患者,为了照顾病人,需要提交的 pr(pull request)符合一些规范,规范如下:

  1. 注释完备,尤其每个新增的方法应按照 Java 文档规范标明方法说明、参数说明、返回值说明等信息,必要时请添加单元测试,如果愿意,也可以加上你的大名。
  2. Hutool 的缩进按照 Eclipse(不要跟我说 IDEA 多好用,维护者非常懒,学不会,IDEA 真香,改了 Eclipse 快捷键后舒服多了)默认(tab)缩进,所以请遵守(不要和我争执空格与 tab 的问题,这是一个病人的习惯)。
  3. 新加的方法不要使用第三方库的方法,Hutool 遵循无依赖原则(除非在 extra 模块中加方法工具)。
  4. 请 pull request 到v5-dev分支。Hutool 在 5.x 版本后使用了新的分支:v5-master是主分支,表示已经发布中央库的版本,这个分支不允许 pr,也不允许修改。
  5. 我们如果关闭了你的 issue 或 pr,请不要诧异,这是我们保持问题处理整洁的一种方式,你依旧可以继续讨论,当有讨论结果时我们会重新打开。

⭐Star Hutool

Stargazers over time

📌 知识星球

Apps
About Me
GitHub: Trinea
Facebook: Dev Tools