Use MessageSource to interpolate bean validation messages
See gh-17530pull/27538/head
Dmytro Nosan
5 years ago
committed by
Andy Wilkinson
parent
ea9b155776
commit
bbb8367afb
@ -0,0 +1,105 @@
|
||||
/*
|
||||
* Copyright 2012-2019 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.boot.validation;
|
||||
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.Set;
|
||||
import java.util.function.Function;
|
||||
|
||||
/**
|
||||
* Utility class to extract message parameters ({@code {param}}) from the message. These
|
||||
* parameters can be substituted for supplied values.
|
||||
*
|
||||
* @author Dmytro Nosan
|
||||
*/
|
||||
final class MessageParameterPlaceholderHelper {
|
||||
|
||||
private static final char PREFIX = '{';
|
||||
|
||||
private static final char SUFFIX = '}';
|
||||
|
||||
private static final char ESCAPE = '\\';
|
||||
|
||||
/**
|
||||
* Replaces all message parameters using the given {@code parameterResolver}.
|
||||
* <p>
|
||||
* If returned value has other message parameters, they will be replaced recursively
|
||||
* until no replacement is performed;
|
||||
* <p>
|
||||
* Resolver can return {@code null} to signal that no further actions need to be done
|
||||
* and replacement should be omitted;
|
||||
* <p>
|
||||
* The message parameter can be escaped by the {@code '\'} symbol;
|
||||
* @param message the value containing the parameters to be replaced
|
||||
* @param parameterResolver the {@code parameterResolver} to use for replacement
|
||||
* @return the replaced message
|
||||
*/
|
||||
String replaceParameters(String message, Function<String, String> parameterResolver) {
|
||||
return replaceParameters(message, parameterResolver, new LinkedHashSet<>(4));
|
||||
}
|
||||
|
||||
private static String replaceParameters(String message, Function<String, String> parameterResolver,
|
||||
Set<String> visitedParameters) {
|
||||
StringBuilder buf = new StringBuilder(message);
|
||||
int parentheses = 0;
|
||||
int startIndex = -1;
|
||||
int endIndex = -1;
|
||||
for (int i = 0; i < buf.length(); i++) {
|
||||
if (buf.charAt(i) == ESCAPE) {
|
||||
i++;
|
||||
}
|
||||
else if (buf.charAt(i) == PREFIX) {
|
||||
if (startIndex == -1) {
|
||||
startIndex = i;
|
||||
}
|
||||
parentheses++;
|
||||
}
|
||||
else if (buf.charAt(i) == SUFFIX) {
|
||||
if (parentheses > 0) {
|
||||
parentheses--;
|
||||
}
|
||||
endIndex = i;
|
||||
}
|
||||
if (parentheses == 0 && startIndex < endIndex) {
|
||||
String parameter = buf.substring(startIndex + 1, endIndex);
|
||||
if (!visitedParameters.add(parameter)) {
|
||||
throw new IllegalArgumentException("Circular reference '{" + parameter + "}'");
|
||||
}
|
||||
String value = replaceParameter(parameter, parameterResolver, visitedParameters);
|
||||
if (value != null) {
|
||||
buf.replace(startIndex, endIndex + 1, value);
|
||||
i = startIndex + value.length() - 1;
|
||||
}
|
||||
visitedParameters.remove(parameter);
|
||||
startIndex = -1;
|
||||
endIndex = -1;
|
||||
}
|
||||
}
|
||||
return buf.toString();
|
||||
}
|
||||
|
||||
private static String replaceParameter(String parameter, Function<String, String> parameterResolver,
|
||||
Set<String> visitedParameters) {
|
||||
parameter = replaceParameters(parameter, parameterResolver, visitedParameters);
|
||||
String value = parameterResolver.apply(parameter);
|
||||
if (value != null) {
|
||||
return replaceParameters(value, parameterResolver, visitedParameters);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,57 @@
|
||||
/*
|
||||
* Copyright 2012-2019 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.boot.validation;
|
||||
|
||||
import java.util.Locale;
|
||||
|
||||
import javax.validation.MessageInterpolator;
|
||||
|
||||
import org.springframework.context.MessageSource;
|
||||
import org.springframework.context.i18n.LocaleContextHolder;
|
||||
|
||||
/**
|
||||
* Resolves any message parameters via {@link MessageSource} and then interpolates a
|
||||
* message using the underlying {@link MessageInterpolator}.
|
||||
*
|
||||
* @author Dmytro Nosan
|
||||
*/
|
||||
class MessageSourceInterpolatorDelegate implements MessageInterpolator {
|
||||
|
||||
private static final MessageParameterPlaceholderHelper helper = new MessageParameterPlaceholderHelper();
|
||||
|
||||
private final MessageSource messageSource;
|
||||
|
||||
private final MessageInterpolator messageInterpolator;
|
||||
|
||||
MessageSourceInterpolatorDelegate(MessageSource messageSource, MessageInterpolator messageInterpolator) {
|
||||
this.messageSource = messageSource;
|
||||
this.messageInterpolator = messageInterpolator;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String interpolate(String messageTemplate, Context context) {
|
||||
return interpolate(messageTemplate, context, LocaleContextHolder.getLocale());
|
||||
}
|
||||
|
||||
@Override
|
||||
public String interpolate(String messageTemplate, Context context, Locale locale) {
|
||||
String message = helper.replaceParameters(messageTemplate,
|
||||
(parameter) -> this.messageSource.getMessage(parameter, null, null, locale));
|
||||
return this.messageInterpolator.interpolate(message, context, locale);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,100 @@
|
||||
/*
|
||||
* Copyright 2012-2019 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.boot.validation;
|
||||
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.Map;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
|
||||
|
||||
/**
|
||||
* Tests for {@link MessageParameterPlaceholderHelper}.
|
||||
*
|
||||
* @author Dmytro Nosan
|
||||
*/
|
||||
class MessageParameterPlaceholderHelperTests {
|
||||
|
||||
private final MessageParameterPlaceholderHelper resolver = new MessageParameterPlaceholderHelper();
|
||||
|
||||
@Test
|
||||
void recursionInParameters() {
|
||||
Map<String, String> props = new LinkedHashMap<>();
|
||||
props.put("a", "{b}");
|
||||
props.put("b", "{c}");
|
||||
props.put("c", "{a}");
|
||||
assertThatIllegalArgumentException().isThrownBy(() -> this.resolver.replaceParameters("{a}", props::get))
|
||||
.withMessage("Circular reference '{a}'");
|
||||
}
|
||||
|
||||
@Test
|
||||
void replaceParameters() {
|
||||
Map<String, String> props = new LinkedHashMap<>();
|
||||
props.put("foo", "fooValue");
|
||||
props.put("bar", "");
|
||||
assertThat(this.resolver.replaceParameters("{foo}{bar}", props::get)).isEqualTo("fooValue");
|
||||
}
|
||||
|
||||
@Test
|
||||
void replaceNestedParameters() {
|
||||
Map<String, String> props = new LinkedHashMap<>();
|
||||
props.put("top", "{child}+{child}");
|
||||
props.put("child", "{{differentiator}.grandchild}");
|
||||
props.put("differentiator", "first");
|
||||
props.put("first.grandchild", "actualValue");
|
||||
assertThat(this.resolver.replaceParameters("{top}", props::get)).isEqualTo("actualValue+actualValue");
|
||||
}
|
||||
|
||||
@Test
|
||||
void unresolvedParameters() {
|
||||
Map<String, String> props = new LinkedHashMap<>();
|
||||
props.put("top", "{child}+{child}");
|
||||
assertThat(this.resolver.replaceParameters("{foo}{top}{bar}", props::get))
|
||||
.isEqualTo("{foo}{child}+{child}{bar}");
|
||||
}
|
||||
|
||||
@Test
|
||||
void unbalancedParentheses() {
|
||||
Map<String, String> props = new LinkedHashMap<>();
|
||||
props.put("top", "topValue");
|
||||
assertThat(this.resolver.replaceParameters("\\{top}", props::get)).isEqualTo("\\{top}");
|
||||
assertThat(this.resolver.replaceParameters("{top\\}", props::get)).isEqualTo("{top\\}");
|
||||
assertThat(this.resolver.replaceParameters("{{top}", props::get)).isEqualTo("{{top}");
|
||||
assertThat(this.resolver.replaceParameters("{top}}", props::get)).isEqualTo("topValue}");
|
||||
}
|
||||
|
||||
@Test
|
||||
void resolveEscapeParameters() {
|
||||
Map<String, String> props = new LinkedHashMap<>();
|
||||
props.put("foo", "fooValue");
|
||||
props.put("bar", "\\{foo}");
|
||||
props.put("bazz\\}", "bazzValue");
|
||||
assertThat(this.resolver.replaceParameters("{foo}", props::get)).isEqualTo("fooValue");
|
||||
assertThat(this.resolver.replaceParameters("{foo}\\a", props::get)).isEqualTo("fooValue\\a");
|
||||
assertThat(this.resolver.replaceParameters("\\\\{foo}", props::get)).isEqualTo("\\\\fooValue");
|
||||
assertThat(this.resolver.replaceParameters("\\\\\\{foo}", props::get)).isEqualTo("\\\\\\{foo}");
|
||||
assertThat(this.resolver.replaceParameters("\\{foo}", props::get)).isEqualTo("\\{foo}");
|
||||
assertThat(this.resolver.replaceParameters("{foo\\}", props::get)).isEqualTo("{foo\\}");
|
||||
assertThat(this.resolver.replaceParameters("\\{foo\\}", props::get)).isEqualTo("\\{foo\\}");
|
||||
assertThat(this.resolver.replaceParameters("{foo}\\", props::get)).isEqualTo("fooValue\\");
|
||||
assertThat(this.resolver.replaceParameters("{bar}", props::get)).isEqualTo("\\{foo}");
|
||||
assertThat(this.resolver.replaceParameters("{bazz\\}}", props::get)).isEqualTo("bazzValue");
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,133 @@
|
||||
/*
|
||||
* Copyright 2012-2019 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.boot.validation;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Set;
|
||||
|
||||
import javax.validation.ConstraintViolation;
|
||||
import javax.validation.Validator;
|
||||
import javax.validation.constraints.NotNull;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.context.i18n.LocaleContextHolder;
|
||||
import org.springframework.context.support.StaticMessageSource;
|
||||
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.assertThatThrownBy;
|
||||
|
||||
/**
|
||||
* Tests for {@link MessageSourceInterpolatorDelegate}.
|
||||
*
|
||||
* @author Dmytro Nosan
|
||||
*/
|
||||
class MessageSourceInterpolatorDelegateTests {
|
||||
|
||||
private final Validator validator = buildValidator();
|
||||
|
||||
@NotNull(message = "{null}")
|
||||
private String nullable;
|
||||
|
||||
@NotNull(message = "{blank}")
|
||||
private String blank;
|
||||
|
||||
@NotNull(message = "{unknown}")
|
||||
private String unknown;
|
||||
|
||||
@NotNull(message = "{recursion}")
|
||||
private String recursion;
|
||||
|
||||
@NotNull(message = "\\{null}")
|
||||
private String escapePrefix;
|
||||
|
||||
@NotNull(message = "{null\\}")
|
||||
private String escapeSuffix;
|
||||
|
||||
@NotNull(message = "\\{null\\}")
|
||||
private String escapePrefixSuffix;
|
||||
|
||||
@NotNull(message = "\\\\{null}")
|
||||
private String escapeEscape;
|
||||
|
||||
@Test
|
||||
void nullable() {
|
||||
assertThat(validate("nullable")).containsExactly("must not be null");
|
||||
}
|
||||
|
||||
@Test
|
||||
void blank() {
|
||||
assertThat(validate("blank")).containsExactly("must not be null or must not be blank");
|
||||
}
|
||||
|
||||
@Test
|
||||
void recursion() {
|
||||
assertThatThrownBy(() -> validate("recursion")).hasStackTraceContaining("Circular reference '{recursion}'");
|
||||
}
|
||||
|
||||
@Test
|
||||
void unknown() {
|
||||
assertThat(validate("unknown")).containsExactly("{unknown}");
|
||||
}
|
||||
|
||||
@Test
|
||||
void escapePrefix() {
|
||||
assertThat(validate("escapePrefix")).containsExactly("\\{null}");
|
||||
}
|
||||
|
||||
@Test
|
||||
void escapeSuffix() {
|
||||
assertThat(validate("escapeSuffix")).containsExactly("{null\\}");
|
||||
}
|
||||
|
||||
@Test
|
||||
void escapePrefixSuffix() {
|
||||
assertThat(validate("escapePrefixSuffix")).containsExactly("{null}");
|
||||
}
|
||||
|
||||
@Test
|
||||
void escapeEscape() {
|
||||
assertThat(validate("escapeEscape")).containsExactly("\\must not be null");
|
||||
}
|
||||
|
||||
private List<String> validate(String property) {
|
||||
List<String> messages = new ArrayList<>();
|
||||
Set<ConstraintViolation<Object>> constraints = this.validator.validateProperty(this, property);
|
||||
for (ConstraintViolation<Object> constraint : constraints) {
|
||||
messages.add(constraint.getMessage());
|
||||
}
|
||||
return messages;
|
||||
}
|
||||
|
||||
private static Validator buildValidator() {
|
||||
Locale locale = LocaleContextHolder.getLocale();
|
||||
StaticMessageSource messageSource = new StaticMessageSource();
|
||||
messageSource.addMessage("blank", locale, "{null} or {javax.validation.constraints.NotBlank.message}");
|
||||
messageSource.addMessage("null", locale, "{javax.validation.constraints.NotNull.message}");
|
||||
messageSource.addMessage("recursion", locale, "{recursion}");
|
||||
MessageInterpolatorFactory messageInterpolatorFactory = new MessageInterpolatorFactory();
|
||||
messageInterpolatorFactory.setMessageSource(messageSource);
|
||||
LocalValidatorFactoryBean validatorFactory = new LocalValidatorFactoryBean();
|
||||
validatorFactory.setMessageInterpolator(messageInterpolatorFactory.getObject());
|
||||
validatorFactory.afterPropertiesSet();
|
||||
return validatorFactory.getValidator();
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue