Question

我正在使用带有Bean验证的JAX-RS资源，并按预期在这两个工作之间进行集成。

但是，在验证错误的情况下生成的默认错误消息将参数名称报告为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;
}

虽然我对这种消息模式一般都很好，但实际上是什么，是原始参数名称无法识别，i。即我更愿意看

登录。 loginBody .password而不是 arg0 。

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

我正在使用WildFly Swarm 2017.6.0。从我发现的这意味着我有resteasy + resteasy-validator + hibernate-validator

感谢。

Answer 1

您可以尝试使用-parameters编译您的应用，或指示您的IDE执行此操作，例如：的情况下 eclipse：偏好 - ＆gt; java - ＆gt;编译器 - ＆gt; “存储有关方法参数的信息（可通过反射使用）”

有了这个，你需要指示Bean Validation基础结构（例如）hibernate-validator 通过ReflectiveParameterNamer使用META-INF/validation.xml。

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

另见Hibernate Validator Configuration

我能够可靠地使用Paranamer library

META-INF/validation.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，我需要创建一个parameter-namer jboss模块并从module.xml模块的hibernate-validator引用该模块。

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

@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.authRequest.password，而不只是login.arg0.password

Answer 2

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

Answer 3

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

@NotNull(message = "password is required")

如果您想要基于JAX-RS参数注释的更通用的解决方案，则可以实现自己的简单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;
  }
}

在validation.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并将其注册到validation.xml

中，自定义错误消息的格式。

Answer 4

用于 Hibernate Validator 6.X 的@ thomas-darimont更新版本。

变体＃1-使用Java 8构建（使用-parameters编译参数）

指定依赖关系（等级示例）：

// Define explicit hibernate validator 6.x
implementation('org.hibernate.validator:hibernate-validator:6.0.13.Final')
implementation('org.jboss.resteasy:resteasy-validator-provider-11:3.6.2.Final') {
    // Exclude transitive hibernate validator 5.x
    exclude group: 'org.hibernate', module: 'hibernate-validator'
}

指定验证者：

@GET
@Path("user/{userId}")
public Response getUser(@Size(min = 2) @PathParam("userId") String userId) {
    return null;
}

注意： org.hibernate.validator.internal.engine.DefaultParameterNameProvider将返回从Java反射API获得的参数名称。

变体＃2-使用ParaNamer库。（xml配置） 如果您不想依赖编译标志。

指定依赖关系（等级示例）：

// Define explicit hibernate validator 6.x
implementation('org.hibernate.validator:hibernate-validator:6.0.13.Final')
implementation('org.jboss.resteasy:resteasy-validator-provider-11:3.6.2.Final') {
    // Exclude transitive hibernate validator 5.x
    exclude group: 'org.hibernate', module: 'hibernate-validator'
}
// ParaNamer library
implementation('com.thoughtworks.paranamer:paranamer:2.8')

指定验证者：

@GET
@Path("user/{userId}")
public Response getUser(@Size(min = 2) @PathParam("userId") String userId) {
    return null;
}

放入<project_dir>/src/main/resources/META-INF/validation.xml

<?xml version="1.0" encoding="UTF-8"?>
<validation-config
        xmlns="http://xmlns.jcp.org/xml/ns/validation/configuration"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/validation/configuration
            http://xmlns.jcp.org/xml/ns/validation/configuration/validation-configuration-2.0.xsd"
        version="2.0">
    <parameter-name-provider>org.hibernate.validator.parameternameprovider.ParanamerParameterNameProvider</parameter-name-provider>
</validation-config>

注意： 由于Hibernate Validator 6.x org.hibernate.validator.parameternameprovider.ReflectionParameterNameProvider已被弃用，请改用org.hibernate.validator.parameternameprovider.ParanamerParameterNameProvider。

问题：我只能使用Java代码样式进行配置吗？ 很不幸的是，不行。（See details here）。

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

4 个答案: