[프로젝트] charlieZip - #2. validation refactoring

기존 Validation

현재 제가 구현해놓은 validation을 먼저 보여드리고 왜 리팩토링을 할려고 하는지 설명하겠습니다.

회원가입 시 검증 요구 사항

• 필드 검증
  • 이름 : 필수
  • 비밀번호 : 필수, 공백X
  • 생년월일 : 8자리 숫자

MemberForm - 회원가입 저장 폼

package study.charlieZip.dto;

import lombok.Getter;
import lombok.Setter;
import study.charlieZip.entity.Gender;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;

@Getter @Setter
public class MemberForm {

    //NotEmpty는 null과 ""을 허용하지 않는다.
    @NotEmpty(message = "회원 이름은 필수 입니다.")
    private String username;

    //NotBlank는 null과 ""와 " "(빈공백문자열)을 허용하지 않는다.
    @NotBlank(message = "비밀번호는 필수 입력 값입니다.")
    private String password;

    @Pattern(regexp = "^[a-zA-z0-9]{8}$", message = "8자리로 입력해주세요.")
    private String date;

    private Gender gender;

}

MemberController

@PostMapping(value = "/members/new")
public String addMember(@Valid MemberForm memberform, Errors errors, Model model) {
    if (errors.hasErrors()) {
        //회원가입 실패시, 입력 데이터를 유지
        model.addAttribute("memberForm", memberform);

        // 유효성 통과 못한 필드와 메시지 핸들링
        Map<String, String> validatorResult = memberService.validateHandling(errors);
        for (String key : validatorResult.keySet()) {
            model.addAttribute(key, validatorResult.get(key));
        }

        return "members/addForm";
    }

    // 비밀번호 암호화
    BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();

    Member member = Member.builder()
            .username(memberform.getUsername())
            .password(passwordEncoder.encode(memberform.getPassword()))
            .date(memberform.getDate())
            .gender(memberform.getGender())
            .build();

    memberService.join(member);
    return "redirect:/";
}

회원가입 실패시 발생하는 오류를 Errors 객체를 이용해 담고 Errors의 내용을 Model을 통해 다시 회원가입폼으로 넘겨준다.

MemberService

/**
* 회원가입시, 유효성 체크
*/
public Map<String, String> validateHandling(Errors errors) {
    Map<String, String> validatorResult = new HashMap<>();

    for (FieldError error : errors.getFieldErrors()) {
        String validKeyName = String.format("valid_%s", error.getField());
        validatorResult.put(validKeyName, error.getDefaultMessage());
    }

    return validatorResult;
}

회원가입시 발생한 오류를 validatorResult Map 자료구조에 넣어 넘겨주었다.

문제점

기존의 코드도 정상작동하지만 검증이 Service 단까지 넘어온다는것과 오류메시지를 Map자료구조에 담은다음에 일일이 Model에 담는 부분이 복잡하다고 느껴집니다.

Map자료구조가 아닌 BindingResult 객체를 사용해서 오류메시지를 담아서 넘겨주자.

검증을 할때 크게 Errors와 BindingResult 객체를 사용합니다..
두 객체는 BindingResult는 groups 기능을 추가로 제공하는것 말고는 거의 똑같은 기능을 제공하므로 둘중에 아무거나 써도 상관없지만 여기서는 스프링이 제공하는 BindingResult 객체를 사용하도록 하겠습니다.

검증 순서

Bean Validation을 사용하면 LocalValidatorFactoryBean을 글로벌 Validator로 등록합니다. 이 Validator는 @NotNull 같은 애노테이션을 보고 검증을 수행합니다.

검증 오류가 발생하면 FieldError, ObjectError를 생성해서 BindingResult 에 담아줍니다.

추가로 오류를 자동으로 Model에 추가해줍니다.

즉 기존에 Errors에 있는 오류메시지를 Map자료구조에 담아서 Model에 넣어주는 과정이 BindingResult를 사용하므로써 자동으로 처리되게 할 수 있습니다.

 

