web-dev-qa-db-ja.com

メソッド引数のConstraintValidatorのプロパティパスを変更できますか？

Bean Validation Frameworkに精通している場合は、メソッド引数の名前を取得できないことをご存知でしょう。したがって、メソッドの最初の引数に@NotNull制約を実行し、検証が失敗した場合、getPropertyPathは「arg1」のようになります。

値を取ることができる独自のバージョンの@NotNullを作成したいと思います。 @NamedNotNull（ "emailAddress"）。しかし、バリデーターで#getPropertyPathをオーバーライドする方法がわかりませんか？これを行う方法はありますか、それとも「arg1」や「arg2」などで立ち往生していますか。

[〜＃〜]編集[〜＃〜]

私が受け取った回答に基づいて、@ QueryParamまたは@PathParamアノテーションから値を取得し、それらを@NotNullなどのBeanValidationアノテーションのプロパティパスとして使用できるようにする次の実装を思い付くことができました。

ジャージーの場合、次のクラスを作成する必要があります。 DefaultParameterNameProviderの実装に注意してください。

public class ValidationConfigurationContextResolver implements ContextResolver<ValidationConfig> {
    @Override
    public ValidationConfig getContext( final Class<?> type ) {
        final ValidationConfig config = new ValidationConfig();
        config.parameterNameProvider( new RestAnnotationParameterNameProvider() );
        return config;
    }

    static class RestAnnotationParameterNameProvider extends DefaultParameterNameProvider {

        @Override
        public List<String> getParameterNames( Method method ) {
            Annotation[][] annotationsByParam = method.getParameterAnnotations();
            List<String> names = new ArrayList<>( annotationsByParam.length );
            for ( Annotation[] annotations : annotationsByParam ) {
                String name = getParamName( annotations );
                if ( name == null )
                    name = "arg" + ( names.size() + 1 );

                names.add( name );
            }

            return names;
        }

        private static String getParamName( Annotation[] annotations ) {
            for ( Annotation annotation : annotations ) {
                if ( annotation.annotationType() == QueryParam.class ) {
                    return QueryParam.class.cast( annotation ).value();
                }
                else if ( annotation.annotationType() == PathParam.class ) {
                    return PathParam.class.cast( annotation ).value();
                }
            }

            return null;
        }
    }
}

次に、RestConfigに次の行を追加する必要があります。

register( ValidationConfigurationContextResolver.class );

それでおしまい。これで、ConstraintValidationExceptionsに、注釈が付けられたQueryParamまたはPathParamの名前が含まれます。例えば：

 public void getUser( 
     @NotNull @QueryParam( "emailAddress" ) String emailAddress,
     @NotNull @QueryParam( "password" ) String password ) 
 { ... }
javahibernatebean-validationjersey-2.0
23
robert_difalco

Bean Validation 1.1では、制約違反オブジェクトを作成するときにメソッドとコンストラクターのパラメーターに名前を付けるための ParameterNameProvider インターフェースが導入されました。

Hibernate Validator 5.2では、 ReflectionParameterNameProvider クラス、リフレクションを使用して実際のパラメーター名を取得する ParameterNameProvider 実装が導入されました（正しく機能するために、クラスは-parametersコンパイラ引数を使用してコンパイルする必要があります）：

/**
 * Uses Java 8 reflection to get the parameter names.
 * <p>
 * <p>For this provider to return the actual parameter names, classes must be compiled with the '-parameters' compiler
 * argument. Otherwise, the JDK will return synthetic names in the form {@code arg0}, {@code arg1}, etc.</p>
 * <p>
 * <p>See also <a href="http://openjdk.Java.net/jeps/118">JEP 118</a></p>
 *
 * @author Khalid Alqinyah
 * @since 5.2
 */
public class ReflectionParameterNameProvider implements ParameterNameProvider {

    @Override
    public List<String> getParameterNames(Constructor<?> constructor) {
        return getParameterNames(constructor.getParameters());
    }

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

    private List<String> getParameterNames(Parameter[] parameters) {

        List<String> parameterNames = newArrayList();
        for (Parameter parameter : parameters) {
            // If '-parameters' is used at compile time, actual names will be returned. Otherwise, it will be arg0, arg1...
            parameterNames.add(parameter.getName());
        }

        return parameterNames;
    }
}

Dropwizardはそれを拡張し、他のJAX-RS実装でも機能するはずの JerseyParameterNameProvider を使用してJAX-RS @XxxParamアノテーションにサポートを追加します。

/**
 * Adds jersey support to parameter name discovery in hibernate validator.
 * <p>
 * <p>This provider will behave like the hibernate-provided {@link ReflectionParameterNameProvider} except when a
 * method parameter is annotated with a jersey parameter annotation, like {@link QueryParam}. If a jersey parameter
 * annotation is present the value of the annotation is used as the parameter name.</p>
 */
public class JerseyParameterNameProvider extends ReflectionParameterNameProvider {

    @Override
    public List<String> getParameterNames(Method method) {
        Parameter[] parameters = method.getParameters();
        Annotation[][] parameterAnnotations = method.getParameterAnnotations();
        List<String> names = new ArrayList<>(parameterAnnotations.length);
        for (int i = 0; i < parameterAnnotations.length; i++) {
            Annotation[] annotations = parameterAnnotations[i];
            String name = getParameterNameFromAnnotations(annotations).orElse(parameters[i].getName());
            names.add(name);
        }
        return names;
    }

    /**
     * Derives member's name and type from it's annotations
     */
    public static Optional<String> getParameterNameFromAnnotations(Annotation[] memberAnnotations) {

        for (Annotation a : memberAnnotations) {
            if (a instanceof QueryParam) {
                return Optional.of("query param " + ((QueryParam) a).value());
            } else if (a instanceof PathParam) {
                return Optional.of("path param " + ((PathParam) a).value());
            } else if (a instanceof HeaderParam) {
                return Optional.of("header " + ((HeaderParam) a).value());
            } else if (a instanceof CookieParam) {
                return Optional.of("cookie " + ((CookieParam) a).value());
            } else if (a instanceof FormParam) {
                return Optional.of("form field " + ((FormParam) a).value());
            } else if (a instanceof Context) {
                return Optional.of("context");
            } else if (a instanceof MatrixParam) {
                return Optional.of("matrix param " + ((MatrixParam) a).value());
            }
        }

        return Optional.empty();
    }
}

Dropwizardを使用しない場合は、上記のコードを使用して独自の実装を作成できます。

ジャージーリソースクラス/メソッドの検証で使用される Validator のカスタマイズは、 ValidationConfig クラスを使用して、 ContextResolver<T> メカニズム：

public class ValidationConfigurationContextResolver 
        implements ContextResolver<ValidationConfig> {

    @Override
    public ValidationConfig getContext(final Class<?> type) {
        ValidationConfig config = new ValidationConfig();
        config.parameterNameProvider(new CustomParameterNameProvider());
        return config;
    }
}

次に、ValidationConfigurationContextResolverをResourceConfigに登録します。

詳細については、 JerseyのBean Validationサポート に関するドキュメントを参照してください。

8
cassiomolin

Bean Validation Frameworkに精通している場合は、メソッド引数の名前を取得できないことをご存知でしょう。

それは完全に正しくありません。 Bean Validationは、独自の実装を提供できる ParameterNameProvider の概念を指定します。 Hibernate Validatorは ParaNamer と統合して、パラメーター名を提供します。詳細については、バリデーター オンラインドキュメント を参照してください。 ValidatorがJava 8をサポートすると、Java 8パラメーター命名機能もサポートします。

IMO、ParaNamerを試してみてください。

11
Hardy