SpringBoot 内置工具类的使用

忘是亡心i 2023-10-05 22:08 79阅读 0赞

*  [断言][Link 1]
 *  [对象、数组、集合][Link 2]
    
     *  [ObjectUtils][]
     *  [StringUtils][]
     *  [CollectionUtils][]
 *  [文件、资源、IO 流][IO]
    
     *  [FileCopyUtils][]
     *  [ResourceUtils][]
     *  [StreamUtils][]
 *  [反射、AOP][AOP]
    
     *  [ReflectionUtils][]
     *  [AopUtils][]
     *  [AopContext][]

### 断言 ###

*  断言是一个逻辑判断，用于检查不应该发生的情况
 *  Assert 关键字在 JDK1.4 中引入，可通过 JVM 参数-enableassertions开启
 *  SpringBoot 中提供了 Assert 断言工具类，通常用于数据合法性检查

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 </td> 
 <td> <code>// 要求参数 object 必须为非空（Not Null），否则抛出异常，不予放行</code> <code>// 参数 message 参数用于定制异常信息。</code> <code>void</code> <code>notNull(Object object, String message)</code> <code>// 要求参数必须空（Null），否则抛出异常，不予『放行』。</code> <code>// 和 notNull() 方法断言规则相反</code> <code>void</code> <code>isNull(Object object, String message)</code> <code>// 要求参数必须为真（True），否则抛出异常，不予『放行』。</code> <code>void</code> <code>isTrue(</code><code>boolean</code> <code>expression, String message)</code> <code>// 要求参数（List/Set）必须非空（Not Empty），否则抛出异常，不予放行</code> <code>void</code> <code>notEmpty(Collection collection, String message)</code> <code>// 要求参数（String）必须有长度（即，Not Empty），否则抛出异常，不予放行</code> <code>void</code> <code>hasLength(String text, String message)</code> <code>// 要求参数（String）必须有内容（即，Not Blank），否则抛出异常，不予放行</code> <code>void</code> <code>hasText(String text, String message)</code> <code>// 要求参数是指定类型的实例，否则抛出异常，不予放行</code> <code>void</code> <code>isInstanceOf(Class type, Object obj, String message)</code> <code>// 要求参数 `subType` 必须是参数 superType 的子类或实现类，否则抛出异常，不予放行</code> <code>void</code> <code>isAssignable(Class superType, Class subType, String message)</code> </td> 
 </tr> 
 </tbody> 
</table>

### 对象、数组、集合 ###

#### ObjectUtils ####

获取对象的基本信息

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>// 获取对象的类名。参数为 null 时，返回字符串："null" </code> <code>String nullSafeClassName(Object obj)</code> <code>// 参数为 null 时，返回 0</code> <code>int</code> <code>nullSafeHashCode(Object object)</code> <code>// 参数为 null 时，返回字符串："null"</code> <code>String nullSafeToString(</code><code>boolean</code><code>[] array)</code> <code>// 获取对象 HashCode（十六进制形式字符串）。参数为 null 时，返回 0 </code> <code>String getIdentityHexString(Object obj)</code> <code>// 获取对象的类名和 HashCode。 参数为 null 时，返回字符串："" </code> <code>String identityToString(Object obj)</code> <code>// 相当于 toString()方法，但参数为 null 时，返回字符串：""</code> <code>String getDisplayString(Object obj)</code> </td> 
 </tr> 
 </tbody> 
</table>

判断工具

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>// 判断数组是否为空</code> <code>boolean</code> <code>isEmpty(Object[] array)</code> <code>// 判断参数对象是否是数组</code> <code>boolean</code> <code>isArray(Object obj)</code> <code>// 判断数组中是否包含指定元素</code> <code>boolean</code> <code>containsElement(Object[] array, Object element)</code> <code>// 相等，或同为 null时，返回 true</code> <code>boolean</code> <code>nullSafeEquals(Object o1, Object o2)</code> <code>/*</code> <code>判断参数对象是否为空，判断标准为：</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Optional: Optional.empty()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Array: length == 0</code> <code>CharSequence: length == 0</code> <code>&nbsp;&nbsp;</code><code>Collection: Collection.isEmpty()</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Map: Map.isEmpty()</code> <code>&nbsp;</code><code>*/</code> <code>boolean</code> <code>isEmpty(Object obj)</code> </td> 
 </tr> 
 </tbody> 
