Skip to content

Commit e0f3ea4

Browse files
quaffquaff
committed
Include errors from HandlerMethodValidationException for DefaultErrorAttributes
Fix GH-39858
1 parent 8b4f411 commit e0f3ea4

File tree

4 files changed

+141
-7
lines changed

4 files changed

+141
-7
lines changed

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributes.java

+16
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
import org.springframework.util.StringUtils;
3333
import org.springframework.validation.BindingResult;
3434
import org.springframework.validation.ObjectError;
35+
import org.springframework.validation.method.MethodValidationResult;
3536
import org.springframework.web.bind.annotation.ResponseStatus;
3637
import org.springframework.web.reactive.function.server.ServerRequest;
3738
import org.springframework.web.server.ResponseStatusException;
@@ -58,6 +59,7 @@
5859
* @author Michele Mancioppi
5960
* @author Scott Frederick
6061
* @author Moritz Halbritter
62+
* @author Yanming Zhou
6163
* @since 2.0.0
6264
* @see ErrorAttributes
6365
*/
@@ -117,6 +119,14 @@ private String determineMessage(Throwable error, MergedAnnotation<ResponseStatus
117119
if (error instanceof BindingResult) {
118120
return error.getMessage();
119121
}
122+
if (error instanceof MethodValidationResult methodValidationResult) {
123+
long errorCount = methodValidationResult.getAllErrors()
124+
.stream()
125+
.filter(ObjectError.class::isInstance)
126+
.count();
127+
return "Validation failed for method: %s, with %d %s".formatted(methodValidationResult.getMethod(),
128+
errorCount, (errorCount > 2) ? "errors" : "error");
129+
}
120130
if (error instanceof ResponseStatusException responseStatusException) {
121131
return responseStatusException.getReason();
122132
}
@@ -151,6 +161,12 @@ private void handleException(Map<String, Object> errorAttributes, Throwable erro
151161
errorAttributes.put("errors", result.getAllErrors());
152162
}
153163
}
164+
if (error instanceof MethodValidationResult result) {
165+
if (result.hasErrors()) {
166+
errorAttributes.put("errors",
167+
result.getAllErrors().stream().filter(ObjectError.class::isInstance).toList());
168+
}
169+
}
154170
}
155171

156172
@Override

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributes.java

+33-4
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import java.io.StringWriter;
2121
import java.util.Date;
2222
import java.util.LinkedHashMap;
23+
import java.util.List;
2324
import java.util.Map;
2425

2526
import jakarta.servlet.RequestDispatcher;
@@ -29,13 +30,15 @@
2930

3031
import org.springframework.boot.web.error.ErrorAttributeOptions;
3132
import org.springframework.boot.web.error.ErrorAttributeOptions.Include;
33+
import org.springframework.context.MessageSourceResolvable;
3234
import org.springframework.core.Ordered;
3335
import org.springframework.core.annotation.Order;
3436
import org.springframework.http.HttpStatus;
3537
import org.springframework.util.ObjectUtils;
3638
import org.springframework.util.StringUtils;
3739
import org.springframework.validation.BindingResult;
3840
import org.springframework.validation.ObjectError;
41+
import org.springframework.validation.method.MethodValidationResult;
3942
import org.springframework.web.context.request.RequestAttributes;
4043
import org.springframework.web.context.request.WebRequest;
4144
import org.springframework.web.servlet.HandlerExceptionResolver;
@@ -62,6 +65,7 @@
6265
* @author Vedran Pavic
6366
* @author Scott Frederick
6467
* @author Moritz Halbritter
68+
* @author Yanming Zhou
6569
* @since 2.0.0
6670
* @see ErrorAttributes
6771
*/
@@ -149,13 +153,20 @@ private void addErrorDetails(Map<String, Object> errorAttributes, WebRequest web
149153
}
150154

151155
private void addErrorMessage(Map<String, Object> errorAttributes, WebRequest webRequest, Throwable error) {
152-
BindingResult result = extractBindingResult(error);
153-
if (result == null) {
154-
addExceptionErrorMessage(errorAttributes, webRequest, error);
156+
MethodValidationResult methodValidationResult = extractMethodValidationResult(error);
157+
if (methodValidationResult != null) {
158+
addMethodValidationResultErrorMessage(errorAttributes, methodValidationResult);
155159
}
156160
else {
157-
addBindingResultErrorMessage(errorAttributes, result);
161+
BindingResult bindingResult = extractBindingResult(error);
162+
if (bindingResult != null) {
163+
addBindingResultErrorMessage(errorAttributes, bindingResult);
164+
}
165+
else {
166+
addExceptionErrorMessage(errorAttributes, webRequest, error);
167+
}
158168
}
169+
159170
}
160171

161172
private void addExceptionErrorMessage(Map<String, Object> errorAttributes, WebRequest webRequest, Throwable error) {
@@ -193,13 +204,31 @@ private void addBindingResultErrorMessage(Map<String, Object> errorAttributes, B
193204
errorAttributes.put("errors", result.getAllErrors());
194205
}
195206

207+
private void addMethodValidationResultErrorMessage(Map<String, Object> errorAttributes,
208+
MethodValidationResult result) {
209+
List<? extends MessageSourceResolvable> errors = result.getAllErrors()
210+
.stream()
211+
.filter(ObjectError.class::isInstance)
212+
.toList();
213+
errorAttributes.put("message",
214+
"Validation failed for method='" + result.getMethod() + "'. " + "Error count: " + errors.size());
215+
errorAttributes.put("errors", errors);
216+
}
217+
196218
private BindingResult extractBindingResult(Throwable error) {
197219
if (error instanceof BindingResult bindingResult) {
198220
return bindingResult;
199221
}
200222
return null;
201223
}
202224

225+
private MethodValidationResult extractMethodValidationResult(Throwable error) {
226+
if (error instanceof MethodValidationResult methodValidationResult) {
227+
return methodValidationResult;
228+
}
229+
return null;
230+
}
231+
203232
private void addStackTrace(Map<String, Object> errorAttributes, Throwable error) {
204233
StringWriter stackTrace = new StringWriter();
205234
error.printStackTrace(new PrintWriter(stackTrace));

‎spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/reactive/error/DefaultErrorAttributesTests.java

+43
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,11 @@
3535
import org.springframework.validation.BindingResult;
3636
import org.springframework.validation.MapBindingResult;
3737
import org.springframework.validation.ObjectError;
38+
import org.springframework.validation.method.MethodValidationResult;
39+
import org.springframework.validation.method.ParameterValidationResult;
3840
import org.springframework.web.bind.annotation.ResponseStatus;
3941
import org.springframework.web.bind.support.WebExchangeBindException;
42+
import org.springframework.web.method.annotation.HandlerMethodValidationException;
4043
import org.springframework.web.reactive.function.server.ServerRequest;
4144
import org.springframework.web.server.ResponseStatusException;
4245
import org.springframework.web.server.ServerWebExchange;
@@ -51,6 +54,7 @@
5154
* @author Stephane Nicoll
5255
* @author Scott Frederick
5356
* @author Moritz Halbritter
57+
* @author Yanming Zhou
5458
*/
5559
class DefaultErrorAttributesTests {
5660

@@ -271,6 +275,45 @@ void extractBindingResultErrors() throws Exception {
271275
assertThat(attributes).containsEntry("errors", bindingResult.getAllErrors());
272276
}
273277

278+
@Test
279+
void extractMethodValidationResultErrors() throws Exception {
280+
Object target = "test";
281+
Method method = String.class.getMethod("substring", int.class);
282+
MethodParameter parameter = new MethodParameter(method, 0);
283+
MethodValidationResult methodValidationResult = new MethodValidationResult() {
284+
285+
@Override
286+
public Object getTarget() {
287+
return target;
288+
}
289+
290+
@Override
291+
public Method getMethod() {
292+
return method;
293+
}
294+
295+
@Override
296+
public boolean isForReturnValue() {
297+
return false;
298+
}
299+
300+
@Override
301+
public List<ParameterValidationResult> getAllValidationResults() {
302+
return List.of(new ParameterValidationResult(parameter, -1,
303+
List.of(new ObjectError("beginIndex", "beginIndex is negative")), null, null, null));
304+
}
305+
};
306+
HandlerMethodValidationException ex = new HandlerMethodValidationException(methodValidationResult);
307+
MockServerHttpRequest request = MockServerHttpRequest.get("/test").build();
308+
Map<String, Object> attributes = this.errorAttributes.getErrorAttributes(buildServerRequest(request, ex),
309+
ErrorAttributeOptions.of(Include.MESSAGE, Include.BINDING_ERRORS));
310+
assertThat(attributes.get("message")).asString()
311+
.isEqualTo(
312+
"Validation failed for method: public java.lang.String java.lang.String.substring(int), with 1 error");
313+
assertThat(attributes).containsEntry("errors",
314+
methodValidationResult.getAllErrors().stream().filter(ObjectError.class::isInstance).toList());
315+
}
316+
274317
@Test
275318
void extractBindingResultErrorsExcludeMessageAndErrors() throws Exception {
276319
Method method = getClass().getDeclaredMethod("method", String.class);

‎spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/error/DefaultErrorAttributesTests.java

+49-3
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,16 @@
1919
import java.lang.reflect.Method;
2020
import java.util.Collections;
2121
import java.util.Date;
22+
import java.util.List;
2223
import java.util.Map;
24+
import java.util.function.Supplier;
2325

2426
import jakarta.servlet.ServletException;
2527
import org.junit.jupiter.api.Test;
2628

2729
import org.springframework.boot.web.error.ErrorAttributeOptions;
2830
import org.springframework.boot.web.error.ErrorAttributeOptions.Include;
31+
import org.springframework.context.MessageSourceResolvable;
2932
import org.springframework.core.MethodParameter;
3033
import org.springframework.http.HttpStatus;
3134
import org.springframework.mock.web.MockHttpServletRequest;
@@ -34,9 +37,12 @@
3437
import org.springframework.validation.BindingResult;
3538
import org.springframework.validation.MapBindingResult;
3639
import org.springframework.validation.ObjectError;
40+
import org.springframework.validation.method.MethodValidationResult;
41+
import org.springframework.validation.method.ParameterValidationResult;
3742
import org.springframework.web.bind.MethodArgumentNotValidException;
3843
import org.springframework.web.context.request.ServletWebRequest;
3944
import org.springframework.web.context.request.WebRequest;
45+
import org.springframework.web.method.annotation.HandlerMethodValidationException;
4046
import org.springframework.web.servlet.ModelAndView;
4147

4248
import static org.assertj.core.api.Assertions.assertThat;
@@ -48,6 +54,7 @@
4854
* @author Vedran Pavic
4955
* @author Scott Frederick
5056
* @author Moritz Halbritter
57+
* @author Yanming Zhou
5158
*/
5259
class DefaultErrorAttributesTests {
5360

@@ -202,18 +209,57 @@ void withMethodArgumentNotValidExceptionBindingErrors() {
202209
testBindingResult(bindingResult, ex, ErrorAttributeOptions.of(Include.MESSAGE, Include.BINDING_ERRORS));
203210
}
204211

212+
@Test
213+
void withHandlerMethodValidationExceptionBindingErrors() {
214+
Object target = "test";
215+
Method method = ReflectionUtils.findMethod(String.class, "substring", int.class);
216+
MethodParameter parameter = new MethodParameter(method, 0);
217+
MethodValidationResult methodValidationResult = new MethodValidationResult() {
218+
219+
@Override
220+
public Object getTarget() {
221+
return target;
222+
}
223+
224+
@Override
225+
public Method getMethod() {
226+
return method;
227+
}
228+
229+
@Override
230+
public boolean isForReturnValue() {
231+
return false;
232+
}
233+
234+
@Override
235+
public List<ParameterValidationResult> getAllValidationResults() {
236+
return List.of(new ParameterValidationResult(parameter, -1,
237+
List.of(new ObjectError("beginIndex", "beginIndex is negative")), null, null, null));
238+
}
239+
};
240+
HandlerMethodValidationException ex = new HandlerMethodValidationException(methodValidationResult);
241+
testErrorsSupplier(methodValidationResult::getAllErrors,
242+
"Validation failed for method='public java.lang.String java.lang.String.substring(int)'. Error count: 1",
243+
ex, ErrorAttributeOptions.of(Include.MESSAGE, Include.BINDING_ERRORS));
244+
}
245+
205246
private void testBindingResult(BindingResult bindingResult, Exception ex, ErrorAttributeOptions options) {
247+
testErrorsSupplier(bindingResult::getAllErrors, "Validation failed for object='objectName'. Error count: 1", ex,
248+
options);
249+
}
250+
251+
private void testErrorsSupplier(Supplier<List<? extends MessageSourceResolvable>> errorsSupplier,
252+
String expectedMessage, Exception ex, ErrorAttributeOptions options) {
206253
this.request.setAttribute("jakarta.servlet.error.exception", ex);
207254
Map<String, Object> attributes = this.errorAttributes.getErrorAttributes(this.webRequest, options);
208255
if (options.isIncluded(Include.MESSAGE)) {
209-
assertThat(attributes).containsEntry("message",
210-
"Validation failed for object='objectName'. Error count: 1");
256+
assertThat(attributes).containsEntry("message", expectedMessage);
211257
}
212258
else {
213259
assertThat(attributes).doesNotContainKey("message");
214260
}
215261
if (options.isIncluded(Include.BINDING_ERRORS)) {
216-
assertThat(attributes).containsEntry("errors", bindingResult.getAllErrors());
262+
assertThat(attributes).containsEntry("errors", errorsSupplier.get());
217263
}
218264
else {
219265
assertThat(attributes).doesNotContainKey("errors");

0 commit comments

Comments
 (0)