很喜歡的一款開源類庫，可以幫你簡化每一行程式碼，推薦給大家

沉默王二發表於2020-10-23
行程

“黑鐵時代”讀者群裡有個小夥伴感慨說，“Hutool 這款開源類庫太厲害了，基本上該有該的工具類，它裡面都有。”講真的，我平常工作中也經常用 Hutool，它確實可以幫助我們簡化每一行程式碼，使 Java 擁有函式式語言般的優雅，讓 Java 語言變得“甜甜的”。

但是呢，群裡還有一部分小夥伴表示還不知道這個開源類庫，第一次聽說。所以我決定寫一篇文章普及下，畢竟好的輪子值得推薦啊。

Hutool 的作者在官網上說，Hutool 是 Hu+tool 的自造詞（好像不用說，我們也能猜得到），“Hu”用來致敬他的“前任”公司，“tool”就是工具的意思，諧音就有意思了，“糊塗”，寓意追求“萬事都作糊塗觀，無所謂失，無所謂得”（一個開源類庫，上升到了哲學的高度，作者厲害了）。

看了一下開發團隊的一個成員介紹，一個 Java 後端工具的作者竟然愛前端、愛數碼，愛美女，嗯嗯嗯，確實“難得糊塗”（手動狗頭）。

就連向這個開源類庫提交的 PR（pull request）規範都非常“病態化”（哈哈哈）：

廢話就說到這，來吧，實操走起！

01、引入 Hutool

Maven 專案只需要在 pom.xml 檔案中新增以下依賴即可。

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

Hutool 的設計思想是儘量減少重複的定義，讓專案中的 util 包儘量少。一個好的輪子可以在很大程度上避免“複製貼上”，從而節省我們開發人員對專案中公用類庫和公用工具方法的封裝時間。同時呢，成熟的開源庫也可以最大限度的避免封裝不完善帶來的 bug。

就像作者在官網上說的那樣：

  • 以前，我們開啟搜尋引擎 -> 搜“Java MD5 加密” -> 開啟某篇部落格 -> 複製貼上 -> 改改，變得好用些

有了 Hutool 以後呢，引入 Hutool -> 直接 SecureUtil.md5()

Hutool 對不僅對 JDK 底層的檔案、流、加密解密、轉碼、正則、執行緒、XML等做了封裝，還提供了以下這些元件：

非常多，非常全面，鑑於此，我只挑選一些我喜歡的來介紹下（偷偷地告訴你，我就是想偷懶）。

02、型別轉換

型別轉換在 Java 開發中很常見，尤其是從 HttpRequest 中獲取引數的時候，前端傳遞的是整形，但後端只能先獲取到字串，然後再呼叫 parseXXX() 方法進行轉換，還要加上判空，很繁瑣。

Hutool 的 Convert 類可以簡化這個操作，可以將任意可能的型別轉換為指定型別，同時第二個引數 defaultValue 可用於在轉換失敗時返回一個預設值。

String param = "10";
int paramInt = Convert.toInt(param);
int paramIntDefault = Convert.toInt(param, 0);

把字串轉換成日期：

String dateStr = "2020年09月29日";
Date date = Convert.toDate(dateStr);

把字串轉成 Unicode：

String unicodeStr = "沉默王二";
String unicode = Convert.strToUnicode(unicodeStr);

03、日期時間

JDK 自帶的 Date 和 Calendar 不太好用，Hutool 封裝的 DateUtil 用起來就舒服多了！

獲取當前日期：

Date date = DateUtil.date();

DateUtil.date() 返回的其實是 DateTime，它繼承自 Date 物件，重寫了 toString() 方法，返回 yyyy-MM-dd HH:mm:ss 格式的字串。

有些小夥伴是不是想看看我寫這篇文章的時間，輸出一下給大家看看：

System.out.println(date);// 2020-09-29 04:28:02

字串轉日期：

String dateStr = "2020-09-29";
Date date = DateUtil.parse(dateStr);