</table>

其他工具方法

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>// 向参数数组的末尾追加新元素，并返回一个新数组</code> <code>&lt;A, O </code><code>extends</code> <code>A&gt; A[] addObjectToArray(A[] array, O obj)</code> <code>// 原生基础类型数组 --&gt; 包装类数组</code> <code>Object[] toObjectArray(Object source)</code> </td> 
 </tr> 
 </tbody> 
</table>

#### StringUtils ####

字符串判断工具

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code>// 判断字符串是否为 null，或 ""。注意，包含空白符的字符串为非空</code> <code>boolean</code> <code>isEmpty(Object str)</code> <code>// 判断字符串是否是以指定内容结束。忽略大小写</code> <code>boolean</code> <code>endsWithIgnoreCase(String str, String suffix)</code> <code>// 判断字符串是否已指定内容开头。忽略大小写</code> <code>boolean</code> <code>startsWithIgnoreCase(String str, String prefix) </code> <code>// 是否包含空白符</code> <code>boolean</code> <code>containsWhitespace(String str)</code> <code>// 判断字符串非空且长度不为 0，即，Not Empty</code> <code>boolean</code> <code>hasLength(CharSequence str)</code> <code>// 判断字符串是否包含实际内容，即非仅包含空白符，也就是 Not Blank</code> <code>boolean</code> <code>hasText(CharSequence str)</code> <code>// 判断字符串指定索引处是否包含一个子串。</code> <code>boolean</code> <code>substringMatch(CharSequence str, </code><code>int</code> <code>index, CharSequence substring)</code> <code>// 计算一个字符串中指定子串的出现次数</code> <code>int</code> <code>countOccurrencesOf(String str, String sub)</code> </td> 
 </tr> 
 </tbody> 
</table>

字符串操作工具

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 </td> 
 <td> <code>// 查找并替换指定子串</code> <code>String replace(String inString, String oldPattern, String newPattern)</code> <code>// 去除尾部的特定字符</code> <code>String trimTrailingCharacter(String str, </code><code>char</code> <code>trailingCharacter) </code> <code>// 去除头部的特定字符</code> <code>String trimLeadingCharacter(String str, </code><code>char</code> <code>leadingCharacter)</code> <code>// 去除头部的空白符</code> <code>String trimLeadingWhitespace(String str)</code> <code>// 去除头部的空白符</code> <code>String trimTrailingWhitespace(String str)</code> <code>// 去除头部和尾部的空白符</code> <code>String trimWhitespace(String str)</code> <code>// 删除开头、结尾和中间的空白符</code> <code>String trimAllWhitespace(String str)</code> <code>// 删除指定子串</code> <code>String delete(String inString, String pattern)</code> <code>// 删除指定字符（可以是多个）</code> <code>String deleteAny(String inString, String charsToDelete)</code> <code>// 对数组的每一项执行 trim() 方法</code> <code>String[] trimArrayElements(String[] array)</code> <code>// 将 URL 字符串进行解码</code> <code>String uriDecode(String source, Charset charset)</code> </td> 
 </tr> 
 </tbody> 
</table>

路径相关工具方法

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td> <code>// 解析路径字符串，优化其中的 “..” </code> <code>String cleanPath(String path)</code> <code>// 解析路径字符串，解析出文件名部分</code> <code>String getFilename(String path)</code> <code>// 解析路径字符串，解析出文件后缀名</code> <code>String getFilenameExtension(String path)</code> <code>// 比较两个两个字符串，判断是否是同一个路径。会自动处理路径中的 “..” </code> <code>boolean</code> <code>pathEquals(String path1, String path2)</code> <code>// 删除文件路径名中的后缀部分</code> <code>String stripFilenameExtension(String path) </code> <code>// 以 “. 作为分隔符，获取其最后一部分</code> <code>String unqualify(String qualifiedName)</code> <code>// 以指定字符作为分隔符，获取其最后一部分</code> <code>String unqualify(String qualifiedName, </code><code>char</code> <code>separator)</code> </td> 
 </tr> 
 </tbody> 
