一个小而全的Java工具类库 | Hutool

原创

迟恩

修改于 2021-03-21 18:42:26

1.6K0

修改于 2021-03-21 18:42:26

文章被收录于专栏：陈言懒调陈言懒调

Hutool是什么

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

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

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

Hutool能做什么

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

tool-aop JDK 动态代理封装，提供非 IOC 下的切面支持
tool-bloomFilter 布隆过滤，提供一些 Hash 算法的布隆过滤
tool-cache 缓存
tool-core 核心，包括 Bean 操作、日期、各种 Util 等
tool-cron 定时任务模块，提供类 Crontab 表达式的定时任务
tool-crypto 加密解密模块
tool-db JDBC 封装后的数据操作，基于 ActiveRecord 思想
tool-dfa 基于 DFA 模型的多关键字查找
tool-extra 扩展模块，对第三方封装（模板引擎、邮件等）
tool-http 基于 HttpUrlConnection 的 Http 客户端封装
tool-log 自动识别日志实现的日志门面
tool-script 脚本执行封装，例如 Javascript
tool-setting 功能更强大的 Setting 配置文件和 Properties 封装
tool-system 系统参数调用封装（JVM 信息等）
tool-json JSON 实现
tool-captcha 图片验证码实现

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

代码示例

SecureUtil（加密解密工具）

主要是在登录的时候还有修改密码的时候用到的，因为数据库里面的密码是 md5 加密处理的，所以登录的时候需要先加密之后再到数据库进行查询，使用 Hutool 的话，只需要调用 SecureUtil 中的 md5 方法就可以了。

user = userService.userLoginByName(loginName,SecureUtil.md5(loginPwd));

HtmlUtil（HTML 工具类）

这个工具类就比较厉害了，不过我在日常用得最多的还是 HtmlUtil.encode，可以将一些字符转化为安全字符，防止 xss 注入和 SQL 注入，比如下面的评论提交。

comment.setCommentAuthor(HtmlUtil.encode(comment.getCommentAuthor()));

这就是防止有小坏蛋故意写一些可执行的 js 代码，然后提交评论，在后台面板就会执行这一段代码，比较危险，使用 encode 方法就可以将标签给转化成，这样转化之后，js 代码就不会执行了。

另外，HtmlUtil 还提供了以下方法，有兴趣的可以去试一下。

HtmlUtil.restoreEscaped 还原被转义的 HTML 特殊字符
HtmlUtil.encode 转义文本中的 HTML 字符为安全的字符
HtmlUtil.cleanHtmlTag 清除所有 HTML 标签
HtmlUtil.removeHtmlTag 清除指定 HTML 标签和被标签包围的内容
HtmlUtil.unwrapHtmlTag 清除指定 HTML 标签，不包括内容
HtmlUtil.removeHtmlAttr 去除 HTML 标签中的属性
HtmlUtil.removeAllHtmlAttr 去除指定标签的所有属性
HtmlUtil.filter 过滤 HTML 文本，防止 XSS 攻击

CronUtil（定时任务）

这个工具就更厉害了，完全不需要类似 quartz 这样的框架来做定时任务，而且 CronUtil 也不需要任何其他依赖，只需要在 resources 下建一个配置文件，然后在程序启动的时候将定时任务开启就行了，如 Halo 的定时备份功能（每天凌晨 1 点备份一次）。

cron.setting:

cc.ryanc.halo.web.controller.admin.BackupController.backupResources = 0 0 1 * * ?
cc.ryanc.halo.web.controller.admin.BackupController.backupDatabase = 0 0 1 * * ?
cc.ryanc.halo.web.controller.admin.BackupController.backupPosts = 0 0 1 * * ?
@Override
public void onApplicationEvent(ContextRefreshedEvent event){
 this.loadActiveTheme();
 this.loadOptions();
 this.loadFiles();
 this.loadThemes();
 //启动定时任务
 CronUtil.start();
 log.info("定时任务启动成功！");
}

其他就不逐一展开说明，可以自己去看文档。

参与贡献

在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默认（tab）缩进，所以请遵守。
新加的方法不要使用第三方库的方法，Hutool遵循无依赖原则（除非在extra模块中加方法工具）。
请pull request到v5-dev分支。Hutool在5.x版本后使用了新的分支：v5-master是主分支，表示已经发布中央库的版本，这个分支不允许pr，也不允许修改。