DateUtil.parse() 會自動識別一些常用的格式，比如說：

  • 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 = "2020-09-29 22:33:23";
Date date1 = DateUtil.parse(dateStr1);

String dateStr2 = "2020-10-01 23:34:27";
Date date2 = DateUtil.parse(dateStr2);

long betweenDay = DateUtil.between(date1, date2, DateUnit.MS);

// 輸出：2天1小時1分4秒
String formatBetween = DateUtil.formatBetween(betweenDay, BetweenFormater.Level.SECOND);

星座和屬相：

// 射手座
String zodiac = DateUtil.getZodiac(Month.DECEMBER.getValue(), 10);
// 蛇
String chineseZodiac = DateUtil.getChineseZodiac(1989);

04、IO 流相關

IO 操作包括讀和寫，應用的場景主要包括網路操作和檔案操作，原生的 Java 類庫區分字元流和位元組流，位元組流 InputStream 和 OutputStream 就有很多很多種，使用起來讓人頭皮發麻。

Hutool 封裝了流操作工具類 IoUtil、檔案讀寫操作工具類 FileUtil、檔案型別判斷工具類 FileTypeUtil 等等。

BufferedInputStream in = FileUtil.getInputStream("hutool/origin.txt");
BufferedOutputStream out = FileUtil.getOutputStream("hutool/to.txt");
long copySize = IoUtil.copy(in, out, IoUtil.DEFAULT_BUFFER_SIZE);

在 IO 操作中，檔案的操作相對來說是比較複雜的，但使用頻率也很高，幾乎所有的專案中都躺著一個叫 FileUtil 或者 FileUtils 的工具類。Hutool 的 FileUtil 類包含以下幾類操作：

  • 檔案操作：包括檔案目錄的新建、刪除、複製、移動、改名等
  • 檔案判斷：判斷檔案或目錄是否非空，是否為目錄，是否為檔案等等
  • 絕對路徑：針對 ClassPath 中的檔案轉換為絕對路徑檔案
  • 檔名：主檔名，副檔名的獲取
  • 讀操作：包括 getReader、readXXX 操作
  • 寫操作：包括 getWriter、writeXXX 操作

順帶說說 classpath。

在實際編碼當中，我們通常需要從某些檔案裡面讀取一些資料，比如配置檔案、文字檔案、圖片等等，那這些檔案通常放在什麼位置呢？

放在專案結構圖中的 resources 目錄下，當專案編譯後，會出現在 classes 目錄下。對應磁碟上的目錄如下圖所示：

當我們要讀取檔案的時候，我是不建議使用絕對路徑的，因為作業系統不一樣的話，檔案的路徑識別符號也是不一樣的。最好使用相對路徑。

假設在 src/resources 下放了一個檔案 origin.txt，檔案的路徑引數如下所示：

FileUtil.getInputStream("origin.txt")

假設檔案放在 src/resources/hutool 目錄下，則路徑引數改為：

FileUtil.getInputStream("hutool/origin.txt")

05、字串工具

Hutool 封裝的字串工具類 StrUtil 和 Apache Commons Lang 包中的 StringUtils 類似，作者認為優勢在於 Str 比 String 短，儘管我不覺得。不過，我倒是挺喜歡其中的一個方法的：

String template = "{}，一枚沉默但有趣的程式設計師，喜歡他的文章的話，請微信搜尋{}";
String str = StrUtil.format(template, "沉默王二", "沉默王二");
// 沉默王二，一枚沉默但有趣的程式設計師，喜歡他的文章的話，請微信搜尋沉默王二

06、反射工具

反射機制可以讓 Java 變得更加靈活，因此在某些情況下，反射可以做到事半功倍的效果。Hutool 封裝的反射工具 ReflectUtil 包括：

  • 獲取構造方法
  • 獲取欄位
  • 獲取欄位值
  • 獲取方法
  • 執行方法（物件方法和靜態方法）
