javaで複数のフィールドの検証を組み合わせる方法

1年 ago
結衣, 春花
1 minute

Javaではバリデーションフレームワークを使用して、フィールドを組み合わせた検証が可能です。以下に例を示します。

  1. まずは、validationフレームワークの依存関係を追加していることを確認してください。Mavenプロジェクトの場合は、pom.xmlファイルに次のように依存関係を追加してください。
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
  1. 検証対象のオブジェクトを表すJavaクラスを作成します。このクラス内で、検証アノテーションを使用して検証する必要のあるフィールドと検証ルールをマークします。たとえば、
public class User {
    @NotBlank(message = "用户名不能为空")
    private String username;

    @NotBlank(message = "密码不能为空")
    private String password;

    // 其他字段...

    // 省略getter和setter方法
}

上の例ではusernameとpasswordフィールドが空でないことを保証するために@NotBlank注釈が利用されています。

  1. 組合わせフィールドと検証ルールを検証フレームワークが提供するアノテーションでマークアップできる検証ロジックを実装するバリデータクラスを作成する。例えば：
public class UserValidator implements ConstraintValidator<UserValidation, User> {
    @Override
    public boolean isValid(User user, ConstraintValidatorContext context) {
        // 自定义验证逻辑
        if (user.getUsername().equals(user.getPassword())) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate("用户名和密码不能相同")
                    .addPropertyNode("password").addConstraintViolation();
            return false;
        }
        return true;
    }
}

上の例では、UserValidator クラスが定義され、ConstraintValidator<UserValidation, User> インタフェースが実装されています。isValid メソッドでは、カスタムの検証ロジックを記述できます。検証に失敗した場合、ConstraintValidatorContext オブジェクトを使用してエラーメッセージを追加できます。

  1. 検証の組み合わせフィールドをマークするアノテーションクラスを作成します。たとえば、
@Constraint(validatedBy = UserValidator.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface UserValidation {
    String message() default "验证失败";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

上記サンプルでは、UserValidationアノテーションを定義し、@Constraintアノテーションを使用してこのアノテーションがUserValidatorクラスによって処理される必要があることを指定しています。

  1. ネイティブな日本語で言い換えると
  2. 会員登録が完了しました。
@RestController
@Validated
public class UserController {
    @PostMapping("/user")
    public ResponseEntity<String> createUser(@Valid @UserValidation @RequestBody User user) {
        // 处理创建用户的逻辑
        // ...
        return ResponseEntity.ok("用户创建成功");
    }
}

上の例では、@Valid アノテーションは User オブジェクトにマークされ、検証のトリガーに使用されます。検証が必要な組み合わせのフィールドは @UserValidation アノテーションでマークされています。

それにより、createUserメソッド呼び出し時にバリデーションロジックが自動で実行されます。バリデーションに失敗すると、MethodArgumentNotValidException例外が発生し、例外処理にてバリデーションエラー情報が取得できます。

bannerAds