Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update error format in MethodArgumentNotValidException

Browse Source 
1. Remove list markers (those can be provided in message).
2. Use ", and " between errors for readability.
3. Remove single quotes around errors.
4. If MessageSource is provided, use resolved message as is since in
that case applications have full control over each message.

Closes gh-30198
This commit is contained in:
rstoyanchev
2023-06-13 07:46:05 +01:00
parent 48548b29d6
commit 96c494c6ad
5 changed files with 149 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
spring-web/src/main/java/org/springframework/web/bind/MethodArgumentNotValidException.java
View File

@@ -16,12 +16,10 @@
package org.springframework.web.bind;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.function.Function;
import org.springframework.context.MessageSource;
import org.springframework.core.MethodParameter;
@@ -29,6 +27,7 @@ import org.springframework.http.HttpStatus;
import org.springframework.http.HttpStatusCode;
import org.springframework.http.ProblemDetail;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
@@ -100,21 +99,26 @@ public class MethodArgumentNotValidException extends BindException implements Er
@Override
public Object[] getDetailMessageArguments() {
return new Object[] {errorsToStringList(getGlobalErrors()), errorsToStringList(getFieldErrors())};
return new Object[] {
join(formatErrors(getGlobalErrors(), null, null)),
join(formatErrors(getFieldErrors(), null, null))};
}
@Override
public Object[] getDetailMessageArguments(MessageSource messageSource, Locale locale) {
return new Object[] {
errorsToStringList(getGlobalErrors(), messageSource, locale),
errorsToStringList(getFieldErrors(), messageSource, locale)
};
join(formatErrors(getGlobalErrors(), messageSource, locale)),
join(formatErrors(getFieldErrors(), messageSource, locale))};
}
private static String join(List<String> errors) {
return String.join(", and ", errors);
}
/**
* Resolve global and field errors to messages with the given
* {@link MessageSource} and {@link Locale}.
* @return a Map with errors as key and resolved messages as value
* @return a Map with errors as keys and resolved messages as values
* @since 6.0.3
*/
public Map<ObjectError, String> resolveErrorMessages(MessageSource messageSource, Locale locale) {
@@ -141,8 +145,7 @@ public class MethodArgumentNotValidException extends BindException implements Er
* @since 6.0
*/
public static List<String> errorsToStringList(List<? extends ObjectError> errors) {
return errorsToStringList(errors, error ->
error.getDefaultMessage() != null ? error.getDefaultMessage() : error.getCode());
return formatErrors(errors, null, null);
}
/**
@@ -154,23 +157,28 @@ public class MethodArgumentNotValidException extends BindException implements Er
public static List<String> errorsToStringList(
List<? extends ObjectError> errors, @Nullable MessageSource source, Locale locale) {
return (source != null ?
errorsToStringList(errors, error -> source.getMessage(error, locale)) :
errorsToStringList(errors));
return formatErrors(errors, source, locale);
}
private static List<String> errorsToStringList(
List<? extends ObjectError> errors, Function<ObjectError, String> formatter) {
public static List<String> formatErrors(
List<? extends ObjectError> errors, @Nullable MessageSource messageSource, @Nullable Locale locale) {
List<String> result = new ArrayList<>(errors.size());
for (ObjectError error : errors) {
String value = formatter.apply(error);
if (StringUtils.hasText(value)) {
result.add(error instanceof FieldError fieldError ?
fieldError.getField() + ": '" + value + "'" : "'" + value + "'");
}
return errors.stream()
.map(error -> formatError(error, messageSource, locale))
.filter(StringUtils::hasText)
.toList();
}
private static String formatError(
ObjectError error, @Nullable MessageSource messageSource, @Nullable Locale locale) {
if (messageSource != null) {
Assert.notNull(locale, "Expected MessageSource and locale");
return messageSource.getMessage(error, locale);
}
return result;
String field = (error instanceof FieldError fieldError ? fieldError.getField() + ": " : "");
String message = (error.getDefaultMessage() != null ? error.getDefaultMessage() : error.getCode());
return (field + message);
}
}

14
spring-web/src/main/java/org/springframework/web/bind/support/WebExchangeBindException.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* 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.
@@ -56,11 +56,13 @@ public class WebExchangeBindException extends ServerWebInputException implements
private static Object[] initMessageDetailArguments(BindingResult bindingResult) {
return new Object[] {
MethodArgumentNotValidException.errorsToStringList(bindingResult.getGlobalErrors()),
MethodArgumentNotValidException.errorsToStringList(bindingResult.getFieldErrors())
};
join(MethodArgumentNotValidException.errorsToStringList(bindingResult.getGlobalErrors())),
join(MethodArgumentNotValidException.errorsToStringList(bindingResult.getFieldErrors()))};
}
private static String join(List<String> errors) {
return String.join(", and ", errors);
}
/**
* Return the BindingResult that this BindException wraps.
@@ -303,8 +305,8 @@ public class WebExchangeBindException extends ServerWebInputException implements
@Override
public Object[] getDetailMessageArguments(MessageSource source, Locale locale) {
return new Object[] {
MethodArgumentNotValidException.errorsToStringList(getGlobalErrors(), source, locale),
MethodArgumentNotValidException.errorsToStringList(getFieldErrors(), source, locale)
join(MethodArgumentNotValidException.errorsToStringList(getGlobalErrors(), source, locale)),
join(MethodArgumentNotValidException.errorsToStringList(getFieldErrors(), source, locale))
};
}