Hutool工具包

谷梁楷

2023-12-01

Hutool工具包

简介

Hutool是Hu + tool的自造词，前者致敬我的“前任公司”，后者为工具之意，谐音“糊涂”，寓意追求“万事都作糊涂观，无所谓失，无所谓得”的境界。

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

官网地址：http://www.hutool.cn/

API文档：https://www.hutool.cn/docs/#/

[Maven]

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

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

功能

一个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 扩展模块，对第三方封装（模板引擎、邮件等）
hutool-http 基于HttpUrlConnection的Http客户端封装
hutool-log 自动识别日志实现的日志门面
hutool-script 脚本执行封装，例如Javascript
hutool-setting 功能更强大的Setting配置文件和Properties封装
hutool-system 系统参数调用封装（JVM信息等）
hutool-json JSON实现
hutool-captcha 图片验证码实现

简单测试

这两天使用Hutool把Halo里面的一些代码给替换掉了，不得不说，用起来十分顺心，下面简单介绍一下我用到的一些Hutool的工具类。

SecureUtil（加密解密工具）

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

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

HtmlUtil（HTML工具类）

这个工具类就比较厉害了，不过我在Halo当中用得最多的还是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("定时任务启动成功！");
}

Hutool工具包