diff --git a/spring-core/src/main/java/org/springframework/util/ClassUtils.java b/spring-core/src/main/java/org/springframework/util/ClassUtils.java index 937e296eb2b..8850d9cf06d 100644 --- a/spring-core/src/main/java/org/springframework/util/ClassUtils.java +++ b/spring-core/src/main/java/org/springframework/util/ClassUtils.java @@ -18,18 +18,24 @@ package org.springframework.util; import java.io.Closeable; import java.io.Externalizable; +import java.io.File; import java.io.Serializable; import java.lang.reflect.Array; import java.lang.reflect.Constructor; import java.lang.reflect.Method; import java.lang.reflect.Modifier; import java.lang.reflect.Proxy; +import java.net.InetAddress; import java.net.URI; import java.net.URL; +import java.nio.charset.Charset; +import java.nio.file.Path; +import java.time.ZoneId; import java.time.temporal.Temporal; import java.util.Arrays; import java.util.Collection; import java.util.Collections; +import java.util.Currency; import java.util.Date; import java.util.Enumeration; import java.util.HashMap; @@ -43,7 +49,9 @@ import java.util.Map; import java.util.Optional; import java.util.Set; import java.util.StringJoiner; +import java.util.TimeZone; import java.util.UUID; +import java.util.regex.Pattern; import org.springframework.lang.Nullable; @@ -538,10 +546,12 @@ public abstract class ClassUtils { * Delegate for {@link org.springframework.beans.BeanUtils#isSimpleValueType}. * Also used by {@link ObjectUtils#nullSafeConciseToString}. *

Check if the given type represents a common "simple" value type: - * a primitive or primitive wrapper, an {@code Enum}, a {@code String} - * or other {@code CharSequence}, a {@code Number}, a {@code Date}, - * a {@code Temporal}, a {@code UUID}, a {@code URI}, a {@code URL}, - * a {@code Locale}, or a {@code Class}. + * a primitive or primitive wrapper, an {@link Enum}, a {@link String} + * or other {@link CharSequence}, a {@link Number}, a {@link Date}, + * a {@link Temporal}, a {@link ZoneId} a {@link TimeZone}, a {@link File}, + * a {@link Path}, a {@link URI}, a {@link URL}, an {@link InetAddress}, + * a {@link Charset}, a {@link Currency}, a {@link Locale}, a {@link UUID}, + * a {@link Pattern}, or a {@link Class}. *

{@code Void} and {@code void} are not considered simple value types. * @param type the type to check * @return whether the given type represents a "simple" value type, @@ -556,10 +566,18 @@ public abstract class ClassUtils { Number.class.isAssignableFrom(type) || Date.class.isAssignableFrom(type) || Temporal.class.isAssignableFrom(type) || - UUID.class == type || + ZoneId.class.isAssignableFrom(type) || + TimeZone.class.isAssignableFrom(type) || + File.class.isAssignableFrom(type) || + Path.class.isAssignableFrom(type) || + Charset.class.isAssignableFrom(type) || + Currency.class.isAssignableFrom(type) || + InetAddress.class.isAssignableFrom(type) || URI.class == type || URL.class == type || + UUID.class == type || Locale.class == type || + Pattern.class == type || Class.class == type)); } diff --git a/spring-core/src/main/java/org/springframework/util/ObjectUtils.java b/spring-core/src/main/java/org/springframework/util/ObjectUtils.java index d7a9b2a008c..316a8e2d7fc 100644 --- a/spring-core/src/main/java/org/springframework/util/ObjectUtils.java +++ b/spring-core/src/main/java/org/springframework/util/ObjectUtils.java @@ -17,11 +17,14 @@ package org.springframework.util; import java.lang.reflect.Array; +import java.nio.charset.Charset; +import java.time.ZoneId; import java.util.Arrays; import java.util.Collection; import java.util.Map; import java.util.Optional; import java.util.StringJoiner; +import java.util.TimeZone; import org.springframework.lang.Nullable; @@ -894,19 +897,30 @@ public abstract class ObjectUtils { *

Returns: *

*

In the context of this method, a simple value type is any of the following: - * a primitive wrapper (excluding {@code Void}), an {@code Enum}, a {@code Number}, - * a {@code Date}, a {@code Temporal}, a {@code UUID}, a {@code URI}, a {@code URL}, - * or a {@code Locale}. + * primitive wrapper (excluding {@link Void}), {@link Enum}, {@link Number}, + * {@link java.util.Date Date}, {@link java.time.temporal.Temporal Temporal}, + * {@link java.io.File File}, {@link java.nio.file.Path Path}, + * {@link java.net.URI URI}, {@link java.net.URL URL}, + * {@link java.net.InetAddress InetAddress}, {@link java.util.Currency Currency}, + * {@link java.util.Locale Locale}, {@link java.util.UUID UUID}, + * {@link java.util.regex.Pattern Pattern}. * @param obj the object to build a string representation for * @return a concise string representation of the supplied object * @since 5.3.27 @@ -918,9 +932,22 @@ public abstract class ObjectUtils { if (obj == null) { return "null"; } + if (obj instanceof Optional optional) { + return (optional.isEmpty() ? "Optional.empty" : + "Optional[%s]".formatted(nullSafeConciseToString(optional.get()))); + } if (obj instanceof Class clazz) { return clazz.getName(); } + if (obj instanceof Charset charset) { + return charset.name(); + } + if (obj instanceof TimeZone timeZone) { + return timeZone.getID(); + } + if (obj instanceof ZoneId zoneId) { + return zoneId.getId(); + } if (obj instanceof CharSequence charSequence) { return StringUtils.truncate(charSequence); } diff --git a/spring-core/src/test/java/org/springframework/util/ObjectUtilsTests.java b/spring-core/src/test/java/org/springframework/util/ObjectUtilsTests.java index 3ec2373bb80..025c3a99f5c 100644 --- a/spring-core/src/test/java/org/springframework/util/ObjectUtilsTests.java +++ b/spring-core/src/test/java/org/springframework/util/ObjectUtilsTests.java @@ -16,20 +16,34 @@ package org.springframework.util; +import java.io.File; import java.io.IOException; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.net.InetAddress; import java.net.URI; import java.net.URL; +import java.net.UnknownHostException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.nio.file.Path; import java.sql.SQLException; import java.time.LocalDate; +import java.time.ZoneId; import java.util.ArrayList; import java.util.Collections; +import java.util.Currency; import java.util.Date; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Locale; +import java.util.Map; +import java.util.Optional; import java.util.Set; +import java.util.TimeZone; import java.util.UUID; +import java.util.regex.Pattern; import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; @@ -232,7 +246,7 @@ class ObjectUtilsTests { } @Test - void addObjectToNullArray() throws Exception { + void addObjectToNullArray() { String newElement = "foo"; String[] newArray = ObjectUtils.addObjectToArray(null, newElement); assertThat(newArray).hasSize(1); @@ -240,14 +254,14 @@ class ObjectUtilsTests { } @Test - void addNullObjectToNullArray() throws Exception { + void addNullObjectToNullArray() { Object[] newArray = ObjectUtils.addObjectToArray(null, null); assertThat(newArray).hasSize(1); assertThat(newArray[0]).isNull(); } @Test - void nullSafeEqualsWithArrays() throws Exception { + void nullSafeEqualsWithArrays() { assertThat(ObjectUtils.nullSafeEquals(new String[] {"a", "b", "c"}, new String[] {"a", "b", "c"})).isTrue(); assertThat(ObjectUtils.nullSafeEquals(new int[] {1, 2, 3}, new int[] {1, 2, 3})).isTrue(); } @@ -823,6 +837,41 @@ class ObjectUtilsTests { assertThat(ObjectUtils.nullSafeConciseToString(null)).isEqualTo("null"); } + @Test + void nullSafeConciseToStringForEmptyOptional() { + Optional optional = Optional.empty(); + assertThat(ObjectUtils.nullSafeConciseToString(optional)).isEqualTo("Optional.empty"); + } + + @Test + void nullSafeConciseToStringForNonEmptyOptionals() { + Optional optionalEnum = Optional.of(Tropes.BAR); + String expected = "Optional[BAR]"; + assertThat(ObjectUtils.nullSafeConciseToString(optionalEnum)).isEqualTo(expected); + + String repeat100 = "X".repeat(100); + String repeat101 = "X".repeat(101); + + Optional optionalString = Optional.of(repeat100); + expected = "Optional[%s]".formatted(repeat100); + assertThat(ObjectUtils.nullSafeConciseToString(optionalString)).isEqualTo(expected); + + optionalString = Optional.of(repeat101); + expected = "Optional[%s]".formatted(repeat100 + truncated); + assertThat(ObjectUtils.nullSafeConciseToString(optionalString)).isEqualTo(expected); + } + + @Test + void nullSafeConciseToStringForNonEmptyOptionalCustomType() { + class CustomType { + } + + CustomType customType = new CustomType(); + Optional optional = Optional.of(customType); + String expected = "Optional[%s]".formatted(ObjectUtils.nullSafeConciseToString(customType)); + assertThat(ObjectUtils.nullSafeConciseToString(optional)).isEqualTo(expected); + } + @Test void nullSafeConciseToStringForClass() { assertThat(ObjectUtils.nullSafeConciseToString(String.class)).isEqualTo("java.lang.String"); @@ -855,11 +904,19 @@ class ObjectUtilsTests { } @Test - void nullSafeConciseToStringForNumber() { + void nullSafeConciseToStringForPrimitivesAndWrappers() { + assertThat(ObjectUtils.nullSafeConciseToString(true)).isEqualTo("true"); + assertThat(ObjectUtils.nullSafeConciseToString('X')).isEqualTo("X"); assertThat(ObjectUtils.nullSafeConciseToString(42L)).isEqualTo("42"); assertThat(ObjectUtils.nullSafeConciseToString(99.1234D)).isEqualTo("99.1234"); } + @Test + void nullSafeConciseToStringForBigNumbers() { + assertThat(ObjectUtils.nullSafeConciseToString(BigInteger.valueOf(42L))).isEqualTo("42"); + assertThat(ObjectUtils.nullSafeConciseToString(BigDecimal.valueOf(99.1234D))).isEqualTo("99.1234"); + } + @Test void nullSafeConciseToStringForDate() { Date date = new Date(); @@ -878,6 +935,30 @@ class ObjectUtilsTests { assertThat(ObjectUtils.nullSafeConciseToString(id)).isEqualTo(id.toString()); } + @Test + void nullSafeConciseToStringForFile() { + String path = "/tmp/file.txt"; + assertThat(ObjectUtils.nullSafeConciseToString(new File(path))).isEqualTo(path); + + path = "/tmp/" + "xyz".repeat(32); + assertThat(ObjectUtils.nullSafeConciseToString(new File(path))) + .hasSize(truncatedLength) + .startsWith(path.subSequence(0, 100)) + .endsWith(truncated); + } + + @Test + void nullSafeConciseToStringForPath() { + String path = "/tmp/file.txt"; + assertThat(ObjectUtils.nullSafeConciseToString(Path.of(path))).isEqualTo(path); + + path = "/tmp/" + "xyz".repeat(32); + assertThat(ObjectUtils.nullSafeConciseToString(Path.of(path))) + .hasSize(truncatedLength) + .startsWith(path.subSequence(0, 100)) + .endsWith(truncated); + } + @Test void nullSafeConciseToStringForURI() { String uri = "https://www.example.com/?foo=1&bar=2&baz=3"; @@ -902,11 +983,56 @@ class ObjectUtilsTests { .endsWith(truncated); } + @Test + void nullSafeConciseToStringForInetAddress() { + InetAddress localhost = getLocalhost(); + assertThat(ObjectUtils.nullSafeConciseToString(localhost)).isEqualTo(localhost.toString()); + } + + private static InetAddress getLocalhost() { + try { + return InetAddress.getLocalHost(); + } + catch (UnknownHostException ex) { + return InetAddress.getLoopbackAddress(); + } + } + + @Test + void nullSafeConciseToStringForCharset() { + Charset charset = StandardCharsets.UTF_8; + assertThat(ObjectUtils.nullSafeConciseToString(charset)).isEqualTo(charset.name()); + } + + @Test + void nullSafeConciseToStringForCurrency() { + Currency currency = Currency.getInstance(Locale.US); + assertThat(ObjectUtils.nullSafeConciseToString(currency)).isEqualTo(currency.toString()); + } + @Test void nullSafeConciseToStringForLocale() { assertThat(ObjectUtils.nullSafeConciseToString(Locale.GERMANY)).isEqualTo("de_DE"); } + @Test + void nullSafeConciseToStringForRegExPattern() { + Pattern pattern = Pattern.compile("^(foo|bar)$"); + assertThat(ObjectUtils.nullSafeConciseToString(pattern)).isEqualTo(pattern.toString()); + } + + @Test + void nullSafeConciseToStringForTimeZone() { + TimeZone timeZone = TimeZone.getDefault(); + assertThat(ObjectUtils.nullSafeConciseToString(timeZone)).isEqualTo(timeZone.getID()); + } + + @Test + void nullSafeConciseToStringForZoneId() { + ZoneId zoneId = ZoneId.systemDefault(); + assertThat(ObjectUtils.nullSafeConciseToString(zoneId)).isEqualTo(zoneId.getId()); + } + @Test void nullSafeConciseToStringForArraysAndCollections() { List list = List.of("a", "b", "c"); @@ -917,6 +1043,12 @@ class ObjectUtilsTests { assertThat(ObjectUtils.nullSafeConciseToString(new HashSet<>(list))).startsWith(prefix(HashSet.class)); } + @Test + void nullSafeConciseToStringForMaps() { + Map map = Map.of("a", 1, "b", 2, "c", 3); + assertThat(ObjectUtils.nullSafeConciseToString(map)).startsWith(prefix(map.getClass())); + } + @Test void nullSafeConciseToStringForCustomTypes() { class ExplosiveType {