別再自己瞎寫工具類了，Spring Boot 內建工具類應有盡有， 建議收藏！！

2024-07-16碼農

點選「 IT碼徒」，關註，置頂公眾號

每日技術幹貨，第一時間送達！

最近發現同事寫了不少重復的工具類，發現其中很多功能，Spring 內建的都有。於是整理了本文，希望能夠幫助到大家！

斷言

斷言是一個邏輯判斷，用於檢查不應該發生的情況

Assert 關鍵字在 JDK1.4 中引入，可透過 JVM 參數-enableassertions開啟

SpringBoot 中提供了 Assert 斷言工具類，通常用於數據合法性檢查

// 要求參數 object 必須為非空（Not Null），否則丟擲異常，不予放行 // 參數 message 參數用於客製異常資訊。 void notNull(Object object, String message) // 要求參數必須空（Null），否則丟擲異常，不予『放行』。 // 和 notNull() 方法斷言規則相反 void isNull(Object object, String message) // 要求參數必須為真（True），否則丟擲異常，不予『放行』。 void isTrue(boolean expression, String message) // 要求參數（List/Set）必須非空（Not Empty），否則丟擲異常，不予放行 void notEmpty(Collection collection, String message) // 要求參數（String）必須有長度（即，Not Empty），否則丟擲異常，不予放行 void hasLength(String text, String message) // 要求參數（String）必須有內容（即，Not Blank），否則丟擲異常，不予放行 void hasText(String text, String message) // 要求參數是指定型別的例項，否則丟擲異常，不予放行 void isInstanceOf( class type, Object obj, String message) // 要求參數 `subType` 必須是參數 superType 的子類別或實作類，否則丟擲異常，不予放行 void isAssignable( class superType, class subType, String message)

物件、陣列、集合

ObjectUtils

獲取物件的基本資訊

// 獲取物件的類名。參數為 null 時，返回字串："null" String nullSafe className(Object obj) // 參數為 null 時，返回 0 int nullSafeHashCode(Object object) // 參數為 null 時，返回字串："null" String nullSafeToString(boolean[] array) // 獲取物件 HashCode（十六進制形式字串）。參數為 null 時，返回 0 String getIdentityHexString(Object obj) // 獲取物件的類名和 HashCode。參數為 null 時，返回字串："" String identityToString(Object obj) // 相當於 toString()方法，但參數為 null 時，返回字串："" String getDisplayString(Object obj)

判斷工具

// 判斷陣列是否為空 boolean isEmpty(Object[] array) // 判斷參數物件是否是陣列 boolean isArray(Object obj) // 判斷陣列中是否包含指定元素 boolean containsElement(Object[] array, Object element) // 相等，或同為 null時，返回 true boolean nullSafeEquals(Object o1, Object o2) /* 判斷參數物件是否為空，判斷標準為： Optional: Optional.empty() Array: length == 0 CharSequence: length == 0 Collection: Collection.isEmpty() Map: Map.isEmpty() */ boolean isEmpty(Object obj)

其他工具方法

// 向參數陣列的末尾追加新元素，並返回一個新陣列 <A, O extends A> A[] addObjectToArray(A[] array, O obj) // 原生基礎型別陣列 --> 包裝類陣列 Object[] toObjectArray(Object source)

StringUtils

字串判斷工具

// 判斷字串是否為 null，或 ""。註意，包含空白符的字串為非空 boolean isEmpty(Object str) // 判斷字串是否是以指定內容結束。忽略大小寫 boolean endsWithIgnoreCase(String str, String suffix) // 判斷字串是否已指定內容開頭。忽略大小寫 boolean startsWithIgnoreCase(String str, String prefix) // 是否包含空白符 boolean containsWhitespace(String str) // 判斷字串非空且長度不為 0，即，Not Empty boolean hasLength(CharSequence str) // 判斷字串是否包含實際內容，即非僅包含空白符，也就是 Not Blank boolean hasText(CharSequence str) // 判斷字串指定索引處是否包含一個子串。 boolean substringMatch(CharSequence str, int index, CharSequence substring) // 計算一個字串中指定子串的出現次數 int countOccurrencesOf(String str, String sub)