package com.itwanger.hutool.reflect;

import cn.hutool.core.util.ReflectUtil;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

/**
 * @author 微信搜「沉默王二」，回覆關鍵字 PDF
 */
public class ReflectDemo {
    private int id;

    public ReflectDemo() {
        System.out.println("構造方法");
    }

    public void print() {
        System.out.println("我是沉默王二");
    }

    public static void main(String[] args) throws IllegalAccessException {
        // 構建物件
        ReflectDemo reflectDemo = ReflectUtil.newInstance(ReflectDemo.class);

        // 獲取構造方法
        Constructor[] constructors = ReflectUtil.getConstructors(ReflectDemo.class);
        for (Constructor constructor : constructors) {
            System.out.println(constructor.getName());
        }

        // 獲取欄位
        Field field = ReflectUtil.getField(ReflectDemo.class, "id");
        field.setInt(reflectDemo, 10);
        // 獲取欄位值
        System.out.println(ReflectUtil.getFieldValue(reflectDemo, field));

        // 獲取所有方法
        Method[] methods = ReflectUtil.getMethods(ReflectDemo.class);
        for (Method m : methods) {
            System.out.println(m.getName());
        }

        // 獲取指定方法
        Method method = ReflectUtil.getMethod(ReflectDemo.class, "print");
        System.out.println(method.getName());


        // 執行方法
        ReflectUtil.invoke(reflectDemo, "print");
    }
}

07、壓縮工具

在 Java 中，對檔案、資料夾打包壓縮是一件很繁瑣的事情，Hutool 封裝的 ZipUtil 針對 java.util.zip 包做了優化，可以使用一個方法搞定壓縮和解壓，並且自動處理檔案和目錄的問題，不再需要使用者判斷，大大簡化的壓縮解壓的複雜度。

ZipUtil.zip("hutool", "hutool.zip");
File unzip = ZipUtil.unzip("hutool.zip", "hutoolzip");

08、身份證工具

Hutool 封裝的 IdcardUtil 可以用來對身份證進行驗證，支援大陸 15 位、18 位身份證，港澳臺 10 位身份證。

String ID_18 = "321083197812162119";
String ID_15 = "150102880730303";

boolean valid = IdcardUtil.isValidCard(ID_18);
boolean valid15 = IdcardUtil.isValidCard(ID_15);

09、擴充套件 HashMap

Java 中的 HashMap 是強型別的，而 Hutool 封裝的 Dict 對鍵的型別要求沒那麼嚴格。

Dict dict = Dict.create()
        .set("age", 18)
        .set("name", "沉默王二")
        .set("birthday", DateTime.now());

int age = dict.getInt("age");
String name = dict.getStr("name");

10、控制檯列印

本地編碼的過程中，經常需要使用 System.out 列印結果，但是往往一些複雜的物件不支援直接列印，比如說陣列，需要呼叫 Arrays.toString。Hutool 封裝的 Console 類借鑑了 JavaScript 中的 console.log()，使得列印變成了一個非常便捷的方式。

/**
 * @author 微信搜「沉默王二」，回覆關鍵字 PDF
 */
public class ConsoleDemo {
    public static void main(String[] args) {
        // 列印字串
        Console.log("沉默王二，一枚有趣的程式設計師");

        // 列印字串模板
        Console.log("洛陽是{}朝古都",13);

        int [] ints = {1,2,3,4};
        // 列印陣列
        Console.log(ints);
    }
}

11、欄位驗證器

做 Web 開發的時候，後端通常需要對錶單提交過來的資料進行驗證。Hutool 封裝的 Validator 可以進行很多有效的條件驗證：

  • 是不是郵箱
  • 是不是 IP V4、V6
  • 是不是電話號碼
  • 等等
Validator.isEmail("沉默王二");
Validator.isMobile("itwanger.com");

12、雙向查詢 Map

