Introduce Validator.validateObject(Object) with returned Errors

Includes failOnError method on Errors interface for use with validateObject.
Declares many Errors methods as default methods for lean SimpleErrors class.

Closes gh-19877
This commit is contained in:
Juergen Hoeller 2023-07-19 21:56:44 +02:00
parent 9571aa1c68
commit 10cb2322e9
6 changed files with 576 additions and 296 deletions

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2020 the original author or authors. * Copyright 2002-2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -28,13 +28,14 @@ import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils; import org.springframework.util.StringUtils;
/** /**
* Abstract implementation of the {@link Errors} interface. Provides common * Abstract implementation of the {@link Errors} interface.
* access to evaluated errors; however, does not define concrete management * Provides nested path handling but does not define concrete management
* of {@link ObjectError ObjectErrors} and {@link FieldError FieldErrors}. * of {@link ObjectError ObjectErrors} and {@link FieldError FieldErrors}.
* *
* @author Juergen Hoeller * @author Juergen Hoeller
* @author Rossen Stoyanchev * @author Rossen Stoyanchev
* @since 2.5.3 * @since 2.5.3
* @see AbstractBindingResult
*/ */
@SuppressWarnings("serial") @SuppressWarnings("serial")
public abstract class AbstractErrors implements Errors, Serializable { public abstract class AbstractErrors implements Errors, Serializable {
@ -81,8 +82,8 @@ public abstract class AbstractErrors implements Errors, Serializable {
nestedPath = ""; nestedPath = "";
} }
nestedPath = canonicalFieldName(nestedPath); nestedPath = canonicalFieldName(nestedPath);
if (nestedPath.length() > 0 && !nestedPath.endsWith(Errors.NESTED_PATH_SEPARATOR)) { if (nestedPath.length() > 0 && !nestedPath.endsWith(NESTED_PATH_SEPARATOR)) {
nestedPath += Errors.NESTED_PATH_SEPARATOR; nestedPath += NESTED_PATH_SEPARATOR;
} }
this.nestedPath = nestedPath; this.nestedPath = nestedPath;
} }
@ -97,7 +98,7 @@ public abstract class AbstractErrors implements Errors, Serializable {
} }
else { else {
String path = getNestedPath(); String path = getNestedPath();
return (path.endsWith(Errors.NESTED_PATH_SEPARATOR) ? return (path.endsWith(NESTED_PATH_SEPARATOR) ?
path.substring(0, path.length() - NESTED_PATH_SEPARATOR.length()) : path); path.substring(0, path.length() - NESTED_PATH_SEPARATOR.length()) : path);
} }
} }
@ -112,117 +113,19 @@ public abstract class AbstractErrors implements Errors, Serializable {
return field; return field;
} }
@Override
public void reject(String errorCode) {
reject(errorCode, null, null);
}
@Override
public void reject(String errorCode, String defaultMessage) {
reject(errorCode, null, defaultMessage);
}
@Override
public void rejectValue(@Nullable String field, String errorCode) {
rejectValue(field, errorCode, null, null);
}
@Override
public void rejectValue(@Nullable String field, String errorCode, String defaultMessage) {
rejectValue(field, errorCode, null, defaultMessage);
}
@Override
public boolean hasErrors() {
return !getAllErrors().isEmpty();
}
@Override
public int getErrorCount() {
return getAllErrors().size();
}
@Override
public List<ObjectError> getAllErrors() {
List<ObjectError> result = new ArrayList<>();
result.addAll(getGlobalErrors());
result.addAll(getFieldErrors());
return Collections.unmodifiableList(result);
}
@Override
public boolean hasGlobalErrors() {
return (getGlobalErrorCount() > 0);
}
@Override
public int getGlobalErrorCount() {
return getGlobalErrors().size();
}
@Override
@Nullable
public ObjectError getGlobalError() {
List<ObjectError> globalErrors = getGlobalErrors();
return (!globalErrors.isEmpty() ? globalErrors.get(0) : null);
}
@Override
public boolean hasFieldErrors() {
return (getFieldErrorCount() > 0);
}
@Override
public int getFieldErrorCount() {
return getFieldErrors().size();
}
@Override
@Nullable
public FieldError getFieldError() {
List<FieldError> fieldErrors = getFieldErrors();
return (!fieldErrors.isEmpty() ? fieldErrors.get(0) : null);
}
@Override
public boolean hasFieldErrors(String field) {
return (getFieldErrorCount(field) > 0);
}
@Override
public int getFieldErrorCount(String field) {
return getFieldErrors(field).size();
}
@Override @Override
public List<FieldError> getFieldErrors(String field) { public List<FieldError> getFieldErrors(String field) {
List<FieldError> fieldErrors = getFieldErrors(); List<FieldError> fieldErrors = getFieldErrors();
List<FieldError> result = new ArrayList<>(); List<FieldError> result = new ArrayList<>();
String fixedField = fixedField(field); String fixedField = fixedField(field);
for (FieldError error : fieldErrors) { for (FieldError fieldError : fieldErrors) {
if (isMatchingFieldError(fixedField, error)) { if (isMatchingFieldError(fixedField, fieldError)) {
result.add(error); result.add(fieldError);
} }
} }
return Collections.unmodifiableList(result); return Collections.unmodifiableList(result);
} }
@Override
@Nullable
public FieldError getFieldError(String field) {
List<FieldError> fieldErrors = getFieldErrors(field);
return (!fieldErrors.isEmpty() ? fieldErrors.get(0) : null);
}
@Override
@Nullable
public Class<?> getFieldType(String field) {
Object value = getFieldValue(field);
return (value != null ? value.getClass() : null);
}
/** /**
* Check whether the given FieldError matches the given field. * Check whether the given FieldError matches the given field.
* @param field the field that we are looking up FieldErrors for * @param field the field that we are looking up FieldErrors for

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2018 the original author or authors. * Copyright 2002-2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -17,29 +17,33 @@
package org.springframework.validation; package org.springframework.validation;
import java.util.List; import java.util.List;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Stream;
import org.springframework.beans.PropertyAccessor; import org.springframework.beans.PropertyAccessor;
import org.springframework.lang.Nullable; import org.springframework.lang.Nullable;
/** /**
* Stores and exposes information about data-binding and validation * Stores and exposes information about data-binding and validation errors
* errors for a specific object. * for a specific object.
* *
* <p>Field names can be properties of the target object (e.g. "name" * <p>Field names are typically properties of the target object (e.g. "name"
* when binding to a customer object), or nested fields in case of * when binding to a customer object). Implementations may also support nested
* subobjects (e.g. "address.street"). Supports subtree navigation * fields in case of nested objects (e.g. "address.street"), in conjunction
* via {@link #setNestedPath(String)}: for example, an * with subtree navigation via {@link #setNestedPath}: for example, an
* {@code AddressValidator} validates "address", not being aware * {@code AddressValidator} may validate "address", not being aware that this
* that this is a subobject of customer. * is a nested object of a top-level customer object.
* *
* <p>Note: {@code Errors} objects are single-threaded. * <p>Note: {@code Errors} objects are single-threaded.
* *
* @author Rod Johnson * @author Rod Johnson
* @author Juergen Hoeller * @author Juergen Hoeller
* @see #setNestedPath * @see #setNestedPath
* @see BindException * @see Validator
* @see DataBinder
* @see ValidationUtils * @see ValidationUtils
* @see SimpleErrors
* @see BindingResult
*/ */
public interface Errors { public interface Errors {
@ -63,18 +67,26 @@ public interface Errors {
* subtrees. Reject calls prepend the given path to the field names. * subtrees. Reject calls prepend the given path to the field names.
* <p>For example, an address validator could validate the subobject * <p>For example, an address validator could validate the subobject
* "address" of a customer object. * "address" of a customer object.
* <p>The default implementation throws {@code UnsupportedOperationException}
* since not all {@code Errors} implementations support nested paths.
* @param nestedPath nested path within this object, * @param nestedPath nested path within this object,
* e.g. "address" (defaults to "", {@code null} is also acceptable). * e.g. "address" (defaults to "", {@code null} is also acceptable).
* Can end with a dot: both "address" and "address." are valid. * Can end with a dot: both "address" and "address." are valid.
* @see #getNestedPath()
*/ */
void setNestedPath(String nestedPath); default void setNestedPath(String nestedPath) {
throw new UnsupportedOperationException(getClass().getSimpleName() + " does not support nested paths");
}
/** /**
* Return the current nested path of this {@link Errors} object. * Return the current nested path of this {@link Errors} object.
* <p>Returns a nested path with a dot, i.e. "address.", for easy * <p>Returns a nested path with a dot, i.e. "address.", for easy
* building of concatenated paths. Default is an empty String. * building of concatenated paths. Default is an empty String.
* @see #setNestedPath(String)
*/ */
String getNestedPath(); default String getNestedPath() {
return "";
}
/** /**
* Push the given sub path onto the nested path stack. * Push the given sub path onto the nested path stack.
@ -85,32 +97,44 @@ public interface Errors {
* for subobjects without having to worry about a temporary path holder. * for subobjects without having to worry about a temporary path holder.
* <p>For example: current path "spouse.", pushNestedPath("child") &rarr; * <p>For example: current path "spouse.", pushNestedPath("child") &rarr;
* result path "spouse.child."; popNestedPath() &rarr; "spouse." again. * result path "spouse.child."; popNestedPath() &rarr; "spouse." again.
* <p>The default implementation throws {@code UnsupportedOperationException}
* since not all {@code Errors} implementations support nested paths.
* @param subPath the sub path to push onto the nested path stack * @param subPath the sub path to push onto the nested path stack
* @see #popNestedPath * @see #popNestedPath()
*/ */
void pushNestedPath(String subPath); default void pushNestedPath(String subPath) {
throw new UnsupportedOperationException(getClass().getSimpleName() + " does not support nested paths");
}
/** /**
* Pop the former nested path from the nested path stack. * Pop the former nested path from the nested path stack.
* @throws IllegalStateException if there is no former nested path on the stack * @throws IllegalStateException if there is no former nested path on the stack
* @see #pushNestedPath * @see #pushNestedPath(String)
*/ */
void popNestedPath() throws IllegalStateException; default void popNestedPath() throws IllegalStateException {
throw new IllegalStateException("Cannot pop nested path: no nested path on stack");
}
/** /**
* Register a global error for the entire target object, * Register a global error for the entire target object,
* using the given error description. * using the given error description.
* @param errorCode error code, interpretable as a message key * @param errorCode error code, interpretable as a message key
* @see #reject(String, Object[], String)
*/ */
void reject(String errorCode); default void reject(String errorCode) {
reject(errorCode, null, null);
}
/** /**
* Register a global error for the entire target object, * Register a global error for the entire target object,
* using the given error description. * using the given error description.
* @param errorCode error code, interpretable as a message key * @param errorCode error code, interpretable as a message key
* @param defaultMessage fallback default message * @param defaultMessage fallback default message
* @see #reject(String, Object[], String)
*/ */
void reject(String errorCode, String defaultMessage); default void reject(String errorCode, String defaultMessage) {
reject(errorCode, null, defaultMessage);
}
/** /**
* Register a global error for the entire target object, * Register a global error for the entire target object,
@ -119,6 +143,7 @@ public interface Errors {
* @param errorArgs error arguments, for argument binding via MessageFormat * @param errorArgs error arguments, for argument binding via MessageFormat
* (can be {@code null}) * (can be {@code null})
* @param defaultMessage fallback default message * @param defaultMessage fallback default message
* @see #rejectValue(String, String, Object[], String)
*/ */
void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage); void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage);
@ -132,9 +157,11 @@ public interface Errors {
* global error if the current object is the top object. * global error if the current object is the top object.
* @param field the field name (may be {@code null} or empty String) * @param field the field name (may be {@code null} or empty String)
* @param errorCode error code, interpretable as a message key * @param errorCode error code, interpretable as a message key
* @see #getNestedPath() * @see #rejectValue(String, String, Object[], String)
*/ */
void rejectValue(@Nullable String field, String errorCode); default void rejectValue(@Nullable String field, String errorCode) {
rejectValue(field, errorCode, null, null);
}
/** /**
* Register a field error for the specified field of the current object * Register a field error for the specified field of the current object
@ -147,9 +174,11 @@ public interface Errors {
* @param field the field name (may be {@code null} or empty String) * @param field the field name (may be {@code null} or empty String)
* @param errorCode error code, interpretable as a message key * @param errorCode error code, interpretable as a message key
* @param defaultMessage fallback default message * @param defaultMessage fallback default message
* @see #getNestedPath() * @see #rejectValue(String, String, Object[], String)
*/ */
void rejectValue(@Nullable String field, String errorCode, String defaultMessage); default void rejectValue(@Nullable String field, String errorCode, String defaultMessage) {
rejectValue(field, errorCode, null, defaultMessage);
}
/** /**
* Register a field error for the specified field of the current object * Register a field error for the specified field of the current object
@ -164,7 +193,7 @@ public interface Errors {
* @param errorArgs error arguments, for argument binding via MessageFormat * @param errorArgs error arguments, for argument binding via MessageFormat
* (can be {@code null}) * (can be {@code null})
* @param defaultMessage fallback default message * @param defaultMessage fallback default message
* @see #getNestedPath() * @see #reject(String, Object[], String)
*/ */
void rejectValue(@Nullable String field, String errorCode, void rejectValue(@Nullable String field, String errorCode,
@Nullable Object[] errorArgs, @Nullable String defaultMessage); @Nullable Object[] errorArgs, @Nullable String defaultMessage);
@ -178,110 +207,169 @@ public interface Errors {
* <p>Note that the passed-in {@code Errors} instance is supposed * <p>Note that the passed-in {@code Errors} instance is supposed
* to refer to the same target object, or at least contain compatible errors * to refer to the same target object, or at least contain compatible errors
* that apply to the target object of this {@code Errors} instance. * that apply to the target object of this {@code Errors} instance.
* <p>The default implementation throws {@code UnsupportedOperationException}
* since not all {@code Errors} implementations support {@code #addAllErrors}.
* @param errors the {@code Errors} instance to merge in * @param errors the {@code Errors} instance to merge in
* @see #getAllErrors()
*/ */
void addAllErrors(Errors errors); default void addAllErrors(Errors errors) {
throw new UnsupportedOperationException(getClass().getSimpleName() + " does not support addAllErrors");
}
/** /**
* Return if there were any errors. * Throw the mapped exception with a message summarizing the recorded errors.
* @param messageToException a function mapping the message to the exception,
* e.g. {@code IllegalArgumentException::new} or {@code IllegalStateException::new}
* @param <T> the exception type to be thrown
* @since 6.1
* @see #toString()
*/ */
boolean hasErrors(); default <T extends Throwable> void failOnError(Function<String, T> messageToException) throws T {
if (hasErrors()) {
throw messageToException.apply(toString());
}
}
/**
* BReturn if there were any errors.
* @see #hasGlobalErrors()
* @see #hasFieldErrors()
*/
default boolean hasErrors() {
return (!getGlobalErrors().isEmpty() || !getFieldErrors().isEmpty());
}
/** /**
* Return the total number of errors. * Return the total number of errors.
* @see #getGlobalErrorCount()
* @see #getFieldErrorCount()
*/ */
int getErrorCount(); default int getErrorCount() {
return (getGlobalErrors().size() + getFieldErrors().size());
}
/** /**
* Get all errors, both global and field ones. * Get all errors, both global and field ones.
* @return a list of {@link ObjectError} instances * @return a list of {@link ObjectError} instances
* @see #getGlobalErrors()
* @see #getFieldErrors()
*/ */
List<ObjectError> getAllErrors(); default List<ObjectError> getAllErrors() {
return Stream.concat(getGlobalErrors().stream(), getFieldErrors().stream()).toList();
}
/** /**
* Are there any global errors? * Are there any global errors?
* @return {@code true} if there are any global errors * @return {@code true} if there are any global errors
* @see #hasFieldErrors() * @see #hasFieldErrors()
*/ */
boolean hasGlobalErrors(); default boolean hasGlobalErrors() {
return !getGlobalErrors().isEmpty();
}
/** /**
* Return the number of global errors. * Return the number of global errors.
* @return the number of global errors * @return the number of global errors
* @see #getFieldErrorCount() * @see #getFieldErrorCount()
*/ */
int getGlobalErrorCount(); default int getGlobalErrorCount() {
return getGlobalErrors().size();
}
/** /**
* Get all global errors. * Get all global errors.
* @return a list of {@link ObjectError} instances * @return a list of {@link ObjectError} instances
* @see #getFieldErrors()
*/ */
List<ObjectError> getGlobalErrors(); List<ObjectError> getGlobalErrors();
/** /**
* Get the <i>first</i> global error, if any. * Get the <i>first</i> global error, if any.
* @return the global error, or {@code null} * @return the global error, or {@code null}
* @see #getFieldError()
*/ */
@Nullable @Nullable
ObjectError getGlobalError(); default ObjectError getGlobalError() {
return getGlobalErrors().stream().findFirst().orElse(null);
}
/** /**
* Are there any field errors? * Are there any field errors?
* @return {@code true} if there are any errors associated with a field * @return {@code true} if there are any errors associated with a field
* @see #hasGlobalErrors() * @see #hasGlobalErrors()
*/ */
boolean hasFieldErrors(); default boolean hasFieldErrors() {
return !getFieldErrors().isEmpty();
}
/** /**
* Return the number of errors associated with a field. * Return the number of errors associated with a field.
* @return the number of errors associated with a field * @return the number of errors associated with a field
* @see #getGlobalErrorCount() * @see #getGlobalErrorCount()
*/ */
int getFieldErrorCount(); default int getFieldErrorCount() {
return getFieldErrors().size();
}
/** /**
* Get all errors associated with a field. * Get all errors associated with a field.
* @return a List of {@link FieldError} instances * @return a List of {@link FieldError} instances
* @see #getGlobalErrors()
*/ */
List<FieldError> getFieldErrors(); List<FieldError> getFieldErrors();
/** /**
* Get the <i>first</i> error associated with a field, if any. * Get the <i>first</i> error associated with a field, if any.
* @return the field-specific error, or {@code null} * @return the field-specific error, or {@code null}
* @see #getGlobalError()
*/ */
@Nullable @Nullable
FieldError getFieldError(); default FieldError getFieldError() {
return getFieldErrors().stream().findFirst().orElse(null);
}
/** /**
* Are there any errors associated with the given field? * Are there any errors associated with the given field?
* @param field the field name * @param field the field name
* @return {@code true} if there were any errors associated with the given field * @return {@code true} if there were any errors associated with the given field
* @see #hasFieldErrors()
*/ */
boolean hasFieldErrors(String field); default boolean hasFieldErrors(String field) {
return (getFieldError(field) != null);
}
/** /**
* Return the number of errors associated with the given field. * Return the number of errors associated with the given field.
* @param field the field name * @param field the field name
* @return the number of errors associated with the given field * @return the number of errors associated with the given field
* @see #getFieldErrorCount()
*/ */
int getFieldErrorCount(String field); default int getFieldErrorCount(String field) {
return getFieldErrors(field).size();
}
/** /**
* Get all errors associated with the given field. * Get all errors associated with the given field.
* <p>Implementations should support not only full field names like * <p>Implementations may support not only full field names like
* "name" but also pattern matches like "na*" or "address.*". * "address.street" but also pattern matches like "address.*".
* @param field the field name * @param field the field name
* @return a List of {@link FieldError} instances * @return a List of {@link FieldError} instances
* @see #getFieldErrors()
*/ */
List<FieldError> getFieldErrors(String field); default List<FieldError> getFieldErrors(String field) {
return getFieldErrors().stream().filter(error -> field.equals(error.getField())).toList();
}
/** /**
* Get the first error associated with the given field, if any. * Get the first error associated with the given field, if any.
* @param field the field name * @param field the field name
* @return the field-specific error, or {@code null} * @return the field-specific error, or {@code null}
* @see #getFieldError()
*/ */
@Nullable @Nullable
FieldError getFieldError(String field); default FieldError getFieldError(String field) {
return getFieldErrors().stream().filter(error -> field.equals(error.getField())).findFirst().orElse(null);
}
/** /**
* Return the current value of the given field, either the current * Return the current value of the given field, either the current
@ -290,6 +378,7 @@ public interface Errors {
* even if there were type mismatches. * even if there were type mismatches.
* @param field the field name * @param field the field name
* @return the current value of the given field * @return the current value of the given field
* @see #getFieldType(String)
*/ */
@Nullable @Nullable
Object getFieldValue(String field); Object getFieldValue(String field);
@ -301,8 +390,18 @@ public interface Errors {
* associated descriptor. * associated descriptor.
* @param field the field name * @param field the field name
* @return the type of the field, or {@code null} if not determinable * @return the type of the field, or {@code null} if not determinable
* @see #getFieldValue(String)
*/ */
@Nullable @Nullable
Class<?> getFieldType(String field); default Class<?> getFieldType(String field) {
return Optional.ofNullable(getFieldValue(field)).map(Object::getClass).orElse(null);
}
/**
* Return a summary of the recorded errors,
* e.g. for inclusion in an exception message.
* @see #failOnError(Function)
*/
String toString();
} }

View File

@ -0,0 +1,181 @@
/*
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.validation;
import java.beans.PropertyDescriptor;
import java.io.Serializable;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;
import org.springframework.beans.BeanUtils;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.StringUtils;
/**
* A simple implementation of the {@link Errors} interface, managing global
* errors and field errors for a top-level target object. Flexibly retrieves
* field values through bean property getter methods, and automatically
* falls back to raw field access if necessary.
*
* <p>Note that this {@link Errors} implementation comes without support for
* nested paths. It is exclusively designed for the validation of individual
* top-level objects, not aggregating errors from multiple sources.
* If this is insufficient for your purposes, use a binding-capable
* {@link Errors} implementation such as {@link BeanPropertyBindingResult}.
*
* @author Juergen Hoeller
* @since 6.1
* @see Validator#validateObject(Object)
* @see BeanPropertyBindingResult
* @see DirectFieldBindingResult
*/
@SuppressWarnings("serial")
public class SimpleErrors implements Errors, Serializable {
private final Object target;
private final String objectName;
private final List<ObjectError> globalErrors = new ArrayList<>();
private final List<FieldError> fieldErrors = new ArrayList<>();
/**
* Create a new {@link SimpleErrors} holder for the given target,
* using the simple name of the target class as the object name.
* @param target the target to wrap
*/
public SimpleErrors(Object target) {
Assert.notNull(target, "Target must not be null");
this.target = target;
this.objectName = this.target.getClass().getSimpleName();
}
/**
* Create a new {@link SimpleErrors} holder for the given target.
* @param target the target to wrap
* @param objectName the name of the target object for error reporting
*/
public SimpleErrors(Object target, String objectName) {
Assert.notNull(target, "Target must not be null");
this.target = target;
this.objectName = objectName;
}
@Override
public String getObjectName() {
return this.objectName;
}
@Override
public void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage) {
this.globalErrors.add(new ObjectError(getObjectName(), new String[] {errorCode}, errorArgs, defaultMessage));
}
@Override
public void rejectValue(@Nullable String field, String errorCode,
@Nullable Object[] errorArgs, @Nullable String defaultMessage) {
if (!StringUtils.hasLength(field)) {
reject(errorCode, errorArgs, defaultMessage);
return;
}
Object newVal = getFieldValue(field);
this.fieldErrors.add(new FieldError(getObjectName(), field, newVal, false,
new String[] {errorCode}, errorArgs, defaultMessage));
}
@Override
public void addAllErrors(Errors errors) {
this.globalErrors.addAll(errors.getGlobalErrors());
this.fieldErrors.addAll(errors.getFieldErrors());
}
@Override
public List<ObjectError> getGlobalErrors() {
return this.globalErrors;
}
@Override
public List<FieldError> getFieldErrors() {
return this.fieldErrors;
}
@Override
@Nullable
public Object getFieldValue(String field) {
PropertyDescriptor pd = BeanUtils.getPropertyDescriptor(this.target.getClass(), field);
if (pd != null && pd.getReadMethod() != null) {
return ReflectionUtils.invokeMethod(pd.getReadMethod(), this.target);
}
Field rawField = ReflectionUtils.findField(this.target.getClass(), field);
if (rawField != null) {
ReflectionUtils.makeAccessible(rawField);
return ReflectionUtils.getField(rawField, this.target);
}
throw new IllegalArgumentException("Cannot retrieve value for field '" + field +
"' - neither a getter method nor a raw field found");
}
@Override
public Class<?> getFieldType(String field) {
PropertyDescriptor pd = BeanUtils.getPropertyDescriptor(this.target.getClass(), field);
if (pd != null) {
return pd.getPropertyType();
}
Field rawField = ReflectionUtils.findField(this.target.getClass(), field);
if (rawField != null) {
return rawField.getType();
}
return null;
}
@Override
public boolean equals(@Nullable Object other) {
return (this == other || (other instanceof SimpleErrors that &&
ObjectUtils.nullSafeEquals(this.target, that.target) &&
this.globalErrors.equals(that.globalErrors) &&
this.fieldErrors.equals(that.fieldErrors)));
}
@Override
public int hashCode() {
return this.target.hashCode();
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
for (ObjectError error : this.globalErrors) {
sb.append('\n').append(error);
}
for (ObjectError error : this.fieldErrors) {
sb.append('\n').append(error);
}
return sb.toString();
}
}

View File

@ -48,16 +48,17 @@ import java.util.function.BiConsumer;
* } * }
* });</pre> * });</pre>
* *
* <p>See also the Spring reference manual for a fuller discussion of * <p>See also the Spring reference manual for a fuller discussion of the
* the {@code Validator} interface and its role in an enterprise * {@code Validator} interface and its role in an enterprise application.
* application.
* *
* @author Rod Johnson * @author Rod Johnson
* @author Juergen Hoeller
* @author Toshiaki Maki * @author Toshiaki Maki
* @author Arjen Poutsma * @author Arjen Poutsma
* @see SmartValidator * @see SmartValidator
* @see Errors * @see Errors
* @see ValidationUtils * @see ValidationUtils
* @see DataBinder#setValidator
*/ */
public interface Validator { public interface Validator {
@ -77,17 +78,43 @@ public interface Validator {
boolean supports(Class<?> clazz); boolean supports(Class<?> clazz);
/** /**
* Validate the supplied {@code target} object, which must be * Validate the given {@code target} object which must be of a
* of a {@link Class} for which the {@link #supports(Class)} method * {@link Class} for which the {@link #supports(Class)} method
* typically has (or would) return {@code true}. * typically has returned (or would return) {@code true}.
* <p>The supplied {@link Errors errors} instance can be used to report * <p>The supplied {@link Errors errors} instance can be used to report
* any resulting validation errors. * any resulting validation errors, typically as part of a larger
* binding process which this validator is meant to participate in.
* Binding errors have typically been pre-registered with the
* {@link Errors errors} instance before this invocation already.
* @param target the object that is to be validated * @param target the object that is to be validated
* @param errors contextual state about the validation process * @param errors contextual state about the validation process
* @see ValidationUtils * @see ValidationUtils
*/ */
void validate(Object target, Errors errors); void validate(Object target, Errors errors);
/**
* Validate the given {@code target} object individually.
* <p>Delegates to the common {@link #validate(Object, Errors)} method.
* The returned {@link Errors errors} instance can be used to report
* any resulting validation errors for the specific target object, e.g.
* {@code if (validator.validateObject(target).hasErrors()) ...} or
* {@code validator.validateObject(target).failOnError(IllegalStateException::new));}.
* <p>Note: This validation call comes with limitations in the {@link Errors}
* implementation used, in particular no support for nested paths.
* If this is insufficient for your purposes, call the regular
* {@link #validate(Object, Errors)} method with a binding-capable
* {@link Errors} implementation such as {@link BeanPropertyBindingResult}.
* @param target the object that is to be validated
* @return resulting errors from the validation of the given object
* @since 6.1
* @see SimpleErrors
*/
default Errors validateObject(Object target) {
Errors errors = new SimpleErrors(target);
validate(target, errors);
return errors;
}
/** /**
* Return a {@code Validator} that checks whether the target object * Return a {@code Validator} that checks whether the target object

View File

@ -79,6 +79,7 @@ import static org.assertj.core.api.Assertions.entry;
* @author Rob Harrop * @author Rob Harrop
* @author Kazuki Shimizu * @author Kazuki Shimizu
* @author Sam Brannen * @author Sam Brannen
* @author Arjen Poutsma
*/ */
class DataBinderTests { class DataBinderTests {
@ -92,6 +93,7 @@ class DataBinderTests {
} }
}); });
@Test @Test
void bindingNoErrors() throws BindException { void bindingNoErrors() throws BindException {
TestBean rod = new TestBean(); TestBean rod = new TestBean();
@ -113,7 +115,7 @@ class DataBinderTests {
TestBean tb = (TestBean) map.get("person"); TestBean tb = (TestBean) map.get("person");
assertThat(tb.equals(rod)).as("Same object").isTrue(); assertThat(tb.equals(rod)).as("Same object").isTrue();
BindingResult other = new BeanPropertyBindingResult(rod, "person"); BindingResult other = new DataBinder(rod, "person").getBindingResult();
assertThat(binder.getBindingResult()).isEqualTo(other); assertThat(binder.getBindingResult()).isEqualTo(other);
assertThat(other).isEqualTo(binder.getBindingResult()); assertThat(other).isEqualTo(binder.getBindingResult());
BindException ex = new BindException(other); BindException ex = new BindException(other);
@ -167,8 +169,9 @@ class DataBinderTests {
pvs.add("name", "Rod"); pvs.add("name", "Rod");
pvs.add("age", 32); pvs.add("age", 32);
pvs.add("nonExisting", "someValue"); pvs.add("nonExisting", "someValue");
assertThatExceptionOfType(NotWritablePropertyException.class).isThrownBy(() ->
binder.bind(pvs)); assertThatExceptionOfType(NotWritablePropertyException.class)
.isThrownBy(() -> binder.bind(pvs));
} }
@Test @Test
@ -178,8 +181,9 @@ class DataBinderTests {
MutablePropertyValues pvs = new MutablePropertyValues(); MutablePropertyValues pvs = new MutablePropertyValues();
pvs.add("name", "Rod"); pvs.add("name", "Rod");
pvs.add("spouse.age", 32); pvs.add("spouse.age", 32);
assertThatExceptionOfType(NullValueInNestedPathException.class).isThrownBy(() ->
binder.bind(pvs)); assertThatExceptionOfType(NullValueInNestedPathException.class)
.isThrownBy(() -> binder.bind(pvs));
} }
@Test @Test
@ -207,57 +211,56 @@ class DataBinderTests {
pvs.add("age", "32x"); pvs.add("age", "32x");
pvs.add("touchy", "m.y"); pvs.add("touchy", "m.y");
binder.bind(pvs); binder.bind(pvs);
assertThatExceptionOfType(BindException.class).isThrownBy(
binder::close)
.satisfies(ex -> {
assertThat(rod.getName()).isEqualTo("Rod");
Map<?, ?> map = binder.getBindingResult().getModel();
TestBean tb = (TestBean) map.get("person");
assertThat(tb).isSameAs(rod);
BindingResult br = (BindingResult) map.get(BindingResult.MODEL_KEY_PREFIX + "person"); assertThatExceptionOfType(BindException.class).isThrownBy(binder::close).satisfies(ex -> {
assertThat(BindingResultUtils.getBindingResult(map, "person")).isEqualTo(br); assertThat(rod.getName()).isEqualTo("Rod");
assertThat(BindingResultUtils.getRequiredBindingResult(map, "person")).isEqualTo(br); Map<?, ?> map = binder.getBindingResult().getModel();
TestBean tb = (TestBean) map.get("person");
assertThat(tb).isSameAs(rod);
assertThat(BindingResultUtils.getBindingResult(map, "someOtherName")).isNull(); BindingResult br = (BindingResult) map.get(BindingResult.MODEL_KEY_PREFIX + "person");
assertThatIllegalStateException().isThrownBy(() -> assertThat(BindingResultUtils.getBindingResult(map, "person")).isEqualTo(br);
BindingResultUtils.getRequiredBindingResult(map, "someOtherName")); assertThat(BindingResultUtils.getRequiredBindingResult(map, "person")).isEqualTo(br);
assertThat(binder.getBindingResult()).as("Added itself to map").isSameAs(br); assertThat(BindingResultUtils.getBindingResult(map, "someOtherName")).isNull();
assertThat(br.hasErrors()).isTrue(); assertThatIllegalStateException().isThrownBy(() ->
assertThat(br.getErrorCount()).isEqualTo(2); BindingResultUtils.getRequiredBindingResult(map, "someOtherName"));
assertThat(br.hasFieldErrors("age")).isTrue(); assertThat(binder.getBindingResult()).as("Added itself to map").isSameAs(br);
assertThat(br.getFieldErrorCount("age")).isEqualTo(1); assertThat(br.hasErrors()).isTrue();
assertThat(binder.getBindingResult().getFieldValue("age")).isEqualTo("32x"); assertThat(br.getErrorCount()).isEqualTo(2);
FieldError ageError = binder.getBindingResult().getFieldError("age");
assertThat(ageError).isNotNull();
assertThat(ageError.getCode()).isEqualTo("typeMismatch");
assertThat(ageError.getRejectedValue()).isEqualTo("32x");
assertThat(ageError.contains(TypeMismatchException.class)).isTrue();
assertThat(ageError.contains(NumberFormatException.class)).isTrue();
assertThat(ageError.unwrap(NumberFormatException.class).getMessage()).contains("32x");
assertThat(tb.getAge()).isEqualTo(0);
assertThat(br.hasFieldErrors("touchy")).isTrue(); assertThat(br.hasFieldErrors("age")).isTrue();
assertThat(br.getFieldErrorCount("touchy")).isEqualTo(1); assertThat(br.getFieldErrorCount("age")).isEqualTo(1);
assertThat(binder.getBindingResult().getFieldValue("touchy")).isEqualTo("m.y"); assertThat(binder.getBindingResult().getFieldValue("age")).isEqualTo("32x");
FieldError touchyError = binder.getBindingResult().getFieldError("touchy"); FieldError ageError = binder.getBindingResult().getFieldError("age");
assertThat(touchyError).isNotNull(); assertThat(ageError).isNotNull();
assertThat(touchyError.getCode()).isEqualTo("methodInvocation"); assertThat(ageError.getCode()).isEqualTo("typeMismatch");
assertThat(touchyError.getRejectedValue()).isEqualTo("m.y"); assertThat(ageError.getRejectedValue()).isEqualTo("32x");
assertThat(touchyError.contains(MethodInvocationException.class)).isTrue(); assertThat(ageError.contains(TypeMismatchException.class)).isTrue();
assertThat(touchyError.unwrap(MethodInvocationException.class).getCause().getMessage()).contains("a ."); assertThat(ageError.contains(NumberFormatException.class)).isTrue();
assertThat(tb.getTouchy()).isNull(); assertThat(ageError.unwrap(NumberFormatException.class).getMessage()).contains("32x");
assertThat(tb.getAge()).isEqualTo(0);
DataBinder binder2 = new DataBinder(new TestBean(), "person"); assertThat(br.hasFieldErrors("touchy")).isTrue();
MutablePropertyValues pvs2 = new MutablePropertyValues(); assertThat(br.getFieldErrorCount("touchy")).isEqualTo(1);
pvs2.add("name", "Rod"); assertThat(binder.getBindingResult().getFieldValue("touchy")).isEqualTo("m.y");
pvs2.add("age", "32x"); FieldError touchyError = binder.getBindingResult().getFieldError("touchy");
pvs2.add("touchy", "m.y"); assertThat(touchyError).isNotNull();
binder2.bind(pvs2); assertThat(touchyError.getCode()).isEqualTo("methodInvocation");
assertThat(ex.getBindingResult()).isEqualTo(binder2.getBindingResult()); assertThat(touchyError.getRejectedValue()).isEqualTo("m.y");
}); assertThat(touchyError.contains(MethodInvocationException.class)).isTrue();
assertThat(touchyError.unwrap(MethodInvocationException.class).getCause().getMessage()).contains("a .");
assertThat(tb.getTouchy()).isNull();
DataBinder binder2 = new DataBinder(new TestBean(), "person");
MutablePropertyValues pvs2 = new MutablePropertyValues();
pvs2.add("name", "Rod");
pvs2.add("age", "32x");
pvs2.add("touchy", "m.y");
binder2.bind(pvs2);
assertThat(ex.getBindingResult()).isEqualTo(binder2.getBindingResult());
});
} }
@Test @Test
@ -267,15 +270,17 @@ class DataBinderTests {
MutablePropertyValues pvs = new MutablePropertyValues(); MutablePropertyValues pvs = new MutablePropertyValues();
pvs.add("class.classLoader.URLs[0]", "https://myserver"); pvs.add("class.classLoader.URLs[0]", "https://myserver");
binder.setIgnoreUnknownFields(false); binder.setIgnoreUnknownFields(false);
assertThatExceptionOfType(NotWritablePropertyException.class).isThrownBy(() ->
binder.bind(pvs)) assertThatExceptionOfType(NotWritablePropertyException.class)
.withMessageContaining("classLoader"); .isThrownBy(() -> binder.bind(pvs))
.withMessageContaining("classLoader");
} }
@Test @Test
void bindingWithErrorsAndCustomEditors() { void bindingWithErrorsAndCustomEditors() {
TestBean rod = new TestBean(); TestBean rod = new TestBean();
DataBinder binder = new DataBinder(rod, "person"); DataBinder binder = new DataBinder(rod, "person");
binder.registerCustomEditor(String.class, "touchy", new PropertyEditorSupport() { binder.registerCustomEditor(String.class, "touchy", new PropertyEditorSupport() {
@Override @Override
public void setAsText(String text) throws IllegalArgumentException { public void setAsText(String text) throws IllegalArgumentException {
@ -296,6 +301,7 @@ class DataBinderTests {
return ((TestBean) getValue()).getName(); return ((TestBean) getValue()).getName();
} }
}); });
MutablePropertyValues pvs = new MutablePropertyValues(); MutablePropertyValues pvs = new MutablePropertyValues();
pvs.add("name", "Rod"); pvs.add("name", "Rod");
pvs.add("age", "32x"); pvs.add("age", "32x");
@ -303,41 +309,39 @@ class DataBinderTests {
pvs.add("spouse", "Kerry"); pvs.add("spouse", "Kerry");
binder.bind(pvs); binder.bind(pvs);
assertThatExceptionOfType(BindException.class).isThrownBy( assertThatExceptionOfType(BindException.class).isThrownBy(binder::close).satisfies(ex -> {
binder::close) assertThat(rod.getName()).isEqualTo("Rod");
.satisfies(ex -> { Map<?, ?> model = binder.getBindingResult().getModel();
assertThat(rod.getName()).isEqualTo("Rod"); TestBean tb = (TestBean) model.get("person");
Map<?, ?> model = binder.getBindingResult().getModel(); assertThat(tb).isEqualTo(rod);
TestBean tb = (TestBean) model.get("person");
assertThat(tb).isEqualTo(rod);
BindingResult br = (BindingResult) model.get(BindingResult.MODEL_KEY_PREFIX + "person"); BindingResult br = (BindingResult) model.get(BindingResult.MODEL_KEY_PREFIX + "person");
assertThat(binder.getBindingResult()).isSameAs(br); assertThat(binder.getBindingResult()).isSameAs(br);
assertThat(br.hasErrors()).isTrue(); assertThat(br.hasErrors()).isTrue();
assertThat(br.getErrorCount()).isEqualTo(2); assertThat(br.getErrorCount()).isEqualTo(2);
assertThat(br.hasFieldErrors("age")).isTrue(); assertThat(br.hasFieldErrors("age")).isTrue();
assertThat(br.getFieldErrorCount("age")).isEqualTo(1); assertThat(br.getFieldErrorCount("age")).isEqualTo(1);
assertThat(binder.getBindingResult().getFieldValue("age")).isEqualTo("32x"); assertThat(binder.getBindingResult().getFieldValue("age")).isEqualTo("32x");
FieldError ageError = binder.getBindingResult().getFieldError("age"); FieldError ageError = binder.getBindingResult().getFieldError("age");
assertThat(ageError).isNotNull(); assertThat(ageError).isNotNull();
assertThat(ageError.getCode()).isEqualTo("typeMismatch"); assertThat(ageError.getCode()).isEqualTo("typeMismatch");
assertThat(ageError.getRejectedValue()).isEqualTo("32x"); assertThat(ageError.getRejectedValue()).isEqualTo("32x");
assertThat(tb.getAge()).isEqualTo(0); assertThat(tb.getAge()).isEqualTo(0);
assertThat(br.hasFieldErrors("touchy")).isTrue(); assertThat(br.hasFieldErrors("touchy")).isTrue();
assertThat(br.getFieldErrorCount("touchy")).isEqualTo(1); assertThat(br.getFieldErrorCount("touchy")).isEqualTo(1);
assertThat(binder.getBindingResult().getFieldValue("touchy")).isEqualTo("m.y"); assertThat(binder.getBindingResult().getFieldValue("touchy")).isEqualTo("m.y");
FieldError touchyError = binder.getBindingResult().getFieldError("touchy"); FieldError touchyError = binder.getBindingResult().getFieldError("touchy");
assertThat(touchyError).isNotNull(); assertThat(touchyError).isNotNull();
assertThat(touchyError.getCode()).isEqualTo("methodInvocation"); assertThat(touchyError.getCode()).isEqualTo("methodInvocation");
assertThat(touchyError.getRejectedValue()).isEqualTo("m.y"); assertThat(touchyError.getRejectedValue()).isEqualTo("m.y");
assertThat(tb.getTouchy()).isNull(); assertThat(tb.getTouchy()).isNull();
assertThat(br.hasFieldErrors("spouse")).isFalse(); assertThat(br.hasFieldErrors("spouse")).isFalse();
assertThat(binder.getBindingResult().getFieldValue("spouse")).isEqualTo("Kerry"); assertThat(binder.getBindingResult().getFieldValue("spouse")).isEqualTo("Kerry");
assertThat(tb.getSpouse()).isNotNull(); assertThat(tb.getSpouse()).isNotNull();
}); });
} }
@Test @Test
@ -1144,12 +1148,11 @@ class DataBinderTests {
tb2.setAge(34); tb2.setAge(34);
tb.setSpouse(tb2); tb.setSpouse(tb2);
DataBinder db = new DataBinder(tb, "tb"); DataBinder db = new DataBinder(tb, "tb");
db.setValidator(new TestBeanValidator());
MutablePropertyValues pvs = new MutablePropertyValues(); MutablePropertyValues pvs = new MutablePropertyValues();
pvs.add("spouse.age", "argh"); pvs.add("spouse.age", "argh");
db.bind(pvs); db.bind(pvs);
Errors errors = db.getBindingResult(); Errors errors = db.getBindingResult();
Validator testValidator = new TestBeanValidator();
testValidator.validate(tb, errors);
errors.setNestedPath("spouse"); errors.setNestedPath("spouse");
assertThat(errors.getNestedPath()).isEqualTo("spouse."); assertThat(errors.getNestedPath()).isEqualTo("spouse.");
@ -1196,8 +1199,7 @@ class DataBinderTests {
void validatorWithErrors() { void validatorWithErrors() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
tb.setSpouse(new TestBean()); tb.setSpouse(new TestBean());
Errors errors = new DataBinder(tb, "tb").getBindingResult();
Errors errors = new BeanPropertyBindingResult(tb, "tb");
Validator testValidator = new TestBeanValidator(); Validator testValidator = new TestBeanValidator();
testValidator.validate(tb, errors); testValidator.validate(tb, errors);
@ -1209,7 +1211,11 @@ class DataBinderTests {
errors.setNestedPath(""); errors.setNestedPath("");
assertThat(errors.hasErrors()).isTrue(); assertThat(errors.hasErrors()).isTrue();
assertThat(errors.getErrorCount()).isEqualTo(6); assertThat(errors.getErrorCount()).isEqualTo(6);
assertThat(errors.getAllErrors())
.containsAll(errors.getGlobalErrors())
.containsAll(errors.getFieldErrors());
assertThat(errors.hasGlobalErrors()).isTrue();
assertThat(errors.getGlobalErrorCount()).isEqualTo(2); assertThat(errors.getGlobalErrorCount()).isEqualTo(2);
assertThat(errors.getGlobalError().getCode()).isEqualTo("NAME_TOUCHY_MISMATCH"); assertThat(errors.getGlobalError().getCode()).isEqualTo("NAME_TOUCHY_MISMATCH");
assertThat((errors.getGlobalErrors().get(0)).getCode()).isEqualTo("NAME_TOUCHY_MISMATCH"); assertThat((errors.getGlobalErrors().get(0)).getCode()).isEqualTo("NAME_TOUCHY_MISMATCH");
@ -1265,10 +1271,11 @@ class DataBinderTests {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
tb.setSpouse(new TestBean()); tb.setSpouse(new TestBean());
BeanPropertyBindingResult errors = new BeanPropertyBindingResult(tb, "tb"); DataBinder dataBinder = new DataBinder(tb, "tb");
DefaultMessageCodesResolver codesResolver = new DefaultMessageCodesResolver(); DefaultMessageCodesResolver codesResolver = new DefaultMessageCodesResolver();
codesResolver.setPrefix("validation."); codesResolver.setPrefix("validation.");
errors.setMessageCodesResolver(codesResolver); dataBinder.setMessageCodesResolver(codesResolver);
Errors errors = dataBinder.getBindingResult();
Validator testValidator = new TestBeanValidator(); Validator testValidator = new TestBeanValidator();
testValidator.validate(tb, errors); testValidator.validate(tb, errors);
@ -1280,7 +1287,11 @@ class DataBinderTests {
errors.setNestedPath(""); errors.setNestedPath("");
assertThat(errors.hasErrors()).isTrue(); assertThat(errors.hasErrors()).isTrue();
assertThat(errors.getErrorCount()).isEqualTo(6); assertThat(errors.getErrorCount()).isEqualTo(6);
assertThat(errors.getAllErrors())
.containsAll(errors.getGlobalErrors())
.containsAll(errors.getFieldErrors());
assertThat(errors.hasGlobalErrors()).isTrue();
assertThat(errors.getGlobalErrorCount()).isEqualTo(2); assertThat(errors.getGlobalErrorCount()).isEqualTo(2);
assertThat(errors.getGlobalError().getCode()).isEqualTo("validation.NAME_TOUCHY_MISMATCH"); assertThat(errors.getGlobalError().getCode()).isEqualTo("validation.NAME_TOUCHY_MISMATCH");
assertThat((errors.getGlobalErrors().get(0)).getCode()).isEqualTo("validation.NAME_TOUCHY_MISMATCH"); assertThat((errors.getGlobalErrors().get(0)).getCode()).isEqualTo("validation.NAME_TOUCHY_MISMATCH");
@ -1332,11 +1343,62 @@ class DataBinderTests {
} }
@Test @Test
void validatorWithNestedObjectNull() { void validateObjectWithErrors() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = new SimpleErrors(tb, "tb");
Validator testValidator = new TestBeanValidator(); Validator testValidator = new TestBeanValidator();
testValidator.validate(tb, errors); testValidator.validate(tb, errors);
assertThat(errors.hasErrors()).isTrue();
assertThat(errors.getErrorCount()).isEqualTo(5);
assertThat(errors.getAllErrors())
.containsAll(errors.getGlobalErrors())
.containsAll(errors.getFieldErrors());
assertThat(errors.hasGlobalErrors()).isTrue();
assertThat(errors.getGlobalErrorCount()).isEqualTo(2);
assertThat(errors.getGlobalError().getCode()).isEqualTo("NAME_TOUCHY_MISMATCH");
assertThat((errors.getGlobalErrors().get(0)).getCode()).isEqualTo("NAME_TOUCHY_MISMATCH");
assertThat((errors.getGlobalErrors().get(0)).getObjectName()).isEqualTo("tb");
assertThat((errors.getGlobalErrors().get(1)).getCode()).isEqualTo("GENERAL_ERROR");
assertThat((errors.getGlobalErrors().get(1)).getDefaultMessage()).isEqualTo("msg");
assertThat((errors.getGlobalErrors().get(1)).getArguments()[0]).isEqualTo("arg");
assertThat(errors.hasFieldErrors()).isTrue();
assertThat(errors.getFieldErrorCount()).isEqualTo(3);
assertThat(errors.getFieldError().getCode()).isEqualTo("TOO_YOUNG");
assertThat((errors.getFieldErrors().get(0)).getCode()).isEqualTo("TOO_YOUNG");
assertThat((errors.getFieldErrors().get(0)).getField()).isEqualTo("age");
assertThat((errors.getFieldErrors().get(1)).getCode()).isEqualTo("AGE_NOT_ODD");
assertThat((errors.getFieldErrors().get(1)).getField()).isEqualTo("age");
assertThat((errors.getFieldErrors().get(2)).getCode()).isEqualTo("NOT_ROD");
assertThat((errors.getFieldErrors().get(2)).getField()).isEqualTo("name");
assertThat(errors.hasFieldErrors("age")).isTrue();
assertThat(errors.getFieldErrorCount("age")).isEqualTo(2);
assertThat(errors.getFieldError("age").getCode()).isEqualTo("TOO_YOUNG");
assertThat((errors.getFieldErrors("age").get(0)).getCode()).isEqualTo("TOO_YOUNG");
assertThat((errors.getFieldErrors("age").get(0)).getObjectName()).isEqualTo("tb");
assertThat((errors.getFieldErrors("age").get(0)).getField()).isEqualTo("age");
assertThat((errors.getFieldErrors("age").get(0)).getRejectedValue()).isEqualTo(0);
assertThat((errors.getFieldErrors("age").get(1)).getCode()).isEqualTo("AGE_NOT_ODD");
assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldErrorCount("name")).isEqualTo(1);
assertThat(errors.getFieldError("name").getCode()).isEqualTo("NOT_ROD");
assertThat((errors.getFieldErrors("name").get(0)).getField()).isEqualTo("name");
assertThat((errors.getFieldErrors("name").get(0)).getRejectedValue()).isNull();
}
@Test
void validatorWithNestedObjectNull() {
TestBean tb = new TestBean();
Errors errors = new DataBinder(tb, "tb").getBindingResult();
Validator testValidator = new TestBeanValidator();
testValidator.validate(tb, errors);
errors.setNestedPath("spouse."); errors.setNestedPath("spouse.");
assertThat(errors.getNestedPath()).isEqualTo("spouse."); assertThat(errors.getNestedPath()).isEqualTo("spouse.");
spouseValidator.validate(tb.getSpouse(), errors); spouseValidator.validate(tb.getSpouse(), errors);
@ -1353,13 +1415,12 @@ class DataBinderTests {
void nestedValidatorWithoutNestedPath() { void nestedValidatorWithoutNestedPath() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
tb.setName("XXX"); tb.setName("XXX");
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = spouseValidator.validateObject(tb);
spouseValidator.validate(tb, errors);
assertThat(errors.hasGlobalErrors()).isTrue(); assertThat(errors.hasGlobalErrors()).isTrue();
assertThat(errors.getGlobalErrorCount()).isEqualTo(1); assertThat(errors.getGlobalErrorCount()).isEqualTo(1);
assertThat(errors.getGlobalError().getCode()).isEqualTo("SPOUSE_NOT_AVAILABLE"); assertThat(errors.getGlobalError().getCode()).isEqualTo("SPOUSE_NOT_AVAILABLE");
assertThat((errors.getGlobalErrors().get(0)).getObjectName()).isEqualTo("tb"); assertThat((errors.getGlobalErrors().get(0)).getObjectName()).isEqualTo("TestBean");
} }
@Test @Test
@ -1770,7 +1831,7 @@ class DataBinderTests {
binder.bind(pvs); binder.bind(pvs);
Errors errors = binder.getBindingResult(); Errors errors = binder.getBindingResult();
BeanPropertyBindingResult errors2 = new BeanPropertyBindingResult(rod, "person"); Errors errors2 = new SimpleErrors(rod, "person");
errors.rejectValue("name", "badName"); errors.rejectValue("name", "badName");
errors.addAllErrors(errors2); errors.addAllErrors(errors2);
@ -1805,16 +1866,16 @@ class DataBinderTests {
tb.setName("myName"); tb.setName("myName");
tb.setAge(99); tb.setAge(99);
BeanPropertyBindingResult ex = new BeanPropertyBindingResult(tb, "tb"); Errors errors = new SimpleErrors(tb, "tb");
ex.reject("invalid"); errors.reject("invalid");
ex.rejectValue("age", "invalidField"); errors.rejectValue("age", "invalidField");
StaticMessageSource ms = new StaticMessageSource(); StaticMessageSource ms = new StaticMessageSource();
ms.addMessage("invalid", Locale.US, "general error"); ms.addMessage("invalid", Locale.US, "general error");
ms.addMessage("invalidField", Locale.US, "invalid field"); ms.addMessage("invalidField", Locale.US, "invalid field");
assertThat(ms.getMessage(ex.getGlobalError(), Locale.US)).isEqualTo("general error"); assertThat(ms.getMessage(errors.getGlobalError(), Locale.US)).isEqualTo("general error");
assertThat(ms.getMessage(ex.getFieldError("age"), Locale.US)).isEqualTo("invalid field"); assertThat(ms.getMessage(errors.getFieldError("age"), Locale.US)).isEqualTo("invalid field");
} }
@Test @Test
@ -1882,13 +1943,13 @@ class DataBinderTests {
void autoGrowBeyondDefaultLimit() { void autoGrowBeyondDefaultLimit() {
TestBean testBean = new TestBean(); TestBean testBean = new TestBean();
DataBinder binder = new DataBinder(testBean, "testBean"); DataBinder binder = new DataBinder(testBean, "testBean");
MutablePropertyValues mpvs = new MutablePropertyValues(); MutablePropertyValues mpvs = new MutablePropertyValues();
mpvs.add("friends[256]", ""); mpvs.add("friends[256]", "");
assertThatExceptionOfType(InvalidPropertyException.class) assertThatExceptionOfType(InvalidPropertyException.class)
.isThrownBy(() -> binder.bind(mpvs)) .isThrownBy(() -> binder.bind(mpvs))
.havingRootCause() .havingRootCause()
.isInstanceOf(IndexOutOfBoundsException.class); .isInstanceOf(IndexOutOfBoundsException.class);
} }
@Test @Test
@ -1909,13 +1970,13 @@ class DataBinderTests {
TestBean testBean = new TestBean(); TestBean testBean = new TestBean();
DataBinder binder = new DataBinder(testBean, "testBean"); DataBinder binder = new DataBinder(testBean, "testBean");
binder.setAutoGrowCollectionLimit(10); binder.setAutoGrowCollectionLimit(10);
MutablePropertyValues mpvs = new MutablePropertyValues(); MutablePropertyValues mpvs = new MutablePropertyValues();
mpvs.add("friends[16]", ""); mpvs.add("friends[16]", "");
assertThatExceptionOfType(InvalidPropertyException.class) assertThatExceptionOfType(InvalidPropertyException.class)
.isThrownBy(() -> binder.bind(mpvs)) .isThrownBy(() -> binder.bind(mpvs))
.havingRootCause() .havingRootCause()
.isInstanceOf(IndexOutOfBoundsException.class); .isInstanceOf(IndexOutOfBoundsException.class);
} }
@Test @Test
@ -2165,6 +2226,7 @@ class DataBinderTests {
} }
} }
@SuppressWarnings("unused") @SuppressWarnings("unused")
private static class GrowingList<E> extends AbstractList<E> { private static class GrowingList<E> extends AbstractList<E> {

View File

@ -22,6 +22,7 @@ import org.springframework.beans.testfixture.beans.TestBean;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
/** /**
* Unit tests for {@link ValidationUtils}. * Unit tests for {@link ValidationUtils}.
@ -29,82 +30,93 @@ import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException
* @author Juergen Hoeller * @author Juergen Hoeller
* @author Rick Evans * @author Rick Evans
* @author Chris Beams * @author Chris Beams
* @author Arjen Poutsma
* @since 08.10.2004 * @since 08.10.2004
*/ */
public class ValidationUtilsTests { public class ValidationUtilsTests {
private final Validator emptyValidator = Validator.forInstanceOf(TestBean.class, (testBean, errors) -> ValidationUtils.rejectIfEmpty(errors, "name", "EMPTY", "You must enter a name!")); private final Validator emptyValidator = Validator.forInstanceOf(TestBean.class, (testBean, errors) ->
ValidationUtils.rejectIfEmpty(errors, "name", "EMPTY", "You must enter a name!"));
private final Validator emptyOrWhitespaceValidator = Validator.forInstanceOf(TestBean.class, (testBean, errors) ->
ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "EMPTY_OR_WHITESPACE", "You must enter a name!"));
private final Validator emptyOrWhitespaceValidator = Validator.forInstanceOf(TestBean.class, (testBean, errors) -> ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "EMPTY_OR_WHITESPACE", "You must enter a name!"));
@Test @Test
public void testInvokeValidatorWithNullValidator() throws Exception { public void testInvokeValidatorWithNullValidator() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = new SimpleErrors(tb);
assertThatIllegalArgumentException().isThrownBy(() -> assertThatIllegalArgumentException().isThrownBy(() ->
ValidationUtils.invokeValidator(null, tb, errors)); ValidationUtils.invokeValidator(null, tb, errors));
} }
@Test @Test
public void testInvokeValidatorWithNullErrors() throws Exception { public void testInvokeValidatorWithNullErrors() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
assertThatIllegalArgumentException().isThrownBy(() -> assertThatIllegalArgumentException().isThrownBy(() ->
ValidationUtils.invokeValidator(emptyValidator, tb, null)); ValidationUtils.invokeValidator(emptyValidator, tb, null));
} }
@Test @Test
public void testInvokeValidatorSunnyDay() throws Exception { public void testInvokeValidatorSunnyDay() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = new SimpleErrors(tb);
ValidationUtils.invokeValidator(emptyValidator, tb, errors); ValidationUtils.invokeValidator(emptyValidator, tb, errors);
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY");
} }
@Test @Test
public void testValidationUtilsSunnyDay() throws Exception { public void testValidationUtilsSunnyDay() {
TestBean tb = new TestBean(""); TestBean tb = new TestBean("");
tb.setName(" "); tb.setName(" ");
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = emptyValidator.validateObject(tb);
emptyValidator.validate(tb, errors);
assertThat(errors.hasFieldErrors("name")).isFalse(); assertThat(errors.hasFieldErrors("name")).isFalse();
tb.setName("Roddy"); tb.setName("Roddy");
errors = new BeanPropertyBindingResult(tb, "tb"); errors = emptyValidator.validateObject(tb);
emptyValidator.validate(tb, errors);
assertThat(errors.hasFieldErrors("name")).isFalse(); assertThat(errors.hasFieldErrors("name")).isFalse();
// Should not raise exception
errors.failOnError(IllegalStateException::new);
} }
@Test @Test
public void testValidationUtilsNull() throws Exception { public void testValidationUtilsNull() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = emptyValidator.validateObject(tb);
emptyValidator.validate(tb, errors);
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY");
assertThatIllegalStateException()
.isThrownBy(() -> errors.failOnError(IllegalStateException::new))
.withMessageContaining("'name'").withMessageContaining("EMPTY");
} }
@Test @Test
public void testValidationUtilsEmpty() throws Exception { public void testValidationUtilsEmpty() {
TestBean tb = new TestBean(""); TestBean tb = new TestBean("");
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = emptyValidator.validateObject(tb);
emptyValidator.validate(tb, errors);
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY");
assertThatIllegalStateException()
.isThrownBy(() -> errors.failOnError(IllegalStateException::new))
.withMessageContaining("'name'").withMessageContaining("EMPTY");
} }
@Test @Test
public void testValidationUtilsEmptyVariants() { public void testValidationUtilsEmptyVariants() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = new SimpleErrors(tb);
ValidationUtils.rejectIfEmpty(errors, "name", "EMPTY_OR_WHITESPACE", new Object[] {"arg"}); ValidationUtils.rejectIfEmpty(errors, "name", "EMPTY_OR_WHITESPACE", new Object[] {"arg"});
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE");
assertThat(errors.getFieldError("name").getArguments()[0]).isEqualTo("arg"); assertThat(errors.getFieldError("name").getArguments()[0]).isEqualTo("arg");
errors = new BeanPropertyBindingResult(tb, "tb"); errors = new SimpleErrors(tb);
ValidationUtils.rejectIfEmpty(errors, "name", "EMPTY_OR_WHITESPACE", new Object[] {"arg"}, "msg"); ValidationUtils.rejectIfEmpty(errors, "name", "EMPTY_OR_WHITESPACE", new Object[] {"arg"}, "msg");
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE");
@ -113,33 +125,29 @@ public class ValidationUtilsTests {
} }
@Test @Test
public void testValidationUtilsEmptyOrWhitespace() throws Exception { public void testValidationUtilsEmptyOrWhitespace() {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
// Test null // Test null
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = emptyOrWhitespaceValidator.validateObject(tb);
emptyOrWhitespaceValidator.validate(tb, errors);
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE");
// Test empty String // Test empty String
tb.setName(""); tb.setName("");
errors = new BeanPropertyBindingResult(tb, "tb"); errors = emptyOrWhitespaceValidator.validateObject(tb);
emptyOrWhitespaceValidator.validate(tb, errors);
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE");
// Test whitespace String // Test whitespace String
tb.setName(" "); tb.setName(" ");
errors = new BeanPropertyBindingResult(tb, "tb"); errors = emptyOrWhitespaceValidator.validateObject(tb);
emptyOrWhitespaceValidator.validate(tb, errors);
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE");
// Test OK // Test OK
tb.setName("Roddy"); tb.setName("Roddy");
errors = new BeanPropertyBindingResult(tb, "tb"); errors = emptyOrWhitespaceValidator.validateObject(tb);
emptyOrWhitespaceValidator.validate(tb, errors);
assertThat(errors.hasFieldErrors("name")).isFalse(); assertThat(errors.hasFieldErrors("name")).isFalse();
} }
@ -148,13 +156,13 @@ public class ValidationUtilsTests {
TestBean tb = new TestBean(); TestBean tb = new TestBean();
tb.setName(" "); tb.setName(" ");
Errors errors = new BeanPropertyBindingResult(tb, "tb"); Errors errors = new SimpleErrors(tb);
ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "EMPTY_OR_WHITESPACE", new Object[] {"arg"}); ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "EMPTY_OR_WHITESPACE", new Object[] {"arg"});
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE");
assertThat(errors.getFieldError("name").getArguments()[0]).isEqualTo("arg"); assertThat(errors.getFieldError("name").getArguments()[0]).isEqualTo("arg");
errors = new BeanPropertyBindingResult(tb, "tb"); errors = new SimpleErrors(tb);
ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "EMPTY_OR_WHITESPACE", new Object[] {"arg"}, "msg"); ValidationUtils.rejectIfEmptyOrWhitespace(errors, "name", "EMPTY_OR_WHITESPACE", new Object[] {"arg"}, "msg");
assertThat(errors.hasFieldErrors("name")).isTrue(); assertThat(errors.hasFieldErrors("name")).isTrue();
assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE"); assertThat(errors.getFieldError("name").getCode()).isEqualTo("EMPTY_OR_WHITESPACE");