Apache BValの紹介

1. 前書き

この記事では、Apache BVal library’s implementation of the Java Bean Validation specification (JSR 349)を見ていきます。

2. Mavenの依存関係

Apache BValを使用するには、最初に次の依存関係をpom.xmlファイルに追加する必要があります。


    org.apache.bval
    bval-jsr
    1.1.2


    javax.validation
    validation-api
    1.1.0.Final

カスタムBVal制約は、オプションのbval-extras依存関係にあります。


    org.apache.bval
    bval-extras
    1.1.2

bval-jsr、bval-extras、およびvalidation-apiの最新バージョンは、MavenCentralからダウンロードできます。

3. 制約の適用

Apache BValは、javax.validationパッケージで定義されているすべての制約の実装を提供します。 Beanのプロパティに制約を適用するために、add the constraint annotation to the property declarationを実行できます。

4つの属性を持つUserクラスを作成してから、@NotNull、@Size、および@Minアノテーションを適用してみましょう。

public class User {

    @NotNull
    private String email;

    private String password;

    @Size(min=1, max=20)
    private String name;

    @Min(18)
    private int age;

    // standard constructor, getters, setters
}

4. Beanの検証

Userクラスに適用された制約を検証するには、ValidatorFactoryインスタンスと1つ以上のValidatorインスタンスを取得する必要があります。

**4.1. ValidatorFactoryの取得**

ファクトリの作成は要求の厳しいプロセスであるため、Apache BValのドキュメントでは、このクラスの単一のインスタンスを取得することをお勧めします。

ValidatorFactory validatorFactory
  = Validation.byProvider(ApacheValidationProvider.class)
  .configure().buildValidatorFactory();

**4.2. Validatorの取得**

次に、上記で定義したvalidatorFactoryからValidatorインスタンスを取得する必要があります。

Validator validator = validatorFactory.getValidator();

This is a thread-safe implementationなので、作成済みのインスタンスを安全に再利用できます。

Validatorクラスは、Beanの有効性を判断するための3つのメソッド、validate()、validateProperty()、およびvalidateValue()を提供します。

これらの各メソッドは、従わなかった制約に関する情報を含むConstraintViolationオブジェクトのセットを返します。

**4.3. validate() API**

validate()メソッドは、Bean全体の有効性をチェックします。つまり、パラメーターとして渡されるのはverifies all the constraints applied to properties of an objectです。

Userオブジェクトを定義し、validate()メソッドを使用してそのプロパティをテストするJUnitテストを作成しましょう。

@Test
public void givenUser_whenValidate_thenValidationViolations() {
    User user
      = new User("[email protected]", "pass", "nameTooLong_______________", 15);

    Set> violations = validator.validate(user);
    assertTrue("no violations", violations.size() > 0);
}

**4.4. validateProperty() API**

validateProperty()メソッドはvalidate a single property of a beanに使用できます。

必要な最小値18未満のageプロパティを持つUserオブジェクトを定義し、このプロパティを検証すると1つの違反が発生することを確認するJUnitテストを作成しましょう。

@Test
public void givenInvalidAge_whenValidateProperty_thenConstraintViolation() {
    User user = new User("[email protected]", "pass", "Ana", 12);

    Set> propertyViolations
      = validator.validateProperty(user, "age");

    assertEquals("size is not 1", 1, propertyViolations.size());
}

**4.5. validateValue() API**

validateValue()メソッドは、Beanに設定する前にcheck if some value would be a valid value for a property of a beanに使用できます。

Userオブジェクトを使用してJUnitテストを作成し、値20がageプロパティの有効な値であることを確認しましょう。

@Test
public void givenValidAge_whenValidateValue_thenNoConstraintViolation() {
    User user = new User("[email protected]", "pass", "Ana", 18);

    Set> valueViolations
      = validator.validateValue(User.class, "age", 20);

    assertEquals("size is not 0", 0, valueViolations.size());
}

**4.6. ValidatorFactoryを閉じる**

最後のAfter using the ValidatorFactory, we must remember to close it：

if (validatorFactory != null) {
    validatorFactory.close();
}

**5. JSR以外の制約**

Apache BValライブラリは、series of constraints that are not a part of the JSR specificationも提供し、追加のより強力な検証機能を提供します。

bval-jsrパッケージには、有効な電子メールアドレスを検証するための@Emailと、値が空でないことを確認するための@NotEmptyの2つの追加の制約が含まれています。

残りのカスタムBVal制約は、オプションのパッケージbval-extrasで提供されます。

