Spring工具类之Assert的使用
作用:帮忙做参数检验并抛出IllegalArgumentException
抛出的都是IllegalArgumentException异常
- 根据boolean表达式的值抛出异常信息isTrue
- 判断对象是否为空isNull或不为空notNull
- 判断字符串是否null或”有N个空都是空” hasText
- 判断字符串是否包含另外一个字符串
doesNotContain(@Nullable String textToSearch, String substring, String message)
- 判断一个数组是否null或长度为0 notEmpty
- 判断一个数组的元素是否有null,只要有null就抛异常 noNullElements
- 判断一个集合不为空,为null或长度为0抛出异常
- 判断一个对象是否是某个类的实例isInstanceOf
- 使用isAssignable方法判断2个类是否是父子类
- 安全获取String
@Nullable private static String nullSafeGet(@Nullable Supplier<String> messageSupplier) { return messageSupplier != null ? (String)messageSupplier.get() : null; }
- Assert.hasText(“如果为空或null”,”抛出的异常信息”);
说明:当第1个参数为null或””或” 有空格或有N个空格”,抛出IllegalArgumentException异常,此异常是运行时异常。异常信息为第2个参数
public static void main(String[] args) {
// Assert.hasText(null, "输入信息错误!");
// Assert.hasText("", "输入信息错误!");
// Assert.hasText(" ", "输入信息错误!");
Assert.hasText(" ", "输入信息错误!");
System.out.println("执行了吗? 没有");
}
- Assert.notNull(null, "object is required");// 第一个参数为null抛IllegalArgumentException
- Assert.isTrue(Object object, "object must be true") - 对象必须为true
- Assert.notEmpty(Collection collection, "collection must not be empty") - 集合非空
- Assert.hasLength(String text, "text must be specified") - 字符不为null且字符长度不为0
Assert.hasText(String text, "text must not be empty") - text 不为null且必须至少包含一个非空格的字符
Assert.isInstanceOf(Class clazz, Object obj, "clazz must be of type [clazz]") - obj必须能被正确造型成为clazz 指定的类
public abstract class Assert { public Assert() { } public static void state(boolean expression, String message) { if (!expression) { throw new IllegalStateException(message); } } public static void state(boolean expression, Supplier<String> messageSupplier) { if (!expression) { throw new IllegalStateException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void state(boolean expression) { state(expression, "[Assertion failed] - this state invariant must be true"); } public static void isTrue(boolean expression, String message) { if (!expression) { throw new IllegalArgumentException(message); } } public static void isTrue(boolean expression, Supplier<String> messageSupplier) { if (!expression) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void isTrue(boolean expression) { isTrue(expression, "[Assertion failed] - this expression must be true"); } public static void isNull(@Nullable Object object, String message) { if (object != null) { throw new IllegalArgumentException(message); } } public static void isNull(@Nullable Object object, Supplier<String> messageSupplier) { if (object != null) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void isNull(@Nullable Object object) { isNull(object, "[Assertion failed] - the object argument must be null"); } public static void notNull(@Nullable Object object, String message) { if (object == null) { throw new IllegalArgumentException(message); } } public static void notNull(@Nullable Object object, Supplier<String> messageSupplier) { if (object == null) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void notNull(@Nullable Object object) { notNull(object, "[Assertion failed] - this argument is required; it must not be null"); } public static void hasLength(@Nullable String text, String message) { if (!StringUtils.hasLength(text)) { throw new IllegalArgumentException(message); } } public static void hasLength(@Nullable String text, Supplier<String> messageSupplier) { if (!StringUtils.hasLength(text)) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void hasLength(@Nullable String text) { hasLength(text, "[Assertion failed] - this String argument must have length; it must not be null or empty"); } public static void hasText(@Nullable String text, String message) { if (!StringUtils.hasText(text)) { throw new IllegalArgumentException(message); } } public static void hasText(@Nullable String text, Supplier<String> messageSupplier) { if (!StringUtils.hasText(text)) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void hasText(@Nullable String text) { hasText(text, "[Assertion failed] - this String argument must have text; it must not be null, empty, or blank"); } public static void doesNotContain(@Nullable String textToSearch, String substring, String message) { if (StringUtils.hasLength(textToSearch) && StringUtils.hasLength(substring) && textToSearch.contains(substring)) { throw new IllegalArgumentException(message); } } public static void doesNotContain(@Nullable String textToSearch, String substring, Supplier<String> messageSupplier) { if (StringUtils.hasLength(textToSearch) && StringUtils.hasLength(substring) && textToSearch.contains(substring)) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void doesNotContain(@Nullable String textToSearch, String substring) { doesNotContain(textToSearch, substring, () -> { return "[Assertion failed] - this String argument must not contain the substring [" + substring + "]"; }); } public static void notEmpty(@Nullable Object[] array, String message) { if (ObjectUtils.isEmpty(array)) { throw new IllegalArgumentException(message); } } public static void notEmpty(@Nullable Object[] array, Supplier<String> messageSupplier) { if (ObjectUtils.isEmpty(array)) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void notEmpty(@Nullable Object[] array) { notEmpty(array, "[Assertion failed] - this array must not be empty: it must contain at least 1 element"); } public static void noNullElements(@Nullable Object[] array, String message) { if (array != null) { Object[] var2 = array; int var3 = array.length; for(int var4 = 0; var4 < var3; ++var4) { Object element = var2[var4]; if (element == null) { throw new IllegalArgumentException(message); } } } } public static void noNullElements(@Nullable Object[] array, Supplier<String> messageSupplier) { if (array != null) { Object[] var2 = array; int var3 = array.length; for(int var4 = 0; var4 < var3; ++var4) { Object element = var2[var4]; if (element == null) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } } } /** @deprecated */ @Deprecated public static void noNullElements(@Nullable Object[] array) { noNullElements(array, "[Assertion failed] - this array must not contain any null elements"); } public static void notEmpty(@Nullable Collection<?> collection, String message) { if (CollectionUtils.isEmpty(collection)) { throw new IllegalArgumentException(message); } } public static void notEmpty(@Nullable Collection<?> collection, Supplier<String> messageSupplier) { if (CollectionUtils.isEmpty(collection)) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void notEmpty(@Nullable Collection<?> collection) { notEmpty(collection, "[Assertion failed] - this collection must not be empty: it must contain at least 1 element"); } public static void notEmpty(@Nullable Map<?, ?> map, String message) { if (CollectionUtils.isEmpty(map)) { throw new IllegalArgumentException(message); } } public static void notEmpty(@Nullable Map<?, ?> map, Supplier<String> messageSupplier) { if (CollectionUtils.isEmpty(map)) { throw new IllegalArgumentException(nullSafeGet(messageSupplier)); } } /** @deprecated */ @Deprecated public static void notEmpty(@Nullable Map<?, ?> map) { notEmpty(map, "[Assertion failed] - this map must not be empty; it must contain at least one entry"); } public static void isInstanceOf(Class<?> type, @Nullable Object obj, String message) { notNull(type, (String)"Type to check against must not be null"); if (!type.isInstance(obj)) { instanceCheckFailed(type, obj, message); } } public static void isInstanceOf(Class<?> type, @Nullable Object obj, Supplier<String> messageSupplier) { notNull(type, (String)"Type to check against must not be null"); if (!type.isInstance(obj)) { instanceCheckFailed(type, obj, nullSafeGet(messageSupplier)); } } public static void isInstanceOf(Class<?> type, @Nullable Object obj) { isInstanceOf(type, obj, ""); } public static void isAssignable(Class<?> superType, @Nullable Class<?> subType, String message) { notNull(superType, (String)"Super type to check against must not be null"); if (subType == null || !superType.isAssignableFrom(subType)) { assignableCheckFailed(superType, subType, message); } } public static void isAssignable(Class<?> superType, @Nullable Class<?> subType, Supplier<String> messageSupplier) { notNull(superType, (String)"Super type to check against must not be null"); if (subType == null || !superType.isAssignableFrom(subType)) { assignableCheckFailed(superType, subType, nullSafeGet(messageSupplier)); } } public static void isAssignable(Class<?> superType, Class<?> subType) { isAssignable(superType, subType, ""); } private static void instanceCheckFailed(Class<?> type, @Nullable Object obj, @Nullable String msg) { String className = obj != null ? obj.getClass().getName() : "null"; String result = ""; boolean defaultMessage = true; if (StringUtils.hasLength(msg)) { if (endsWithSeparator(msg)) { result = msg + " "; } else { result = messageWithTypeName(msg, className); defaultMessage = false; } } if (defaultMessage) { result = result + "Object of class [" + className + "] must be an instance of " + type; } throw new IllegalArgumentException(result); } private static void assignableCheckFailed(Class<?> superType, @Nullable Class<?> subType, @Nullable String msg) { String result = ""; boolean defaultMessage = true; if (StringUtils.hasLength(msg)) { if (endsWithSeparator(msg)) { result = msg + " "; } else { result = messageWithTypeName(msg, subType); defaultMessage = false; } } if (defaultMessage) { result = result + subType + " is not assignable to " + superType; } throw new IllegalArgumentException(result); } private static boolean endsWithSeparator(String msg) { return msg.endsWith(":") || msg.endsWith(";") || msg.endsWith(",") || msg.endsWith("."); } private static String messageWithTypeName(String msg, @Nullable Object typeName) { return msg + (msg.endsWith(" ") ? "" : ": ") + typeName; } @Nullable private static String nullSafeGet(@Nullable Supplier<String> messageSupplier) { return messageSupplier != null ? (String)messageSupplier.get() : null; } }