字串操作工具

// 尋找並替換指定子串 String replace(String inString, String oldPattern, String newPattern) // 去除尾部的特定字元 String trimTrailingCharacter(Stringstr, char trailingCharacter) // 去除頭部的特定字元 String trimLeadingCharacter(Stringstr, char leadingCharacter) // 去除頭部的空白符 String trimLeadingWhitespace(Stringstr) // 去除頭部的空白符 String trimTrailingWhitespace(Stringstr) // 去除頭部和尾部的空白符 String trimWhitespace(Stringstr) // 刪除開頭、結尾和中間的空白符 String trimAllWhitespace(Stringstr) // 刪除指定子串 Stringdelete(String inString, String pattern) // 刪除指定字元（可以是多個） String deleteAny(String inString, String charsToDelete) // 對陣列的每一項執行 trim() 方法 String[] trimArrayElements(String[] array) // 將 URL 字串進行解碼 String uriDecode(Stringsource, Charsetcharset)

路徑相關工具方法

// 解析路徑字串，最佳化其中的「..」 String cleanPath(String path) // 解析路徑字串，解析出檔名部份 String getFilename(String path) // 解析路徑字串，解析出檔字尾名 String getFilenameExtension(String path) // 比較兩個兩個字串，判斷是否是同一個路徑。會自動處理路徑中的「..」 boolean pathEquals(String path1, String path2) // 刪除檔路徑名中的字尾部份 String stripFilenameExtension(String path) // 以「. 作為分隔符，獲取其最後一部份 String unqualify(String qualifiedName) // 以指定字元作為分隔符，獲取其最後一部份 String unqualify(String qualifiedName, char separator)

CollectionUtils

集合判斷工具

// 判斷 List/Set 是否為空 boolean isEmpty(Collection<?> collection) // 判斷 Map 是否為空 boolean isEmpty(Map<?,?> map) // 判斷 List/Set 中是否包含某個物件 boolean containsInstance(Collection<?> collection, Objectelement) // 以叠代器的方式，判斷 List/Set 中是否包含某個物件 boolean contains(Iterator<?> iterator, Objectelement) // 判斷 List/Set 是否包含某些物件中的任意一個 boolean containsAny(Collection<?> source, Collection<?> candidates) // 判斷 List/Set 中的每個元素是否唯一。即 List/Set 中不存在重復元素 boolean hasUniqueObject(Collection<?> collection)

集合操作工具

// 將 Array 中的元素都添加到 List/Set 中 <E> void mergeArrayIntoCollection(Objectarray, Collection<E> collection) // 將 Properties 中的鍵值對都添加到 Map 中 <K,V> void mergePropertiesIntoMap(Properties props, Map<K,V> map) // 返回 List 中最後一個元素 <T> T lastElement(List<T> list) // 返回 Set 中最後一個元素 <T> T lastElement(Set<T> set) // 返回參數 candidates 中第一個存在於參數 source 中的元素 <E> E findFirstMatch(Collection<?> source, Collection<E> candidates) // 返回 List/Set 中指定型別的元素。 <T> T findValueOfType(Collection<?> collection, class<T> type) // 返回 List/Set 中指定型別的元素。如果第一種型別未找到，則尋找第二種型別，以此類推 Object findValueOfType(Collection<?> collection, class<?>[] types) // 返回 List/Set 中元素的型別 class<?> findCommonElementType(Collection<?> collection)

檔、資源、IO 流

FileCopyUtils

輸入

// 從檔中讀入到字節陣列中 byte[] copyToByteArray(File in) // 從輸入流中讀入到字節陣列中 byte[] copyToByteArray(InputStream in) // 從輸入流中讀入到字串中 String copyToString(Reader in)

輸出

