• 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 开放平台项目中编写的签名工具类:

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

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

    三. 如何使用Hutool

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

    Maven引入,在项目的 pom.xml 中添加依赖:

    1. cn.hutool
    2. hutool-all
    3. 5.8.16
    wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

    Gradle引入,在 build.gradle 中添加引用:

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

    四. Hutool中的常用工具

    1. 日期工具

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

    日期工具类Demo:

    1. /**
    2. * 日期工具类
    3. */
    4. @Test
    5. public void testDateUtil() {
    6. /**
    7. * yyyy-MM-dd HH:mm:ss
    8. * yyyy-MM-dd
    9. * HH:mm:ss
    10. * yyyy-MM-dd HH:mm
    11. * yyyy-MM-dd HH:mm:ss.SSS
    12. */
    13. String dateStr1 = "2017-03-01";
    14. Date date2 = DateUtil.parse(dateStr1);
    15. /**
    16. * 格式化日期输出
    17. */
    18. String dateStr = "2021-01-28";
    19. Date dateFormat = DateUtil.parse(dateStr);
    20. //结果 2021/01/26
    21. String format = DateUtil.format(dateFormat, "yyyy/MM/dd");
    22. //常用格式的格式化,结果:2021-01-28
    23. String formatDate = DateUtil.formatDate(dateFormat);
    24. //结果:2021-01-28 00:00:00
    25. String formatDateTime = DateUtil.formatDateTime(dateFormat);
    26. //结果:00:00:00
    27. String formatTime = DateUtil.formatTime(dateFormat);
    28. /**
    29. * 获取Date对象的某个部分
    30. */
    31. Date datePart = DateUtil.date();
    32. //获得年的部分
    33. System.out.println("年:"+DateUtil.year(datePart));
    34. //获得月份,从0开始计数
    35. System.out.println("月:"+DateUtil.month(datePart));
    36. //获得月份枚举
    37. System.out.println("日:"+DateUtil.dayOfMonth(datePart));
    38. /**
    39. * 日期时间偏移
    40. */
    41. //昨天
    42. DateTime yesterday = DateUtil.yesterday();
    43. System.out.println("昨天:" + yesterday);
    44. //明天
    45. System.out.println("明天:"+DateUtil.tomorrow());
    46. //上周
    47. System.out.println("上周:"+DateUtil.lastWeek());
    48. //下周
    49. System.out.println("下周:"+DateUtil.nextWeek());
    50. //上个月
    51. System.out.println("上个月:"+DateUtil.lastMonth());
    52. //下个月
    53. System.out.println("下个月:"+DateUtil.nextMonth());
    54. /**
    55. * 开始 和 结束时间
    56. */
    57. String dateStr2 = "2021-01-28 11:04:44";
    58. Date date = DateUtil.parse(dateStr2);
    59. //一天的开始,结果:2021-01-28 00:00:00
    60. Date beginOfDay = DateUtil.beginOfDay(date);
    61. System.out.println("一天的开始: "+beginOfDay);
    62. //一天的结束,结果:2021-01-28 23:59:59
    63. Date endOfDay = DateUtil.endOfDay(date);
    64. System.out.println("一天的结束: "+endOfDay);
    65. /**
    66. * 时间区间
    67. */
    68. String start = "2021-01-28";
    69. String end = "2021-02-09";
    70. List dateTimeList = DateUtil.rangeToList(DateUtil.parse(start), DateUtil.parse(end), DateField.DAY_OF_MONTH);
    71. dateTimeList.stream().forEach(System.out::println);
    72. }

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

    1. // "双子座"
    2. String zodiac = DateUtil.getZodiac(Month.MAY.getValue(), 26);
    3. // "龙"
    4. String chineseZodiac = DateUtil.getChineseZodiac(2000);

    2. 加密解密工具

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

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

    AES加解密Demo:

    1. String content = "test中文";
    2. //随机生成密钥
    3. byte[] key = SecureUtil.generateKey(SymmetricAlgorithm.AES.getValue()).getEncoded();
    4. //构建
    5. SymmetricCrypto aes = new SymmetricCrypto(SymmetricAlgorithm.AES, key);
    6. //加密
    7. byte[] encrypt = aes.encrypt(content);
    8. //解密
    9. byte[] decrypt = aes.decrypt(encrypt);
    10. //加密为16进制表示
    11. String encryptHex = aes.encryptHex(content);
    12. //解密为字符串
    13. String decryptStr = aes.decryptStr(encryptHex, CharsetUtil.CHARSET_UTF_8);

    3. HTTP客户端

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

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

    1. // GET请求
    2. // 最简单的HTTP请求,可以自动通过header等信息判断编码,不区分HTTP和HTTPS
    3. String result1= HttpUtil.get("https://www.baidu.com");
    4. // 当无法识别页面编码的时候,可以自定义请求页面的编码
    5. String result2= HttpUtil.get("https://www.baidu.com", CharsetUtil.CHARSET_UTF_8);
    6. // 可以单独传入http参数,这样参数会自动做URL编码,拼接在URL中
    7. HashMap paramMap = new HashMap<>();
    8. paramMap.put("city", "北京");
    9. String result3= HttpUtil.get("https://www.baidu.com", paramMap);
    10. // POST请求
    11. HashMap paramMap = new HashMap<>();
    12. paramMap.put("city", "北京");
    13. String result= HttpUtil.post("https://www.baidu.com", paramMap);
    14. // 文件上传
    15. HashMap paramMap = new HashMap<>();
    16. //文件上传只需将参数中的键指定(默认file),值设为文件对象即可,对于使用者来说,文件上传与普通表单提交并无区别
    17. paramMap.put("file", FileUtil.file("D:\\face.jpg"));
    18. String result= HttpUtil.post("https://www.baidu.com", paramMap);

    4. 其它组件

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

    Hutool 对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行了封装,组成了各种 Util 工具类。

    模块介绍
    hutool-aopJDK动态代理封装,提供非IOC下的切面支持
    hutool-bloomFilter布隆过滤,提供一些Hash算法的布隆过滤
    hutool-cache

    简单缓存实现

    hutool-core核心类,包括Bean操作、日期、各种Util等
    hutool-cron定时任务模块,提供类Crontab表达式的定时任务
    hutool-crypto加密解密模块,提供对称、非对称和摘要算法封装
    hutool-dbJDBC封装后的数据操作,基于ActiveRecord思想
    hutool-dfa基于DFA模型的多关键字查找
    hutool-extra扩展模块,对第三方封装(模板引擎、邮件、Servlet等)
    hutool-http基于HttpUrlConnection的Http客户端封装
    hutool-log自动识别日志实现的日志门面
    hutool-script

    脚本执行封装,例如Javascript

    hutool-setting功能更强大的Setting配置文件和Properties封装
    hutool-system系统参数调用封装(JVM信息等)
    hutool-jsonJSON实现
    hutool-captcha图片验证码实现
    hutool-poi针对POI中Excel和Word的封装
    hutool-socket基于Java的NIO和AIO的Socket封装
    hutool-jwtJSON Web Token(JWT)封装实现

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

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

  • 相关阅读:
    【TypeScript】掌握 TypeScript 这些官方工具类型
    Java中JRE指什么呢?
    博睿数据出席阿里云可观测技术峰会,数字体验管理驱动可持续发展
    gitlab图形化界面使用
    华为云云耀云服务器 L 实例使用,从性能、性价比、易用性、稳定性和安全性等方面进行评测
    面试算法26:重排链表
    log4j2安全漏洞修复
    【Spring AOP】统⼀数据返回格式
    基本的Python内置函数
    zabbix被动模式和主动模式的区别
  • 原文地址:https://blog.csdn.net/konghaoran1/article/details/139991572