Hutool工具包等常用工具类总结

一、Spring Boot 内置工具类

1、对象、字符串、集合

1.1、ObjectUtils

1. 获取对象的基本信息

// 获取对象的类名。参数为 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)

2、判断工具

// 判断数组是否为空

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)

3、其他工具方法

// 向参数数组的末尾追加新元素，并返回一个新数组

<A, O extends A> A[] addObjectToArray(A[] array, O obj)

// 原生基础类型数组 --> 包装类数组

Object[] toObjectArray(Object source)

1.2、StringUtils

1、字符串判断工具

// 判断字符串是否为 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)

2、字符串操作工具

// 查找并替换指定子串

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)

3. 路径相关工具方法

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

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)

1.3、CollectionUtils

1、集合判断工具

// 判断 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)

2. 集合操作工具

// 将 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)

2、文件、资源、IO 流

2.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.2、ResourceUtils

1、从资源路径获取文件

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

static boolean isUrl(String resourceLocation)

// 获取 URL

static URL getURL(String resourceLocation)

// 获取文件（在 JAR 包内无法正常使用，需要是一个独立的文件）

static File getFile(String resourceLocation)

2、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()

2.3、StreamUtils

1、输入

void copy(byte[] in, OutputStream out)

int copy(InputStream in, OutputStream out)

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

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

2、输出

byte[] copyToByteArray(InputStream in)

String copyToString(InputStream in, Charset charset)

// 舍弃输入流中的内容

int drain(InputStream in)

3、反射、AOP

3.1、ReflectionUtils

1、获取方法

// 在类中查找指定方法

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)

2、执行方法

// 执行方法

Object invokeMethod(Method method, Object target)

// 同上，提供方法参数

Object invokeMethod(Method method, Object target, Object... args)

// 取消 Java 权限检查。以便后续执行该私有方法

void makeAccessible(Method method)

// 取消 Java 权限检查。以便后续执行私有构造方法

void makeAccessible(Constructor<?> ctor)

3、获取字段

// 在类中查找指定属性

Field findField(Class<?> clazz, String name)

// 同上，多提供了属性的类型

Field findField(Class<?> clazz, String name, Class<?> type)

// 是否为一个 "public static final" 属性

boolean isPublicStaticFinal(Field field)

4、设置字段

// 获取 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)

3.2、AopUtils

1、判断代理类型

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

boolean isAopProxy()

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

isJdkDynamicProxy()

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

boolean isCglibProxy()

2、获取被代理对象的class

// 获取被代理的目标 class

Class<?> getTargetClass()

3.3、AopContext

获取当前对象的代理对象

Object currentProxy()

二、apache commons 工具类库

1、简述

官网地址：

Apache Commons – Apache Commons

参考文档

一篇关于apache commons类库的详解_lhw_csd的博客-CSDN博客_orgapachecommons库

Apache Commons 工具集使用简介 - 王培 - 博客园

2、commons-lang

作为java.lang 的增强版，建议使用 commons-lang3，优化了一些 api，原来的 commons-lang 已停止更新

<dependency>

   <groupId>org.apache.commons</groupId>

   <artifactId>commons-lang3</artifactId>

   <version>3.12.0</version>

</dependency>

主要方法类

1、字符串判空

public static boolean isEmpty(final CharSequence cs) {

   return cs == null || cs.length() == 0;

}

public static boolean isNotEmpty(final CharSequence cs) {

   return !isEmpty(cs);

}

/** 判空的时候，会去除字符串中的空白字符，比如空格、换行、制表符 包含了下面三种情况

String str=null;

String str1 = "";

String str2 = " ";

*/

public static boolean isBlank(final CharSequence cs) {

   final int strLen = length(cs);

   if (strLen == 0) {

       return true;

   }

   for (int i = 0; i < strLen; i++) {

       if (!Character.isWhitespace(cs.charAt(i))) {

           return false;

       }

   }

   return true;

}

public static boolean isNotBlank(final CharSequence cs) {

   return !isBlank(cs);

}

2、首字母转成大写

String str = "yideng"; String capitalize = StringUtils.capitalize(str); System.out.println(capitalize); // 输出Yideng

3、重复拼接字符串

String str = StringUtils.repeat("ab", 2);

System.out.println(str); // 输出abab

4、格式化日期

// Date类型转String类型

String date = DateFormatUtils.format(new Date(), "yyyy-MM-dd HH:mm:ss"); System.out.println(date); // 输出 2021-05-01 01:01:01

// String类型转Date类型

Date date = DateUtils.parseDate("2021-05-01 01:01:01", "yyyy-MM-dd HH:mm:ss");

// 计算一个小时后的日期

Date date = DateUtils.addHours(new Date(), 1);

5、包装临时对象

// 返回两个字段

ImmutablePair<Integer, String> pair = ImmutablePair.of(1, "yideng");

System.out.println(pair.getLeft() + "," + pair.getRight()); // 输出 1,yideng

// 返回三个字段

ImmutableTriple<Integer, String, Date> triple = ImmutableTriple.of(1, "yideng", new Date());

