Java知识点整理 13 — Hutool工具库

在开发时经常需要编写很多与业务无关的代码，比如获取指定日期对象、获取本机 IP 地址、数据加密等。通常我们会将这些代码独立出来，放到 utils 目录下，作为工具类供其它代码调用。

但如果遇到一个从未接触过的领域知识，开发一个新工具类，该怎么办？

比如在API Hunter 开放平台项目中，使用到了SHA256加密算法的 Digester 进行加密操作。

之前我们或许会在CSDN或其它博客平台搜索相关代码，然后二次修改使用。

Hutool 工具库提供了各种现成的 util 工具包供开发人员使用，大大缩短了开发时间，提升开发效率。

Hutool 工具库：https://hutool.cn/

一. 什么是Hutool

Hutool 是一个开源的、小而全的 Java 工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率。它是项目中 util 包友好的替代，节省了开发人员对项目中公用类和公用工具方法的封装时间，使开发专注于业务，同时最大限度的避免封装不完善带来的bug。

二. 为什么要使用Hutool

Hutool的目标是使用一个工具方法代替一段复杂代码，从而最大限度的避免"复制粘贴"代码的问题。

比如计算 MD5：

以前：搜索引擎 -> 搜"Java MD5 加密" -> 打开某篇博客 -> 修改使用

现在：引入Hutool -> SercureUtil.md5()

大幅减少了代码搜索成本，同时也可以防止引入网上不正确的代码导致的bug。

API Hunter 开放平台项目中编写的签名工具类：

public class SignUtils{
 
 public static String genSign(Map<String,String>hashMap,String secretKey){
       //使用SHA256算法的Digester
       Digester md5 = new Digester(DigestAlgorithm.SHA256);
       //构建签名内容，将哈希映射转换为字符串并拼接密钥
       String content = hashMap.toString()+ "." +secretKey;
       //计算签名的摘要并返回摘要的十六进制表示形式
       return md5.digestHex(content);
}
}

几行代码即可完成加密功能，需要使用时直接调用 SignUtils 工具类即可。

三. 如何使用Hutool

Hutool的使用简单且对业务无入侵，直接通过Maven 或者 Gradle 等包管理工具引入即可，也可以将某个工具类中的方法直接粘贴到代码中。

Maven引入，在项目的 pom.xml 中添加依赖：

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

Gradle引入，在 build.gradle 中添加引用：

compile 'cn.hutool:hutool-all:5.8.16'

四. Hutool中的常用工具

1. 日期工具

DataUtil 类提供了高度便捷的日期访问、处理和转换方式。

日期工具类Demo：

     /**
     * 日期工具类
     */
    @Test
    public void testDateUtil() {

        /**
         * yyyy-MM-dd HH:mm:ss
         * yyyy-MM-dd
         * HH:mm:ss
         * yyyy-MM-dd HH:mm
         * yyyy-MM-dd HH:mm:ss.SSS
         */

        String dateStr1 = "2017-03-01";
        Date date2 = DateUtil.parse(dateStr1);

        /**
         * 格式化日期输出
         */
        String dateStr = "2021-01-28";
        Date dateFormat = DateUtil.parse(dateStr);
        //结果 2021/01/26
        String format = DateUtil.format(dateFormat, "yyyy/MM/dd");
        //常用格式的格式化，结果：2021-01-28
        String formatDate = DateUtil.formatDate(dateFormat);
        //结果：2021-01-28 00:00:00
        String formatDateTime = DateUtil.formatDateTime(dateFormat);
        //结果：00:00:00
        String formatTime = DateUtil.formatTime(dateFormat);

        /**
         * 获取Date对象的某个部分
         */
        Date datePart = DateUtil.date();
        //获得年的部分
        System.out.println("年:"+DateUtil.year(datePart));
        //获得月份，从0开始计数
        System.out.println("月:"+DateUtil.month(datePart));
        //获得月份枚举
        System.out.println("日:"+DateUtil.dayOfMonth(datePart));

        /**
         * 日期时间偏移
         */
        //昨天
        DateTime yesterday = DateUtil.yesterday();
        System.out.println("昨天:" + yesterday);
        //明天
        System.out.println("明天:"+DateUtil.tomorrow());
        //上周
        System.out.println("上周:"+DateUtil.lastWeek());
        //下周
        System.out.println("下周:"+DateUtil.nextWeek());
        //上个月
        System.out.println("上个月:"+DateUtil.lastMonth());
        //下个月
        System.out.println("下个月:"+DateUtil.nextMonth());

        /**
         * 开始 和 结束时间
         */
        String dateStr2 = "2021-01-28 11:04:44";
        Date date = DateUtil.parse(dateStr2);
        //一天的开始，结果：2021-01-28 00:00:00
        Date beginOfDay = DateUtil.beginOfDay(date);
        System.out.println("一天的开始: "+beginOfDay);
        //一天的结束，结果：2021-01-28 23:59:59
        Date endOfDay = DateUtil.endOfDay(date);
        System.out.println("一天的结束: "+endOfDay);

        /**
         * 时间区间
         */
        String start = "2021-01-28";
        String end = "2021-02-09";
        List<DateTime> dateTimeList = DateUtil.rangeToList(DateUtil.parse(start), DateUtil.parse(end), DateField.DAY_OF_MONTH);
        dateTimeList.stream().forEach(System.out::println);
    }

