Question

我有一种服务方法：

 @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没有它。

我正在春季引导中运行我的应用。

任何帮助将不胜感激。

P.S .：我去过其他声称可以解决问题的类似话题，但实际上它们都没有。

Answer 1

像这样向@Min批注添加自定义消息

@Min(value=0, message="page-number must be equal or greater than {value}")

Answer 2

这是我在spring-boot 2.0.3中使其工作的方式：

我必须在spring-boot中覆盖并禁用ValidationAutoConfiguration：

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是我处理验证错误的自定义方式，简而言之，它会生成错误DTO，并将其与所有验证错误消息一起序列化为JSON。

Answer 3

现在，您不能执行此操作（嗯，除非您为每个注释定义自定义消息，但我想那不是您想要的）。

有趣的是，最近有人从事类似的工作：https://github.com/hibernate/hibernate-validator/pull/1029。

该作品已被合并到master分支中，但是我尚未发布包含该作品的新6.1 alpha。几天就可以了。

话虽如此，我们已经牢记属性，现在您要问的是，我们可能应该将其推广到更多东西，包括方法参数。

现在我们有了一般性的想法，我认为将其概括起来应该不花太多精力。

我将与贡献者和团队中的其他成员讨论此问题，并再次与您联系。

Answer 4

我认为不可能获得查询参数的名称，但是如果有人知道一种方法，我想被证明是错误的。

正如德米特里·博格达诺维奇（Dmitry Bogdanovich）所说，拥有自定义消息是我知道如何做接近您所需的事情的最简单也是唯一的方法。如果您不想将这些消息弄乱，可以执行以下操作：

在您的资源文件夹中添加ValidationMessages.properties文件。在这里您可以说：

page_number.min=page-number must be equal or greater than {value}

现在您可以使用注释并编写：

@Min(value = 0, message = "{page_number.min}")

这样，您只有一个来源就可以在需要时更改有关消息的任何内容。

如何从ConstraintViolationException获取查询参数名称

4 个答案: