太厲害了，這款開源類庫能夠幫你簡化每一行代碼

時間  2020-10-24
標籤 前端 java git 程序員 github 後端 數組 緩存 微信 網絡 欄目 Java 简体版
原文   原文鏈接

「黑鐵時代」讀者羣裏有個小夥伴感慨說，「Hutool 這款開源類庫太厲害了，基本上該有該的工具類，它裏面都有。」講真的，我日常工做中也常常用 Hutool，它確實能夠幫助咱們簡化每一行代碼，使 Java 擁有函數式語言般的優雅，讓 Java 語言變得「甜甜的」。前端

可是呢，羣裏還有一部分小夥伴表示還不知道這個開源類庫，第一次據說。因此我決定寫一篇文章普及下，畢竟好的輪子值得推薦啊。java

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

看了一下開發團隊的一個成員介紹，一個 Java 後端工具的做者居然愛前端、愛數碼，愛漂亮女，嗯嗯嗯，確實「可貴糊塗」（手動狗頭）。程序員

就連向這個開源類庫提交的 PR（pull request）規範都很是「病態化」（哈哈哈）：github

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

0一、引入 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等作了封裝，還提供瞭如下這些組件：網絡

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

0二、類型轉換

類型轉換在 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);

0三、日期時間

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

0四、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")

0五、字符串工具

Hutool 封裝的字符串工具類 StrUtil 和 Apache Commons Lang 包中的 StringUtils 相似，做者認爲優點在於 Str 比 String 短，儘管我不以爲。不過，我卻是挺喜歡其中的一個方法的：

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

0六、反射工具

反射機制可讓 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");
    }
}

0七、壓縮工具

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

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

0八、身份證工具

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

0九、擴展 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");

十、控制檯打印

本地編碼的過程當中，常常須要使用 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);
    }
}

十一、字段驗證器

作 Web 開發的時候，後端一般須要對錶單提交過來的數據進行驗證。Hutool 封裝的 Validator 能夠進行不少有效的條件驗證：

  • 是否是郵箱
  • 是否是 IP V四、V6
  • 是否是電話號碼
  • 等等

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

十二、雙向查找 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（從中能夠看出我一顆一絲不苟的心和一雙清澈明亮的大眼睛啊）。

1三、圖片工具

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

趁機讓你們欣賞一下二哥帥氣的真容。

1四、配置文件

衆所周知，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);
    }
}

1五、日誌工廠

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("爽啊 {}.", "沉默王二的文章");

1六、緩存工具

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

1七、加密解密

加密分爲三種：

  • 對稱加密（symmetric），例如：AES、DES 等
  • 非對稱加密（asymmetric），例如：RSA、DSA 等
  • 摘要加密（digest），例如：MD五、SHA-一、SHA-25六、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);
    }
}

1八、其餘類庫

Hutool 中的類庫還有不少，尤爲是一些對第三方類庫的進一步封裝，好比郵件工具 MailUtil，二維碼工具 QrCodeUtil，Emoji 工具 EmojiUtil，小夥伴們能夠參考 Hutool 的官方文檔：https://www.hutool.cn/

項目源碼地址：https://github.com/looly/hutool

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

https://github.com/itwanger/JavaBooks

最後，平常求個贊吧，滿滿的乾貨，我先乾爲敬，你隨意😑

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程