System.out.println(triple.getLeft() + "," + triple.getMiddle() + "," + triple.getRight()); // 输出 1,yideng,Wed Apr 07 23:30:00 CST 2021

3、commons-collections 集合工具类

<dependency>

   <groupId>org.apache.commons</groupId>

   <artifactId>commons-collections4</artifactId>

   <version>4.4</version>

</dependency>

主要方法类

//集合判空

public static boolean isEmpty(final Collection<?> coll) {

   return coll == null || coll.isEmpty();

}

public static boolean isNotEmpty(final Collection<?> coll) {

   return !isEmpty(coll);

}

// 两个集合取交集

Collection<String> collection = CollectionUtils.retainAll(listA, listB);

// 两个集合取并集

Collection<String> collection = CollectionUtils.union(listA, listB);

// 两个集合取差集

Collection<String> collection = CollectionUtils.subtract(listA, listB);

4、common-beanutils 操作对象

<dependency>

   <groupId>commons-beanutils</groupId>

   <artifactId>commons-beanutils</artifactId>

   <version>1.9.4</version>

</dependency>

主要方法类

public class User {

   private Integer id;

   private String name;

}

//设置对象属性

User user = new User();

BeanUtils.setProperty(user, "id", 1);

BeanUtils.setProperty(user, "name", "yideng");

System.out.println(BeanUtils.getProperty(user, "name")); // 输出 yideng

System.out.println(user); // 输出 {"id":1,"name":"yideng"}

//对象和 map 互转

// 对象转map

Map<String, String> map = BeanUtils.describe(user);

System.out.println(map); // 输出 {"id":"1","name":"yideng"}

// map转对象

User newUser = new User();

BeanUtils.populate(newUser, map);

System.out.println(newUser); // 输出 {"id":1,"name":"yideng"}

两个实体类属性之间的转换类

UsersVO usersVO = new UsersVO();

BeanUtils.copyProperties(users,usersVO);

 

5、commons-io 文件流处理

<dependency>

   <groupId>commons-io</groupId>

   <artifactId>commons-io</artifactId>

   <version>2.8.0</version>

</dependency>

主要方法类

File file = new File("demo1.txt");

// 读取文件

List<String> lines = FileUtils.readLines(file, Charset.defaultCharset());

// 写入文件

FileUtils.writeLines(new File("demo2.txt"), lines);

// 复制文件

FileUtils.copyFile(srcFile, destFile);

三、Google Guava 工具类库

1、基本使用

List<String> list = Lists.newArrayList();

List<Integer> list = Lists.newArrayList(1, 2, 3);

// 反转list

List<Integer> reverse = Lists.reverse(list);

System.out.println(reverse); // 输出 [3, 2, 1]

// list集合元素太多，可以分成若干个集合，每个集合10个元素

List<List<Integer>> partition = Lists.partition(list, 10);

Map<String, String> map = Maps.newHashMap();

Set<String> set = Sets.newHashSet();

2、Multimap

Multimap 一个 key 可以映射多个 value 的 HashMap

Multimap<String, Integer> map = ArrayListMultimap.create();

map.put("key", 1);

map.put("key", 2);

Collection<Integer> values = map.get("key");

System.out.println(map); // 输出 {"key":[1,2]}

// 还能返回你以前使用的臃肿的Map

Map<String, Collection<Integer>> collectionMap = map.asMap();

多省事，多简洁，省得你再创建 Map<String, List>

3、Bimap

一种连 value 也不能重复的 HashMap

BiMap<String, String> biMap = HashBiMap.create();

// 如果value重复，put方法会抛异常，除非用forcePut方法

biMap.put("key","value");

System.out.println(biMap); // 输出 {"key":"value"}

// 既然value不能重复，何不实现个翻转key/value的方法，已经有了

BiMap<String, String> inverse = biMap.inverse();

System.out.println(inverse); // 输出 {"value":"key"}

4、table

一种有两个 key 的 HashMap

// 一批用户，同时按年龄和性别分组

Table<Integer, String, String> table = HashBasedTable.create();

table.put(18, "男", "yideng");

table.put(18, "女", "Lily");

System.out.println(table.get(18, "男")); // 输出 yideng

// 这其实是一个二维的Map，可以查看行数据

Map<String, String> row = table.row(18);

System.out.println(row); // 输出 {"男":"yideng","女":"Lily"}

// 查看列数据

Map<Integer, String> column = table.column("男");

System.out.println(column); // 输出 {18:"yideng"}

5、Multiset

一种用来计数的 Set

Multiset<String> multiset = HashMultiset.create();

multiset.add("apple");

multiset.add("apple");

multiset.add("orange");

System.out.println(multiset.count("apple")); // 输出 2

// 查看去重的元素

Set<String> set = multiset.elementSet();

System.out.println(set); // 输出 ["orange","apple"]

// 还能查看没有去重的元素

Iterator<String> iterator = multiset.iterator();

while (iterator.hasNext()) {

   System.out.println(iterator.next());

}