</table>

#### CollectionUtils ####

集合判断工具

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>// 判断 List/Set 是否为空</code> <code>boolean</code> <code>isEmpty(Collection&lt;?&gt; collection)</code> <code>// 判断 Map 是否为空</code> <code>boolean</code> <code>isEmpty(Map&lt;?,?&gt; map)</code> <code>// 判断 List/Set 中是否包含某个对象</code> <code>boolean</code> <code>containsInstance(Collection&lt;?&gt; collection, Object element)</code> <code>// 以迭代器的方式，判断 List/Set 中是否包含某个对象</code> <code>boolean</code> <code>contains(Iterator&lt;?&gt; iterator, Object element)</code> <code>// 判断 List/Set 是否包含某些对象中的任意一个</code> <code>boolean</code> <code>containsAny(Collection&lt;?&gt; source, Collection&lt;?&gt; candidates)</code> <code>// 判断 List/Set 中的每个元素是否唯一。即 List/Set 中不存在重复元素</code> <code>boolean</code> <code>hasUniqueObject(Collection&lt;?&gt; collection)</code> </td> 
 </tr> 
 </tbody> 
</table>

集合操作工具

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code>// 将 Array 中的元素都添加到 List/Set 中</code> <code>&lt;E&gt; </code><code>void</code> <code>mergeArrayIntoCollection(Object array, Collection&lt;E&gt; collection)&nbsp; </code> <code>// 将 Properties 中的键值对都添加到 Map 中</code> <code>&lt;K,V&gt; </code><code>void</code> <code>mergePropertiesIntoMap(Properties props, Map&lt;K,V&gt; map)</code> <code>// 返回 List 中最后一个元素</code> <code>&lt;T&gt; T lastElement(List&lt;T&gt; list)&nbsp; </code> <code>// 返回 Set 中最后一个元素</code> <code>&lt;T&gt; T lastElement(Set&lt;T&gt; set) </code> <code>// 返回参数 candidates 中第一个存在于参数 source 中的元素</code> <code>&lt;E&gt; E findFirstMatch(Collection&lt;?&gt; source, Collection&lt;E&gt; candidates)</code> <code>// 返回 List/Set 中指定类型的元素。</code> <code>&lt;T&gt; T findValueOfType(Collection&lt;?&gt; collection, Class&lt;T&gt; type)</code> <code>// 返回 List/Set 中指定类型的元素。如果第一种类型未找到，则查找第二种类型，以此类推</code> <code>Object findValueOfType(Collection&lt;?&gt; collection, Class&lt;?&gt;[] types)</code> <code>// 返回 List/Set 中元素的类型</code> <code>Class&lt;?&gt; findCommonElementType(Collection&lt;?&gt; collection)</code> </td> 
 </tr> 
 </tbody> 
</table>

### 文件、资源、IO 流 ###

#### FileCopyUtils ####

输入

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>// 从文件中读入到字节数组中</code> <code>byte</code><code>[] copyToByteArray(File in)</code> <code>// 从输入流中读入到字节数组中</code> <code>byte</code><code>[] copyToByteArray(InputStream in)</code> <code>// 从输入流中读入到字符串中</code> <code>String copyToString(Reader in)</code> </td> 
 </tr> 
 </tbody> 
</table>

输出

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>// 从字节数组到文件</code> <code>void</code> <code>copy(</code><code>byte</code><code>[] in, File out)</code> <code>// 从文件到文件</code> <code>int</code> <code>copy(File in, File out)</code> <code>// 从字节数组到输出流</code> <code>void</code> <code>copy(</code><code>byte</code><code>[] in, OutputStream out) </code> <code>// 从输入流到输出流</code> <code>int</code> <code>copy(InputStream in, OutputStream out) </code> <code>// 从输入流到输出流</code> <code>int</code> <code>copy(Reader in, Writer out)</code> <code>// 从字符串到输出流</code> <code>void</code> <code>copy(String in, Writer out)</code> </td> 
 </tr> 
 </tbody> 
