java - 如何从 ConstraintViolationException 中获取查询参数名称
问题描述
我有一个服务方法:
@GetMapping(path = "/api/some/path", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<?> getWhatever(@RequestParam(value = "page-number", defaultValue = "0") @Min(0) Integer pageNumber, ...
如果 API 的调用者没有为page-number
查询参数提交正确的值,javax.ConstraintViolationexception
则会引发。异常消息的内容如下:
getWhatever.pageNumber must be equal or greater than 0
在响应正文中,我希望收到此消息:
page-number must be equal or greater than 0
我希望我的消息具有查询参数的名称,而不是参数的名称。恕我直言,包括参数的名称正在公开实现细节。
问题是,我找不到带有查询参数名称的对象。好像ConstraintViolationException
没有啊
我在 spring-boot 中运行我的应用程序。
任何帮助,将不胜感激。
PS:我去过其他声称可以解决问题的类似线程,实际上它们都没有。
解决方案
这是我在 spring-boot 2.0.3 中如何使它工作的:
我不得不ValidationAutoConfiguration
在 spring-boot 中覆盖和禁用:
import org.springframework.boot.validation.MessageInterpolatorFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Lazy;
import org.springframework.core.env.Environment;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
import javax.validation.Validator;
@Configuration
public class ValidationConfiguration {
public ValidationConfiguration() {
}
@Bean
public static LocalValidatorFactoryBean validator() {
LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();
factoryBean.setParameterNameDiscoverer(new CustomParamNamesDiscoverer());
MessageInterpolatorFactory interpolatorFactory = new MessageInterpolatorFactory();
factoryBean.setMessageInterpolator(interpolatorFactory.getObject());
return factoryBean;
}
@Bean
public static MethodValidationPostProcessor methodValidationPostProcessor(Environment environment, @Lazy Validator validator) {
MethodValidationPostProcessor processor = new MethodValidationPostProcessor();
boolean proxyTargetClass = (Boolean) environment.getProperty("spring.aop.proxy-target-class", Boolean.class, true);
processor.setProxyTargetClass(proxyTargetClass);
processor.setValidator(validator);
return processor;
}
}
CustomParamNamesDiscoverer
位于同一个包中,它几乎是DefaultParameterNameDiscoverer
spring-boot 的参数名称发现器的默认实现的复制粘贴:
import org.springframework.core.*;
import org.springframework.util.ClassUtils;
public class CustomParameterNameDiscoverer extends PrioritizedParameterNameDiscoverer {
private static final boolean kotlinPresent = ClassUtils.isPresent("kotlin.Unit", CustomParameterNameDiscoverer.class.getClassLoader());
public CustomParameterNameDiscoverer() {
if (kotlinPresent) {
this.addDiscoverer(new KotlinReflectionParameterNameDiscoverer());
}
this.addDiscoverer(new ReqParamNamesDiscoverer());
this.addDiscoverer(new StandardReflectionParameterNameDiscoverer());
this.addDiscoverer(new LocalVariableTableParameterNameDiscoverer());
}
}
我希望它保持几乎完整(你甚至可以在那里看到 kotlin 检查),唯一的补充是:我正在将一个实例添加ReqParamNamesDiscoverer
到发现者的链接列表中。请注意,添加的顺序在这里很重要。
这是源代码:
import com.google.common.base.Strings;
import org.springframework.core.ParameterNameDiscoverer;
import org.springframework.lang.Nullable;
import org.springframework.web.bind.annotation.RequestParam;
import java.lang.reflect.Constructor;
import java.lang.reflect.Executable;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
public class ReqParamNamesDiscoverer implements ParameterNameDiscoverer {
public ReqParamNamesDiscoverer() {
}
@Override
@Nullable
public String[] getParameterNames(Method method) {
return doGetParameterNames(method);
}
@Override
@Nullable
public String[] getParameterNames(Constructor<?> constructor) {
return doGetParameterNames(constructor);
}
@Nullable
private static String[] doGetParameterNames(Executable executable) {
Parameter[] parameters = executable.getParameters();
String[] parameterNames = new String[parameters.length];
for (int i = 0; i < parameters.length; ++i) {
Parameter param = parameters[i];
if (!param.isNamePresent()) {
return null;
}
String paramName = param.getName();
if (param.isAnnotationPresent(RequestParam.class)) {
RequestParam requestParamAnnotation = param.getAnnotation(RequestParam.class);
if (!Strings.isNullOrEmpty(requestParamAnnotation.value())) {
paramName = requestParamAnnotation.value();
}
}
parameterNames[i] = paramName;
}
return parameterNames;
}
}
如果参数带有RequestParam
注释,我将检索value
属性并将其作为参数名称返回。
接下来的事情是禁用自动验证配置,不知何故,没有它就无法工作。这个注释虽然可以解决问题:
@SpringBootApplication(exclude = {ValidationAutoConfiguration.class})
此外,您需要为您的自定义处理程序ConstraintValidationException
:
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(ConstraintViolationException.class)
public ErrorDTO handleConstraintViolationException(ConstraintViolationException ex) {
Map<String, Collection<String>> errors = new LinkedHashMap<>();
ex.getConstraintViolations().forEach(constraintViolation -> {
String queryParamPath = constraintViolation.getPropertyPath().toString();
log.debug("queryParamPath = {}", queryParamPath);
String queryParam = queryParamPath.contains(".") ?
queryParamPath.substring(queryParamPath.indexOf(".") + 1) :
queryParamPath;
String errorMessage = constraintViolation.getMessage();
Collection<String> perQueryParamErrors = errors.getOrDefault(queryParam, new ArrayList<>());
perQueryParamErrors.add(errorMessage);
errors.put(queryParam, perQueryParamErrors);
});
return validationException(new ValidationException("queryParameter", errors));
}
ValidationException
stuff 是我处理验证错误的自定义方式,简而言之,它会产生一个错误 DTO,它将与所有验证错误消息一起序列化为 JSON。
推荐阅读
- ruby-on-rails - Rails 5:表单中的第一个参数不能包含 nil 或为空
- python - 加入表本身以查找具有相同关系的用户
- excel - Excel 嵌套 IF(INDEX(IFERROR(MATCH)
- spring-boot - 如何将服务生成的 nodePort 注入到部署中?
- node.js - 使用redis缓存关系数据
- c# - 树视图 XML 创建
- spring-boot - 使用链文件在 Spring 执行器上启用 SSL
- django - TypeError:“NoneType”对象在 Django 单元测试中不可为消息下标
- r - 根据 checkboxGroupInput 的多个图
- mongodb - Mongo $geoNear 不在所有记录中搜索