검증(Validation) 처리 방법

검증 요구사항

상품 관리 시스템에서 상품 등록 폼의 입력값에 대한 검증 오류를 처리해보도록 하겠습니다.

타입 검증 : 가격, 수량에 문자가 들어오면 검증 오류 처리

필드 검증

상품명 : 필수, 공백 X
가격 : 1000원~1백만원 이하
수량 : 최대 9999

특정 필드의 범위를 넘어서는 검증

가격*수량 >= 10000원

컨트롤러의 중요한 역할 중 하나는 HTTP 요청이 정상인지 검증하는 일입니다.
검증에는 클라이언트 검증, 서버 검증이 있는데 클라이언트 검증은 조작이 가능해서 보안에 취약하고,
서버만으로 검증하면, 즉각적인 고객 사용성이 부족해집니다.
둘을 적절히 사용하되, 최종적인 서버검증은 필수적입니다.
API 방식을 사용하면 API 스펙을 잘 정의해서 검증 오류를 API 응답 결과에 잘 남겨주어야 합니다.

@PostMapping("/add")에서 상품 저장에 실패하면 Model에 검증 오류 결과를 포함해서 상품 등록 폼으로 리다이렉트 해줍니다.

이렇게 검증에 실패했을 때, 다시 상품 등록 폼을 보여주고, 오류 결과를 통해 어떤 값을 잘못입력했는지 클라이언트에게 알려줍니다.

이제 검증 로직을 직접 개발해보겠습니다.

검증 처리 - 직접 개발 using Map

Controller

@PostMapping("/add")
public String addItem(@ModelAttribute Item item, RedirectAttributes redirectAttributes,
                      Model model) {

    // 검증 오류 결과 보관
    Map<String,String> errors = new HashMap<>();


    // 검증 로직 - 상품명
    if(!StringUtils.hasText(item.getItemName()))
    {
        errors.put("itemName","상품 이름은 필수입니다.");
    }

    // 검증 로직 - 가격
    if(item.getPrice()==null || item.getPrice()<1000 || item.getPrice() > 1000000)
    {
        errors.put("price","가격은 1,000 ~ 1,000,000원까지 허용합니다.");
    }

    // 검증 로직 - 수량
    if(item.getQuantity() == null || item.getQuantity() >= 9999)
    {
        errors.put("quantity","수량은 최대 9999까지 허용합니다.");
    }

    // 복합 로직 - 가격*수량
    if(item.getPrice() != null && item.getItemName()!=null)
    {
        int resultPrice = item.getPrice() * item.getQuantity();
        if(resultPrice<10000)
        {
            errors.put("globalError","가격 * 수량의 합은 10,000원 이상이어야 합니다. " +
                    "현재 값 = " + resultPrice + "원");
        }
    }

    if(!errors.isEmpty())
    {
        log.info("Error message = {}",errors);
        model.addAttribute("errors",errors);
        return "validation/v1/addForm";
    }

    // 성공 로직
    Item savedItem = itemRepository.save(item);
    redirectAttributes.addAttribute("itemId", savedItem.getId());
    redirectAttributes.addAttribute("status", true);
    return "redirect:/validation/v1/items/{itemId}";
}

Logic