// 还能手动设置某个元素出现的次数

multiset.setCount("apple", 5);

四、bean validation和hibernate validator

简介

beanvalidation和hibernate-validator是校验的好搭档，使用它们可助力减少又臭又长的if else代码,让代码少点臭味道,看起来更清爽了。bean validation是一项javaee规范,核心api有Validator以及常用的@NotBlank @Valid等约束constraints注解。在springmvc中，更加入了@Validated 注解,使得方法入参级别的校验也变得超简单，结合统一异常处理@ControllerAdvice更方便。

参考文档

Spring框架--Bean Validation（Hibernate Validator）_虾米BaBa的博客-CSDN博客

参考视频

java代码简洁之道 用bean validation和hibernate validator提升代码质量,让代码少点臭味道_哔哩哔哩_bilibili

五、Java 实体映射工具 MapStruct

官网

MapStruct – Java bean mappings, the easy way!

文档地址

MapStruct 1.5.1.Final Reference Guide

参考地址

视频

java代码简洁之道 mapstruct助力pojo之间的花式转换_哔哩哔哩_bilibili

文档

推荐一个 Java 实体映射工具 MapStruct_志哥谈笑间的博客-CSDN博客_mapstruct

六、Hutool & feilong-core

Hutool git地址：GitHub - dromara/hutool: 🍬A set of tools that keep Java sweet.

文档地址:Hutool参考文档

feilong-core

feilong-core 让Java开发更简便的工具包_V2.1.0

feilong-core 让Java开发更简便的工具包_V2.1.0

hutool简短介绍

一个Java基础工具类，对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装，组成各种Util工具类，同时提供以下组件

maven引入方式

<dependency>

   <groupId>cn.hutool</groupId>

   <artifactId>hutool-all</artifactId>

   <version>5.5.1</version>

</dependency>

jar方式

Central Repository: cn/hutool/hutool-all/5.5.1

显示详细信息

可以根据需求对每个模块单独引入，也可以通过引入hutool-all方式引入所有模块。

官方文档地址：Hutool参考文档

git地址:https://github.com/looly/hutool

七、常用的自定义工具类

1、动态载入bean的工具类

/**
 * 动态载入bean的类
 * 调用例子
 * PlayerService playerService = (PlayerService)BeanUtil.getBean("playerService");
 *
 */
public class BeanUtil implements ApplicationContextAware {
  private static ApplicationContext ctx;
 
  public void setApplicationContext(ApplicationContext arg0)throws BeansException {
    BeanUtil.ctx = arg0;
  }
  /**
   * 获取指定的bean实例
   * @param beanName
   * @return
   */
  @SuppressWarnings("unchecked")
  public static <T> T getBean(String beanName) {
    return (T)ctx.getBean(beanName);
  }
 
  public static void show(){
    System.out.println("声明的bean");
    String[] sArr = ctx.getBeanDefinitionNames();
    for (int i = 0; i < sArr.length; i++) {
      String s = sArr[i];
      System.out.println(s);
    }
    System.out.println("声明的bean     --end--");
  }
}

2、判断请求来自浏览器还是手机工具类

/**
 * 判断请求来自浏览器还是手机
 */
public class IsMobileUtil {
    private final static String[] agent = { "Android", "iPhone", "iPod","iPad", "Windows Phone", "MQQBrowser" }; //定义移动端请求的所有可能类型
 
    /**
     * 判断User-Agent 是不是来自于手机
     * @param ua
     * @return
     */
    public static boolean isMobileDevice(String ua) {
        boolean flag = false;
        if (!ua.contains("Windows NT") || (ua.contains("Windows NT") && ua.contains("compatible; MSIE 9.0;"))) {
            // 排除 苹果桌面系统
            if (!ua.contains("Windows NT") && !ua.contains("Macintosh")) {
                for (String item : agent) {
                    if (ua.contains(item)) {
                        flag = true;
                        break;
                    }
                }
            }
        }
        return flag;
    }
}

3、使用原生java发送http get请求工具类

 
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
 
public class HttpUtils {
  
    /**
     * get请求
     * @param getUrl
     * @return
     */
    public static String get(String getUrl) {
        try {
            URL url = new URL(getUrl);
            //设置连接方式
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("GET");
            //设置主机连接时间超时时间3000毫秒
            conn.setConnectTimeout(3000);
            //设置读取远程返回数据的时间3000毫秒
            conn.setReadTimeout(3000);
 
            //发送请求
            conn.connect();
            //获取输入流
            InputStream is = conn.getInputStream();
            //封装输入流
            BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
            //接收读取数据
            StringBuffer sb = new StringBuffer();
 
            String line = null;
            while ((line = br.readLine()) != null) {
                sb.append(line);
                sb.append("\r\n");
            }
            if (null != br) {
                br.close();
            }
            if (null != is) {
                is.close();
            }
            //关闭连接
            conn.disconnect();
            return sb.toString();
        } catch (Exception e) {
           e.getMessage();
        }
        return "";
    }
}