이 글은 JavaBean Validation(이하 Bean Validation)의 기본 개념과 Hibernate Validator와의 관계 그리고 Spring Boot에서 간단한 사용법을 소개한다.

Bean Validation

Bean Validation과 Hibernate Validator

Bean Validation과 Spring Boot

Spring Boot(1.5.9 RELEASE 기준)는 Bean Validation을 Validation 모듈로 제공하고 있으며, Web 모듈에는 Validation 모듈을 포함하고 있다.

Spring Boot Web 모듈(spring-boot-starter-web-1.5.9.RELEASE.pom)을 자세히 살펴보면 Hibernate Validator(5.3.6.Final)를 사용하는 것을 확인할 수 있다.

1
2
3
4
5
6
7
8
9
10
11
12
13
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <artifactId>spring-boot-starter-web</artifactId>
    <name>Spring Boot Web Starter</name>
    ...
    <dependencies>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>
        ...
    </dependencies>
</project>

1
2
3
4
5
6
7
8
9
10
11
<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>1.5.9.RELEASE</version>
    <packaging>pom</packaging>
    ...
    <properties>
        <hibernate-validator.version>5.3.6.Final</hibernate-validator.version>
    </properties>
    ...
</project>

정리하면 Spring Boot 버전에 따라 다르겠지만 1.5.9 RELEASE 기준으로 보면 BeanValidation의 구현체로 Hibernate Validator를 사용하고 Hibernate Validator 버전이 5.3.6 Final이기 때문에 BeanValidation 1.1을 지원한다.

Spring Boot + Hibernate Validator 맛보기

Hibernate Validator의 여러 쓰임새 중에서도 이 글에서는 REST 개발할 때 HTTP Reqeust Body 검증에 초점을 맞춰 소개한다.

검증 로직이 없는 코드부터 시작해 보자.

1
2
3
4
5
6
7
8
9
@RestController
@RequestMapping("/api/v1/members")
public class MemberRestController {
    @PostMapping
    public ResponseEntity<Void> registerMember(@RequestBody final MemberRegistration registration) {
        // ...
        return new ResponseEntity<>(HttpStatus.OK);
    }
}

1
2
3
4
5
6
7
public class MemberRegistration {
    private String name;
    private String password;
    private String email;
    private String phoneNumber;
    // getter, setter
}

지금 코드에는 아무런 검증 로직이 없기 때문에 Request Body에 빈 값을 넣어 요청해도 HTTP Response Code를 200(OK)을 반환한다.

이제 하나씩 검증 로직을 추가해 보자.

Validation 1 - 'name'은 필수이어야 한다.

name 필드에 @NotEmpty 붙이고 검증 로직이 통과하지 못했을 때 메시지를 기술해 준다.

1
2
3
4
5
6
7
import org.hibernate.validator.constraints.NotEmpty;
public class MemberRegistration {
    @NotEmpty(message = "이름은 필수 입니다")
    private String name;
    // ...
    // getter, setter
}

마지막으로 Validation을 실행하는 Trigger^[3]로써 @Valid를 MemberRegistration에 붙여준다.

1
2
3
4
5
6
7
8
9
import javax.validation.Valid;
@RestController
@RequestMapping("/api/v1/members")
public class MemberRestController {
    @PostMapping
    public ResponseEntity<Void> registerMember(@Valid @RequestBody final MemberRegistration registration) {
        // ...
    }
}

이전과 동일하게 HTTP Request Body 빈 값으로 REST API를 호출해 보자.

HTTP Response Code로 400(Bad Request)로 그리고 ResponseBody로 @NotEmpty message에 기술했던 부분을 반환한다.

Validation 2 - 'password'는 필수이면서 6~20자리로 숫자와 특수 문자가 포함된 영문 대소문자로 문자열이어야 한다

password 필드에 @NotEmpty을 붙이고, @Pattern을 사용하여 비밀번호 제약 조건을 정규식으로 기술해 준다.

1
2
3
4
5
6
7
8
9
import org.hibernate.validator.constraints.NotEmpty;
import javax.validation.constraints.Pattern;
public class MemberRegistration {
    // ...
    @NotEmpty(message = "비밀번호는 필수 입니다")
    @Pattern(regexp = "((?=.*\\d)(?=.*[a-z])(?=.*[A-Z])(?=.*[@#$%]).{6,20})", message = "비밀 번호는 6~20자리로 숫자와 특수 문자가 포함된 영문 대소문자로 입력해 주세요")
    private String password;
    // getter, setter
}

Request Body의 password 가 빈값이 아니면 정규식으로 제약 조건을 검증 후 통과하지 못 하면 일전과 동일하게 HTTP Response Code로 400(Bad Request)로 그리고 ResponseBody로 @NotEmpty message에 기술했던 부분을 반환한다.

Validation 3 - 'email' 또는 'phoneNumber' 둘 중 하나는 필수이어야 한다

@ScriptAssert를 사용하면 필드 수준이 아닌 클래스 수준에서 검증이 가능하다.

1
2
3
4
5
6
7
8
9
10
import org.hibernate.validator.constraints.ScriptAssert;
@ScriptAssert(lang = "javascript",
        script = "(_.email != null && _.email.length() > 0) || (_.phoneNumber != null && _.phoneNumber.length() > 0)",
        alias = "_", message = "이메일 혹은 전화 번호 둘 중 하나는 필수 입니다")
public class MemberRegistration {
    // ...
    private String email;
    private String phoneNumber;
    // getter, setter
}

Validation 4 - 'email'에 값이 있다면 email 형식에 따라야 한다

1
2
3
4
5
6
7
8
9
10
11
12
import org.hibernate.validator.constraints.ScriptAssert;
import org.hibernate.validator.constraints.Email;
@ScriptAssert(lang = "javascript",
        script = "(_.email != null && _.email.length() > 0) || (_.phoneNumber != null && _.phoneNumber.length() > 0)",
        alias = "_", message = "이메일 혹은 전화 번호 둘 중 하나는 필수 입니다")
public class MemberRegistration {
    // ...
    @Email(message = "이메일 형식으로 입력해 주세요")
    private String email;
    private String phoneNumber;
    // getter, setter
}

Validation 5 - 'phoneNumber'에 값이 있다면 10자리 이하여야 한다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import org.hibernate.validator.constraints.ScriptAssert;
import org.hibernate.validator.constraints.Email;
import org.hibernate.validator.constraints.Length;
@ScriptAssert(lang = "javascript",
        script = "(_.email != null && _.email.length() > 0) || (_.phoneNumber != null && _.phoneNumber.length() > 0)",
        alias = "_", message = "이메일 혹은 전화 번호 둘 중 하나는 필수 입니다")
public class MemberRegistration {
    // ...
    @Email(message = "이메일 형식으로 입력해 주세요")
    private String email;
    @Length(min = 1, max = 10, message = "전화 번호는 10자리 이하로 입력해 주세요")
    private String phoneNumber;
    // getter, setter
}

GitHub

전체 코드는 필자의 GitHub에서 확인 가능하다.

주석

[1] https://ko.wikipedia.org/wiki/메타데이터

[2] Hibernate 이름에서 ORM을 떠올리는 경우가 많은데 ORM과는 별개이다.

[3] https://spring.io/blog/2009/11/17/spring-3-type-conversion-and-validation/

Validation It is common to validate a model after binding user input to it. Spring 3 provides support for declarative validation with JSR-303. This support is enabled automatically if a JSR-303 provider, such as Hibernate Validator, is present on your classpath. When enabled, you can trigger validation simply by annotating a Controller method parameter with the @Valid annotation