📌 Spring Validation + @InitBinder 활용법 / PropertyEditorSupport로 입력 데이터 포맷팅 자동화

📅 2025-04-24

📝 학습 내용

0️⃣ PropertyEditorSupport와 포맷팅(Formatting) 개념 정리

✅ PropertyEditorSupport란?

• Spring 데이터 바인딩 과정에서 문자열 데이터를 원하는 타입으로 변환해주는 클래스.
• 주로 사용자 입력값(String)을 LocalDate, 정제된 String 등으로 변환할 때 사용.
• @InitBinder와 함께 특정 필드에만 적용 가능.

🚨 언제 사용할까?

• 사용자가 입력하는 데이터 포맷이 일정하지 않을 때 (날짜, 전화번호, 금액 등)
• 반복적인 변환 로직을 없애고, 바인딩 시점에서 자동 변환 처리하고 싶을 때

---

⚠️ PropertyEditorSupport 사용 시 주의할 점

• PropertyEditorSupport의 getValue() 와 setValue() 메서드는 thread-safe 하지 않다.
• 즉, 멀티스레드 환경에서 공유하면 예상치 못한 문제가 발생할 수 있음.
• 따라서 절대 Spring Bean으로 등록해서 싱글톤으로 사용하면 안 됨!

✔️ 안전하게 사용하려면?

• 매 요청마다 생성되는 WebDataBinder에 등록해야 함.
• 이를 위해 사용하는 것이 바로 @InitBinder.

✔️ 결론: PropertyEditor는 요청 스코프 내에서만 사용해야 안전!

---

✅ 왜 @InitBinder를 사용해야 할까?

• @InitBinder는 컨트롤러 단위로 동작하며, 요청 시 생성되는 WebDataBinder에 커스텀 에디터를 등록.
• 이렇게 하면 매 요청마다 새로운 인스턴스가 적용되므로, thread-safe하지 않은 PropertyEditorSupport도 안전하게 사용 가능.
• 특정 필드에만 적용되기 때문에, 글로벌 설정보다 더 세밀한 데이터 바인딩이 가능!

✔️ 정리:
@InitBinder 사용 이유
1️⃣ 요청마다 안전하게 커스텀 에디터 적용
2️⃣ 반복적인 데이터 포맷팅 자동화
3️⃣ 필드 단위 세밀한 데이터 변환

---

1️⃣ Validation 애노테이션 정리

javax.validation 주요 애노테이션

• 숫자: @Min, @Max, @Positive, @Negative
• 문자열: @NotBlank, @Size, @Email, @Pattern
• 날짜: @Future, @Past, @DateTimeFormat
• 기타: @AssertTrue, @CreditCardNumber

---

2️⃣ @InitBinder와 Custom PropertyEditor 적용

✅ UserController.java

@Controller
@Slf4j
public class UserController {

    @InitBinder
    public void dataBinder(WebDataBinder webDataBinder) {
        // 전화번호와 생일 필드에 대해 커스텀 에디터 등록
        webDataBinder.registerCustomEditor(String.class, "phone", new PhoneNumberEditor());
        webDataBinder.registerCustomEditor(LocalDate.class, "birthday", new BirthdayEditor());
    }

    @GetMapping("/join")
    public void join() {
        log.info("GET /join...");
    }

    @PostMapping("/join")
    public void join_post(@Valid UserDto dto, BindingResult bindingResult, Model model) {
        log.info("POST /join..." + dto);

        if (bindingResult.hasErrors()) {
            for (FieldError error : bindingResult.getFieldErrors()) {
                log.info("Error Field: " + error.getField() + " | Msg: " + error.getDefaultMessage());
                model.addAttribute(error.getField(), error.getDefaultMessage());
            }
        }
    }

    // 생일 변환용 에디터
    private static class BirthdayEditor extends PropertyEditorSupport {
        @Override
        public void setAsText(String text) {
            LocalDate date = text.isEmpty() ? LocalDate.now()
                : LocalDate.parse(text.replaceAll("~", "-"), DateTimeFormatter.ofPattern("yyyy-MM-dd"));
            setValue(date);
        }
    }

    // 전화번호 포맷팅 에디터
    private static class PhoneNumberEditor extends PropertyEditorSupport {
        @Override
        public void setAsText(String phone) {
            if (phone.isEmpty()) {
                setValue("");
            } else {
                String formatNumber = phone.replace("-", "");
                setValue(formatNumber);
            }
            log.info("PhoneNumberEditor's setAsText invoke..." + phone);
        }
    }
}

---

3️⃣ JSP 회원가입 폼

<form action="${pageContext.request.contextPath}/join" method="post">
    <h1>회원가입</h1>
    ...
    <div>
        <label>phone:</label><span>${phone}</span><br>
        <input name="phone" placeholder="ex)010-0000-0000" />
    </div>
    <div>
        <label>birthday:</label><span>${birthday}</span><br>
        <input type="text" name="birthday" placeholder="ex)2025~01~01"/>
    </div>
    <div>
        <input type="submit" value="회원가입" />
    </div>
</form>

---

🔹 로그 출력 예시 (바인딩 과정 확인)

INFO : UserController - UserController's dataBinder 호출
INFO : UserController - POST /join...UserDto(phone=01012345678, birthday=2025-04-24)
INFO : PhoneNumberEditor - PhoneNumberEditor's setAsText invoke...010-1234-5678

---

🔗 참고 자료

• Spring WebDataBinder 공식 문서
• Bean Validation 가이드
• PropertyEditorSupport JavaDoc

---

느낀 점

• @InitBinder를 통해 입력 데이터의 포맷 문제를 사전에 해결할 수 있다는 점이 가장 큰 수확.
• 단순히 기능 구현이 아니라, 안정성(thread-safe) 까지 고려해야 함을 다시 한번 느꼈다.
• 실무에서도 적극 활용할 수 있는 좋은 패턴이라고 생각!

---

요약

• PropertyEditorSupport는 입력값 변환에 유용하지만, thread-safe 하지 않기 때문에 항상 @InitBinder로 요청마다 등록해야 함.
• Validation 애노테이션으로 기본 유효성 검사를 수행하고, 커스텀 에디터로 포맷팅을 자동화.
• 사용자 입력 포맷이 다양한 환경에서 코드 효율성과 안정성을 동시에 확보할 수 있는 방법!

---