어노테이션 기반 유효성 검사기 만들기

현재 회사에서 고객 결제 기록을 가져올 때 날짜 필터링을 해야 하는데, 어노테이션 기반으로 커스텀 검사기를 작성하기 위해 공부한 것을 적어본다. 여기 예제에서는 전화번호가 유효한지 확인하는 커스텀 유효성 검사기를 만들어 본다.

의존성 추가

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.10.Final</version>
</dependency>

1 커스텀 어노테이션 생성하기

• @Constraint: 어떤 검사기에 의해 검사될 건지 지정한다.

• @Target: 어노테이션을 어느 레벨에서 사용할 수 있을지 정할 수 있다.

@Documented
@Constraint(validatedBy = MyValidator.class)
@Target( { ElementType.METHOD, ElementType.FIELD }) 
@Retention(RetentionPolicy.RUNTIME)
public @interface ContactNumberConstraint {
    String message() default "Invalid phone number"; // UI에서 보여질 에러 메시지
    Class<?>[] groups() default {}; // 스프링 표준 지키기 위해 따라오는 boilerplate 코드 
    Class<? extends Payload>[] payload() default {}; // 스프링 표준 지키기 위해 따라오는 boilerplate 코드  
}

public class ContactNumberValidator implements 
  ConstraintValidator<ContactNumberConstraint, String> { // 제너릭에 검증 어노테이션과, 검증할 타입을 지정합니다. 여기선 String으로된 번호를 할것이므로, String.

    @Override
    public void initialize(ContactNumberConstraint contactNumber) {
    }

    @Override
    public boolean isValid(String contactField,
      ConstraintValidatorContext cxt) {
        return contactField != null && contactField.matches("[0-9]+")
          && (8 < contactField.length()) && (contactField.length() < 14);
    }
}

어노테이션을 사용해보자.

변수에 만든 어노테이션를 붙혀준다.

class ValidatedPhone {
	//...
    @ContactNumberConstraint
    private String phone;
    //...
}

1.1 컨트롤러로 넘어온 값 검증하기

컨트롤러에서, @Valid 를 사용해서, 검증할 객체를 지정한다. BindingResult 는 에러가 날 경우 잡기 위해 사용되었다.

@Controller
public class ValidatedPhoneController {
 
    @GetMapping("/validatePhone")
    public String loadFormPage(Model m) {
        m.addAttribute("validatedPhone", new ValidatedPhone());
        return "phoneHome";
    }
    
    @PostMapping("/addValidatePhone")
    public String submitForm(@Valid ValidatedPhone validatedPhone,
      BindingResult result, Model m) {
        if(result.hasErrors()) {
            return "phoneHome";
        }
        m.addAttribute("message", "Successfully saved phone: "
          + validatedPhone.toString());
        return "phoneHome";
    }   
}

1.2 테스트 작성

@Test
public void 
  givenPhoneURIWithPostAndFormData_whenMockMVC_thenVerifyErrorResponse() {
    this.mockMvc.perform(MockMvcRequestBuilders.post("/addValidatePhone"). // 컨트롤러로 mock 통신
      accept(MediaType.TEXT_HTML).
      param("phoneInput", "123")). // 8자가 안넘는 유효하지 않은 번호
      andExpect(model().attributeHasFieldErrorCode(
          "validatedPhone","phone","ContactNumberConstraint")). // 어노테이션을 설정한 phone 필드가 비유효함
      andExpect(view().name("phoneHome")).
      andExpect(status().isOk()).
      andDo(print());
}

2 클래스 전체 유효성 검사 하기

필드가 아닌 클래스 전체의 값들이 유효한지 체크해보자.

예시는, 회원 가입시 두번째로 입력된 이메일과 비번이 첫번째것들 일치하는지 검증을 목적으로 한다.

