cn.hutool.core.util.ObjectUtil Maven / Gradle / Ivy
package cn.hutool.core.util;
import cn.hutool.core.collection.IterUtil;
import cn.hutool.core.comparator.CompareUtil;
import cn.hutool.core.convert.Convert;
import cn.hutool.core.exceptions.UtilException;
import cn.hutool.core.map.MapUtil;
import java.lang.reflect.Array;
import java.math.BigDecimal;
import java.util.Collection;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.Map;
import java.util.Objects;
import java.util.function.Supplier;
/**
* 对象工具类，包括判空、克隆、序列化等操作
*
* @author Looly
*/
public class ObjectUtil {
/**
* 比较两个对象是否相等，此方法是 {@link #equal(Object, Object)}的别名方法。
* 相同的条件有两个，满足其一即可：
*
* - obj1 == null && obj2 == null
* - obj1.equals(obj2)
* - 如果是BigDecimal比较，0 == obj1.compareTo(obj2)
*
*
* @param obj1 对象1
* @param obj2 对象2
* @return 是否相等
* @see #equal(Object, Object)
* @since 5.4.3
*/
public static boolean equals(Object obj1, Object obj2) {
return equal(obj1, obj2);
}
/**
* 比较两个对象是否相等。
* 相同的条件有两个，满足其一即可：
*
* - obj1 == null && obj2 == null
* - obj1.equals(obj2)
* - 如果是BigDecimal比较，0 == obj1.compareTo(obj2)
*
*
* @param obj1 对象1
* @param obj2 对象2
* @return 是否相等
* @see Objects#equals(Object, Object)
*/
public static boolean equal(Object obj1, Object obj2) {
if (obj1 instanceof BigDecimal && obj2 instanceof BigDecimal) {
return NumberUtil.equals((BigDecimal) obj1, (BigDecimal) obj2);
}
return Objects.equals(obj1, obj2);
}
/**
* 比较两个对象是否不相等。
*
* @param obj1 对象1
* @param obj2 对象2
* @return 是否不等
* @since 3.0.7
*/
public static boolean notEqual(Object obj1, Object obj2) {
return false == equal(obj1, obj2);
}
/**
* 计算对象长度，如果是字符串调用其length函数，集合类调用其size函数，数组调用其length属性，其他可遍历对象遍历计算长度
* 支持的类型包括：
*
* - CharSequence
* - Map
* - Iterator
* - Enumeration
* - Array
*
*
* @param obj 被计算长度的对象
* @return 长度
*/
public static int length(Object obj) {
if (obj == null) {
return 0;
}
if (obj instanceof CharSequence) {
return ((CharSequence) obj).length();
}
if (obj instanceof Collection) {
return ((Collection) obj).size();
}
if (obj instanceof Map) {
return ((Map) obj).size();
}
int count;
if (obj instanceof Iterator) {
final Iterator iter = (Iterator) obj;
count = 0;
while (iter.hasNext()) {
count++;
iter.next();
}
return count;
}
if (obj instanceof Enumeration) {
final Enumeration enumeration = (Enumeration) obj;
count = 0;
while (enumeration.hasMoreElements()) {
count++;
enumeration.nextElement();
}
return count;
}
if (obj.getClass().isArray() == true) {
return Array.getLength(obj);
}
return -1;
}
/**
* 对象中是否包含元素
* 支持的对象类型包括：
*
* - String
* - Collection
* - Map
* - Iterator
* - Enumeration
* - Array
*
*
* @param obj 对象
* @param element 元素
* @return 是否包含
*/
public static boolean contains(Object obj, Object element) {
if (obj == null) {
return false;
}
if (obj instanceof String) {
if (element == null) {
return false;
}
return ((String) obj).contains(element.toString());
}
if (obj instanceof Collection) {
return ((Collection) obj).contains(element);
}
if (obj instanceof Map) {
return ((Map) obj).containsValue(element);
}
if (obj instanceof Iterator) {
final Iterator iter = (Iterator) obj;
while (iter.hasNext()) {
final Object o = iter.next();
if (equal(o, element)) {
return true;
}
}
return false;
}
if (obj instanceof Enumeration) {
final Enumeration enumeration = (Enumeration) obj;
while (enumeration.hasMoreElements()) {
final Object o = enumeration.nextElement();
if (equal(o, element)) {
return true;
}
}
return false;
}
if (obj.getClass().isArray() == true) {
final int len = Array.getLength(obj);
for (int i = 0; i < len; i++) {
final Object o = Array.get(obj, i);
if (equal(o, element)) {
return true;
}
}
}
return false;
}
/**
* 检查对象是否为null
* 判断标准为：
*
*
* 1. == null
* 2. equals(null)
*
*
* @param obj 对象
* @return 是否为null
*/
public static boolean isNull(Object obj) {
//noinspection ConstantConditions
return null == obj || obj.equals(null);
}
/**
* 检查对象是否不为null
*
* 1. != null
* 2. not equals(null)
*
*
* @param obj 对象
* @return 是否为非null
*/
public static boolean isNotNull(Object obj) {
//noinspection ConstantConditions
return null != obj && false == obj.equals(null);
}
/**
* 判断指定对象是否为空，支持：
*
*
* 1. CharSequence
* 2. Map
* 3. Iterable
* 4. Iterator
* 5. Array
*
*
* @param obj 被判断的对象
* @return 是否为空，如果类型不支持，返回false
* @since 4.5.7
*/
@SuppressWarnings("rawtypes")
public static boolean isEmpty(Object obj) {
if (null == obj) {
return true;
}
if (obj instanceof CharSequence) {
return StrUtil.isEmpty((CharSequence) obj);
} else if (obj instanceof Map) {
return MapUtil.isEmpty((Map) obj);
} else if (obj instanceof Iterable) {
return IterUtil.isEmpty((Iterable) obj);
} else if (obj instanceof Iterator) {
return IterUtil.isEmpty((Iterator) obj);
} else if (ArrayUtil.isArray(obj)) {
return ArrayUtil.isEmpty(obj);
}
return false;
}
/**
* 判断指定对象是否为非空，支持：
*
*
* 1. CharSequence
* 2. Map
* 3. Iterable
* 4. Iterator
* 5. Array
*
*
* @param obj 被判断的对象
* @return 是否为空，如果类型不支持，返回true
* @since 4.5.7
*/
public static boolean isNotEmpty(Object obj) {
return false == isEmpty(obj);
}
/**
* 如果给定对象为{@code null}返回默认值
*
*
* ObjectUtil.defaultIfNull(null, null) = null
* ObjectUtil.defaultIfNull(null, "") = ""
* ObjectUtil.defaultIfNull(null, "zz") = "zz"
* ObjectUtil.defaultIfNull("abc", *) = "abc"
* ObjectUtil.defaultIfNull(Boolean.TRUE, *) = Boolean.TRUE
*
*
* @param 对象类型
* @param object 被检查对象，可能为{@code null}
* @param defaultValue 被检查对象为{@code null}返回的默认值，可以为{@code null}
* @return 被检查对象为{@code null}返回默认值，否则返回原值
* @since 3.0.7
*/
public static T defaultIfNull(final T object, final T defaultValue) {
return isNull(object) ? defaultValue : object;
}
/**
* 如果被检查对象为 {@code null}， 返回默认值（由 defaultValueSupplier 提供）；否则直接返回
*
* @param source 被检查对象
* @param defaultValueSupplier 默认值提供者
* @param 对象类型
* @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值
* @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出
* @since 5.7.20
*/
public static T defaultIfNull(T source, Supplier defaultValueSupplier) {
if (isNull(source)) {
return defaultValueSupplier.get();
}
return source;
}
/**
* 如果给定对象为{@code null} 返回默认值, 如果不为null 返回自定义handle处理后的返回值
*
* @param source Object 类型对象
* @param handle 非空时自定义的处理方法
* @param defaultValue 默认为空的返回值
* @param 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值
* @return 处理后的返回值
* @since 5.4.6
*/
public static T defaultIfNull(Object source, Supplier handle, final T defaultValue) {
if (isNotNull(source)) {
return handle.get();
}
return defaultValue;
}
/**
* 如果给定对象为{@code null}或者""返回默认值, 否则返回自定义handle处理后的返回值
*
* @param str String 类型
* @param handle 自定义的处理方法
* @param defaultValue 默认为空的返回值
* @param 被检查对象为{@code null}或者 ""返回默认值，否则返回自定义handle处理后的返回值
* @return 处理后的返回值
* @since 5.4.6
*/
public static T defaultIfEmpty(String str, Supplier handle, final T defaultValue) {
if (StrUtil.isNotEmpty(str)) {
return handle.get();
}
return defaultValue;
}
/**
* 如果给定对象为{@code null}或者 "" 返回默认值
*
*
* ObjectUtil.defaultIfEmpty(null, null) = null
* ObjectUtil.defaultIfEmpty(null, "") = ""
* ObjectUtil.defaultIfEmpty("", "zz") = "zz"
* ObjectUtil.defaultIfEmpty(" ", "zz") = " "
* ObjectUtil.defaultIfEmpty("abc", *) = "abc"
*
*
* @param 对象类型（必须实现CharSequence接口）
* @param str 被检查对象，可能为{@code null}
* @param defaultValue 被检查对象为{@code null}或者 ""返回的默认值，可以为{@code null}或者 ""
* @return 被检查对象为{@code null}或者 ""返回默认值，否则返回原值
* @since 5.0.4
*/
public static T defaultIfEmpty(final T str, final T defaultValue) {
return StrUtil.isEmpty(str) ? defaultValue : str;
}
/**
* 如果被检查对象为 {@code null} 或 "" 时，返回默认值（由 defaultValueSupplier 提供）；否则直接返回
*
* @param str 被检查对象
* @param defaultValueSupplier 默认值提供者
* @param 对象类型（必须实现CharSequence接口）
* @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值
* @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出
* @since 5.7.20
*/
public static T defaultIfEmpty(T str, Supplier defaultValueSupplier) {
if (StrUtil.isEmpty(str)) {
return defaultValueSupplier.get();
}
return str;
}
/**
* 如果给定对象为{@code null}或者""或者空白符返回默认值
*
*
* ObjectUtil.defaultIfBlank(null, null) = null
* ObjectUtil.defaultIfBlank(null, "") = ""
* ObjectUtil.defaultIfBlank("", "zz") = "zz"
* ObjectUtil.defaultIfBlank(" ", "zz") = "zz"
* ObjectUtil.defaultIfBlank("abc", *) = "abc"
*
*
* @param 对象类型（必须实现CharSequence接口）
* @param str 被检查对象，可能为{@code null}
* @param defaultValue 被检查对象为{@code null}或者 ""或者空白符返回的默认值，可以为{@code null}或者 ""或者空白符
* @return 被检查对象为{@code null}或者 ""或者空白符返回默认值，否则返回原值
* @since 5.0.4
*/
public static T defaultIfBlank(final T str, final T defaultValue) {
return StrUtil.isBlank(str) ? defaultValue : str;
}
/**
* 如果被检查对象为 {@code null} 或 "" 或 空白字符串时，返回默认值（由 defaultValueSupplier 提供）；否则直接返回
*
* @param str 被检查对象
* @param defaultValueSupplier 默认值提供者
* @param 对象类型（必须实现CharSequence接口）
* @return 被检查对象为{@code null}返回默认值，否则返回自定义handle处理后的返回值
* @throws NullPointerException {@code defaultValueSupplier == null} 时，抛出
* @since 5.7.20
*/
public static T defaultIfBlank(T str, Supplier defaultValueSupplier) {
if (StrUtil.isBlank(str)) {
return defaultValueSupplier.get();
}
return str;
}
/**
* 克隆对象
* 如果对象实现Cloneable接口，调用其clone方法
* 如果实现Serializable接口，执行深度克隆
* 否则返回{@code null}
*
* @param 对象类型
* @param obj 被克隆对象
* @return 克隆后的对象
*/
public static T clone(T obj) {
T result = ArrayUtil.clone(obj);
if (null == result) {
if (obj instanceof Cloneable) {
result = ReflectUtil.invoke(obj, "clone");
} else {
result = cloneByStream(obj);
}
}
return result;
}
/**
* 返回克隆后的对象，如果克隆失败，返回原对象
*
* @param 对象类型
* @param obj 对象
* @return 克隆后或原对象
*/
public static T cloneIfPossible(final T obj) {
T clone = null;
try {
clone = clone(obj);
} catch (Exception e) {
// pass
}
return clone == null ? obj : clone;
}
/**
* 序列化后拷贝流的方式克隆
* 对象必须实现Serializable接口
*
* @param 对象类型
* @param obj 被克隆对象
* @return 克隆后的对象
* @throws UtilException IO异常和ClassNotFoundException封装
*/
public static T cloneByStream(T obj) {
return SerializeUtil.clone(obj);
}
/**
* 序列化
* 对象必须实现Serializable接口
*
* @param 对象类型
* @param obj 要被序列化的对象
* @return 序列化后的字节码
*/
public static byte[] serialize(T obj) {
return SerializeUtil.serialize(obj);
}
/**
* 反序列化
* 对象必须实现Serializable接口
*
*
* 注意！！！ 此方法不会检查反序列化安全，可能存在反序列化漏洞风险！！！
*
*
* @param 对象类型
* @param bytes 反序列化的字节码
* @return 反序列化后的对象
*/
public static T deserialize(byte[] bytes) {
return SerializeUtil.deserialize(bytes);
}
/**
* 是否为基本类型，包括包装类型和非包装类型
*
* @param object 被检查对象，{@code null}返回{@code false}
* @return 是否为基本类型
* @see ClassUtil#isBasicType(Class)
*/
public static boolean isBasicType(Object object) {
if (null == object) {
return false;
}
return ClassUtil.isBasicType(object.getClass());
}
/**
* 检查是否为有效的数字
* 检查Double和Float是否为无限大，或者Not a Number
* 非数字类型和Null将返回true
*
* @param obj 被检查类型
* @return 检查结果，非数字类型和Null将返回true
*/
public static boolean isValidIfNumber(Object obj) {
if (obj instanceof Number) {
return NumberUtil.isValidNumber((Number) obj);
}
return true;
}
/**
* {@code null}安全的对象比较，{@code null}对象排在末尾
*
* @param 被比较对象类型
* @param c1 对象1，可以为{@code null}
* @param c2 对象2，可以为{@code null}
* @return 比较结果，如果c1 < c2，返回数小于0，c1==c2返回0，c1 > c2 大于0
* @see java.util.Comparator#compare(Object, Object)
* @since 3.0.7
*/
public static > int compare(T c1, T c2) {
return CompareUtil.compare(c1, c2);
}
/**
* {@code null}安全的对象比较
*
* @param 被比较对象类型
* @param c1 对象1，可以为{@code null}
* @param c2 对象2，可以为{@code null}
* @param nullGreater 当被比较对象为null时是否排在前面
* @return 比较结果，如果c1 < c2，返回数小于0，c1==c2返回0，c1 > c2 大于0
* @see java.util.Comparator#compare(Object, Object)
* @since 3.0.7
*/
public static > int compare(T c1, T c2, boolean nullGreater) {
return CompareUtil.compare(c1, c2, nullGreater);
}
/**
* 获得给定类的第一个泛型参数
*
* @param obj 被检查的对象
* @return {@link Class}
* @since 3.0.8
*/
public static Class getTypeArgument(Object obj) {
return getTypeArgument(obj, 0);
}
/**
* 获得给定类的第一个泛型参数
*
* @param obj 被检查的对象
* @param index 泛型类型的索引号，即第几个泛型类型
* @return {@link Class}
* @since 3.0.8
*/
public static Class getTypeArgument(Object obj, int index) {
return ClassUtil.getTypeArgument(obj.getClass(), index);
}
/**
* 将Object转为String
* 策略为：
*
* 1、null转为"null"
* 2、调用Convert.toStr(Object)转换
*
*
* @param obj Bean对象
* @return Bean所有字段转为Map后的字符串
* @since 3.2.0
*/
public static String toString(Object obj) {
if (null == obj) {
return StrUtil.NULL;
}
if (obj instanceof Map) {
return obj.toString();
}
return Convert.toStr(obj);
}
/**
* 存在多少个{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素
*
* @param objs 被检查的对象,一个或者多个
* @return 存在{@code null}的数量
*/
public static int emptyCount(Object... objs) {
return ArrayUtil.emptyCount(objs);
}
/**
* 是否存在{@code null}对象，通过{@link ObjectUtil#isNull(Object)} 判断元素
*
* @param objs 被检查对象
* @return 是否存在
* @see ArrayUtil#hasNull(Object[])
* @since 5.5.3
*/
public static boolean hasNull(Object... objs) {
return ArrayUtil.hasNull(objs);
}
/**
* 是否存在{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素
*
* @param objs 被检查对象
* @return 是否存在
* @see ArrayUtil#hasEmpty(Object...)
*/
public static boolean hasEmpty(Object... objs) {
return ArrayUtil.hasEmpty(objs);
}
/**
* 是否全都为{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素
*
* @param objs 被检查的对象,一个或者多个
* @return 是否都为空
*/
public static boolean isAllEmpty(Object... objs) {
return ArrayUtil.isAllEmpty(objs);
}
/**
* 是否全都不为{@code null}或空对象，通过{@link ObjectUtil#isEmpty(Object)} 判断元素
*
* @param objs 被检查的对象,一个或者多个
* @return 是否都不为空
*/
public static boolean isAllNotEmpty(Object... objs) {
return ArrayUtil.isAllNotEmpty(objs);
}
}