前言
hutool是作者的一個自造詞，hu tool，hu指的是他的前公司，諧音：糊塗，意為"萬事都作糊塗觀，無所謂失，無所謂得"，tool就是“工具”的意思
hutool簡略大綱
依賴
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>${hutool.version}</version>
</dependency>
convert 類型轉換
// int轉字符串
int a = 1;
String aStr = Convert.toStr(a);
// 字符串轉int
String param = "10";
int paramInt = Convert.toInt(param);
// 重載 第二個參數 defaultValue 可用於在轉換失敗時返回一個默認值
int paramIntDefault = Convert.toInt(param, 0);
// 轉換為指定類型數組
String[] b = {"1", "2", "3", "4"};
Integer[] bArr = Convert.toIntArray(b);
// 轉換為日期對象
String dateStr = "2017-05-06";
Date date = Convert.toDate(dateStr);
// 轉為Unicode
String unicodeStr = "紫邪情";
String unicode = Convert.strToUnicode(unicodeStr);
// 轉換為List
String[] strArr = {"a", "b", "c", "d"};
List<String> strList = Convert.toList(String.class, strArr);
DataUtil 日期時間
此工具定義了一些操作日期的方法: Date、long、Calendar之間的相互轉換
// 當前時間
// 返回的其實是 DateTime，它繼承自 Date 對象，重寫了 toString() 方法，返回 yyyy-MM-dd HH:mm:ss 格式的字符串
Date date = DateUtil.date();
// 字符串轉日期
/*
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 dateStr = "2021-08-28";
Date date = DateUtil.parse(dateStr);
// 自定義格式化轉換
date = DateUtil.parse(dateStr, "yyyy-MM-dd");
// 星座、屬相
// 射手座
String zodiac = DateUtil.getZodiac(Month.DECEMBER.getValue(), 10);
// 蛇
String chineseZodiac = DateUtil.getChineseZodiac(1989);
// Calendar轉Date
date = DateUtil.date(Calendar.getInstance());
// 時間戳轉Date
date = DateUtil.date(System.currentTimeMillis());
// 格式化輸出日期
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);
IO流相關
流操作工具類 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相關的，如下：
- 文件操作：包括文件目錄的新建、刪除、復制、移動、改名等
- 文件判斷：判斷文件或目錄是否非空，是否為目錄，是否為文件等等
- 絕對路徑：針對 ClassPath 中的文件轉換為絕對路徑文件
- 文件名：主文件名，擴展名的獲取
- 讀操作：包括 getReader、readXXX 操作
- 寫操作：包括 getWriter、writeXXX 操作
StrUtil 字符串工具
此工具和Apache Commons Lang 包中的 StringUtils 差不多
// 判斷是否為空字符串
String str = "test";
StrUtil.isEmpty(str);
StrUtil.isNotEmpty(str);
// 去除字符串的前后綴
StrUtil.removeSuffix("a.jpg", ".jpg");
StrUtil.removePrefix("a.jpg", "a.");
// 格式化字符串 這個是比較有意思的一個點
String template = "這只是個占位符:{}";
String str2 = StrUtil.format(template, "我是占位符");
LOGGER.info("strUtil format:{}", str2);
ReflectUtil 反射工具
Hutool 封裝的反射工具 ReflectUtil 包括：
- 獲取構造方法
- 獲取字段
- 獲取字段值
- 獲取方法
- 執行方法（對象方法和靜態方法）
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("無參構造");
}
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");
}
}
ZipUtil 壓縮工具
Hutool 封裝的 ZipUtil 針對 java.util.zip 包做了優化，可以使用一個方法搞定壓縮和解壓，並且自動處理文件和目錄的問題，不再需要用戶判斷
ZipUtil.zip("hutool", "hutool.zip");
File unzip = ZipUtil.unzip("hutool.zip", "hutoolzip");+
IdcardUtil 身份證驗證工具
支持大陸 15 位、18 位身份證，港澳台 10 位身份證
String ID_18 = "321083197812162119";
String ID_15 = "150102880730303";
boolean valid = IdcardUtil.isValidCard(ID_18);
boolean valid15 = IdcardUtil.isValidCard(ID_15);
Console 控制台工具
一些復雜的對象不支持直接打印，比如說數組，需要調用 Arrays.toString。Hutool 封裝的 Console 類借鑒了 JavaScript 中的 console.log()，使得打印變成了一個非常便捷的方式
public class ConsoleDemo {
public static void main(String[] args) {
// 打印字符串
Console.log("紫邪情，一個臉皮厚的人");
// 打印字符串模板
Console.log("洛陽是{}朝古都",13);
int [] ints = {1,2,3,4};
// 打印數組
Console.log(ints);
}
}
Validator 字段驗證器
做 Web 開發的時候，后端通常需要對表單提交過來的數據進行驗證。Hutool 封裝的 Validator 可以進行很多有效的條件驗證，以下的方法名見名知意
Validator.isEmail("紫邪情");
Validator.isMobile("itwanger.com");
ImgUtil 圖片工具
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
);
setting 配置文件
Java 中廣泛應用的配置文件 Properties 存在一個特別大的詬病：不支持中文
於是，Hutool 的 Setting 運用而生。Setting 除了兼容 Properties 文件格式外，還提供了一些特有功能，這些功能包括：
- 各種編碼方式支持
- 變量支持
- 分組支持
整個example.setting配置文件
name=紫邪情
age=18
讀取和更新配置文件
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", "2021年08月28日");
setting.store(SETTING);
}
}
SecureUtil 加密解密
加密分為三種：
- 對稱加密（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
- cureUtil.hmacSha1
// MD5加密
String str = "123456";
String md5Str = SecureUtil.md5(str);
LOGGER.info("secureUtil md5:{}", md5Str);
String encry = aes.encryptHex("紫邪情");
System.out.println(encry);
String oo = aes.decryptStr(encry);
System.out.println(oo);
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();
}
ClassPathResource ClassPath資源工具
此工具是獲取ClassPath下的文件，在Tomcat等容器中，ClassPath一般為：WEB-INFO/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 = 1.234;
double n2 = 1.234;
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 = "1.234";
// 判斷是否為數字、整數、浮點數
NumberUtil.isNumber(n3);
NumberUtil.isInteger(n3);
NumberUtil.isDouble(n3);
BeanUtil Bean與Map轉換工具
此工具是用於Map與JavaBean對象的互相轉換以及對象屬性的拷貝
PmsBrand brand = new PmsBrand();
brand.setId(1L);
brand.setName("小米");
brand.setShowStatus(0);
// Bean轉Map
Map<String, Object> map = BeanUtil.beanToMap(brand);
LOGGER.info("beanUtil bean to map:{}", map);
// Map轉Bean
PmsBrand mapBrand = BeanUtil.mapToBean(map, PmsBrand.class, false);
LOGGER.info("beanUtil map to bean:{}", mapBrand);
// Bean屬性拷貝
PmsBrand copyBrand = new PmsBrand();
BeanUtil.copyProperties(brand, copyBrand);
LOGGER.info("beanUtil copy properties:{}", copyBrand);
CollUtil 集合工具
// 數組轉換為列表
String[] array = new String[]{"a", "b", "c", "d", "e"};
List<String> list = CollUtil.newArrayList(array);
// 數組轉字符串時添加連接符號
String joinStr = CollUtil.join(list, ",");
LOGGER.info("collUtil join:{}", joinStr);
// 將以連接符號分隔的字符串再轉換為列表
List<String> splitList = StrUtil.split(joinStr, ',');
LOGGER.info("collUtil split:{}", splitList);
// 創建新的Map、Set、List
HashMap<Object, Object> newMap = CollUtil.newHashMap();
HashSet<Object> newHashSet = CollUtil.newHashSet();
ArrayList<Object> newList = CollUtil.newArrayList();
// 判斷列表是否為空
CollUtil.isEmpty(list);
MapUtil Map集合工具
此工具可用於創建Map和判斷Map是否為null
// 將多個鍵值對加入到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);