diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributes.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributes.java
index 18765f6a67..a618c45132 100644
--- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributes.java
+++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributes.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -20,6 +20,7 @@ import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Date;
import java.util.LinkedHashMap;
+import java.util.List;
import java.util.Map;
import java.util.Optional;
@@ -47,8 +48,8 @@ import org.springframework.web.server.ServerWebExchange;
* error - The error reason
* exception - The class name of the root exception (if configured)
* message - The exception message (if configured)
- * errors - Any {@link ObjectError}s from a {@link BindingResult} exception (if
- * configured)
+ * errors - Any {@link ObjectError}s from a {@link BindingResult} or
+ * {@link MethodValidationResult} exception (if configured)
* trace - The exception stack trace (if configured)
* path - The URL path when the exception was raised
* requestId - Unique ID associated with the current request
@@ -95,9 +96,8 @@ public class DefaultErrorAttributes implements ErrorAttributes {
HttpStatus errorStatus = determineHttpStatus(error, responseStatusAnnotation);
errorAttributes.put("status", errorStatus.value());
errorAttributes.put("error", errorStatus.getReasonPhrase());
- errorAttributes.put("message", determineMessage(error, responseStatusAnnotation));
errorAttributes.put("requestId", request.exchange().getRequest().getId());
- handleException(errorAttributes, determineException(error), includeStackTrace);
+ handleException(errorAttributes, error, responseStatusAnnotation, includeStackTrace);
return errorAttributes;
}
@@ -111,35 +111,6 @@ public class DefaultErrorAttributes implements ErrorAttributes {
return responseStatusAnnotation.getValue("code", HttpStatus.class).orElse(HttpStatus.INTERNAL_SERVER_ERROR);
}
- private String determineMessage(Throwable error, MergedAnnotation responseStatusAnnotation) {
- if (error instanceof BindingResult) {
- return error.getMessage();
- }
- if (error instanceof MethodValidationResult methodValidationResult) {
- long errorCount = methodValidationResult.getAllErrors()
- .stream()
- .filter(ObjectError.class::isInstance)
- .count();
- return "Validation failed for method: %s, with %d %s".formatted(methodValidationResult.getMethod(),
- errorCount, (errorCount > 1) ? "errors" : "error");
- }
- if (error instanceof ResponseStatusException responseStatusException) {
- return responseStatusException.getReason();
- }
- String reason = responseStatusAnnotation.getValue("reason", String.class).orElse("");
- if (StringUtils.hasText(reason)) {
- return reason;
- }
- return (error.getMessage() != null) ? error.getMessage() : "";
- }
-
- private Throwable determineException(Throwable error) {
- if (error instanceof ResponseStatusException) {
- return (error.getCause() != null) ? error.getCause() : error;
- }
- return error;
- }
-
private void addStackTrace(Map errorAttributes, Throwable error) {
StringWriter stackTrace = new StringWriter();
error.printStackTrace(new PrintWriter(stackTrace));
@@ -147,24 +118,46 @@ public class DefaultErrorAttributes implements ErrorAttributes {
errorAttributes.put("trace", stackTrace.toString());
}
- private void handleException(Map errorAttributes, Throwable error, boolean includeStackTrace) {
- errorAttributes.put("exception", error.getClass().getName());
+ private void handleException(Map errorAttributes, Throwable error,
+ MergedAnnotation responseStatusAnnotation, boolean includeStackTrace) {
+ Throwable exception;
+ if (error instanceof BindingResult bindingResult) {
+ errorAttributes.put("message", error.getMessage());
+ errorAttributes.put("errors", bindingResult.getAllErrors());
+ exception = error;
+ }
+ else if (error instanceof MethodValidationResult methodValidationResult) {
+ addMessageAndErrorsFromMethodValidationResult(errorAttributes, methodValidationResult);
+ exception = error;
+ }
+ else if (error instanceof ResponseStatusException responseStatusException) {
+ errorAttributes.put("message", responseStatusException.getReason());
+ exception = (responseStatusException.getCause() != null) ? responseStatusException.getCause() : error;
+ }
+ else {
+ exception = error;
+ String reason = responseStatusAnnotation.getValue("reason", String.class).orElse("");
+ String message = StringUtils.hasText(reason) ? reason : error.getMessage();
+ errorAttributes.put("message", (message != null) ? message : "");
+ }
+ errorAttributes.put("exception", exception.getClass().getName());
if (includeStackTrace) {
- addStackTrace(errorAttributes, error);
- }
- if (error instanceof BindingResult result) {
- if (result.hasErrors()) {
- errorAttributes.put("errors", result.getAllErrors());
- }
- }
- if (error instanceof MethodValidationResult result) {
- if (result.hasErrors()) {
- errorAttributes.put("errors",
- result.getAllErrors().stream().filter(ObjectError.class::isInstance).toList());
- }
+ addStackTrace(errorAttributes, exception);
}
}
+ private void addMessageAndErrorsFromMethodValidationResult(Map errorAttributes,
+ MethodValidationResult result) {
+ List errors = result.getAllErrors()
+ .stream()
+ .filter(ObjectError.class::isInstance)
+ .map(ObjectError.class::cast)
+ .toList();
+ errorAttributes.put("message",
+ "Validation failed for method='" + result.getMethod() + "'. Error count: " + errors.size());
+ errorAttributes.put("errors", errors);
+ }
+
@Override
public Throwable getError(ServerRequest request) {
Optional error = request.attribute(ERROR_INTERNAL_ATTRIBUTE);
diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributes.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributes.java
index 4fd891848a..1dccd96f28 100644
--- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributes.java
+++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributes.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -30,7 +30,6 @@ import jakarta.servlet.http.HttpServletResponse;
import org.springframework.boot.web.error.ErrorAttributeOptions;
import org.springframework.boot.web.error.ErrorAttributeOptions.Include;
-import org.springframework.context.MessageSourceResolvable;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
@@ -53,8 +52,8 @@ import org.springframework.web.servlet.ModelAndView;
* error - The error reason
* exception - The class name of the root exception (if configured)
* message - The exception message (if configured)
- * errors - Any {@link ObjectError}s from a {@link BindingResult} exception (if
- * configured)
+ * errors - Any {@link ObjectError}s from a {@link BindingResult} or
+ * {@link MethodValidationResult} exception (if configured)
* trace - The exception stack trace (if configured)
* path - The URL path when the exception was raised
*
@@ -149,20 +148,19 @@ public class DefaultErrorAttributes implements ErrorAttributes, HandlerException
}
private void addErrorMessage(Map errorAttributes, WebRequest webRequest, Throwable error) {
- MethodValidationResult methodValidationResult = extractMethodValidationResult(error);
- if (methodValidationResult != null) {
- addMethodValidationResultErrorMessage(errorAttributes, methodValidationResult);
+ BindingResult bindingResult = extractBindingResult(error);
+ if (bindingResult != null) {
+ addMessageAndErrorsFromBindingResult(errorAttributes, bindingResult);
}
else {
- BindingResult bindingResult = extractBindingResult(error);
- if (bindingResult != null) {
- addBindingResultErrorMessage(errorAttributes, bindingResult);
+ MethodValidationResult methodValidationResult = extractMethodValidationResult(error);
+ if (methodValidationResult != null) {
+ addMessageAndErrorsFromMethodValidationResult(errorAttributes, methodValidationResult);
}
else {
addExceptionErrorMessage(errorAttributes, webRequest, error);
}
}
-
}
private void addExceptionErrorMessage(Map errorAttributes, WebRequest webRequest, Throwable error) {
@@ -194,20 +192,24 @@ public class DefaultErrorAttributes implements ErrorAttributes, HandlerException
return "No message available";
}
- private void addBindingResultErrorMessage(Map errorAttributes, BindingResult result) {
- errorAttributes.put("message", "Validation failed for object='" + result.getObjectName() + "'. "
- + "Error count: " + result.getErrorCount());
- errorAttributes.put("errors", result.getAllErrors());
+ private void addMessageAndErrorsFromBindingResult(Map errorAttributes, BindingResult result) {
+ addMessageAndErrorsForValidationFailure(errorAttributes, "object='" + result.getObjectName() + "'",
+ result.getAllErrors());
}
- private void addMethodValidationResultErrorMessage(Map errorAttributes,
+ private void addMessageAndErrorsFromMethodValidationResult(Map errorAttributes,
MethodValidationResult result) {
- List errors = result.getAllErrors()
+ List errors = result.getAllErrors()
.stream()
.filter(ObjectError.class::isInstance)
+ .map(ObjectError.class::cast)
.toList();
- errorAttributes.put("message",
- "Validation failed for method='" + result.getMethod() + "'. " + "Error count: " + errors.size());
+ addMessageAndErrorsForValidationFailure(errorAttributes, "method='" + result.getMethod() + "'", errors);
+ }
+
+ private void addMessageAndErrorsForValidationFailure(Map errorAttributes, String validated,
+ List errors) {
+ errorAttributes.put("message", "Validation failed for " + validated + ". Error count: " + errors.size());
errorAttributes.put("errors", errors);
}
diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributesTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributesTests.java
index 75baf29c65..797dbcf897 100644
--- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributesTests.java
+++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributesTests.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -255,36 +255,16 @@ class DefaultErrorAttributesTests {
Object target = "test";
Method method = String.class.getMethod("substring", int.class);
MethodParameter parameter = new MethodParameter(method, 0);
- MethodValidationResult methodValidationResult = new MethodValidationResult() {
-
- @Override
- public Object getTarget() {
- return target;
- }
-
- @Override
- public Method getMethod() {
- return method;
- }
-
- @Override
- public boolean isForReturnValue() {
- return false;
- }
-
- @Override
- public List getAllValidationResults() {
- return List.of(new ParameterValidationResult(parameter, -1,
- List.of(new ObjectError("beginIndex", "beginIndex is negative")), null, null, null));
- }
- };
+ MethodValidationResult methodValidationResult = MethodValidationResult.create(target, method,
+ List.of(new ParameterValidationResult(parameter, -1,
+ List.of(new ObjectError("beginIndex", "beginIndex is negative")), null, null, null)));
HandlerMethodValidationException ex = new HandlerMethodValidationException(methodValidationResult);
MockServerHttpRequest request = MockServerHttpRequest.get("/test").build();
Map attributes = this.errorAttributes.getErrorAttributes(buildServerRequest(request, ex),
ErrorAttributeOptions.of(Include.MESSAGE, Include.BINDING_ERRORS));
assertThat(attributes.get("message")).asString()
.isEqualTo(
- "Validation failed for method: public java.lang.String java.lang.String.substring(int), with 1 error");
+ "Validation failed for method='public java.lang.String java.lang.String.substring(int)'. Error count: 1");
assertThat(attributes).containsEntry("errors",
methodValidationResult.getAllErrors().stream().filter(ObjectError.class::isInstance).toList());
}
diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributesTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributesTests.java
index a930bba9ca..9ffa5cbffc 100644
--- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributesTests.java
+++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributesTests.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -21,7 +21,6 @@ import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.Map;
-import java.util.function.Supplier;
import jakarta.servlet.ServletException;
import org.junit.jupiter.api.Test;
@@ -213,42 +212,22 @@ class DefaultErrorAttributesTests {
Object target = "test";
Method method = ReflectionUtils.findMethod(String.class, "substring", int.class);
MethodParameter parameter = new MethodParameter(method, 0);
- MethodValidationResult methodValidationResult = new MethodValidationResult() {
-
- @Override
- public Object getTarget() {
- return target;
- }
-
- @Override
- public Method getMethod() {
- return method;
- }
-
- @Override
- public boolean isForReturnValue() {
- return false;
- }
-
- @Override
- public List getAllValidationResults() {
- return List.of(new ParameterValidationResult(parameter, -1,
- List.of(new ObjectError("beginIndex", "beginIndex is negative")), null, null, null));
- }
- };
+ MethodValidationResult methodValidationResult = MethodValidationResult.create(target, method,
+ List.of(new ParameterValidationResult(parameter, -1,
+ List.of(new ObjectError("beginIndex", "beginIndex is negative")), null, null, null)));
HandlerMethodValidationException ex = new HandlerMethodValidationException(methodValidationResult);
- testErrorsSupplier(methodValidationResult::getAllErrors,
+ testErrors(methodValidationResult.getAllErrors(),
"Validation failed for method='public java.lang.String java.lang.String.substring(int)'. Error count: 1",
ex, ErrorAttributeOptions.of(Include.MESSAGE, Include.BINDING_ERRORS));
}
private void testBindingResult(BindingResult bindingResult, Exception ex, ErrorAttributeOptions options) {
- testErrorsSupplier(bindingResult::getAllErrors, "Validation failed for object='objectName'. Error count: 1", ex,
+ testErrors(bindingResult.getAllErrors(), "Validation failed for object='objectName'. Error count: 1", ex,
options);
}
- private void testErrorsSupplier(Supplier> errorsSupplier,
- String expectedMessage, Exception ex, ErrorAttributeOptions options) {
+ private void testErrors(List errors, String expectedMessage, Exception ex,
+ ErrorAttributeOptions options) {
this.request.setAttribute("jakarta.servlet.error.exception", ex);
Map attributes = this.errorAttributes.getErrorAttributes(this.webRequest, options);
if (options.isIncluded(Include.MESSAGE)) {
@@ -258,7 +237,7 @@ class DefaultErrorAttributesTests {
assertThat(attributes).doesNotContainKey("message");
}
if (options.isIncluded(Include.BINDING_ERRORS)) {
- assertThat(attributes).containsEntry("errors", errorsSupplier.get());
+ assertThat(attributes).containsEntry("errors", errors);
}
else {
assertThat(attributes).doesNotContainKey("errors");