SpringBoot内置工具类,告别瞎写工具类了(spring自带工具类)

  本篇文章为你整理了SpringBoot内置工具类,告别瞎写工具类了(spring自带工具类)的详细内容,包含有springboot内置actuator有哪些 spring自带工具类 springboot 工具类调用service springboot定制配置工具类 SpringBoot内置工具类,告别瞎写工具类了,希望能帮助你了解 SpringBoot内置工具类,告别瞎写工具类了。

   不知大家有没有注意到,接手的项目中存在多个重复的工具类,发现其中很多功能,Spring 自带的都有。于是整理了本文,希望能够帮助到大家!

  


// 要求参数 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)

 

  二、对象、数组、集合

  1.ObjectUtils

  获取对象的基本信息:

  

// 获取对象的类名。参数为 null 时,返回字符串:"null"

 

  String nullSafeClassName(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)

 

  2.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(String str, char trailingCharacter)

  // 去除头部的特定字符

  String trimLeadingCharacter(String str, char leadingCharacter)

  // 去除头部的空白符

  String trimLeadingWhitespace(String str)

  // 去除头部的空白符

  String trimTrailingWhitespace(String str)

  // 去除头部和尾部的空白符

  String trimWhitespace(String str)

  // 删除开头、结尾和中间的空白符

  String trimAllWhitespace(String str)

  // 删除指定子串

  String delete(String inString, String pattern)

  // 删除指定字符(可以是多个)

  String deleteAny(String inString, String charsToDelete)

  // 对数组的每一项执行 trim() 方法

  String[] trimArrayElements(String[] array)

  // 将 URL 字符串进行解码

  String uriDecode(String source, Charset charset)

 

  路径相关工具方法:

  

// 解析路径字符串,优化其中的 “..”

 

  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)

 

  3.CollectionUtils

  集合判断工具:

  

// 判断 List/Set 是否为空

 

  boolean isEmpty(Collection ? collection)

  // 判断 Map 是否为空

  boolean isEmpty(Map ?,? map)

  // 判断 List/Set 中是否包含某个对象

  boolean containsInstance(Collection ? collection, Object element)

  // 以迭代器的方式,判断 List/Set 中是否包含某个对象

  boolean contains(Iterator ? iterator, Object element)

  // 判断 List/Set 是否包含某些对象中的任意一个

  boolean containsAny(Collection ? source, Collection ? candidates)

  // 判断 List/Set 中的每个元素是否唯一。即 List/Set 中不存在重复元素

  boolean hasUniqueObject(Collection ? collection)

 

  集合操作工具:

  

// 将 Array 中的元素都添加到 List/Set 中

 

   E void mergeArrayIntoCollection(Object array, 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 流

  1.FileCopyUtils

  输入:

  

// 从文件中读入到字节数组中

 

  byte[] copyToByteArray(File in)

  // 从输入流中读入到字节数组中

  byte[] copyToByteArray(InputStream in)

  // 从输入流中读入到字符串中

  String copyToString(Reader in)

 

  输出:

  

// 从字节数组到文件

 

  void copy(byte[] in, File out)

  // 从文件到文件

  int copy(File in, File out)

  // 从字节数组到输出流

  void copy(byte[] in, OutputStream out)

  // 从输入流到输出流

  int copy(InputStream in, OutputStream out)

  // 从输入流到输出流

  int copy(Reader in, Writer out)

  // 从字符串到输出流

  void copy(String in, Writer out)

 

  2.ResourceUtils

  从资源路径获取文件:

  

// 判断字符串是否是一个合法的 URL 字符串。

 

  static boolean 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

  // 判断资源是否存在

  boolean exists()

  // 从资源中获得 File 对象

  File getFile()

  // 从资源中获得 URI 对象

  URI getURI()

  // 从资源中获得 URI 对象

  URL getURL()

  // 获得资源的 InputStream

  InputStream getInputStream()

  // 获得资源的描述信息

  String getDescription()

 

  3.StreamUtils

  输入:

  

/**

 

   * 将给定的 {@code byte[]} 字节数组内容复制到给定的 {@link OutputStream} 中,完成后保持流的打开状态。

   * @param in 作为来源的字节数组

   * @param out 复制到目标输出流

  void copy(byte[] in, OutputStream out)

  
* 将给定的 {@link InputStream} 内容复制到给定的 {@link OutputStream} 中,完成后保持流的打开状态。

   * @param in 数据来源输入流

   * @param out 复制到目标输出流

   * @return 复制了多少字节

  int copy(InputStream in, OutputStream out)

   * 将给定的字符串 {@link String} 内容复制到给定的 {@link OutputStream} 中,完成后保持流的打开状态。

   * @param in 数据来源:字符串

   * @param charset 来源字符串对应的字符集

   * @param out 复制到目标输出流

  void copy(String in, Charset charset, OutputStream out)

   * 将给定的 {@link InputStream} 内容复制到给定的 {@link OutputStream} 中,

   * 如果指定的复制范围朝出了 {@code InputStream} 的大小,则返回实际复制了多少字节。

   * 两个流完成后都保持打开状态。

   * @param in 数据来源输入流

   * @param out 复制到目标输出流

   * @param start 开始复制的位置

   * @param end 结束复制的位置

   * @return 复制了多少字节

  long copyRange(InputStream in, OutputStream out, long start, long end)

 

  输出:

  

/**

 

   * 将给定的 {@link InputStream} 内容复制到新的 {@code byte[]} 中,完成后保持流的打开状态。

   * @param in 作为数据来源的输入流(可能为 {@code null} 或 空)

   * @return 一个接收了数据的新字节数组 byte[] (可能为 空)

  byte[] copyToByteArray(InputStream in)

   * 将给定的 {@link InputStream} 内容复制到 {@link String} 中,完成后保持流的打开状态。

   * @param in 作为数据来源的输入流(可能为 {@code null} 或 空)

   * @param charset {@link Charset}解码所需字符集

   * @return 一个接收了数据的字符串 String (可能为 空)

  String copyToString(InputStream in, Charset charset)

   * 清除给定流中的剩余内容,完成后保持流的打开状态。

   * @param in 需要清空的输入流

   * @return 读取到多少字节

  int drain(InputStream in)

 

  四、反射、AOP

  1.ReflectionUtils

  获取方法:

  

// 在类中查找指定方法

 

  Method findMethod(Class ? clazz, String name)

  // 同上,额外提供方法参数类型作查找条件

  Method findMethod(Class ? clazz, String name, Class ? ... paramTypes)

  // 获得类中所有方法,包括继承而来的

  Method[] getAllDeclaredMethods(Class ? leafClass)

  // 在类中查找指定构造方法

  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)

 

  2.AopUtils

  判断代理类型:

  

// 判断是不是 Spring 代理对象

 

  boolean isAopProxy()

  // 判断是不是 jdk 动态代理对象

  isJdkDynamicProxy()

  // 判断是不是 CGLIB 代理对象

  boolean isCglibProxy()

 

  获取被代理对象的 class:

  

// 获取被代理的目标 class

 

  Class ? getTargetClass()

 

  3.AopContext

  获取当前对象的代理对象:

  

Object currentProxy()

 

  

  以上就是SpringBoot内置工具类,告别瞎写工具类了(spring自带工具类)的详细内容,想要了解更多 SpringBoot内置工具类,告别瞎写工具类了的内容,请持续关注盛行IT软件开发工作室。

郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。

留言与评论(共有 条评论)
   
验证码: