• 入门和安装
    • 简介
      • Hutool如何改变我们的coding方式
    • 包含组件
    • 文档
    • 安装
      • Maven
      • Gradle
      • 非Maven项目
      • 编译安装
    • 添砖加瓦
      • 提供bug反馈或建议
      • 遵照的原则
      • 贡献代码的步骤
    • 捐赠

    入门和安装

    入门和安装 - 图1

    A set of tools that keep Java sweet.

    入门和安装 - 图2入门和安装 - 图3入门和安装 - 图4入门和安装 - 图5入门和安装 - 图6入门和安装 - 图7gitee stargithub starnetlify

    — 主页:https://hutool.cn/ | https://www.hutool.club/ —

    — QQ群③:555368316 — — QQ群④:718802356 —


    简介

    Hutool是一个Java工具包,也只是一个工具包,它帮助我们简化每一行代码,减少每一个方法,让Java语言也可以“甜甜的”。它最初是作者项目中“util”包的一个整理,后来慢慢积累并加入更多非业务相关功能,并广泛学习其它开源项目精髓,经过自己整理修改,最终形成丰富的开源工具集。

    Hutool是Hu + tool的自造词,谐音“糊涂”,寓意,追求“万事都作糊涂观,无所谓失,无所谓得”的境界。

    Hutool如何改变我们的coding方式

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

    以计算MD5为例:

    • 【以前】打开百度 -> 搜“Java MD5加密” -> 打开某篇博客-> 复制粘贴 -> 改改好用
    • 【现在】引入Hutool -> SecureUtil.md5()同样,当我们想实现什么功能,脑袋中第一个想到的就是去找XXXUtil,而非百度。

    包含组件

    一个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的封装
    • hutool-socket 基于Java的NIO和AIO的Socket封装可以根据需求对每个模块单独引入,也可以通过引入hutool-all方式引入所有模块。

    文档

    中文文档中文文档(备用)

    参考API


    安装

    Maven

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

    1. <dependency>
    2. <groupId>cn.hutool</groupId>
    3. <artifactId>hutool-all</artifactId>
    4. <version>4.5.15</version>
    5. </dependency>

    Gradle

    1. compile 'cn.hutool:hutool-all:4.5.15'

    非Maven项目

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

    • Maven中央库1
    • Maven中央库2

    注意Hutool支持JDK7+,对Android平台没有测试,不能保证所有工具类获工具方法可用。

    编译安装

    访问Hutool的码云主页:https://gitee.com/loolly/hutool 下载整个项目源码(v4-master或v4-dev分支都可)然后进入Hutool项目目录执行:

    1. bin/hutool.sh install

    然后就可以使用Maven引入了。


    添砖加瓦

    提供bug反馈或建议

    • 码云Gitee
    • Github

    遵照的原则

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

    • 注释完备,尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息,如果愿意,也可以加上你的大名。
    • Hutool的缩进按照Eclipse(不要跟我说IDEA多好用,作者非常懒,学不会)默认(tab)缩进,所以请遵守(不要和我争执空格与tab的问题,这是一个病人的习惯)。
    • 新加的方法不要使用第三方库的方法,Hutool遵循无依赖原则(除非在extra模块中加方法工具)。
    • 请pull request到v4-dev分支。Hutool在4.x版本后使用了新的分支:v4-master是主分支,表示已经发布中央库的版本,这个分支不允许pr,也不允许修改。v4-dev分支是开发分支,Hutool的下个版本或者SNAPSHOT版本在这个分支上开发,你可以pr到这个分支。

    贡献代码的步骤

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

    捐赠

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

    点击以下链接,将页面拉到最下方点击“捐赠”即可。

    前往捐赠