// 從字節陣列到檔 voidcopy(byte[] in, File out) // 從檔到檔 intcopy(File in, File out) // 從字節陣列到輸出流 voidcopy(byte[] in, OutputStream out) // 從輸入流到輸出流 intcopy(InputStream in, OutputStream out) // 從輸入流到輸出流 intcopy(Reader in, Writer out) // 從字串到輸出流 voidcopy(String in, Writer out)

ResourceUtils

從資源路徑獲取檔

// 判斷字串是否是一個合法的 URL 字串。 staticboolean isUrl(String resourceLocation) // 獲取 URL static URL getURL(String resourceLocation) // 獲取檔（在 JAR 包內無法正常使用，需要是一個獨立的檔） static File getFile(String resourceLocation)

Resource

// 檔案系統資源 D:\... FileSystemResource // URL 資源，如 file://... http://... UrlResource // 類路徑下的資源， classpth:... classPathResource // Web 容器上下文中的資源（jar 包、war 包） ServletContextResource // 判斷資源是否存在 booleanexists() // 從資源中獲得 File 物件 FilegetFile() // 從資源中獲得 URI 物件 URIgetURI() // 從資源中獲得 URI 物件 URLgetURL() // 獲得資源的 InputStream InputStreamgetInputStream() // 獲得資源的描述資訊 StringgetDescription()

StreamUtils

輸入

voidcopy(byte[] in, OutputStream out) intcopy(InputStream in, OutputStream out) voidcopy(String in, Charset charset, OutputStream out) long copyRange(InputStream in, OutputStream out, long start, long end)

輸出

byte[] copyToByteArray(InputStream in) String copyToString(InputStream in, Charset charset) // 舍棄輸入流中的內容 intdrain(InputStream in)

反射、AOP

ReflectionUtils

獲取方法

// 在類中尋找指定方法 Method findMethod( class<?> clazz, String name) // 同上，額外提供方法參數型別作尋找條件 Method findMethod( class<?> clazz, String name, class<?>... paramTypes) // 獲得類中所有方法，包括繼承而來的 Method[] getAllDeclaredMethods( class<?> leaf class) // 在類中尋找指定構造方法 Constructor<T> accessibleConstructor( class<T> clazz, class<?>... parameterTypes) // 是否是 equals() 方法 boolean isEqualsMethod(Method method) // 是否是 hashCode() 方法 boolean isHashCodeMethod(Method method) // 是否是 toString() 方法 boolean isToStringMethod(Method method) // 是否是從 Object 類繼承而來的方法 boolean isObjectMethod(Method method) // 檢查一個方法是否聲明丟擲指定異常 boolean declaresException(Method method, class<?> exceptionType)

執行方法

// 執行方法 Object invokeMethod(Method method, Object target) // 同上，提供方法參數 Object invokeMethod(Method method, Object target, Object... args) // 取消 Java 許可權檢查。以便後續執行該私有方法 void makeAccessible(Method method) // 取消 Java 許可權檢查。以便後續執行私有構造方法 void makeAccessible(Constructor<?> ctor)

獲取欄位

// 在類中尋找指定內容 Field findField( class<?> clazz, String name) // 同上，多提供了內容的型別 Field findField( class<?> clazz, String name, class<?> type) // 是否為一個 "public static final" 內容 boolean isPublicStaticFinal(Field field)

設定欄位

// 獲取 target 物件的 field 內容值 Object getField(Field field, Object target) // 設定 target 物件的 field 內容值，值為 value void setField(Field field, Object target, Object value) // 同類物件內容對等賦值 void shallowCopyFieldState(Object src, Object dest) // 取消 Java 的許可權控制檢查。以便後續讀寫該私有內容 void makeAccessible(Field field) // 對類的每個內容執行 callback void doWithFields( class<?> clazz, ReflectionUtils.FieldCallback fc) // 同上，多了個內容過濾功能。 void doWithFields( class<?> clazz, ReflectionUtils.FieldCallback fc, ReflectionUtils.FieldFilter ff) // 同上，但不包括繼承而來的內容 void doWithLocalFields( class<?> clazz, ReflectionUtils.FieldCallback fc)