Bean 유효성 검증

유효성 검증 API

javax.validation 패키지에는 JavaBeans의 유효성을 프로그램적으로 검증하는 방법을 설명하는 빈 유효성 검증 API가 포함되어 있다.

ConstraintViolation은 단일 제한조건 실패를 설명하는 클래스입니다. ConstraintViolation 클래스 세트는 오브젝트 유효성 검증을 위해 리턴됩니다. 제한조건 위반은 위반을 설명하는 육안으로 읽을 수 있는 메시지로 표시됩니다.

유효성 검증 중에 실패하면 ValidationException이 처리됩니다.

유효성 검증기 인터페이스는 기본 유효성 검증 API이고 유효성 검증기 인스턴스는 자바 오브젝트 필드, 메소드 및 유형의 값을 유효성 검증할 수 있는 오브젝트입니다. 부트스트랩 API는 Validator 인터페이스 작성에 사용되는 ValidatorFactory 액세스를 가져오기 위해 사용되는 메커니즘입니다. 제품에 배치된 애플리케이션의 경우 부트스트랩은 자동으로 완료됩니다. 애플리케이션은 두 가지 방법으로 유효성 검증기 또는 ValidatorFactory를 가져올 수 있습니다. 하나는 인젝션으로 예를 들어, @Resource 어노테이션 사용이고 다른 방법은 java 검색입니다.

@Resource ValidatorFactory _validatorFactory;
@Resource Validator _validator;    

ValidatorFactory validatorFactory = (ValidatorFactory)context.lookup("java:comp/ValidatorFactory");
Validator validator = (Validator)context.lookup("java:comp/Validator");

제한조건 메타데이터 요청 API

메타데이터 API 지원 도구 제공자는 다른 프레임워크, 라이브러리 및 Java Platform, Enterprise Edition 기술과의 통합을 제공합니다. 오브젝트 제한조건의 메타데이터 저장소는 지정된 클래스의 Validator 인터페이스를 통해 액세스합니다.

XML 배치 디스크립터

어노테이션에 제한조건을 선언하는 것 이외에도 XML을 사용하여 제한조건을 선언하는 지원도 가능합니다.

유효성 검증 XML 설명은 두 개의 xml 파일 종류로 구성됩니다. META-INF/validation.xml 파일은 모듈에 대한 Bean 유효성 검증 구성을 설명합니다. 다른 XML 파일 유형은 제한조건 선언을 설명하고 어노테이션 선언 메소드와 근접하게 일치합니다. 기본적으로 어노테이션을 통해 표시되는 모든 제한조건 선언은 XML로 설명되는 클래스에 대해 무시됩니다. Bean에서 ignore-annotation="false" 설정을 사용하여 어노테이션 및 XML 제한조건 선언 모두를 사용하도록 강제로 유효성 검증할 수 있습니다. 제품은 validation.xml 파일을 포함하는 배치되는 애플리케이션 모듈 및 XML 파일에 정의되는 제한조건이 XML 디스크립터를 포함하는 모듈에만 고유한 Validator 인터페이스를 작성하여 다른 모듈 validation.xml 및 제한조건 파일에서 격리되도록 합니다.

고급 Bean 유효성 검증 개념

Bean 유효성 검증 API는 기본 제공 제한조건 및 사용자 정의 제한조건을 선언하도록 하는 인터페이스 세트를 제공합니다. 이는 제한조건 어노테이션을 작성하고 Bean 유형, 필드 또는 특성의 어노테이션을 선언하여 수행됩니다. 제한조건 작성은 다른 제한조건 정의에 제한조건을 선언해서도 수행합니다.

다음 예는 주석 문자열 필드가 널이 아니도록 정의되는 CommentChecker 제한조건 작성을 보여줍니다. 주석 텍스트는 대괄호 안에 입력해야 합니다(예: [text]).

package com.my.company;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import javax.validation.Constraint;
import javax.validation.Payload;
    
