很喜歡的一款開源類庫,可以幫你簡化每一行代碼
“黑鐵時代”讀者群里有個小伙伴感慨說,“Hutool 這款開源類庫太厲害了,基本上該有該的工具類,它里面都有。”講真的,我平常工作中也經(jīng)常用 Hutool,它確實可以幫助我們簡化每一行代碼,使 Java 擁有函數(shù)式語言般的優(yōu)雅,讓 Java 語言變得“甜甜的”。
但是呢,群里還有一部分小伙伴表示還不知道這個開源類庫,第一次聽說。所以我決定寫一篇文章普及下,畢竟好的輪子值得推薦啊。
Hutool 的作者在官網(wǎng)上說,Hutool 是 Hu+tool 的自造詞(好像不用說,我們也能猜得到),“Hu”用來致敬他的“前任”公司,“tool”就是工具的意思,諧音就有意思了,“糊涂”,寓意追求“萬事都作糊涂觀,無所謂失,無所謂得”(一個開源類庫,上升到了哲學(xué)的高度,作者厲害了)。
看了一下開發(fā)團隊的一個成員介紹,一個 Java 后端工具的作者竟然愛前端、愛數(shù)碼,愛美女,嗯嗯嗯,確實“難得糊涂”(手動狗頭)。
就連向這個開源類庫提交的 PR(pull request)規(guī)范都非常“病態(tài)化”(哈哈哈):
廢話就說到這,來吧,實操走起!
01、引入 Hutool
Maven 項目只需要在 pom.xml 文件中添加以下依賴即可。
- <dependency>
- <groupId>cn.hutool</groupId>
- <artifactId>hutool-all</artifactId>
- <version>5.4.3</version>
- </dependency>
Hutool 的設(shè)計思想是盡量減少重復(fù)的定義,讓項目中的 util 包盡量少。一個好的輪子可以在很大程度上避免“復(fù)制粘貼”,從而節(jié)省我們開發(fā)人員對項目中公用類庫和公用工具方法的封裝時間。同時呢,成熟的開源庫也可以最大限度的避免封裝不完善帶來的 bug。
就像作者在官網(wǎng)上說的那樣:
- 以前,我們打開搜索引擎 -> 搜“Java MD5 加密” -> 打開某篇博客 -> 復(fù)制粘貼 -> 改改,變得好用些
有了 Hutool 以后呢,引入 Hutool -> 直接 SecureUtil.md5()
Hutool 對不僅對 JDK 底層的文件、流、加密解密、轉(zhuǎn)碼、正則、線程、XML等做了封裝,還提供了以下這些組件:
非常多,非常全面,鑒于此,我只挑選一些我喜歡的來介紹下(偷偷地告訴你,我就是想偷懶)。
02、類型轉(zhuǎn)換
類型轉(zhuǎn)換在 Java 開發(fā)中很常見,尤其是從 HttpRequest 中獲取參數(shù)的時候,前端傳遞的是整形,但后端只能先獲取到字符串,然后再調(diào)用 parseXXX()
方法進行轉(zhuǎn)換,還要加上判空,很繁瑣。
Hutool 的 Convert 類可以簡化這個操作,可以將任意可能的類型轉(zhuǎn)換為指定類型,同時第二個參數(shù) defaultValue 可用于在轉(zhuǎn)換失敗時返回一個默認值。
- String param = "10";
- int paramInt = Convert.toInt(param);
- int paramIntDefault = Convert.toInt(param, 0);
把字符串轉(zhuǎn)換成日期:
- String dateStr = "2020年09月29日";
- Date date = Convert.toDate(dateStr);
把字符串轉(zhuǎn)成 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
字符串轉(zhuǎn)日期:
- 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 流相關(guān)
IO 操作包括讀和寫,應(yīng)用的場景主要包括網(wǎng)絡(luò)操作和文件操作,原生的 Java 類庫區(qū)分字符流和字節(jié)流,字節(jié)流 InputStream 和 OutputStream 就有很多很多種,使用起來讓人頭皮發(fā)麻。
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 操作中,文件的操作相對來說是比較復(fù)雜的,但使用頻率也很高,幾乎所有的項目中都躺著一個叫 FileUtil 或者 FileUtils 的工具類。Hutool 的 FileUtil 類包含以下幾類操作:
- 文件操作:包括文件目錄的新建、刪除、復(fù)制、移動、改名等
- 文件判斷:判斷文件或目錄是否非空,是否為目錄,是否為文件等等
- 絕對路徑:針對 ClassPath 中的文件轉(zhuǎn)換為絕對路徑文件
- 文件名:主文件名,擴展名的獲取
- 讀操作:包括 getReader、readXXX 操作
- 寫操作:包括 getWriter、writeXXX 操作
順帶說說 classpath。
在實際編碼當中,我們通常需要從某些文件里面讀取一些數(shù)據(jù),比如配置文件、文本文件、圖片等等,那這些文件通常放在什么位置呢?
放在項目結(jié)構(gòu)圖中的 resources 目錄下,當項目編譯后,會出現(xiàn)在 classes 目錄下。對應(yīng)磁盤上的目錄如下圖所示:
當我們要讀取文件的時候,我是不建議使用絕對路徑的,因為操作系統(tǒng)不一樣的話,文件的路徑標識符也是不一樣的。最好使用相對路徑。
假設(shè)在 src/resources
下放了一個文件 origin.txt,文件的路徑參數(shù)如下所示:
- FileUtil.getInputStream("origin.txt")
假設(shè)文件放在 src/resources/hutool
目錄下,則路徑參數(shù)改為:
- FileUtil.getInputStream("hutool/origin.txt")
05、字符串工具
Hutool 封裝的字符串工具類 StrUtil 和 Apache Commons Lang 包中的 StringUtils 類似,作者認為優(yōu)勢在于 Str 比 String 短,盡管我不覺得。不過,我倒是挺喜歡其中的一個方法的:
- String template = "{},一枚沉默但有趣的程序員,喜歡他的文章的話,請微信搜索{}";
- String str = StrUtil.format(template, "沉默王二", "沉默王二");
- // 沉默王二,一枚沉默但有趣的程序員,喜歡他的文章的話,請微信搜索沉默王二
06、反射工具
反射機制可以讓 Java 變得更加靈活,因此在某些情況下,反射可以做到事半功倍的效果。Hutool 封裝的反射工具 ReflectUtil 包括:
- 獲取構(gòu)造方法
- 獲取字段
- 獲取字段值
- 獲取方法
- 執(zhí)行方法(對象方法和靜態(tài)方法)
- 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 微信搜「沉默王二」,回復(fù)關(guān)鍵字 PDF
- */
- public class ReflectDemo {
- private int id;
- public ReflectDemo() {
- System.out.println("構(gòu)造方法");
- }
- public void print() {
- System.out.println("我是沉默王二");
- }
- public static void main(String[] args) throws IllegalAccessException {
- // 構(gòu)建對象
- ReflectDemo reflectDemo = ReflectUtil.newInstance(ReflectDemo.class);
- // 獲取構(gòu)造方法
- 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());
- // 執(zhí)行方法
- ReflectUtil.invoke(reflectDemo, "print");
- }
- }
07、壓縮工具
在 Java 中,對文件、文件夾打包壓縮是一件很繁瑣的事情,Hutool 封裝的 ZipUtil 針對 java.util.zip 包做了優(yōu)化,可以使用一個方法搞定壓縮和解壓,并且自動處理文件和目錄的問題,不再需要用戶判斷,大大簡化的壓縮解壓的復(fù)雜度。
- 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、控制臺打印
本地編碼的過程中,經(jīng)常需要使用 System.out
打印結(jié)果,但是往往一些復(fù)雜的對象不支持直接打印,比如說數(shù)組,需要調(diào)用 Arrays.toString
。Hutool 封裝的 Console 類借鑒了 JavaScript 中的 console.log()
,使得打印變成了一個非常便捷的方式。
- /**
- * @author 微信搜「沉默王二」,回復(fù)關(guān)鍵字 PDF
- */
- public class ConsoleDemo {
- public static void main(String[] args) {
- // 打印字符串
- Console.log("沉默王二,一枚有趣的程序員");
- // 打印字符串模板
- Console.log("洛陽是{}朝古都",13);
- int [] ints = {1,2,3,4};
- // 打印數(shù)組
- Console.log(ints);
- }
- }
11、字段驗證器
做 Web 開發(fā)的時候,后端通常需要對表單提交過來的數(shù)據(jù)進行驗證。Hutool 封裝的 Validator 可以進行很多有效的條件驗證:
- 是不是郵箱
- 是不是 IP V4、V6
- 是不是電話號碼
- 等等
- Validator.isEmail("沉默王二");
- Validator.isMobile("itwanger.com");
12、雙向查找 Map
Guava 中提供了一種特殊的 Map 結(jié)構(gòu),叫做 BiMap,實現(xiàn)了一種雙向查找的功能,可以根據(jù) key 查找 value,也可以根據(jù) value 查找 key,Hutool 也提供這種 Map 結(jié)構(gòu)。
- 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("沉默王三");
在實際的開發(fā)工作中,其實我更傾向于使用 Guava 的 BiMap,而不是 Hutool 的。這里提一下,主要是我發(fā)現(xiàn)了 Hutool 在線文檔上的一處錯誤,提了個 issue(從中可以看出我一顆一絲不茍的心和一雙清澈明亮的大眼睛啊)。
13、圖片工具
Hutool 封裝的 ImgUtil 可以對圖片進行縮放、裁剪、轉(zhuǎn)為黑白、加水印等操作。
縮放圖片:
- 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)
- );
添加水?。?/p>
- 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 中廣泛應(yīng)用的配置文件 Properties 存在一個特別大的詬病:不支持中文。每次使用時,如果想存放中文字符,就必須借助 IDE 相關(guān)插件才能轉(zhuǎn)為 Unicode 符號,而這種反人類的符號在命令行下根本沒法看。
于是,Hutool 的 Setting 運用而生。Setting 除了兼容 Properties 文件格式外,還提供了一些特有功能,這些功能包括:
- 各種編碼方式支持
- 變量支持
- 分組支持
先整個配置文件 example.setting,內(nèi)容如下:
- name=沉默王二
- age=18
再來讀取和更新配置文件:
- /**
- * @author 微信搜「沉默王二」,回復(fù)關(guān)鍵字 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 微信搜「沉默王二」,回復(fù)關(guān)鍵字 PDF
- */
- public class LogDemo {
- private static final Log log = LogFactory.get();
- public static void main(String[] args) {
- log.debug("難得糊涂");
- }
- }
先通過 LogFactory.get()
自動識別引入的日志框架,從而創(chuàng)建對應(yīng)日志框架的門面 Log 對象,然后調(diào)用 debug()
、 info()
等方法輸出日志。
如果不想創(chuàng)建 Log 對象的話,可以使用 StaticLog,顧名思義,一個提供了靜態(tài)方法的日志類。
- StaticLog.info("爽啊 {}.", "沉默王二的文章");
16、緩存工具
CacheUtil 是 Hutool 封裝的創(chuàng)建緩存的快捷工具類,可以創(chuàng)建不同的緩存對象:
- 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,最少使用,根據(jù)使用次數(shù)來判定對象是否被持續(xù)緩存,當緩存滿時清理過期對象,清理后依舊滿的情況下清除最少訪問的對象并將其他對象的訪問數(shù)減去這個最少訪問數(shù),以便新對象進入后可以公平計數(shù)。
- Cache<String, String> lfuCache = CacheUtil.newLFUCache(3);
- lfuCache.put("key1", "沉默王一");
- // 使用次數(shù)+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,最近最久未使用,根據(jù)使用時間來判定對象是否被持續(xù)緩存,當對象被訪問時放入緩存,當緩存滿了,最久未被使用的對象將被移除。
- 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 微信搜「沉默王二」,回復(fù)關(guān)鍵字 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 上發(fā)現(xiàn)了一個寶藏項目,里面的書單可謂應(yīng)有盡有。需要的小伙伴可以按需自取,地址如下所示:
https://github.com/itwanger/JavaBooks