-
Notifications
You must be signed in to change notification settings - Fork 37.7k
/
MethodArgumentNotValidException.java
175 lines (150 loc) · 5.59 KB
/
MethodArgumentNotValidException.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
* Copyright 2002-2022 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.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;
import org.springframework.http.HttpStatus;
import org.springframework.http.HttpStatusCode;
import org.springframework.http.ProblemDetail;
import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.ErrorResponse;
/**
* Exception to be thrown when validation on an argument annotated with {@code @Valid} fails.
* Extends {@link BindException} as of 5.3.
*
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @since 3.1
*/
@SuppressWarnings("serial")
public class MethodArgumentNotValidException extends BindException implements ErrorResponse {
private final MethodParameter parameter;
private final ProblemDetail body;
/**
* Constructor for {@link MethodArgumentNotValidException}.
* @param parameter the parameter that failed validation
* @param bindingResult the results of the validation
*/
public MethodArgumentNotValidException(MethodParameter parameter, BindingResult bindingResult) {
super(bindingResult);
this.parameter = parameter;
this.body = ProblemDetail.forStatusAndDetail(getStatusCode(), "Invalid request content.");
}
@Override
public HttpStatusCode getStatusCode() {
return HttpStatus.BAD_REQUEST;
}
@Override
public ProblemDetail getBody() {
return this.body;
}
/**
* Return the method parameter that failed validation.
*/
public final MethodParameter getParameter() {
return this.parameter;
}
@Override
public String getMessage() {
StringBuilder sb = new StringBuilder("Validation failed for argument [")
.append(this.parameter.getParameterIndex()).append("] in ")
.append(this.parameter.getExecutable().toGenericString());
BindingResult bindingResult = getBindingResult();
if (bindingResult.getErrorCount() > 1) {
sb.append(" with ").append(bindingResult.getErrorCount()).append(" errors");
}
sb.append(": ");
for (ObjectError error : bindingResult.getAllErrors()) {
sb.append('[').append(error).append("] ");
}
return sb.toString();
}
@Override
public Object[] getDetailMessageArguments() {
return new Object[] {errorsToStringList(getGlobalErrors()), errorsToStringList(getFieldErrors())};
}
@Override
public Object[] getDetailMessageArguments(MessageSource messageSource, Locale locale) {
return new Object[] {
errorsToStringList(getGlobalErrors(), messageSource, locale),
errorsToStringList(getFieldErrors(), messageSource, locale)
};
}
/**
* Resolve global and field errors to messages with the given
* {@link MessageSource} and {@link Locale}.
* @return a Map with errors as key and resolves messages as value
* @since 6.0.3
*/
public Map<ObjectError, String> resolveErrorMessages(MessageSource messageSource, Locale locale) {
Map<ObjectError, String> map = new LinkedHashMap<>();
addMessages(map, getGlobalErrors(), messageSource, locale);
addMessages(map, getFieldErrors(), messageSource, locale);
return map;
}
private static void addMessages(
Map<ObjectError, String> map, List<? extends ObjectError> errors,
MessageSource messageSource, Locale locale) {
List<String> messages = errorsToStringList(errors, messageSource, locale);
for (int i = 0; i < errors.size(); i++) {
map.put(errors.get(i), messages.get(i));
}
}
/**
* Convert each given {@link ObjectError} to a String in single quotes, taking
* either the error's default message, or its error code.
* @since 6.0
*/
public static List<String> errorsToStringList(List<? extends ObjectError> errors) {
return errorsToStringList(errors, error ->
error.getDefaultMessage() != null ? error.getDefaultMessage() : error.getCode());
}
/**
* Variant of {@link #errorsToStringList(List)} that uses a
* {@link MessageSource} to resolve the message code of the error, or fall
* back on the error's default message.
* @since 6.0
*/
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));
}
private static List<String> errorsToStringList(
List<? extends ObjectError> errors, Function<ObjectError, String> formatter) {
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 result;
}
}