@Documented
@Constraint(validatedBy = CommentValidator.class)
@Target({ METHOD, FIELD })
@Retention(RUNTIME)
public @interface CommentChecker {
       String message() default "The comment is not valid.";
       Class<?>[] groups() default {};
       Class<? extends Payload>[] payload() default {};
     	…} 

package com.my.company;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class CommentValidator implements ConstraintValidator<CommentChecker, String> {
    public void initialize(CommentChecker arg0) {       
    }
    public boolean isValid(String comment, ConstraintValidatorContext context) {
        if (comment == null) {
            // Null comment is not allowed, fail the constraint. 
            return false;
        }
        if (!comment.contains("[") && !comment.contains("]")) {
            // Can't find any open or close brackets, fail the constraint
            return false;
        }
        // Ignore leading and trailing spaces
        String trimmedComment = comment.trim();
        return // validate '[' prefix condition
               trimmedComment.charAt(0) == '[' && 
               // validate ']' suffix condition
               trimmedComment.charAt(trimmedComment.length()!-1) == ']';
    }
}

package com.my.company;
public myChecker {  

    @CommentChecker
    String comment = null; 
    ...
}

제품은 기본 Bean 유효성 검증 제공자를 제공하지만 애플리케이션에서 대체 제공자를 사용하고자 할 수 있습니다. 유효성 검증 팩토리를 작성하기 위해 javax.validation.Validation.byProvider() 메소드를 호출하여 프로그래밍 방식으로 대체 제공자를 선택할 수 있습니다. 또는 validation.xml 파일에 <default-provider/> 요소를 지정하여 대체 제공자를 선언적으로 선택할 수 있습니다. 대체 제공자 클래스가 기본 제공자와 충돌하지 않도록 하려면 서버 또는 애플리케이션 클래스 로더 순서를 Classes loaded with local class loader first (parent last)값으로 설정하십시오. 이를 설정하는 방법에 대한 추가 정보는 클래스 로드 문서를 참조하십시오.

Bean 유효성 검증 스펙은 둘 이상의 validation.xml 파일이 클래스 경로에 있는 경우 ValidationException이 발생하도록 표시합니다. 그러나 WebSphere® Application Server 는 여러 팀이 응용프로그램 서버에 어셈블 및 전개된 모듈을 함께 개발하는 환경을 지원합니다. 이 환경에서 애플리케이션의 모든 EJB는 동일한 클래스 로더로 로드되고 모든 EJB 및 웹 서비스(WAR) 모듈이 단일 클래스 로더로 로드될 수 있도록 애플리케이션 클래스 로더를 구성할 수 있습니다. 이로 인해 제품은 동일한 클래스 경로에서 다중 validation.xml 파일 지원을 제공합니다.

<constraint-mapping>META-INF/constraints-house.xml</constaint-mapping>
<constraint-mapping>META-INF/constraints-rooms.xml</constraint-mapping>

이 동작의 예외는 모든 Bean 유효성 검증 제한조건 클래스 및 구성이 모든 애플리케이션 모듈에 표시됩니다. 한 개의 validation.xml 파일이 EAR 파일에 정의되고 다른 validation.xml 파일은 모듈의 클래스 경로에 표시되는 상황인 경우 유효성 검증기 팩토리 또는 유효성 검증기를 작성하는 모든 모듈은 EAR 파일에 정의되는 validation.xml 파일을 사용합니다. 그러면 클래스 경로가 구성된 경우 다른 모듈도 다른 모듈의 validation.xml 파일을 사용하는 유효성 검증기 팩토리를 작성할 수 있으며 두 모듈 모두 동일한 클래스 경로에 표시되고 한 개의 validation.xml 파일만 해당 모듈에 표시됩니다.

Bean 유효성 검증 API 및 메타데이터에 대한 자세한 정보는 JSR 349 Bean 유효성 검증 스펙 문서를 참조하십시오.