</table>

#### ResourceUtils ####

从资源路径获取文件

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>// 判断字符串是否是一个合法的 URL 字符串。</code> <code>static</code> <code>boolean</code> <code>isUrl(String resourceLocation)</code> <code>// 获取 URL</code> <code>static</code> <code>URL getURL(String resourceLocation) </code> <code>// 获取文件（在 JAR 包内无法正常使用，需要是一个独立的文件）</code> <code>static</code> <code>File getFile(String resourceLocation)</code> </td> 
 </tr> 
 </tbody> 
</table>

Resource

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>// 文件系统资源 D:\...</code> <code>FileSystemResource</code> <code>// URL 资源，如 file://... http://...</code> <code>UrlResource</code> <code>// 类路径下的资源，classpth:...</code> <code>ClassPathResource</code> <code>// Web 容器上下文中的资源（jar 包、war 包）</code> <code>ServletContextResource</code> </td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>// 判断资源是否存在</code> <code>boolean</code> <code>exists()</code> <code>// 从资源中获得 File 对象</code> <code>File getFile()</code> <code>// 从资源中获得 URI 对象</code> <code>URI getURI()</code> <code>// 从资源中获得 URI 对象</code> <code>URL getURL()</code> <code>// 获得资源的 InputStream</code> <code>InputStream getInputStream()</code> <code>// 获得资源的描述信息</code> <code>String getDescription()</code> </td> 
 </tr> 
 </tbody> 
</table>

#### StreamUtils ####

输入

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>void</code> <code>copy(</code><code>byte</code><code>[] in, OutputStream out)</code> <code>int</code> <code>copy(InputStream in, OutputStream out)</code> <code>void</code> <code>copy(String in, Charset charset, OutputStream out)</code> <code>long</code> <code>copyRange(InputStream in, OutputStream out, </code><code>long</code> <code>start, </code><code>long</code> <code>end)</code> </td> 
 </tr> 
 </tbody> 
</table>

输出

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>byte</code><code>[] copyToByteArray(InputStream in)</code> <code>String copyToString(InputStream in, Charset charset)</code> <code>// 舍弃输入流中的内容</code> <code>int</code> <code>drain(InputStream in) </code> </td> 
 </tr> 
 </tbody> 
</table>

### 反射、AOP ###

#### ReflectionUtils ####

获取方法

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 </td> 
 <td> <code>// 在类中查找指定方法</code> <code>Method findMethod(Class&lt;?&gt; clazz, String name) </code> <code>// 同上，额外提供方法参数类型作查找条件</code> <code>Method findMethod(Class&lt;?&gt; clazz, String name, Class&lt;?&gt;... paramTypes) </code> <code>// 获得类中所有方法，包括继承而来的</code> <code>Method[] getAllDeclaredMethods(Class&lt;?&gt; leafClass) </code> <code>// 在类中查找指定构造方法</code> <code>Constructor&lt;T&gt; accessibleConstructor(Class&lt;T&gt; clazz, Class&lt;?&gt;... parameterTypes) </code> <code>// 是否是 equals() 方法</code> <code>boolean</code> <code>isEqualsMethod(Method method) </code> <code>// 是否是 hashCode() 方法 </code> <code>boolean</code> <code>isHashCodeMethod(Method method) </code> <code>// 是否是 toString() 方法</code> <code>boolean</code> <code>isToStringMethod(Method method) </code> <code>// 是否是从 Object 类继承而来的方法</code> <code>boolean</code> <code>isObjectMethod(Method method) </code> <code>// 检查一个方法是否声明抛出指定异常</code> <code>boolean</code> <code>declaresException(Method method, Class&lt;?&gt; exceptionType)</code> </td> 
 </tr> 
 </tbody> 
</table>

执行方法

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>// 执行方法</code> <code>Object invokeMethod(Method method, Object target)&nbsp; </code> <code>// 同上，提供方法参数</code> <code>Object invokeMethod(Method method, Object target, Object... args) </code> <code>// 取消 Java 权限检查。以便后续执行该私有方法</code> <code>void</code> <code>makeAccessible(Method method) </code> <code>// 取消 Java 权限检查。以便后续执行私有构造方法</code> <code>void</code> <code>makeAccessible(Constructor&lt;?&gt; ctor) </code> </td> 
 </tr> 
 </tbody> 
</table>

获取字段

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>// 在类中查找指定属性</code> <code>Field findField(Class&lt;?&gt; clazz, String name) </code> <code>// 同上，多提供了属性的类型</code> <code>Field findField(Class&lt;?&gt; clazz, String name, Class&lt;?&gt; type) </code> <code>// 是否为一个 "public static final" 属性</code> <code>boolean</code> <code>isPublicStaticFinal(Field field) </code> </td> 
 </tr> 
 </tbody> 
</table>

设置字段

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> <code>// 获取 target 对象的 field 属性值</code> <code>Object getField(Field field, Object target) </code> <code>// 设置 target 对象的 field 属性值，值为 value</code> <code>void</code> <code>setField(Field field, Object target, Object value) </code> <code>// 同类对象属性对等赋值</code> <code>void</code> <code>shallowCopyFieldState(Object src, Object dest)</code> <code>// 取消 Java 的权限控制检查。以便后续读写该私有属性</code> <code>void</code> <code>makeAccessible(Field field) </code> <code>// 对类的每个属性执行 callback</code> <code>void</code> <code>doWithFields(Class&lt;?&gt; clazz, ReflectionUtils.FieldCallback fc) </code> <code>// 同上，多了个属性过滤功能。</code> <code>void</code> <code>doWithFields(Class&lt;?&gt; clazz, ReflectionUtils.FieldCallback fc, </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ReflectionUtils.FieldFilter ff) </code> <code>// 同上，但不包括继承而来的属性</code> <code>void</code> <code>doWithLocalFields(Class&lt;?&gt; clazz, ReflectionUtils.FieldCallback fc) </code> </td> 
 </tr> 
 </tbody> 
</table>

#### AopUtils ####

判断代理类型

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>// 判断是不是 Spring 代理对象</code> <code>boolean</code> <code>isAopProxy()</code> <code>// 判断是不是 jdk 动态代理对象</code> <code>isJdkDynamicProxy()</code> <code>// 判断是不是 CGLIB 代理对象</code> <code>boolean</code> <code>isCglibProxy()</code> </td> 
 </tr> 
 </tbody> 
</table>

获取被代理对象的 class

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>// 获取被代理的目标 class</code> <code>Class&lt;?&gt; getTargetClass()</code> </td> 
 </tr> 
 </tbody> 
</table>

#### AopContext ####

获取当前对象的代理对象

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>Object currentProxy()</code> &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

[Link 1]: https://www.jb51.net/article/232492.htm#_label0
[Link 2]: https://www.jb51.net/article/232492.htm#_label1
[ObjectUtils]: https://www.jb51.net/article/232492.htm#_lab2_1_0
[StringUtils]: https://www.jb51.net/article/232492.htm#_lab2_1_1
[CollectionUtils]: https://www.jb51.net/article/232492.htm#_lab2_1_2
[IO]: https://www.jb51.net/article/232492.htm#_label2
[FileCopyUtils]: https://www.jb51.net/article/232492.htm#_lab2_2_3
[ResourceUtils]: https://www.jb51.net/article/232492.htm#_lab2_2_4
[StreamUtils]: https://www.jb51.net/article/232492.htm#_lab2_2_5
[AOP]: https://www.jb51.net/article/232492.htm#_label3
[ReflectionUtils]: https://www.jb51.net/article/232492.htm#_lab2_3_6
[AopUtils]: https://www.jb51.net/article/232492.htm#_lab2_3_7
[AopContext]: https://www.jb51.net/article/232492.htm#_lab2_3_8