Guava 中提供了一種特殊的 Map 結構，叫做 BiMap，實現了一種雙向查詢的功能，可以根據 key 查詢 value，也可以根據 value 查詢 key，Hutool 也提供這種 Map 結構。

BiMap<String, String> biMap = new BiMap<>(new HashMap<>());
biMap.put("wanger", "沉默王二");
biMap.put("wangsan", "沉默王三");

// get value by key
biMap.get("wanger");
biMap.get("wangsan");

// get key by value
biMap.getKey("沉默王二");
biMap.getKey("沉默王三");

在實際的開發工作中，其實我更傾向於使用 Guava 的 BiMap，而不是 Hutool 的。這裡提一下，主要是我發現了 Hutool 線上文件上的一處錯誤，提了個 issue（從中可以看出我一顆一絲不苟的心和一雙清澈明亮的大眼睛啊）。

13、圖片工具

Hutool 封裝的 ImgUtil 可以對圖片進行縮放、裁剪、轉為黑白、加水印等操作。

縮放圖片：

ImgUtil.scale(
        FileUtil.file("hutool/wangsan.jpg"),
        FileUtil.file("hutool/wangsan_small.jpg"),
        0.5f
);

裁剪圖片：

ImgUtil.cut(
        FileUtil.file("hutool/wangsan.jpg"),
        FileUtil.file("hutool/wangsan_cut.jpg"),
        new Rectangle(200, 200, 100, 100)
);

新增水印：

ImgUtil.pressText(//
        FileUtil.file("hutool/wangsan.jpg"),
        FileUtil.file("hutool/wangsan_logo.jpg"),
        "沉默王二", Color.WHITE,
        new Font("黑體", Font.BOLD, 100),
        0,
        0,
        0.8f
);

趁機讓大家欣賞一下二哥帥氣的真容。

14、配置檔案

眾所周知，Java 中廣泛應用的配置檔案 Properties 存在一個特別大的詬病：不支援中文。每次使用時，如果想存放中文字元，就必須藉助 IDE 相關外掛才能轉為 Unicode 符號，而這種反人類的符號在命令列下根本沒法看。

於是，Hutool 的 Setting 運用而生。Setting 除了相容 Properties 檔案格式外，還提供了一些特有功能，這些功能包括：

  • 各種編碼方式支援
  • 變數支援
  • 分組支援

先整個配置檔案 example.setting，內容如下：

name=沉默王二
age=18

再來讀取和更新配置檔案：

/**
 * @author 微信搜「沉默王二」，回覆關鍵字 PDF
 */
public class SettingDemo {
    private final static String SETTING = "hutool/example.setting";
    public static void main(String[] args) {
        // 初始化 Setting
        Setting setting = new Setting(SETTING);

        // 讀取
        setting.getStr("name", "沉默王二");

        // 在配置檔案變更時自動載入
        setting.autoLoad(true);

        // 通過程式碼方式增加鍵值對
        setting.set("birthday", "2020年09月29日");
        setting.store(SETTING);
    }
}

15、日誌工廠

Hutool 封裝的日誌工廠 LogFactory 相容了各大日誌框架，使用起來也非常簡便。

/**
 * @author 微信搜「沉默王二」，回覆關鍵字 PDF
 */
public class LogDemo {
    private static final Log log = LogFactory.get();

    public static void main(String[] args) {
        log.debug("難得糊塗");
    }
}

先通過 LogFactory.get() 自動識別引入的日誌框架，從而建立對應日誌框架的門面 Log 物件，然後呼叫 debug()、info() 等方法輸出日誌。

如果不想建立 Log 物件的話，可以使用 StaticLog，顧名思義，一個提供了靜態方法的日誌類。

StaticLog.info("爽啊 {}.", "沉默王二的文章");

16、快取工具

CacheUtil 是 Hutool 封裝的建立快取的快捷工具類，可以建立不同的快取物件：

  • FIFOCache：先入先出，元素不停的加入快取直到快取滿為止，當快取滿時，清理過期快取物件，清理後依舊滿則刪除先入的快取。