@PostMapping("/add")
public String addItem(@ModelAttribute Item item, RedirectAttributes redirectAttributes,
                      Model model) {

Post할 때 매핑된 요청 파라미터 기반으로 @ModelAttribute Item item 생성
▶︎ item의 property 찾아 setter 주입 ( 스프링 부트가 자동화 )

// 검증 오류 결과 보관
Map<String,String> errors = new HashMap<>();

HashMap<String,value>에 검증 오류 결과를 보관합니다.
<key,value> = < 오류가 발생한 필드명, 오류 메시지 >

// 검증 로직 - 상품명
if(!StringUtils.hasText(item.getItemName()))
{
    errors.put("itemName","상품 이름은 필수입니다.");
}

// 검증 로직 - 가격
if(item.getPrice()==null || item.getPrice()<1000 || item.getPrice() > 1000000)
{
    errors.put("price","가격은 1,000 ~ 1,000,000원까지 허용합니다.");
}

// 검증 로직 - 수량
if(item.getQuantity() == null || item.getQuantity() >= 9999)
{
    errors.put("quantity","수량은 최대 9999까지 허용합니다.");
}

// 복합 로직 - 가격*수량
if(item.getPrice() != null && item.getItemName()!=null)
{
    int resultPrice = item.getPrice() * item.getQuantity();
    if(resultPrice<10000)
    {
        errors.put("globalError","가격 * 수량의 합은 10,000원 이상이어야 합니다. " +
                "현재 값 = " + resultPrice + "원");
    }
}

1. 검증 로직 - 상품명

item 객체의 Name이 비어있을 경우 맵에 itemName (= 오류발생 필드명), 오류 메시지 put

2. 검증 로직 - 가격

item 객체의 가격 == null || <1000 || > 1000000 이면 맵에 price, 오류메시지 put

3. 검증 로직 - 가격

item 객체의 수량 == null || >= 9999 면 맵에 quantity, 오류메시지 put

4. 복합 로직 - 가격*수량

item 객체의 가격*수량 < 10000 이면 맵에 globalError, 오류메시지 put

if(!errors.isEmpty())
{
    log.info("Error message = {}",errors);
    model.addAttribute("errors",errors);
    return "validation/v1/addForm";
}

// 성공 로직
Item savedItem = itemRepository.save(item);
redirectAttributes.addAttribute("itemId", savedItem.getId());
redirectAttributes.addAttribute("status", true);
return "redirect:/validation/v1/items/{itemId}";

검증 과정(실패)

에러 맵이 비어있지 않으면 즉, 오류 메시지가 하나라도 있으면 오류 메시지를 출력하기 위해

model에 errors(에러 정보가 담긴 맵)을 담아 addForm 뷰 템플릿을 재 호출합니다.

( addForm에는 에러 메시지를 추가하기 위한 요소를 추가적으로 설정해 주어야 겠죠? )

검증 과정(성공)

성공 로직 실행 ( repository 저장 -> redirectAttribute에 itemId와 리다이렉트 status=true 설정 -> 아이템 상세 폼으로 리다이렉션 )

addForm.html

<style>
    .container {
        max-width: 560px;
    }
    .field-error {
        border-color: #dc3545;
        color: #dc3545;
    }
</style>

우선 class='field-error'로 지정된 경우 색깔을 변경하기 위해 style 태그에 다음과 같이 설정해주었어요.

<div th:if="${errors?.containsKey('globalError')}">
    <p class="field-error" th:text="${errors['globalError']}">
    글로벌 오류 메시지</p>
</div>

우선 글로벌 오류 메시지부터 처리해보겠습니다.

th:if 문을 이용해 errors 맵이 'globalError'을 갖고 있는지 확인합니다.

만약 있다면 하위태그를 실행하고 없다면 오류 메시지를 출력하지 않습니다.

❗️errors 뒤에 ?를 붙인 errors?. 은 errors가 null인 경우 NPE(NullPointerException)을 발생시키지 않고 null을 반환하는 문법입니다. th:if에서 null은 실패로 처리되므로 오류 메시지가 출력되지 않습니다.

<div>
    <label for="itemName" th:text="#{label.item.itemName}">상품명</label>
    <input type="text" id="itemName" th:field="*{itemName}"
           th:class=" ${errors?.containsKey('itemName')} ? 'form-control field-error' : 'form-control' "
           class="form-control" placeholder="이름을 입력하세요">
    <div class="field-error" th:if="${errors?.containsKey('itemName')}" th:text="${errors['itemName']}"></div>
</div>
<div>
    <label for="price" th:text="#{label.item.price}">가격</label>
    <input type="text" id="price" th:field="*{price}"
           th:classappend=" ${errors?.containsKey('price')} ? 'field-error' : _"
           class="form-control" placeholder="가격을 입력하세요">
    <div class="field-error" th:if="${errors?.containsKey('price')}" th:text="${errors['price']}"></div>

</div>

<div>
    <label for="quantity" th:text="#{label.item.quantity}">수량</label>
    <input type="text" id="quantity" th:field="*{quantity}" class="form-control"
           th:class=" ${errors?.containsKey('quantity')} ? 'form-control field-error' : 'form-control' "
           placeholder="수량을 입력하세요">
    <div class="field-error" th:if="${errors?.containsKey('quantity')}" th:text="${errors['quantity']}"></div>

</div>

이제 필드 오류를 처리해보겠습니다.

필드 오류 처리 - th:class (입력 폼 색상 적용)
- th:class를 통해 errors 맵에 'itemName'의 필드 오류가 있는지 확인하고 있으면 class를 'form-control', 'field-error'로 설정하고 없으면 'form-control'로 설정했습니다.
- th:classappend를 통해 처리할수도 있습니다 ( price는 th:classappend 를 사용해서 에러맵에 'price' key가 있으면 field-error 클래스를 append )
필드 오류 처리 - 메시지
- 필드 오류 발생 시 th:if를 사용해 해당 필드 키가 있으면 키에 대한 value를 출력하도록 설정

직접 개발한 검증 처리

검증 오류가 발생하면 입력폼(addForm)을 다시 보여주도록 설정했습니다.
검증 오류 발생시 오류 메시지들을 클라이언트에게 표시해주었습니다.
검증 오류가 발생해도 고객이 입력한 데이터가 그대로 유지됩니다. How?

@GetMapping("/add")
public String addForm(Model model) {
    model.addAttribute("item", new Item());
    return "validation/v1/addForm";
}

최초 상품등록 폼 요청 시 Item의 프로퍼티를 설정하지 않고 모델에 담아주어 addForm으로 넘겨주었었습니다.

@PostMapping("/add")
public String addItem(@ModelAttribute Item item, RedirectAttributes redirectAttributes,
                      Model model) {

<input type="text" id="itemName" th:field="*{itemName}"

<input type="text" id="price" th:field="*{price}"

검증 오류 발생 시 addForm에서 @ModelAttribute Item item에 프로퍼티 주입된 값들을 addForm에서 필드값으로 사용하기 때문에 검증 오류가 발생해도 고객이 입력한 데이터가 그대로 유지됩니다.

남은 문제점

뷰템플릿에서의 중복처리가 많음.
타입 오류 처리
클라이언트가 타입 오류값 입력 시 ( ex) price에 문자입력 ) 입력한 값 별도 관리 필요

BindingResult를 사용한 검증 처리

지금부터는 스프링이 제공하는 검증 오류 처리 방법을 알아보겠습니다.

Controller

@PostMapping("/add")
public String addItemV1(@ModelAttribute Item item, BindingResult bindingResult, RedirectAttributes redirectAttributes) {

    // 검증 로직 - 상품명
    if(!StringUtils.hasText(item.getItemName()))
    {
        bindingResult.addError(new FieldError("item","itemName","상품 이름은 필수입니다."));
    }

    // 검증 로직 - 가격
    if(item.getPrice()==null || item.getPrice()<1000 || item.getPrice() > 1000000)
    {
        bindingResult.addError(new FieldError("item","price","가격은 1,000 ~ 1,000,000까지 허용합니다."));
    }

    // 검증 로직 - 수량
    if(item.getQuantity() == null || item.getQuantity() >= 9999)
    {
        bindingResult.addError(new FieldError("item","quantity","수량은 최대 9,999까지 허용합니다."));
    }

    if(item.getPrice() != null && item.getItemName()!=null)
    {
        int resultPrice = item.getPrice() * item.getQuantity();
        if(resultPrice<10000)
        {
            bindingResult.addError(new ObjectError("item","가격 * 수량의 합은 10,000원 이상이어야 합니다." +
            "현재 값 = " + resultPrice));
        }
    }

    if(bindingResult.hasErrors())
    {
        log.info("Error message = {}",bindingResult);
        return "validation/v2/addForm";
    }

    // 성공 로직
    Item savedItem = itemRepository.save(item);
    redirectAttributes.addAttribute("itemId", savedItem.getId());
    redirectAttributes.addAttribute("status", true);
    return "redirect:/validation/v2/items/{itemId}";
}

BindingResult는 인터페이스로 실제로 넘어오는 구현체는 BeanPropertyBindingResult를 사용합니다.

BindingResult대신 Errors를 사용해도 되지만 Errors 인터페이스는 단순한 오류 저장과 조회 기능만 제공하고, BindingReuslt는 여기에 더해서 추가적인 기능을 제공합니다. addError()도 BindingResult가 제공합니다.

addError는 AbstractBindingResult에 위와 같이 구현되어 있습니다.

FieldError는 ObjectError와 상속관계이므로 FieldError도 사용 가능.

동작 원리

@ModelAttribute에 검증 오류 발생 시 bindingResult에 필드 오류는 FieldError를, 글로벌 오류는 ObjectError를 넣어줍니다.

+ BindingResult는 Model에 자동으로 포함됩니다.

❗️BindingResult bindingResult의 파라미터 위치는 @ModelAttribute Item item 다음에 와야 합니다.

글로벌 오류 - ObjectError

ObjectError의 파라미터

objectName : @ModelAttribute의 이름
defaultMesage : 설정할 기본 오류 메시지

Controller

if(item.getPrice() != null && item.getItemName()!=null)
{
    int resultPrice = item.getPrice() * item.getQuantity();
    if(resultPrice<10000)
    {
        bindingResult.addError(new ObjectError("item","가격 * 수량의 합은 10,000원 이상이어야 합니다." +
        "현재 값 = " + resultPrice));
    }
}

특정 필드를 넘어서는 오류가 있으면 ObjectError 객체를 생성해서 bindingResult에 담아두면 됩니다.

addForm

<div th:if="${#fields.hasGlobalErrors()}">
    <p class="field-error" th:each="err : ${#fields.globalErrors()}"
       th:text="${err}">글로벌 오류 메시지</p>
</div>

타임리프는 스프링의 BindingResult를 활용해서 편리하게 검증 오류를 표현하는 기능을 제공합니다.

#fields : #fields로 BindingResult가 제공하는 검증 오류에 접근할 수 있습니다.
th:errors : 해당 필드에 오류가 있는 경우에 태그를 출력합니다. ( th:if의 편의 버전 )
th:errorclass : th:field에서 지정한 필드에 오류가 있으면 class 정보를 추가합니다.

필드 오류 - FieldError

objectName : @ModelAttribute 이름
field : 오류가 발생한 필드 이름
defaultMessage : 기본 설정할 오류 메시지
+ rejectedValue : 사용자가 입력한 거절된 값
+ bindingFailure : 타입 오류 같은 바인딩 실패인지, 검증 실패인지 구분 값
+ codes : 메시지 코드
+ arguments : 메시지에서 사용하는 인자

뒤에 네개의 파라미터는 뒤에서 다루도록 하겠습니다.

// 검증 로직 - 상품명
if(!StringUtils.hasText(item.getItemName()))
{
    bindingResult.addError(new FieldError("item","itemName","상품 이름은 필수입니다."));
}

// 검증 로직 - 가격
if(item.getPrice()==null || item.getPrice()<1000 || item.getPrice() > 1000000)
{
    bindingResult.addError(new FieldError("item","price","가격은 1,000 ~ 1,000,000까지 허용합니다."));
}

// 검증 로직 - 수량
if(item.getQuantity() == null || item.getQuantity() >= 9999)
{
    bindingResult.addError(new FieldError("item","quantity","수량은 최대 9,999까지 허용합니다."));
}

상품명 검증 로직을 예를들면,

objectName = "item", field = "itemName", defaultMessage = "상품 이름은 필수입니다" 로 지정했는데,

if조건을 만족하면 objectName을 @ModelAttribute Item "item"으로, "itemName"을 필드이름으로, "상품 이름은 필수입니다"를 기본 오류 메시지로 설정해서 bindingResult에 더해주었습니다.

@ModelAttribute에 바인딩 시 타입 오류가 발생하면

BindingResult가 있으면 ➣ @ModelAttribute에 데이터 바인딩 시 오류가 발생하면 오류 정보를 BindingResult에 담아서 컨트롤러를 호출합니다.

BindingResult가 없으면 ➣ 400 오류가 발생하면서 컨트롤러가 호출되지 않고, 오류 페이지로 이동합니다.

즉 BindingResult를 사용하면 타입오류는 스프링이 자동으로 BindingResult에 FieldError를 넣어줍니다.

BindingResult를 사용해 검증 오류를 적용하는 방법은 세 가지가 있습니다.

1. 위와 같은 방식으로 개발자가 직접 넣어준다.(필드 오류, 글로벌 오류)

2. @ModelAttribute의 객체에 타입 오류 등으로 바인딩이 실패하는 경우 스프링이 FieldError 생성해서 BindingResult에 넣어줍니다.

3. Validator 사용

<정리>

BindingResult, FieldError, ObjectError를 사용해서 오류 메시지를 처리하는 방법에 대해 알아보았습니다.

하지만 오류가 발생하면 고객이 입력한 내용이 모두 사라지는 문제가 있습니다. 이 문제를 해결해보겠습니다.

FieldError, ObjectError 추가 파라미터 설정

FieldError는 오류 발생시 사용자 입력 값을 저장하는 기능을 제공합니다.

@PostMapping("/add")
public String addItemV2(@ModelAttribute Item item, BindingResult bindingResult,
                        RedirectAttributes redirectAttributes)
{
    if(!StringUtils.hasText(item.getItemName()))
    {
        bindingResult.addError(
                new FieldError("item",
                        "itemName",
                        item.getItemName(),
                        false,
                        null,
                        null,
                        "상품 이름은 필수입니다."));
    }

    // 검증 로직 - 가격
    if(item.getPrice()==null || item.getPrice()<1000 || item.getPrice() > 1000000)
    {
        bindingResult.addError(
                new FieldError("item",
                        "price",
                        item.getPrice(),
                        false,
                        null,
                        null,
                        "가격은 1,000 ~ 1,000,000까지 허용합니다."));
    }

    // 검증 로직 - 수량
    if(item.getQuantity() == null || item.getQuantity() >= 9999)
    {
        bindingResult.addError(
                new FieldError("item",
                        "quantity",
                        item.getQuantity(),
                        false,
                        null,
                        null,
                        "수량은 최대 9,999까지 허용합니다."));
    }

    if(item.getPrice() != null && item.getItemName()!=null)
    {
        int resultPrice = item.getPrice() * item.getQuantity();
        if(resultPrice<10000)
        {
            bindingResult.addError(
                    new ObjectError("item",
                            null,
                            null,
                            "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice));
        }
    }

    if(bindingResult.hasErrors())
    {
        log.info("Error message = {}",bindingResult);
        return "validation/v2/addForm";
    }

    // 성공 로직
    Item savedItem = itemRepository.save(item);
    redirectAttributes.addAttribute("itemId", savedItem.getId());
    redirectAttributes.addAttribute("status", true);
    return "redirect:/validation/v2/items/{itemId}";
}

FiledError는 두가지 생성자를 지원합니다.

objectName : @ModelAttribute 이름
field : 오류가 발생한 필드 이름
defaultMessage : 기본 설정할 오류 메시지
+ rejectedValue : 사용자가 입력한 거절된 값
+ bindingFailure : 타입 오류 같은 바인딩 실패인지, 검증 실패인지 구분 값
+ codes : 메시지 코드 ( defalutMessgae 대체화 할때 사용, 뒤에 설명 )
+ arguments : 메시지에서 사용하는 인자 ( defalutMessgae 대체화 할때 사용, 뒤에 설명 )

if(!StringUtils.hasText(item.getItemName()))
{
    bindingResult.addError(
            new FieldError("item",
                    "itemName",
                    item.getItemName(),
                    false,
                    null,
                    null,
                    "상품 이름은 필수입니다."));
}

// 검증 로직 - 가격
if(item.getPrice()==null || item.getPrice()<1000 || item.getPrice() > 1000000)
{
    bindingResult.addError(
            new FieldError("item",
                    "price",
                    item.getPrice(),
                    false,
                    null,
                    null,
                    "가격은 1,000 ~ 1,000,000까지 허용합니다."));
}

// 검증 로직 - 수량
if(item.getQuantity() == null || item.getQuantity() >= 9999)
{
    bindingResult.addError(
            new FieldError("item",
                    "quantity",
                    item.getQuantity(),
                    false,
                    null,
                    null,
                    "수량은 최대 9,999까지 허용합니다."));
}

rejectedValue는 바로 오류 발생 시 사용자 입력 값을 저장하는 필드입니다.

타임리프의 사용자 입력 값 유지

th:field="*{price}"
타임리프의 th:field는 매우 똑똑하게 동작하는데, 정상 상황에는 모델 객체의 값을 사용하지만, 오류가 발생하면 FieldError에서 보관한 값을 사용해서 값을 출력합니다.

스프링의 바인딩 오류 처리

타입 오류로 바인딩에 실패하면 스프링은 FieldError를 생성하면서 사용자가 입력한 값을 자동으로 넣어줍니다!
그리고 해당 오류를 BindingResult 에 담아서 컨트롤러를 호출합니다. 따라서 타입 오류 같은 바인딩 실패시에도 사용자의 오류 메시지를 정상적으로 출력할 수 있습니다.

<참고자료>

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

웹 애플리케이션 개발에 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. MVC 2편에서는 MVC 1편의 핵심 원리와 구조 위에 실무 웹 개발에 필요한 모든 활용 기술들을 학습할 수 있

www.inflearn.com

저작자표시

'📕 Backend > MVC Pattern' 카테고리의 다른 글

Bean Validation - 검증 어노테이션 사용 (0)	2023.03.22
오류 코드와 메시지 처리 (0)	2023.03.21
메시지, 국제화 기능 (0)	2023.03.20
Spring MVC 기본 기능 - 응답 매핑 @ResponseBody, MessageConverter, 요청 매핑 핸들러 어댑터 구조 (0)	2023.03.13
Spring MVC 기본 기능 - 요청 매핑 @RequestMapping, @RequestParam (0)	2023.03.12

블로그의 정보

Study Repository

rlaehddnd0422

검증(Validation) 처리 방법

검증 요구사항

검증 처리 - 직접 개발 using Map

Controller

Logic

addForm.html

BindingResult를 사용한 검증 처리

Controller

동작 원리

글로벌 오류 - ObjectError

ObjectError의 파라미터

필드 오류 - FieldError

FieldError, ObjectError 추가 파라미터 설정

FiledError는 두가지 생성자를 지원합니다.

'📕 Backend > MVC Pattern' 카테고리의 다른 글

블로그의 정보

활동하기

티스토리툴바

검증 요구사항

검증 처리 - 직접 개발 using Map

Controller

Logic

addForm.html

BindingResult를 사용한 검증 처리

Controller

동작 원리

글로벌 오류 - ObjectError

ObjectError의 파라미터

필드 오류 - FieldError

FieldError, ObjectError 추가 파라미터 설정

FiledError는 두가지 생성자를 지원합니다.

'📕 Backend > MVC Pattern' 카테고리의 다른 글

블로그의 정보

활동하기

공유하기

다른 글

티스토리툴바