Categories
程式開發

服了,這款開源類庫可以幫你簡化每一行代碼


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

服了,這款開源類庫可以幫你簡化每一行代碼 1

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

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

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

服了,這款開源類庫可以幫你簡化每一行代碼 2

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

服了,這款開源類庫可以幫你簡化每一行代碼 3

廢話就說到這,來吧,實操走起!

01、引入Hutool

Maven 項目只需要在pom.xml 文件中添加以下依賴即可。


cn.hutool
hutool-all
5.4.3

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

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

以前,我們打開搜索引擎-> 搜“Java MD5 加密” -> 打開某篇博客-> 複製粘貼-> 改改,變得好用些

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

Hutool 對不僅對JDK 底層的文件、流、加密解密、轉碼、正則、線程、XML等做了封裝,還提供了以下這些組件:

服了,這款開源類庫可以幫你簡化每一行代碼 4

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

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:ssyyyy-MM-ddHH:mm:ssyyyy-MM-dd HH:mmyyyy-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。

在實際編碼當中,我們通常需要從某些文件裡面讀取一些數據,比如配置文件、文本文件、圖片等等,那這些文件通常放在什麼位置呢?

服了,這款開源類庫可以幫你簡化每一行代碼 5

放在項目結構圖中的resources 目錄下,當項目編譯後,會出現在classes 目錄下。對應磁盤上的目錄如下圖所示:

服了,這款開源類庫可以幫你簡化每一行代碼 6

當我們要讀取文件的時候,我是不建議使用絕對路徑的,因為操作系統不一樣的話,文件的路徑標識符也是不一樣的。最好使用相對路徑。

假設在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是不是電話號碼等等

服了,這款開源類庫可以幫你簡化每一行代碼 7

Validator.isEmail("沉默王二");
Validator.isMobile("itwanger.com");

12、雙向查找Map

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

BiMap 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(從中可以看出我一顆一絲不苟的心和一雙清澈明亮的大眼睛啊)。

服了,這款開源類庫可以幫你簡化每一行代碼 8

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
);

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

服了,這款開源類庫可以幫你簡化每一行代碼 9

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 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 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 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.aesSecureUtil.des

2)非對稱加密

SecureUtil.rsaSecureUtil.dsa

3)摘要加密

SecureUtil.md5SecureUtil.sha1SecureUtil.hmacSecureUtil.hmacMd5SecureUtil.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

最後,日常求個贊吧,滿滿的干貨,我先乾為敬,你隨意😑