Cache<String, String> fifoCache = CacheUtil.newFIFOCache(3);
fifoCache.put("key1", "沉默王一");
fifoCache.put("key2", "沉默王二");
fifoCache.put("key3", "沉默王三");
fifoCache.put("key4", "沉默王四");

// 大小為 3，所以 key3 放入後 key1 被清除
String value1 = fifoCache.get("key1");
  • LFUCache，最少使用，根據使用次數來判定物件是否被持續快取，當快取滿時清理過期物件，清理後依舊滿的情況下清除最少訪問的物件並將其他物件的訪問數減去這個最少訪問數，以便新物件進入後可以公平計數。
Cache<String, String> lfuCache = CacheUtil.newLFUCache(3);

lfuCache.put("key1", "沉默王一");
// 使用次數+1
lfuCache.get("key1");
lfuCache.put("key2", "沉默王二");
lfuCache.put("key3", "沉默王三");
lfuCache.put("key4", "沉默王四");

// 由於快取容量只有 3，當加入第 4 個元素的時候，最少使用的將被移除（2,3被移除）
String value2 = lfuCache.get("key2");
String value3 = lfuCache.get("key3");
  • LRUCache，最近最久未使用，根據使用時間來判定物件是否被持續快取，當物件被訪問時放入快取，當快取滿了，最久未被使用的物件將被移除。
Cache<String, String> lruCache = CacheUtil.newLRUCache(3);

lruCache.put("key1", "沉默王一");
lruCache.put("key2", "沉默王二");
lruCache.put("key3", "沉默王三");
// 使用時間近了
lruCache.get("key1");
lruCache.put("key4", "沉默王四");

// 由於快取容量只有 3，當加入第 4 個元素的時候，最久使用的將被移除（2）
String value2 = lruCache.get("key2");
System.out.println(value2);

17、加密解密

加密分為三種：

  • 對稱加密（symmetric），例如：AES、DES 等
  • 非對稱加密（asymmetric），例如：RSA、DSA 等
  • 摘要加密（digest），例如：MD5、SHA-1、SHA-256、HMAC 等

Hutool 針對這三種情況都做了封裝：

  • 對稱加密 SymmetricCrypto
  • 非對稱加密 AsymmetricCrypto
  • 摘要加密 Digester

快速加密工具類 SecureUtil 有以下這些方法：

1）對稱加密

  • SecureUtil.aes
  • SecureUtil.des

2）非對稱加密

  • SecureUtil.rsa
  • SecureUtil.dsa

3）摘要加密

  • SecureUtil.md5
  • SecureUtil.sha1
  • SecureUtil.hmac
  • SecureUtil.hmacMd5
  • SecureUtil.hmacSha1

只寫一個簡單的例子作為參考：

/**
 * @author 微信搜「沉默王二」，回覆關鍵字 PDF
 */
public class SecureUtilDemo {
    static AES aes = SecureUtil.aes();
    public static void main(String[] args) {
        String encry = aes.encryptHex("沉默王二");
        System.out.println(encry);
        String oo = aes.decryptStr(encry);
        System.out.println(oo);
    }
}

18、其他類庫

Hutool 中的類庫還有很多，尤其是一些對第三方類庫的進一步封裝，比如郵件工具 MailUtil，二維碼工具 QrCodeUtil，Emoji 工具 EmojiUtil，小夥伴們可以參考 Hutool 的官方文件：https://www.hutool.cn/

專案原始碼地址：https://github.com/looly/hutool

PS：需要 Java 書單的話，我在 GitHub 上發現了一個寶藏專案，裡面的書單可謂應有盡有。需要的小夥伴可以按需自取，地址如下所示：

https://github.com/itwanger/JavaBooks

最後，日常求個贊吧，滿滿的乾貨，我先乾為敬，你隨意?

相關文章