참고
Errors도 BindingResult와 똑같이 작동가능합니다.

리팩토링

MemberSaveForm

package study.charlieZip.dto;

import lombok.Data;
import lombok.Getter;
import lombok.Setter;
import org.hibernate.validator.constraints.Range;
import study.charlieZip.entity.Gender;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;

@Data
public class MemberSaveForm {

    //NotEmpty는 null과 ""을 허용하지 않는다.
    @NotBlank(message = "회원 이름은 필수 입니다.")
    private String username;

    //NotBlank는 null과 ""와 " "(빈공백문자열)을 허용하지 않는다.
    @NotBlank(message = "비밀번호는 필수 입력 값입니다.")
    private String password;

    @NotEmpty
    @Pattern(regexp = "^[0-9]{8}$", message = "8자리로 입력해주세요.")
    private String date;

    @NotNull
    private Gender gender;

}

• MemberForm -> MemberSaveForm, MemberUpdateForm
  • 회원가입 폼을 저장과 수정 각각 분리했다.
• date 필드에 @NotEmpty , gender 필드에 @NotNull을 추가

MemberController

/**
* 회원가입
*/
@PostMapping(value = "/members/new")
public String addMember(@Validated @ModelAttribute("memberForm") MemberSaveForm memberForm, BindingResult bindingResult, Model model) {

    if (bindingResult.hasErrors()) {
        log.info("검증 오류 발생={}", bindingResult);
        Gender[] genders = Gender.values();
        model.addAttribute("genders", genders);

        return "members/addForm";
    }

    // 비밀번호 암호화
    BCryptPasswordEncoder passwordEncoder = new BCryptPasswordEncoder();

    Member member = Member.builder()
            .username(memberForm.getUsername())
            .password(passwordEncoder.encode(memberForm.getPassword()))
            .date(memberForm.getDate())
            .gender(memberForm.getGender())
            .build();

    memberService.join(member);
    return "redirect:/";
}

@Validated @ModelAttribute("memberForm") MemberSaveForm memberForm, BindingResult bindingResult

• @Validated를 통해 검증할 객체를 지정
• BindingResult는 MemberSaveForm 파라마티 바로 뒤에 와야한다.

bindingResult.hasErrors()

• hasErrors() 메서드를 통해 에러 메시지가 있는지 판별 가능

에러메시지가 있으면 bindingResult가 에러메시지를 자동으로 Model에 담아준다.

BindingResult를 통해서 기존의 Service까지 넘어가서 Map 자료구조에 데이터를 담는 부분을 Controller에서 처리가능하게 되었습니다.

추가로 타임리프는 th:errors를 제공해줍니다.
th:errors를 이용해 BindingResult가 Model에 담아준 객체를 편하게 꺼내서 쓸 수 있습니다.

회원가입 아이디 입력부분 - th:errors 사용

<div class="join_row">
    <h3 class="join_title">
        <label for="username">아이디</label>
    </h3>
    <input th:field="*{username}" type="text" id="username" class="input_text" maxlength="20">
    <span th:errors="*{username}"></span>
</div>

<span th:errors="*{username}"></span>
th:errors는 오류 메시지가 있으면 값을 불러오고 없으면 아예 태그 자체가 호출되지 않는다.

 

 

검증 리팩토링을 하기 위해 Bean Validation과 BindingResult를 공부해보니 정말 많은 부분을 자동으로 처리해준다는걸 느꼈습니다. 그리고 자동으로 처리해주는 많은 과정을 잘 알지 못한다면 저와 같이 Errors 객체를 사용하는데 Map 자료구조를 추가로 사용하는등 불필요한 과정을 추가하게 되실 수도 있을거 같습니다.

검증 Validation을 사용하실때는 스프링이 처리해주는 자동화 과정을 이해하시고 FieldError, ObjectError에 대해 이해하고 사용하시길 추천드립니다.

여기에 간단한 정리가 되어있으니 참고하시길 추천드립니다.