甚至提供了对星座和属相的输出：

// "双子座"
String zodiac = DateUtil.getZodiac(Month.MAY.getValue(), 26);

// "龙"
String chineseZodiac = DateUtil.getChineseZodiac(2000);

2. 加密解密工具

Hutool针对三种加密方式分别实现了多种不同的算法。

如在API Hunter 项目中实现的通过SHA256摘要签名，或使用 AES 算法加解密。

AES加解密Demo：

String content = "test中文";

//随机生成密钥
byte[] key = SecureUtil.generateKey(SymmetricAlgorithm.AES.getValue()).getEncoded();

//构建
SymmetricCrypto aes = new SymmetricCrypto(SymmetricAlgorithm.AES, key);

//加密
byte[] encrypt = aes.encrypt(content);
//解密
byte[] decrypt = aes.decrypt(encrypt);

//加密为16进制表示
String encryptHex = aes.encryptHex(content);
//解密为字符串
String decryptStr = aes.decryptStr(encryptHex, CharsetUtil.CHARSET_UTF_8);

3. HTTP客户端

通过 HttpUtil 对 HTTP 客户端的封装，实现便捷的 HTTP 请求，并简化文件上传操作。

GET和POST请求以及文件上传Demo：

// GET请求
// 最简单的HTTP请求，可以自动通过header等信息判断编码，不区分HTTP和HTTPS
String result1= HttpUtil.get("https://www.baidu.com");

// 当无法识别页面编码的时候，可以自定义请求页面的编码
String result2= HttpUtil.get("https://www.baidu.com", CharsetUtil.CHARSET_UTF_8);

// 可以单独传入http参数，这样参数会自动做URL编码，拼接在URL中
HashMap<String, Object> paramMap = new HashMap<>();
paramMap.put("city", "北京");

String result3= HttpUtil.get("https://www.baidu.com", paramMap);

// POST请求
HashMap<String, Object> paramMap = new HashMap<>();
paramMap.put("city", "北京");

String result= HttpUtil.post("https://www.baidu.com", paramMap);

// 文件上传
HashMap<String, Object> paramMap = new HashMap<>();
//文件上传只需将参数中的键指定（默认file），值设为文件对象即可，对于使用者来说，文件上传与普通表单提交并无区别
paramMap.put("file", FileUtil.file("D:\\face.jpg"));

String result= HttpUtil.post("https://www.baidu.com", paramMap);

4. 其它组件

除此之外，还有其它很多组件可供选择。

Hutool 对文件、流、加密解密、转码、正则、线程、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等）
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 引入所有模块。

更多 Hutool 工具类的源码示例请参考官方文档。