草庐IT

SpringBoot内置工具类,告别瞎写工具类了

Javaの甘乃迪 2023-04-19 原文

        不知大家有没有注意到,接手的项目中存在多个重复的工具类,发现其中很多功能,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)

二、对象、数组、集合

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内置工具类,告别瞎写工具类了的更多相关文章

  1. 世界前沿3D开发引擎HOOPS全面讲解——集3D数据读取、3D图形渲染、3D数据发布于一体的全新3D应用开发工具 - 2

    无论您是想搭建桌面端、WEB端或者移动端APP应用,HOOPSPlatform组件都可以为您提供弹性的3D集成架构,同时,由工业领域3D技术专家组成的HOOPS技术团队也能为您提供技术支持服务。如果您的客户期望有一种在多个平台(桌面/WEB/APP,而且某些客户端是“瘦”客户端)快速、方便地将数据接入到3D应用系统的解决方案,并且当访问数据时,在各个平台上的性能和用户体验保持一致,HOOPSPlatform将帮助您完成。利用HOOPSPlatform,您可以开发在任何环境下的3D基础应用架构。HOOPSPlatform可以帮您打造3D创新型产品,HOOPSSDK包含的技术有:快速且准确的CAD

  2. 基于C#实现简易绘图工具【100010177】 - 2

    C#实现简易绘图工具一.引言实验目的:通过制作窗体应用程序(C#画图软件),熟悉基本的窗体设计过程以及控件设计,事件处理等,熟悉使用C#的winform窗体进行绘图的基本步骤,对于面向对象编程有更加深刻的体会.Tutorial任务设计一个具有基本功能的画图软件**·包括简单的新建文件,保存,重新绘图等功能**·实现一些基本图形的绘制,包括铅笔和基本形状等,学习橡皮工具的创建**·设计一个合理舒适的UI界面**注明:你可能需要先了解一些关于winform窗体应用程序绘图的基本知识,以及关于GDI+类和结构的知识二.实验环境Windows系统下的visualstudio2017C#窗体应用程序三.

  3. postman接口测试工具-基础使用教程 - 2

    1.postman介绍Postman一款非常流行的API调试工具。其实,开发人员用的更多。因为测试人员做接口测试会有更多选择,例如Jmeter、soapUI等。不过,对于开发过程中去调试接口,Postman确实足够的简单方便,而且功能强大。2.下载安装官网地址:https://www.postman.com/下载完成后双击安装吧,安装过程极其简单,无需任何操作3.使用教程这里以百度为例,工具使用简单,填写URL地址即可发送请求,在下方查看响应结果和响应状态码常用方法都有支持请求方法:getpostputdeleteGet、Post、Put与Delete的作用get:请求方法一般是用于数据查询,

  4. ruby - 是否有内置的 Ruby 1.8.7 将数组拆分为相同大小的子数组? - 2

    我已经开始了:defsplit_array(array,size)index=0results=[]ifsize>0whileindex如果我在[1,2,3,4,5,6]上运行它,比如split_array([1,2,3,4,5,6],3)它将产生这个数组:[[1,2,3],[4,5,6]]。在Ruby1.8.7中是否已经有可用的东西可以做到这一点? 最佳答案 [1,2,3,4,5,6].each_slice(3).to_a#=>[[1,2,3],[4,5,6]]对于1.8.6:require'enumerator'[1,2,3,4

  5. ruby-on-rails - 有没有一种工具可以在编码时自动保存对文件的增量更改? - 2

    我最喜欢的Google文档功能之一是它会在我工作时不断自动保存我的文档版本。这意味着即使我在进行关键更改之前忘记在某个点进行保存,也很有可能会自动创建一个保存点。至少,我可以将文档恢复到错误更改之前的状态,并从该点继续工作。对于在MacOS(或UNIX)上运行的Ruby编码器,是否有具有等效功能的工具?例如,一个工具会每隔几分钟自动将Gitcheckin我的本地存储库以获取我正在处理的文件。也许我有点偏执,但这点小保险可以让我在日常工作中安心。 最佳答案 虚拟机有些人可能讨厌我对此的回应,但我在编码时经常使用VIM,它具有自动保存功

  6. ruby-on-rails - RoR中是否有任何内置方法可以为整数填充零? - 2

    如果我想要“00001”而不是“1”,除了我自己写填零方法之外,有没有内置的方法可以帮助我为整数填零? 最佳答案 puts"%05d"%1#00001参见:String::%,Kernel::sprintf这是正在发生的事情。%左侧的"%05d"是C风格的格式说明符。%右边的变量就是要格式化的东西。格式说明符可以像这样解码:%-格式说明符的开头0-用前导零填充5-长度为5个字符d-被格式化的是一个整数如果你要格式化多个东西,你会把它们放在一个数组中:"%d-%s"%[1,"One"]#=>1-one

  7. ruby - 使用 Ruby 开发工具包将文件上传到 Amazon S3 - 2

    我正在尝试上传文件。一个简单的hello.txt。我正在关注文档,但无法将其上传到我的存储桶。#STARTAWSCLIENTs3=Aws::S3::Resource.newbucket=s3.bucket(BUCKET_NAME)begins3.buckets[BUCKET_NAME].objects[KEY].write(:file=>FILE_NAME)puts"Uploadingfile#{FILE_NAME}tobucket#{BUCKET_NAME}."bucket.objects.eachdo|obj|puts"#{obj.key}=>#{obj.etag}"endresc

  8. ruby - 在 StockChart (highchart) 中以编程方式显示柱形图的工具提示 - 2

    我有一个Highstock图表(带有标记和阴影的线条),并且想以编程方式显示一个highstock工具提示,例如,当我选择某个表上的一行(包含图表数据)我想显示相应的highstock工具提示。这可能吗? 最佳答案 股票图表thissolution不起作用:在thisexample你必须更换这个:chart.tooltip.refresh(chart.series[0].data[i]);为此:chart.tooltip.refresh([chart.series[0].points[i]]);解决方案可用here.

  9. ABB-IRB-1200运动学分析MATLAB RVC工具分析+Simulink-Adams联合仿真 - 2

    一、机器人介绍        此处是基于MATLABRVC工具箱,对ABB-IRB-1200型号的微型机械臂进行正逆向运动学分析,并利Simulink工具实现对机械臂进行具有动力学参数的末端轨迹规划仿真,最后根据机械模型设计Simulink-Adams联合仿真。 图1.ABBIRB 1200尺寸参数示意图ABBIRB 1200提供的两种型号广泛适用于各作业,且两者间零部件通用,两种型号的工作范围分别为700 mm 和 900 mm,大有效负载分别为 7 kg 和5 kg。 IRB 1200 能够在狭小空间内能发挥其工作范围与性能优势,具有全新的设计、小型化的体积、高效的性能、易于集成、便捷的接

  10. Ruby & Syslog & 自定义工具 - 2

    我是syslog的新手。我们决定使用系统日志来跟踪Rails应用程序中的一些特殊事件。问题是我不想使用默认的/var/log/system.log文件,而是使用自定义文件,例如/var/log/myapp_events.log.我看到我必须像这样在/etc/syslog.conf中定义我自己的设施:myapp_events.*/var/log/myapp_events.log重新启动syslogd后,我发现我可以直接在bash控制台中使用它:syslog-s-kFacilitymyapp_eventsMessage"thisismymessage"该消息按预期出现在/var/log/m

随机推荐