Spring Boot 内置工具类

断言

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

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

复制代码

对象、数组、集合

• ObjectUtils
  

获取对象的根本信息

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

复制代码

判断工具

1. // 判断数组是否为空
2. boolean isEmpty(Object[] array)
4. // 判断参数对象是否是数组
5. boolean isArray(Object obj)
7. // 判断数组中是否包含指定元素
8. boolean containsElement(Object[] array, Object element)
10. // 相等，或同为 null时，返回 true
11. boolean nullSafeEquals(Object o1, Object o2)
13. /*
15. 判断参数对象是否为空，判断标准为：
17.     Optional: Optional.empty()
19.        Array: length == 0
21. CharSequence: length == 0
23.   Collection: Collection.isEmpty()
25.          Map: Map.isEmpty()
27. */
28. boolean isEmpty(Object obj)

复制代码

其他工具方法

1. // 向参数数组的末尾追加新元素，并返回一个新数组
2. <A, O extends A> A[] addObjectToArray(A[] array, O obj)
4. // 原生基础类型数组 --> 包装类数组
5. Object[] toObjectArray(Object source)

复制代码

• StringUtils
  

字符串判断工具

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

复制代码

字符串操作工具

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

复制代码

路径相关工具方法

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

复制代码

• CollectionUtils
  

集合判断工具

1. // 判断 List/Set 是否为空
2. boolean isEmpty(Collection<?> collection)
4. // 判断 Map 是否为空
5. boolean isEmpty(Map<?,?> map)
7. // 判断 List/Set 中是否包含某个对象
8. boolean containsInstance(Collection<?> collection, Object element)
10. // 以迭代器的方式，判断 List/Set 中是否包含某个对象
11. boolean contains(Iterator<?> iterator, Object element)
13. // 判断 List/Set 是否包含某些对象中的任意一个
14. boolean containsAny(Collection<?> source, Collection<?> candidates)
16. // 判断 List/Set 中的每个元素是否唯一。即 List/Set 中不存在重复元素
17. boolean hasUniqueObject(Collection<?> collection)

复制代码

集合操作工具

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

复制代码

文件、资源、IO 流

• FileCopyUtils
  

输入

1. // 从文件中读入到字节数组中
2. byte[] copyToByteArray(File in)
4. // 从输入流中读入到字节数组中
5. byte[] copyToByteArray(InputStream in)
7. // 从输入流中读入到字符串中
8. String copyToString(Reader in)

复制代码

输出

1. // 从字节数组到文件
2. void copy(byte[] in, File out)
4. // 从文件到文件
5. int copy(File in, File out)
7. // 从字节数组到输出流
8. void copy(byte[] in, OutputStream out)
10. // 从输入流到输出流
11. int copy(InputStream in, OutputStream out)
13. // 从输入流到输出流
14. int copy(Reader in, Writer out)
16. // 从字符串到输出流
17. void copy(String in, Writer out)

复制代码

• ResourceUtils
  

从资源路径获取文件

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

复制代码

Resource

1. // 文件系统资源 D:\...
2. FileSystemResource
4. // URL 资源，如 file://... http://...
5. UrlResource
7. // 类路径下的资源，classpth:...
8. ClassPathResource
10. // Web 容器上下文中的资源（jar 包、war 包）
11. ServletContextResource
13. // 判断资源是否存在
14. boolean exists()
16. // 从资源中获得 File 对象
17. File getFile()
19. // 从资源中获得 URI 对象
20. URI getURI()
22. // 从资源中获得 URI 对象
23. URL getURL()
25. // 获得资源的 InputStream
26. InputStream getInputStream()
28. // 获得资源的描述信息
29. String getDescription()

复制代码

• StreamUtils
  

输入

1. void copy(byte[] in, OutputStream out)
2. int copy(InputStream in, OutputStream out)
3. void copy(String in, Charset charset, OutputStream out)
4. long copyRange(InputStream in, OutputStream out, long start, long end)

复制代码

输出

1. byte[] copyToByteArray(InputStream in)
2. String copyToString(InputStream in, Charset charset)
3. // 舍弃输入流中的内容
4. int drain(InputStream in)

复制代码

反射、AOP

• ReflectionUtils
  

获取方法

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

复制代码

执行方法

1. // 执行方法
2. Object invokeMethod(Method method, Object target)
4. // 同上，提供方法参数
5. Object invokeMethod(Method method, Object target, Object... args)
7. // 取消 Java 权限检查。以便后续执行该私有方法
8. void makeAccessible(Method method)
10. // 取消 Java 权限检查。以便后续执行私有构造方法
11. void makeAccessible(Constructor<?> ctor)

复制代码

获取字段

1. // 在类中查找指定属性
2. Field findField(Class<?> clazz, String name)
4. // 同上，多提供了属性的类型
5. Field findField(Class<?> clazz, String name, Class<?> type)
7. // 是否为一个 "public static final" 属性
8. boolean isPublicStaticFinal(Field field)

复制代码

设置字段

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

复制代码

• AopUtils
  

判断代理类型

1. // 判断是不是 Spring 代理对象
2. boolean isAopProxy()
4. // 判断是不是 jdk 动态代理对象
5. isJdkDynamicProxy()
7. // 判断是不是 CGLIB 代理对象
8. boolean isCglibProxy()

复制代码

获取被代理对象的 class

1. // 获取被代理的目标 class
2. Class<?> getTargetClass()

复制代码

• AopContext
  

获取当前对象的代理对象

1. Object currentProxy()

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。