このパッケージには、番号が有効な国際銀行口座番号であることを確認する@IBAN注釈、有効な標準図書番号を確認する@Isbn注釈、@EAN13などのconstraints for verifying various number formatsが含まれています。 ■国際記事番号を確認するための注釈。

ライブラリは、annotations for ensuring the validity of various types of credit card numbers（@AmericanExpress、@Diners、@Discover、@Mastercard、および@Visa）も提供します。

@Domainおよび@InetAddressアノテーションを使用して、determine if a value contains a valid domain or Internet Addressを実行できます。

そして最後に、パッケージにはverifying whether a File object is a directory or notの@Directoryおよび@NotDirectory注釈が含まれています。

Userクラスに追加のプロパティを定義し、それらに非JSRアノテーションのいくつかを適用してみましょう。

public class User {

    @NotNull
    @Email
    private String email;

    @NotEmpty
    private String password;

    @Size(min=1, max=20)
    private String name;

    @Min(18)
    private int age;

    @Visa
    private String cardNumber = "";

    @IBAN
    private String iban = "";

    @InetAddress
    private String website = "";

    @Directory
    private File mainDirectory = new File(".");

    // standard constructor, getters, setters
}

制約は、JSR制約と同様の方法でテストできます。

@Test
public void whenValidateNonJSR_thenCorrect() {
    User user = new User("[email protected]", "pass", "Ana", 20);
    user.setCardNumber("1234");
    user.setIban("1234");
    user.setWebsite("10.0.2.50");
    user.setMainDirectory(new File("."));

    Set> violations
      = validator.validateProperty(user,"iban");

    assertEquals("size is not 1", 1, violations.size());

    violations = validator.validateProperty(user,"website");

    assertEquals("size is not 0", 0, violations.size());

    violations = validator.validateProperty(user, "mainDirectory");

    assertEquals("size is not 0", 0, violations.size());
}

これらの追加のアノテーションは潜在的な検証ニーズに便利ですが、JSR仕様の一部ではないアノテーションを使用することの欠点のひとつは、後で必要になった場合に別のJSR実装に簡単に切り替えることができないことです。。

6. カスタム制約

独自の制約を定義するには、最初に標準構文に従って注釈を作成する必要があります。

ユーザーのパスワードが満たす必要のある条件を満たすPasswordアノテーションを作成しましょう。

@Constraint(validatedBy = { PasswordValidator.class })
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface Password {
    String message() default "Invalid password";

    Class[] groups() default {};

    Class[] payload() default {};

    int length() default 6;

    int nonAlpha() default 1;
}

The actual validation of the password value is done in a class that implements the ConstraintValidator interface —この場合、PasswordValidatorクラス。このクラスは、isValid()メソッドをオーバーライドし、passwordの長さがlength属性より短いかどうか、および％に含まれる英数字以外の文字の数より少ないかどうかを検証します。（t5）の属性：

public class PasswordValidator
  implements ConstraintValidator {

    private int length;
    private int nonAlpha;

    @Override
    public void initialize(Password password) {
        this.length = password.length();
        this.nonAlpha = password.nonAlpha();
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext ctx) {
        if (value.length() < length) {
            return false;
        }
        int nonAlphaNr = 0;
        for (int i = 0; i < value.length(); i++) {
            if (!Character.isLetterOrDigit(value.charAt(i))) {
                nonAlphaNr++;
            }
        }
        if (nonAlphaNr < nonAlpha) {
            return false;
        }
        return true;
    }
}

カスタム制約をUserクラスのpasswordプロパティに適用してみましょう。

@Password(length = 8)
private String password;

JUnitテストを作成して、無効なpassword値が制約違反になることを確認できます。

@Test
public void givenValidPassword_whenValidatePassword_thenNoConstraintViolation() {
    User user = new User("[email protected]", "password", "Ana", 20);
    Set> violations
      = validator.validateProperty(user, "password");

    assertEquals(
      "message incorrect",
      "Invalid password",
      violations.iterator().next().getMessage());
}

次に、有効なpassword値を検証するJUnitテストを作成しましょう。

@Test
public void givenValidPassword_whenValidatePassword_thenNoConstraintViolation() {
    User user = new User("[email protected]", "password#", "Ana", 20);

    Set> violations
      = validator.validateProperty(user, "password");
    assertEquals("size is not 0", 0, violations.size());
}

7. 結論

この記事では、Apache BValBean検証実装の使用例を示しました。

この記事の完全なソースコードはover on GitHubにあります。

TOC

Apache BValの紹介