@Constraint(validatedBy = FieldsValueMatchValidator.class)
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldsValueMatch {

    String message() default "Fields values don't match!";

    String field();

    String fieldMatch();

    @Target({ ElementType.TYPE })
    @Retention(RetentionPolicy.RUNTIME)
    @interface List { // 객체 내 여러 필드를 검사하기 위한 리스트 준비
        FieldsValueMatch[] value();
    }
}

사용될 검증기에 ConstraintValidator<어노테이션명, 검증객체> 를 impl 한다.

public class FieldsValueMatchValidator 
  implements ConstraintValidator<FieldsValueMatch, Object> {

    private String field; // 기준값
    private String fieldMatch; // 비교될 값

    public void initialize(FieldsValueMatch constraintAnnotation) {
        this.field = constraintAnnotation.field();
        this.fieldMatch = constraintAnnotation.fieldMatch();
    }

    public boolean isValid(Object value, 
      ConstraintValidatorContext context) {

        Object fieldValue = new BeanWrapperImpl(value) // BeanWrapperImpl는 빈의 값을 조작(set, get)할때 사용된다.
          .getPropertyValue(field);
        Object fieldMatchValue = new BeanWrapperImpl(value)
          .getPropertyValue(fieldMatch);
        
        if (fieldValue != null) {
            return fieldValue.equals(fieldMatchValue); // 두개가 동일한지 확인
        } else {
            return fieldMatchValue == null;
        }
    }
}

검증될 객체에 validator 붙혀보자.

@FieldsValueMatch.List({ // List로..
    @FieldsValueMatch(
      field = "password", 
      fieldMatch = "verifyPassword", 
      message = "Passwords do not match!"
    ), 
    @FieldsValueMatch(
      field = "email", 
      fieldMatch = "verifyEmail", 
      message = "Email addresses do not match!"
    )
})
public class NewUserForm {
    private String email;
    private String verifyEmail;
    private String password;
    private String verifyPassword;

    // standard constructor, getters, setters
}

password와 email이 올바른지 검증될 것이다.

2.1 컨트롤러로 넘어온 값 검증하기

NewUserForm를 컨트롤러에서 받을때 검증이 수행될수 있게 @Valid 삽입한다.

@Controller
public class NewUserController {

    @GetMapping("/user")
    public String loadFormPage(Model model) {
        model.addAttribute("newUserForm", new NewUserForm());
        return "userHome";
    }

    @PostMapping("/user")
    public String submitForm(@Valid NewUserForm newUserForm, 
      BindingResult result, Model model) {
        if (result.hasErrors()) {
            return "userHome";
        }
        model.addAttribute("message", "Valid form");
        return "userHome";
    }
}

2.2 테스트 작성

public class ClassValidationMvcTest {
    private MockMvc mockMvc;

    @Before
    public void setup(){
        this.mockMvc = MockMvcBuilders
            .standaloneSetup(new NewUserController()).build();
    }

    // 사용자가 잘 작성했을 경우, 에러는 없다.
    @Test
    public void givenMatchingEmailPassword_whenPostNewUserForm_thenOk() 
        throws Exception {
        this.mockMvc.perform(MockMvcRequestBuilders
                             .post("/user")
                             .accept(MediaType.TEXT_HTML).
                             .param("email", "[e-mail]") 
                             .param("verifyEmail", "[e-mail]")
                             .param("password", "pass")
                             .param("verifyPassword", "pass"))
            .andExpect(model().errorCount(0)) 
            .andExpect(status().isOk());
    }

    // 사용자가 이메일도 비번도 동일하게 적지 못하였다. 
    @Test
    public void givenNotMatchingEmailPassword_whenPostNewUserForm_thenOk() 
        throws Exception {
        this.mockMvc.perform(MockMvcRequestBuilders
                             .post("/user")
                             .accept(MediaType.TEXT_HTML)
                             .param("email", "[e-mail]")
                             .param("verifyEmail", "[e-mail]")
                             .param("password", "pass")
                             .param("verifyPassword", "passsss"))
            .andExpect(model().errorCount(2))
            .andExpect(status().isOk());
    }
}

참고자료

• https://www.baeldung.com/spring-mvc-custom-validator