使用JAX-RS进行Bean验证（Rest-轻松）：无法识别参数名称

提问者：小点点

使用JAX-RS进行Bean验证（Rest-轻松）：无法识别参数名称

我正在使用JAXRS资源与Bean验证和这两个工作之间的集成。

但是，在验证错误的情况下生成的默认错误消息将参数名称报告为arg0，如下所示

[PARAMETER]
[login.arg0.password]
[password is required]
[]

对应方法定义：

@POST //and other JAX-RS annotations
public Response login(
        @NotNull
        @Valid
        LoginBody loginBody) {

   [...]

protected static class LoginBody {

    @NotNull(message =  EMAIL_REQUIRED)
    public String email;

    @NotNull(message = PASSWORD_REQUIRED)
    public String password;
}

虽然我通常对这种消息模式没意见，但实际上是annyoing，是原始参数名称无法识别，即。我宁愿看到

有没有一种简单的方法来解决这个问题，例如。g.以某种方式为该参数提供一个明确的名称？

我正在使用WildFly Sling 2017.6.0。从我发现的情况来看，这意味着我有resteasy-validator hibernate-validator

谢谢。

共3个答案

匿名用户

您可以尝试使用-参数编译您的应用程序，或者指示您的IDE这样做，例如在eclipse的情况下：首选项-

有了它，您需要指示Bean验证基础架构（例如）hibernate-validator通过META-INF/验证. xml使用ReflectiveParameterNamer。

<parameter-name-provider>org.hibernate.validator.parameternameprovider.ReflectionParameterNameProvider</parameter-name-provider>

另请参阅Hibernate Validator配置

我在Paranamer图书馆找到了可靠的资料

META-IN F/验证. xml：

<?xml version="1.0" encoding="UTF-8"?>
<validation-config
   xmlns="http://jboss.org/xml/ns/javax/validation/configuration"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="
                    http://jboss.org/xml/ns/javax/validation/configuration
                    validation-configuration-1.1.xsd"
   version="1.1">
   <default-provider>org.hibernate.validator.HibernateValidator
   </default-provider>
   <message-interpolator>org.hibernate.validator.messageinterpolation.ResourceBundleMessageInterpolator
   </message-interpolator>
   <traversable-resolver>org.hibernate.validator.internal.engine.resolver.DefaultTraversableResolver
   </traversable-resolver>
   <constraint-validator-factory>org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorFactoryImpl
   </constraint-validator-factory>
   <parameter-name-provider>org.hibernate.validator.parameternameprovider.ParanamerParameterNameProvider</parameter-name-provider>
</validation-config>

为了让paranamer与Wildfly一起工作，我需要创建一个参数名称jbost-module并从hibernate-validator模块的module. xml中引用该模块。

有了这个地方，我可以简单地写：

@POST
public Response login(@NotNull @Valid @Named("authRequest") AuthRequest authRequest) {
    return Response.ok().build();
}
...

public class AuthRequest {

    @NotNull(message = AuthMessages.EMAIL_REQUIRED)
    public String email;

    @NotNull(message = AuthMessages.PASSWORD_REQUIRED)
    public String password;
}

这会对通过curl发送的请求产生以下响应：

curl -H "Content-Type: application/json" -H "Accept: application/json" -d '{"email":"foo@bar.com"}' -v http://localhost:8080/javaweb-training/resources/auth

回应：

{"exception":null,"fieldViolations":[],"propertyViolations":[],"classViolations":[],"parameterViolations":[{"constraintType":"PARAMETER","path":"login.authRequest.password","message":"password.required","value":""}],"returnValueViolations":[]}%

…注意login. autRequest.pass而不仅仅是login.arg0.pass

匿名用户

有一个非常简单的解决方案：您可以在约束定义中设置自己的错误信息，如下所示

@NotNull(message = "password is required")

如果您想要一个基于JAXRS参数注释的更通用的解决方案，您可以实现自己的简单ParameterNamProvider并将其注册到validation. xml中，如下所示。这具有不必更改jboss模块结构的优点。我也不必更改任何编译器标志…

public class AnnotatedParameterNameProvider implements ParameterNameProvider {
  @Override
  public List<String> getParameterNames(Constructor<?> constructor) {
    return lookupParameterNames(constructor.getParameterAnnotations());
  }

  @Override
  public List<String> getParameterNames(Method method) {
    return lookupParameterNames(method.getParameterAnnotations());
  }

  private List<String> lookupParameterNames(Annotation[][] annotations) {
    final List<String> names = new ArrayList<>();
    if (annotations != null) {
      for (Annotation[] annotation : annotations) {
        String annotationValue = null;
        for (Annotation ann : annotation) {
          annotationValue = getAnnotationValue(ann);
          if (annotationValue != null) {
            break;
          }
        }

        // if no matching annotation, must be the request body
        if (annotationValue == null) {
          annotationValue = "requestBody";
        }
        names.add(annotationValue);
      }
    }

    return names;
  }

  private static String getAnnotationValue(Annotation annotation) {
    if (annotation instanceof HeaderParam) {
      return ((HeaderParam) annotation).value();
    } else if (annotation instanceof PathParam) {
      return ((PathParam) annotation).value();
    } else if (annotation instanceof QueryParam) {
      return ((QueryParam) annotation).value();
    }
    return null;
  }
}

在验证. xml中：

    <validation-config xmlns="http://jboss.org/xml/ns/javax/validation/configuration"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xsi:schemaLocation="http://jboss.org/xml/ns/javax/validation/configuration validation-configuration-1.1.xsd"
                   version="1.1">
  <parameter-name-provider>com.yourcompany.providers.AnnotatedParameterNameProvider</parameter-name-provider>
</validation-config>

请注意，您还可以通过实现自己的MessageInterpolator并将其注册到验证. xml来自定义错误消息的格式

匿名用户

您能否尝试为ConstraintViolationExceptions实现一个异常映射器，看看您那里的信息（约束违规列表）是否可以帮助您获取参数名称？