Hutool中使用頻率比較高的工具類和方法

Hutool是一個Java工具包，它幫助我們簡化每一行代碼，避免重復造輪子。如果你有需要用到某些工具方法的時候，也許可以在Hutool里面就能找到。本文將對Hutool中的常用工具類和方法進行介紹。

安裝

maven項目在pom.xml添加以下依賴：

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

常用工具類

Convert

類型轉換工具類，用於各種類型數據的轉換。

//轉換為字符串
int a = 1;
String aStr = Convert.toStr(a);
//轉換為指定類型數組
String[] b = {"1", "2", "3", "4"};
Integer[] bArr = Convert.toIntArray(b);
//轉換為日期對象
String dateStr = "2021-02-01";
Date date = Convert.toDate(dateStr);
//轉換為列表
String[] strArr = {"a", "b", "c", "d"};
List<String> strList = Convert.toList(String.class, strArr);

DateUtil

日期時間工具類，定義了一些常用的日期時間操作方法。

//Date、long、Calendar之間的相互轉換
//當前時間
Date date = DateUtil.date();
//Calendar轉Date
date = DateUtil.date(Calendar.getInstance());
//時間戳轉Date
date = DateUtil.date(System.currentTimeMillis());
//自動識別格式轉換
String dateStr = "2021-02-01";
date = DateUtil.parse(dateStr);
//自定義格式化轉換
date = DateUtil.parse(dateStr, "yyyy-MM-dd");
//格式化輸出日期
String format = DateUtil.format(date, "yyyy-MM-dd");
//獲得年的部分
int year = DateUtil.year(date);
//獲得月份，從0開始計數
int month = DateUtil.month(date);
//獲取某天的開始、結束時間
Date beginOfDay = DateUtil.beginOfDay(date);
Date endOfDay = DateUtil.endOfDay(date);
//計算偏移后的日期時間
Date newDate = DateUtil.offset(date, DateField.DAY_OF_MONTH, 2);
//計算日期時間之間的偏移量
long betweenDay = DateUtil.between(date, newDate, DateUnit.DAY);

StrUtil

字符串工具類，定義一些常用的字符串操作方法。

//判斷是否為空字符串
String str = "test";
StrUtil.isEmpty(str);
StrUtil.isNotEmpty(str);
//去除字符串的前后綴
StrUtil.removeSuffix("Huaji.jpg", ".jpg");
StrUtil.removePrefix("Huaji.jpg", "Huaji.");
//格式化字符串
String template = "這只是個占位符:{}";
String str2 = StrUtil.format(template, "我是占位符");
LOGGER.info("/strUtil format:{}", str2);

ClassPathResource

獲取classPath下的文件，在Tomcat等容器下，classPath一般是WEB-INF/classes。

//獲取定義在src/main/resources文件夾中的配置文件
ClassPathResource resource = new ClassPathResource("generator.properties");
Properties properties = new Properties();
properties.load(resource.getStream());
LOGGER.info("/classPath:{}", properties);

NumberUtil

數字處理工具類，可用於各種類型數字的加減乘除操作及判斷類型。

double n1 = 3.141;
double n2 = 1.098;
double result;
//對float、double、BigDecimal做加減乘除操作
result = NumberUtil.add(n1, n2);
result = NumberUtil.sub(n1, n2);
result = NumberUtil.mul(n1, n2);
result = NumberUtil.div(n1, n2);
//保留兩位小數
BigDecimal roundNum = NumberUtil.round(n1, 2);
String n3 = "2.718";
//判斷是否為數字、整數、浮點數
NumberUtil.isNumber(n3);
NumberUtil.isInteger(n3);
NumberUtil.isDouble(n3);

ReflectUtil

Java反射工具類，可用於反射獲取類的方法及創建對象。

//獲取某個類的所有方法
Method[] methods = ReflectUtil.getMethods(User.class);
//獲取某個類的指定方法
Method method = ReflectUtil.getMethod(User.class, "getUserId");
//使用反射來創建對象
User user= ReflectUtil.newInstance(User.class);
//反射執行對象的方法
ReflectUtil.invoke(user, "setUserId", 1);

SecureUtil

加密解密工具類，可用於MD5加密。

//MD5加密
String str = "123456";
String md5Str = SecureUtil.md5(str);
LOGGER.info("secureUtil md5:{}", md5Str);

CaptchaUtil

驗證碼工具類，可用於生成圖形驗證碼。

//生成驗證碼圖片
LineCaptcha lineCaptcha = CaptchaUtil.createLineCaptcha(200, 100);
try {
    request.getSession().setAttribute("CAPTCHA_KEY", lineCaptcha.getCode());
    response.setContentType("image/png");//告訴瀏覽器輸出內容為圖片
    response.setHeader("Pragma", "No-cache");//禁止瀏覽器緩存
    response.setHeader("Cache-Control", "no-cache");
    response.setDateHeader("Expire", 0);
    lineCaptcha.write(response.getOutputStream());
} catch (IOException e) {
    e.printStackTrace();
}

MapUtil

Map操作工具類，可用於創建Map對象及判斷Map是否為空。

//將多個鍵值對加入到Map中
Map<Object, Object> map = MapUtil.of(new String[][]{
    {"key1", "value1"},
    {"key2", "value2"},
    {"key3", "value3"}
});
//判斷Map是否為空
MapUtil.isEmpty(map);
MapUtil.isNotEmpty(map);

AnnotationUtil

注解工具類，可用於獲取注解與注解中指定的值。

//獲取指定類、方法、字段、構造器上的注解列表
Annotation[] annotationList = AnnotationUtil.getAnnotations(HutoolController.class, false);
LOGGER.info("annotationUtil annotations:{}", annotationList);
//獲取指定類型注解
Api api = AnnotationUtil.getAnnotation(HutoolController.class, Api.class);
LOGGER.info("annotationUtil api value:{}", api.description());
//獲取指定類型注解的值
Object annotationValue = AnnotationUtil.getAnnotationValue(HutoolController.class, RequestMapping.class);

其他工具類

Hutool中的工具類很多，可以參考：https://www.hutool.cn/