讀者群里有個(gè)小伙伴感慨說(shuō)役纹,“Hutool 這款開(kāi)源類(lèi)庫(kù)太厲害了偶摔,基本上該有該的工具類(lèi),它里面都有促脉〕秸”講真的策州,我平常工作中也經(jīng)常用 Hutool,它確實(shí)可以幫助我們簡(jiǎn)化每一行代碼宫仗,使 Java 擁有函數(shù)式語(yǔ)言般的優(yōu)雅够挂,讓 Java 語(yǔ)言變得“甜甜的”。
PS:為了能夠幫助更多的 Java 愛(ài)好者锰什,已將《Java 程序員進(jìn)階之路》開(kāi)源到了 GitHub(本篇已收錄)下硕。該專(zhuān)欄目前已經(jīng)收獲了 598 枚星標(biāo)丁逝,如果你也喜歡這個(gè)專(zhuān)欄汁胆,覺(jué)得有幫助的話(huà),可以去點(diǎn)個(gè) star霜幼,這樣也方便以后進(jìn)行更系統(tǒng)化的學(xué)習(xí)嫩码!
Hutool 的作者在官網(wǎng)上說(shuō),Hutool 是 Hu+tool 的自造詞(好像不用說(shuō)罪既,我們也能猜得到)铸题,“Hu”用來(lái)致敬他的“前任”公司,“tool”就是工具的意思琢感,諧音就有意思了丢间,“糊涂”,寓意追求“萬(wàn)事都作糊涂觀驹针,無(wú)所謂失烘挫,無(wú)所謂得”(一個(gè)開(kāi)源類(lèi)庫(kù),上升到了哲學(xué)的高度柬甥,作者厲害了)饮六。
看了一下開(kāi)發(fā)團(tuán)隊(duì)的一個(gè)成員介紹,一個(gè) Java 后端工具的作者竟然愛(ài)前端苛蒲、愛(ài)數(shù)碼卤橄,愛(ài)美女,嗯嗯嗯臂外,確實(shí)“難得糊涂”(手動(dòng)狗頭)窟扑。
廢話(huà)就說(shuō)到這,來(lái)吧漏健,實(shí)操走起嚎货!
01、引入 Hutool
Maven 項(xiàng)目只需要在 pom.xml 文件中添加以下依賴(lài)即可漾肮。
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.4.3</version>
</dependency>
Hutool 的設(shè)計(jì)思想是盡量減少重復(fù)的定義厂抖,讓項(xiàng)目中的 util 包盡量少。一個(gè)好的輪子可以在很大程度上避免“復(fù)制粘貼”克懊,從而節(jié)省我們開(kāi)發(fā)人員對(duì)項(xiàng)目中公用類(lèi)庫(kù)和公用工具方法的封裝時(shí)間忱辅。同時(shí)呢七蜘,成熟的開(kāi)源庫(kù)也可以最大限度的避免封裝不完善帶來(lái)的 bug。
就像作者在官網(wǎng)上說(shuō)的那樣:
- 以前墙懂,我們打開(kāi)搜索引擎 -> 搜“Java MD5 加密” -> 打開(kāi)某篇博客 -> 復(fù)制粘貼 -> 改改橡卤,變得好用些
有了 Hutool 以后呢,引入 Hutool -> 直接
SecureUtil.md5()
Hutool 對(duì)不僅對(duì) JDK 底層的文件损搬、流碧库、加密解密、轉(zhuǎn)碼巧勤、正則嵌灰、線程、XML等做了封裝颅悉,還提供了以下這些組件:
非常多沽瞭,非常全面,鑒于此剩瓶,我只挑選一些我喜歡的來(lái)介紹下(偷偷地告訴你驹溃,我就是想偷懶)。
02延曙、類(lèi)型轉(zhuǎn)換
類(lèi)型轉(zhuǎn)換在 Java 開(kāi)發(fā)中很常見(jiàn)豌鹤,尤其是從 HttpRequest 中獲取參數(shù)的時(shí)候,前端傳遞的是整形枝缔,但后端只能先獲取到字符串布疙,然后再調(diào)用 parseXXX()
方法進(jìn)行轉(zhuǎn)換,還要加上判空魂仍,很繁瑣拐辽。
Hutool 的 Convert 類(lèi)可以簡(jiǎn)化這個(gè)操作,可以將任意可能的類(lèi)型轉(zhuǎn)換為指定類(lèi)型擦酌,同時(shí)第二個(gè)參數(shù) defaultValue 可用于在轉(zhuǎn)換失敗時(shí)返回一個(gè)默認(rè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、日期時(shí)間
JDK 自帶的 Date 和 Calendar 不太好用赊舶,Hutool 封裝的 DateUtil 用起來(lái)就舒服多了睁搭!
獲取當(dāng)前日期:
Date date = DateUtil.date();
DateUtil.date()
返回的其實(shí)是 DateTime,它繼承自 Date 對(duì)象笼平,重寫(xiě)了 toString()
方法园骆,返回 yyyy-MM-dd HH:mm:ss
格式的字符串。
有些小伙伴是不是想看看我寫(xiě)這篇文章的時(shí)間寓调,輸出一下給大家看看:
System.out.println(date);// 2020-09-29 04:28:02
字符串轉(zhuǎn)日期:
String dateStr = "2020-09-29";
Date date = DateUtil.parse(dateStr);
DateUtil.parse()
會(huì)自動(dòng)識(shí)別一些常用的格式锌唾,比如說(shuō):
- yyyy-MM-dd HH:mm:ss
- yyyy-MM-dd
- HH:mm:ss
- yyyy-MM-dd HH:mm
- yyyy-MM-dd HH:mm:ss.SSS
還可以識(shí)別帶中文的:
- 年月日時(shí)分秒
格式化時(shí)間差:
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小時(shí)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 操作包括讀和寫(xiě),應(yīng)用的場(chǎng)景主要包括網(wǎng)絡(luò)操作和文件操作晌涕,原生的 Java 類(lèi)庫(kù)區(qū)分字符流和字節(jié)流滋捶,字節(jié)流 InputStream 和 OutputStream 就有很多很多種,使用起來(lái)讓人頭皮發(fā)麻余黎。
Hutool 封裝了流操作工具類(lèi) IoUtil重窟、文件讀寫(xiě)操作工具類(lèi) FileUtil、文件類(lèi)型判斷工具類(lèi) 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 操作中厨姚,文件的操作相對(duì)來(lái)說(shuō)是比較復(fù)雜的膨疏,但使用頻率也很高晓折,幾乎所有的項(xiàng)目中都躺著一個(gè)叫 FileUtil 或者 FileUtils 的工具類(lèi)又活。Hutool 的 FileUtil 類(lèi)包含以下幾類(lèi)操作:
- 文件操作:包括文件目錄的新建、刪除帘靡、復(fù)制知给、移動(dòng)、改名等
- 文件判斷:判斷文件或目錄是否非空描姚,是否為目錄,是否為文件等等
- 絕對(duì)路徑:針對(duì) ClassPath 中的文件轉(zhuǎn)換為絕對(duì)路徑文件
- 文件名:主文件名戈次,擴(kuò)展名的獲取
- 讀操作:包括 getReader轩勘、readXXX 操作
- 寫(xiě)操作:包括 getWriter、writeXXX 操作
順帶說(shuō)說(shuō) classpath怯邪。
在實(shí)際編碼當(dāng)中绊寻,我們通常需要從某些文件里面讀取一些數(shù)據(jù),比如配置文件悬秉、文本文件澄步、圖片等等,那這些文件通常放在什么位置呢和泌?
放在項(xiàng)目結(jié)構(gòu)圖中的 resources 目錄下村缸,當(dāng)項(xiàng)目編譯后,會(huì)出現(xiàn)在 classes 目錄下武氓。對(duì)應(yīng)磁盤(pán)上的目錄如下圖所示:
當(dāng)我們要讀取文件的時(shí)候梯皿,我是不建議使用絕對(duì)路徑的,因?yàn)椴僮飨到y(tǒng)不一樣的話(huà)县恕,文件的路徑標(biāo)識(shí)符也是不一樣的东羹。最好使用相對(duì)路徑。
假設(shè)在 src/resources
下放了一個(gè)文件 origin.txt忠烛,文件的路徑參數(shù)如下所示:
FileUtil.getInputStream("origin.txt")
假設(shè)文件放在 src/resources/hutool
目錄下属提,則路徑參數(shù)改為:
FileUtil.getInputStream("hutool/origin.txt")
05、字符串工具
Hutool 封裝的字符串工具類(lèi) StrUtil 和 Apache Commons Lang 包中的 StringUtils 類(lèi)似美尸,作者認(rèn)為優(yōu)勢(shì)在于 Str 比 String 短冤议,盡管我不覺(jué)得旬迹。不過(guò),我倒是挺喜歡其中的一個(gè)方法的:
String template = "{}求类,一枚沉默但有趣的程序員奔垦,喜歡他的文章的話(huà),請(qǐng)微信搜索{}";
String str = StrUtil.format(template, "沉默王二", "沉默王二");
// 沉默王二尸疆,一枚沉默但有趣的程序員椿猎,喜歡他的文章的話(huà),請(qǐng)微信搜索沉默王二
06寿弱、反射工具
反射機(jī)制可以讓 Java 變得更加靈活犯眠,因此在某些情況下,反射可以做到事半功倍的效果症革。Hutool 封裝的反射工具 ReflectUtil 包括:
- 獲取構(gòu)造方法
- 獲取字段
- 獲取字段值
- 獲取方法
- 執(zhí)行方法(對(duì)象方法和靜態(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;
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)建對(duì)象
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 中,對(duì)文件噪矛、文件夾打包壓縮是一件很繁瑣的事情量蕊,Hutool 封裝的 ZipUtil 針對(duì) java.util.zip 包做了優(yōu)化,可以使用一個(gè)方法搞定壓縮和解壓艇挨,并且自動(dòng)處理文件和目錄的問(wèn)題残炮,不再需要用戶(hù)判斷,大大簡(jiǎn)化的壓縮解壓的復(fù)雜度缩滨。
ZipUtil.zip("hutool", "hutool.zip");
File unzip = ZipUtil.unzip("hutool.zip", "hutoolzip");
08势就、身份證工具
Hutool 封裝的 IdcardUtil 可以用來(lái)對(duì)身份證進(jìn)行驗(yàn)證,支持大陸 15 位脉漏、18 位身份證苞冯,港澳臺(tái) 10 位身份證。
String ID_18 = "321083197812162119";
String ID_15 = "150102880730303";
boolean valid = IdcardUtil.isValidCard(ID_18);
boolean valid15 = IdcardUtil.isValidCard(ID_15);
09侧巨、擴(kuò)展 HashMap
Java 中的 HashMap 是強(qiáng)類(lèi)型的舅锄,而 Hutool 封裝的 Dict 對(duì)鍵的類(lèi)型要求沒(méi)那么嚴(yán)格。
Dict dict = Dict.create()
.set("age", 18)
.set("name", "沉默王二")
.set("birthday", DateTime.now());
int age = dict.getInt("age");
String name = dict.getStr("name");
10刃泡、控制臺(tái)打印
本地編碼的過(guò)程中巧娱,經(jīng)常需要使用 System.out
打印結(jié)果,但是往往一些復(fù)雜的對(duì)象不支持直接打印烘贴,比如說(shuō)數(shù)組禁添,需要調(diào)用 Arrays.toString
。Hutool 封裝的 Console 類(lèi)借鑒了 JavaScript 中的 console.log()
桨踪,使得打印變成了一個(gè)非常便捷的方式老翘。
public class ConsoleDemo {
public static void main(String[] args) {
// 打印字符串
Console.log("沉默王二,一枚有趣的程序員");
// 打印字符串模板
Console.log("洛陽(yáng)是{}朝古都",13);
int [] ints = {1,2,3,4};
// 打印數(shù)組
Console.log(ints);
}
}
11、字段驗(yàn)證器
做 Web 開(kāi)發(fā)的時(shí)候铺峭,后端通常需要對(duì)表單提交過(guò)來(lái)的數(shù)據(jù)進(jìn)行驗(yàn)證墓怀。Hutool 封裝的 Validator 可以進(jìn)行很多有效的條件驗(yàn)證:
- 是不是郵箱
- 是不是 IP V4、V6
- 是不是電話(huà)號(hào)碼
- 等等
Validator.isEmail("沉默王二");
Validator.isMobile("itwanger.com");
12卫键、雙向查找 Map
Guava 中提供了一種特殊的 Map 結(jié)構(gòu)傀履,叫做 BiMap,實(shí)現(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("沉默王三");
在實(shí)際的開(kāi)發(fā)工作中梆暮,其實(shí)我更傾向于使用 Guava 的 BiMap,而不是 Hutool 的绍昂。這里提一下啦粹,主要是我發(fā)現(xiàn)了 Hutool 在線文檔上的一處錯(cuò)誤,提了個(gè) issue(從中可以看出我一顆一絲不茍的心和一雙清澈明亮的大眼睛熬接巍)唠椭。
13、圖片工具
Hutool 封裝的 ImgUtil 可以對(duì)圖片進(jìn)行縮放张峰、裁剪泪蔫、轉(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)
);
添加水印:
ImgUtil.pressText(//
FileUtil.file("hutool/wangsan.jpg"),
FileUtil.file("hutool/wangsan_logo.jpg"),
"沉默王二", Color.WHITE,
new Font("黑體", Font.BOLD, 100),
0,
0,
0.8f
);
趁機(jī)讓大家欣賞一下二哥帥氣的真容铣揉。
14饶深、配置文件
眾所周知,Java 中廣泛應(yīng)用的配置文件 Properties 存在一個(gè)特別大的詬补涔啊:不支持中文敌厘。每次使用時(shí),如果想存放中文字符朽合,就必須借助 IDE 相關(guān)插件才能轉(zhuǎn)為 Unicode 符號(hào)俱两,而這種反人類(lèi)的符號(hào)在命令行下根本沒(méi)法看。
于是曹步,Hutool 的 Setting 運(yùn)用而生宪彩。Setting 除了兼容 Properties 文件格式外,還提供了一些特有功能讲婚,這些功能包括:
- 各種編碼方式支持
- 變量支持
- 分組支持
先整個(gè)配置文件 example.setting尿孔,內(nèi)容如下:
name=沉默王二
age=18
再來(lái)讀取和更新配置文件:
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", "沉默王二");
// 在配置文件變更時(shí)自動(dòng)加載
setting.autoLoad(true);
// 通過(guò)代碼方式增加鍵值對(duì)
setting.set("birthday", "2020年09月29日");
setting.store(SETTING);
}
}
15、日志工廠
Hutool 封裝的日志工廠 LogFactory 兼容了各大日志框架,使用起來(lái)也非常簡(jiǎn)便活合。
public class LogDemo {
private static final Log log = LogFactory.get();
public static void main(String[] args) {
log.debug("難得糊涂");
}
}
先通過(guò) LogFactory.get()
自動(dòng)識(shí)別引入的日志框架雏婶,從而創(chuàng)建對(duì)應(yīng)日志框架的門(mén)面 Log 對(duì)象,然后調(diào)用 debug()
白指、info()
等方法輸出日志留晚。
如果不想創(chuàng)建 Log 對(duì)象的話(huà),可以使用 StaticLog告嘲,顧名思義错维,一個(gè)提供了靜態(tài)方法的日志類(lèi)。
StaticLog.info("爽啊 {}.", "沉默王二的文章");
16状蜗、緩存工具
CacheUtil 是 Hutool 封裝的創(chuàng)建緩存的快捷工具類(lèi)需五,可以創(chuàng)建不同的緩存對(duì)象:
- FIFOCache:先入先出,元素不停的加入緩存直到緩存滿(mǎn)為止轧坎,當(dāng)緩存滿(mǎn)時(shí)宏邮,清理過(guò)期緩存對(duì)象,清理后依舊滿(mǎn)則刪除先入的緩存缸血。
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ù)來(lái)判定對(duì)象是否被持續(xù)緩存飒炎,當(dāng)緩存滿(mǎn)時(shí)清理過(guò)期對(duì)象,清理后依舊滿(mǎn)的情況下清除最少訪問(wèn)的對(duì)象并將其他對(duì)象的訪問(wèn)數(shù)減去這個(gè)最少訪問(wèn)數(shù)笆豁,以便新對(duì)象進(jìn)入后可以公平計(jì)數(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,當(dāng)加入第 4 個(gè)元素的時(shí)候闯狱,最少使用的將被移除(2,3被移除)
String value2 = lfuCache.get("key2");
String value3 = lfuCache.get("key3");
- LRUCache煞赢,最近最久未使用,根據(jù)使用時(shí)間來(lái)判定對(duì)象是否被持續(xù)緩存哄孤,當(dāng)對(duì)象被訪問(wèn)時(shí)放入緩存照筑,當(dāng)緩存滿(mǎn)了,最久未被使用的對(duì)象將被移除瘦陈。
Cache<String, String> lruCache = CacheUtil.newLRUCache(3);
lruCache.put("key1", "沉默王一");
lruCache.put("key2", "沉默王二");
lruCache.put("key3", "沉默王三");
// 使用時(shí)間近了
lruCache.get("key1");
lruCache.put("key4", "沉默王四");
// 由于緩存容量只有 3凝危,當(dāng)加入第 4 個(gè)元素的時(shí)候,最久使用的將被移除(2)
String value2 = lruCache.get("key2");
System.out.println(value2);
17晨逝、加密解密
加密分為三種:
- 對(duì)稱(chēng)加密(symmetric)蛾默,例如:AES、DES 等
- 非對(duì)稱(chēng)加密(asymmetric)咏花,例如:RSA趴生、DSA 等
- 摘要加密(digest)阀趴,例如:MD5、SHA-1苍匆、SHA-256刘急、HMAC 等
Hutool 針對(duì)這三種情況都做了封裝:
- 對(duì)稱(chēng)加密 SymmetricCrypto
- 非對(duì)稱(chēng)加密 AsymmetricCrypto
- 摘要加密 Digester
快速加密工具類(lèi) SecureUtil 有以下這些方法:
1)對(duì)稱(chēng)加密
- SecureUtil.aes
- SecureUtil.des
2)非對(duì)稱(chēng)加密
- SecureUtil.rsa
- SecureUtil.dsa
3)摘要加密
- SecureUtil.md5
- SecureUtil.sha1
- SecureUtil.hmac
- SecureUtil.hmacMd5
- SecureUtil.hmacSha1
只寫(xiě)一個(gè)簡(jiǎn)單的例子作為參考:
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、其他類(lèi)庫(kù)
Hutool 中的類(lèi)庫(kù)還有很多浸踩,尤其是一些對(duì)第三方類(lèi)庫(kù)的進(jìn)一步封裝叔汁,比如郵件工具 MailUtil,二維碼工具 QrCodeUtil检碗,Emoji 工具 EmojiUtil据块,小伙伴們可以參考 Hutool 的官方文檔:https://www.hutool.cn/
項(xiàng)目源碼地址:https://github.com/looly/hutool
Java 程序員進(jìn)階之路,該專(zhuān)欄風(fēng)趣幽默折剃、通俗易懂另假,對(duì) Java 愛(ài)好者極度友好和舒適??,內(nèi)容包括但不限于 Java 基礎(chǔ)怕犁、Java 集合框架边篮、Java IO、Java 并發(fā)編程奏甫、Java 虛擬機(jī)戈轿、Java 企業(yè)級(jí)開(kāi)發(fā)(SSM、Spring Boot)等核心知識(shí)點(diǎn)阵子。
GitHub 地址:https://github.com/itwanger/toBeBetterJavaer
亮白版和暗黑版的 PDF 也準(zhǔn)備好了呢思杯,讓我們一起成為更好的 Java 工程師吧,一起沖挠进!