김영한의 스프링 완전 정복 로드맵
스프링 MVC 2편 - 백엔드 웹 개발 활용 기술
섹션4~섹션7 정리입니다.

섹션4. 검증1 - Validation

검증 요구사항

상품 관리 시스템에 새로운 요구사항이 추가되었다

# 요구사항: 검증 로직 추가

• 타입 검증
  • 가격, 수량에 문자가 들어가면 검증 오류 처리
• 필드 검증
  • 상품명: 필수, 공백X
  • 가격: 1000원 이상, 1백만원 이하
  • 수량: 최대 9999
• 특정 필드의 범위를 넘어서는 검증
  • 가격 * 수량의 합은 10,000원 이상

📌 중요한 두가지

1. 지금까지 만든 웹 애플리케이션은 폼 입력시 숫자를 문자로 작성하거나해서 검증 오류가 발생하면 오류 화면으로 바로 이동한다.

💫 해당 폼으로 다시 이동해서 입력하는 것보다는, 그전에 입력한 정보를 불러와 다시 보여주는 것이 좋다 (다시 처음부터 다시 입력해야 한다면 고객 입장에선 서비스 불편으로 떠날 가능성 많음)

2. 웹 서비스는 폼 입력시 오류가 발생하면, 고객이 입력한 데이터를 유지한 상태로 어떤 오류가 발생했는지 친절하게 알려주어야 한다

👉 하나 더

컨트롤러의 중요한 역할중 하나는 HTTP 요청이 정상인지 검증하는 것이다.
그리고 정상 로직보다 이런 검증 로직을 잘 개발하는 것이 어쩌면 더 어려울 수 있다

참고: 클라이언트 검증, 서버 검증
1. 클라이언트 검증은 조작할 수 있으므로 보안에 취약하다.
2. 서버만으로 검증하면, 즉각적인 고객 사용성이 부족해진다.
3. 둘을 적절히 섞어서 사용하되, 최종적으로 서버 검증은 필수
4. API 방식을 사용하면 API 스펙을 잘 정의해서 검증 오류를 API 응답 결과에 잘 남겨주어야 함

V1

상품 저장 성공

사용자가 상품 등록 폼에서 정상 범위의 데이터를 입력하면, 서버에서는 검증 로직이 통과하고, 상품을 저장하고, 상품 상세 화면으로 redirect한다.

상품 저장 검증 실패

1. 고객이 상품 등록 폼에서 상품명을 입력하지 않거나,
2. 가격, 수량 등이 너무 작거나 커서 검증 범위를 넘어서면,

서버 검증 로직이 실패해야 한다.
이렇게 검증에 실패한 경우 고객에게 다시 상품 등록 폼을 보여주고, 어떤 값을 잘못 입력했는지 친절하게 알려주어야 한다.

검증 직접 처리 - 개발

상품 등록 검증

ValidationItemControllerV1 - addItem() 수정

@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", "수량은 최대 9,999 까지 허용합니다.");
     }
     
     //특정 필드가 아닌 복합 룰 검증
     if (item.getPrice() != null && item.getQuantity() != null) {
         int resultPrice = item.getPrice() * item.getQuantity();
         if (resultPrice < 10000) {
             errors.put("globalError", "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice);
         }
     }
     
     //검증에 실패하면 다시 입력 폼으로
     if (!errors.isEmpty()) {
         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}";
}

# 검증 오류 보관 및 검증 로직

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

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

• 검증 오류 보관 :
  만약 검증시 오류가 발생하면 어떤 검증에서 오류가 발생했는지 정보를 담아둔다.
• 검증 로직 :
  검증시 오류가 발생하면 errors에 담아둔다.
  이때 어떤 필드에서 오류가 발생했는지 구분하기 위해 오류가 발생한 필드명을 key로 사용한다.

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

 // 특정 필드의 범위를 넘어서는 검증 로직
 if (item.getPrice() != null && item.getQuantity() != null) {
     int resultPrice = item.getPrice() * item.getQuantity();
     if (resultPrice < 10000) {
     	 errors.put("globalError", "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice);
     }
 }

• 특정 필드를 넘어서는 오류를 처리해야 할 수도 있다. 이때는 필드 이름을 넣을 수 없으므로 globalError 라는 key 를 사용한다.

검증에 실패하면 다시 입력 폼으로

if (!errors.isEmpty()) {
   model.addAttribute("errors", errors);
   return "validation/v1/addForm";
}

만약 검증에서 오류 메시지가 하나라도 있으면,
오류 메시지를 출력하기 위해 model에 errors를 담고, 입력 폼이 있는 뷰 템플릿으로 보낸다.

css 추가

.field-error {
 border-color: #dc3545;
 color: #dc3545;
}

• 오류 메시지를 빨간색으로 강조하기 위해 추가

글로벌 오류 메시지

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

• 오류 메시지는 errors에 내용이 있을 때만 출력하면 된다. \
  타임리프의 th:if 를 사용하면 조건에 만족할 때만 해당 HTML 태그를 출력할 수 있다.

📌 참고 Safe Navigation Operator
만약 여기에서 errors 가 null 이라면 어떻게 될까?🤔
생각해보면 등록폼에 진입한 시점에는 errors가 없다.
따라서 errors.containsKey()를 호출하는 순간 NullPointerException 이 발생한다.

errors?. 은 errors 가 null 일때 NullPointerException 이 발생하는 대신, null 을 반환하는 문법이다.
th:if 에서 null 은 실패로 처리되므로 오류 메시지가 출력되지 않는다.

필드 오류 처리

<input type="text" th:classappend="${errors?.containsKey('itemName')} ? 'field-error' : _"
 class="form-control">

• classappend를 사용해서 해당 필드에 오류가 있으면 field-error라는 클래스 정보를 더해서 폼의 색깔을 빨간색으로 강조한다.
• 만약 값이 없으면 _(No-Operation)을 사용해서 아무것도 하지 않는다.

정리

• 만약 검증 오류가 발생하면 입력 폼을 다시 보여준다.
• 검증 오류들을 고객에게 친절하게 안내해서 다시 입력할 수 있게 한다.
• 검증 오류가 발생해도 고객이 입력한 데이터가 유지된다.

남은 문제점

• 뷰 템플릿에서 중복 처리가 많다. 뭔가 비슷하다.
• 타입 오류 처리가 안된다. Item의 price , quantity 같은 숫자 필드는 타입이 Integer 이므로 문자 타입으로 설정하는 것이 불가능하다.
  숫자 타입에 문자가 들어오면 오류가 발생한다. 그런데 이러한 오류는
  ➞ 스프링MVC에서 컨트롤러에 진입하기도 전에 예외가 발생하기 때문에, 컨트롤러가 호출되지도 않고, 400 예외가 발생하면서 오류 페이지를 띄워준다.
• Item 의 price 에 문자를 입력하는 것 처럼 타입 오류가 발생해도 고객이 입력한 문자를 화면에 남겨야 한다.
  ➞ 만약 컨트롤러가 호출된다고 가정해도 Item 의 price 는 Integer 이므로 문자를 보관할 수가 없다.
  ➞ 결국 문자는 바인딩이 불가능하므로 고객이 입력한 문자가 사라지게 되고, 고객은 본인이 어떤 내용을 입력해서 오류가 발생했는지 이해하기 어렵다.
• 결국 고객이 입력한 값도 어딘가에 별도로 관리가 되어야 한다.

V2

BindingResult1

ValidationItemControllerV2 - addItemV1

@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() > 10000) {
   bindingResult.addError(new FieldError("item", "quantity", "수량은 최대 9,999 까지 허용합니다."));
   }
   
   //특정 필드 예외가 아닌 전체 예외
   if (item.getPrice() != null && item.getQuantity() != null) {
       int resultPrice = item.getPrice() * item.getQuantity();
       if (resultPrice < 10000) {
       bindingResult.addError(new ObjectError("item", "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice));
     }
   }
   
   if (bindingResult.hasErrors()) {
       log.info("errors={}", 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 bindingResult 파라미터의 위치는 @ModelAttribute Item item 다음에 와야 한다.

필드 오류 & 필드 오류 생성자

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

필드에 오류가 있으면 FieldError 객체를 생성해서 bindingResult 에 담아두면 된다.

public FieldError(String objectName, String field, String defaultMessage) {}

• objectName : @ModelAttribute 이름
• field : 오류가 발생한 필드 이름
• defaultMessage : 오류 기본 메시지

글로벌 오류 & 글로벌 오류 생성자

bindingResult.addError(new ObjectError("item", "가격 * 수량의 합은 10,000원 이상이어야 합니다. 현재 값 = " + resultPrice));

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

public ObjectError(String objectName, String defaultMessage) {}

• objectName : @ModelAttribute 의 이름
• defaultMessage : 오류 기본 메시지

타임리프 스프링 검증 오류 통합 기능

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

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

BindingResult2

• 스프링이 제공하는 검증 오류를 보관하는 객체이다. 검증 오류가 발생하면 여기에 보관하면 된다.
• BindingResult 가 있으면 @ModelAttribute 에 데이터 바인딩 시 오류가 발생해도 컨트롤러가호출된다!

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

• BindingResult 가 없으면 ➞ 400 오류가 발생하면서 컨트롤러가 호출되지 않고, 오류 페이지로 이동한다.
• BindingResult 가 있으면 ➞ 오류 정보(FieldError)를 BindingResult 에 담아서 컨트롤러를 정상 호출한다.

# BindingResult에 검증 오류를 적용하는 3가지 방법

1. @ModelAttribute 의 객체에 타입 오류 등으로 바인딩이 실패하는 경우 스프링이 FieldError 생성해서 BindingResult 에 넣어준다.
2. 개발자가 직접 넣어준다.
3. Validator 사용 (이것은 뒤에서 설명)

# 타입 오류 확인

숫자가 입력되어야 할 곳에 문자를 입력해서 타입을 다르게 해서 BindingResult 를 호출하고 bindingResult 의 값을 확인해보자.

📌 주의
BindingResult는 검증할 대상 바로 다음에 와야한다. 순서가 중요하다.
예를 들어서 @ModelAttribute Item item , 바로 다음에 BindingResult 가 와야 한다.
BindingResult 는 Model에 자동으로 포함된다.

BindingResult와 Errors

• org.springframework.validation.Errors
• org.springframework.validation.BindingResult

BindingResult는 인터페이스이고, Errors 인터페이스를 상속받고 있다.
실제 넘어오는 구현체는 BeanPropertyBindingResult 라는 것인데, 둘다 구현하고 있으므로 BindingResult 대신에 Errors 를 사용해도 된다.
Errors 인터페이스는 단순한 오류 저장과 조회 기능을 제공한다.
BindingResult는 여기에 더해서 추가적인 기능들을 제공한다.
addError()도 BindingResult가 제공하므로 여기서는 BindingResult를 사용하자.
➞ 주로 관례상 BindingResult를 많이 사용한다.

정리

BindingResult , FieldError , ObjectError를 사용해서 오류 메시지를 처리하는 방법을 알아보았다.
➞ 런데 오류가 발생하는 경우 고객이 입력한 내용이 모두 사라진다. 이 문제를 해결해보자

FieldError, ObjectError

목표

• 자 입력 오류 메시지가 화면에 남도록 하자.
  • 예) 가격을 1000원 미만으로 설정시 입력한 값이 남아있어야 한다.
• FieldError , ObjectError 에 대해서 더 자세히 알아보자.

ValidationItemControllerV2 - addItemV2

@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() > 10000) {
         bindingResult.addError(new FieldError("item", "quantity",
         				item.getQuantity(), false, null, null, "수량은 최대 9,999 까지 허용합니다."));
     }
     
     //특정 필드 예외가 아닌 전체 예외
     if (item.getPrice() != null && item.getQuantity() != 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("errors={}", 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}";
}

FieldError 생성자

2 가지 생성자를 제공한다.

public FieldError(String objectName, String field, String defaultMessage);
public FieldError(String objectName, String field, @Nullable Object 
rejectedValue, boolean bindingFailure, @Nullable String[] codes, @Nullable
Object[] arguments, @Nullable String defaultMessage)

# 파라미터 목록

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

ObjectError 도 유사하게 2 가지 생성자를 제공한다.

# 오류 발생시 사용자 입력 값 유지

new FieldError("item", "price", item.getPrice(), false, null, null, 
"가격은 1,000 ~ 1,000,000 까지 허용합니다.")

사용자의 입력 데이터가 컨트롤러의 @ModelAttribute 에 바인딩되는 시점에 오류가 발생하면, 모델 객체에 사용자 입력 값을 유지하기 어렵다.

• 예) 가격에 숫자가 아닌 문자가 입력된다면 가격은 Integer 타입이므로 문자를 보관할 수 있는 방법이 없다.
  • 그래서 오류가 발생한 경우 사용자 입력 값을 보관하는 별도의 방법이 필요하다.
  • 그리고 이렇게 보관한 사용자 입력 값을 검증 오류 발생시 화면에 다시 출력하면 된다.

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

여기서 rejectedValue 가 바로 오류 발생시 사용자 입력 값을 저장하는 필드다.
bindingFailure 는 타입 오류 같은 바인딩이 실패했는지 여부를 적어주면 된다.
여기서는 바인딩이 실패한 것은 아니기 때문에 false 를 사용한다.

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

th:field="*{price}"
타임리프의 th:field 는 매우 똑똑하게 동작하는데,

• 정상 상황 ➞ 모델 객체의 값을 사용하지만,
• 오류가 발생하면 ➞ FieldError 에서 보관한 값을 사용해서 값을 출력한다.

스프링의 바인딩 오류 처리

1. 타입 오류로 바인딩에 실패하면 스프링은 FieldError 를 생성하면서 사용자가 입력한 값을 넣어둔다.
2. 오류를 BindingResult 에 담아서 컨트롤러를 호출한다.
   따라서 타입 오류 같은 바인딩실패시에도 사용자의 오류 메시지를 정상 출력할 수 있다.

오류 코드와 메시지 처리1

FieldError 생성자

public FieldError(String objectName, String field, String defaultMessage);
public FieldError(String objectName, String field, @Nullable Object 
rejectedValue, boolean bindingFailure, @Nullable String[] codes, @Nullable
Object[] arguments, @Nullable String defaultMessage)

# 파라미터 목록

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

FieldError , ObjectError 의 생성자는 codes , arguments 를 제공한다. 이것은 오류 발생시 오류 코드로 메시지를 찾기 위해 사용된다.

# errors 메시지 파일 생성

messages.properties 를 사용해도 되지만, 오류 메시지를 구분하기 쉽게 errors.properties 라는 별도의 파일로 관리해보자.

# 스프링 부트 메시지 설정 추가

application.properties

spring.messages.basename=messages,errors

먼저 스프링 부트가 해당 메시지 파일을 인식할 수 있게 다음 설정을 추가한다.
이렇게하면 messages.properties , errors.properties 두 파일을 모두 인식한다. (생략하면 messages.properties 를 기본으로 인식한다.)

errors.properties 추가

src/main/resources/errors.properties

required.item.itemName=상품 이름은 필수입니다.
range.item.price=가격은 {0} ~ {1} 까지 허용합니다.
max.item.quantity=수량은 최대 {0} 까지 허용합니다.
totalPriceMin=가격 * 수량의 합은 {0}원 이상이어야 합니다. 현재 값 = {1}

📌 참고
errors_en.properties 파일을 생성하면 오류 메시지도 국제화 처리를 할 수 있다.

ValidationItemControllerV2 - addItemV3() 추가

@PostMapping("/add")
public String addItemV3(@ModelAttribute Item item, BindingResult bindingResult,
    RedirectAttributes redirectAttributes) {
    
     if (!StringUtils.hasText(item.getItemName())) {
         bindingResult.addError(new FieldError("item", "itemName",
        item.getItemName(), false, new String[]{"required.item.itemName"}, null, null));
     }
     
     if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
         bindingResult.addError(new FieldError("item", "price", item.getPrice(), 
         	false, new String[]{"range.item.price"}, new Object[]{1000, 1000000}, null));
     }
     
     if (item.getQuantity() == null || item.getQuantity() > 10000) {
         bindingResult.addError(new FieldError("item", "quantity",
        item.getQuantity(), false, new String[]{"max.item.quantity"}, new Object[] {9999}, null));
     }
     
     //특정 필드 예외가 아닌 전체 예외
     if (item.getPrice() != null && item.getQuantity() != null) {
         int resultPrice = item.getPrice() * item.getQuantity();
         if (resultPrice < 10000) {
             bindingResult.addError(new ObjectError("item", 
                  new String[] {"totalPriceMin"}, new Object[]{10000, resultPrice}, null));
       }
     }
     
     if (bindingResult.hasErrors()) {
         log.info("errors={}", 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}";
}

• codes : required.item.itemName 를 사용해서 메시지 코드를 지정한다.
  메시지 코드는 하나가 아니라 배열로 여러 값을 전달할 수 있는데, 순서대로 매칭해서 처음 매칭되는 메시지가 사용된다.
• arguments : Object[]{1000, 1000000} 를 사용해서 코드의 {0} , {1} 로 치환할 값을 전달한다.

실행해보면 메시지, 국제화에서 학습한 MessageSource 를 찾아서 메시지를 조회하는 것을 확인할 수 있다.

오류 코드와 메시지 처리2

목표

• FieldError , ObjectError 는 다루기 너무 번거롭다.
• 오류 코드도 좀 더 자동화 할 수 있지 않을까? 예) item.itemName 처럼?🤔

컨트롤러에서 BindingResult 는 검증해야 할 객체인 target 바로 다음에 온다.
따라서 BindingResult 는 이미 본인이 검증해야 할 객체인 target 을 알고 있다.

log.info("objectName={}", bindingResult.getObjectName());
log.info("target={}", bindingResult.getTarget());

출력 결과

objectName=item //@ModelAttribute name
target=Item(id=null, itemName=상품, price=100, quantity=1234)

rejectValue(), reject() 를 사용해서 기존 코드 단순화

BindingResult 가 제공하는 rejectValue() , reject() 를 사용하면 FieldError , ObjectError 를 직접 생성하지 않고, 깔끔하게 검증 오류를 다룰 수 있다.

@PostMapping("/add")
public String addItemV4(@ModelAttribute Item item, BindingResult bindingResult,
RedirectAttributes redirectAttributes) {
   log.info("objectName={}", bindingResult.getObjectName());
   log.info("target={}", bindingResult.getTarget());
  
   if (!StringUtils.hasText(item.getItemName())) {
       bindingResult.rejectValue("itemName", "required");
   }
   
   if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
       bindingResult.rejectValue("price", "range", new Object[]{1000, 1000000}, null);
   }
   
   if (item.getQuantity() == null || item.getQuantity() > 10000) {
       bindingResult.rejectValue("quantity", "max", new Object[]{9999}, null);
   }
   
   //특정 필드 예외가 아닌 전체 예외
   if (item.getPrice() != null && item.getQuantity() != null) {
       int resultPrice = item.getPrice() * item.getQuantity();
       if (resultPrice < 10000) {
       bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
     }
   }
   
   if (bindingResult.hasErrors()) {
     log.info("errors={}", 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}";
}

Q.🔍🧐 오류 메시지가 정상 출력된다. 그런데 errors.properties 에 있는 코드를 직접 입력하지 않았는데 어떻게 된 것일까?

A. 축약된 오류 코드
FieldError() 를 직접 다룰 때는 오류 코드를 모두 입력했다. ex) range.item.price
그런데 rejectValue() 를 사용하고 부터는 오류 코드를 range 로 간단하게 입력했다.
그래도 오류 메시지를 잘 찾아서 출력한다. 무언가 규칙이 있는 것 처럼 보인다.
이 부분을 이해하려면 MessageCodesResolver 를 이해해야 한다.

rejectValue()와 reject()

# rejectValue()

void rejectValue(@Nullable String field, String errorCode,
@Nullable Object[] errorArgs, @Nullable String defaultMessage);

• field : 오류 필드명
• errorCode : 오류 코드
  • (이 오류 코드는 메시지에 등록된 코드가 아니다. 뒤에서 설명할 messageResolver를 위한 오류 코드이다.)
• errorArgs : 오류 메시지에서 {0} 을 치환하기 위한 값
• defaultMessage : 오류 메시지를 찾을 수 없을 때 사용하는 기본 메시지

# reject()

void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String 
defaultMessage);

오류 코드와 메시지 처리3

오류 코드를 만들 때 다음과 같이 자세히 만들 수도 있고
required.item.itemName : 상품 이름은 필수 입니다.
range.item.price : 상품의 가격 범위 오류 입니다.

또는 다음과 같이 단순하게 만들 수도 있다.
required : 필수 값 입니다.
range : 범위 오류 입니다.

단순하게 만들면 범용성이 좋아서 여러곳에서 사용할 수 있지만, 메시지를 세밀하게 작성하기 어렵다. 반대로 너무 자세하게 만들면 범용성이 떨어진다.
➞ 가장 좋은 방법은 범용성으로 사용하다가, 세밀하게 작성해야 하는 경우에는 세밀한 내용이 적용되도록 메시지에 단계를 두는 방법이다.

범용성 있게 잘 개발해두면, 메시지의 추가 만으로 매우 편리하게 오류 메시지를 관리할 수 있을 것이다.
스프링은 MessageCodesResolver 라는 것으로 이러한 기능을 지원한다.

오류 코드와 메시지 처리4

MessageCodesResolverTest

public class MessageCodesResolverTest {
   MessageCodesResolver codesResolver = new DefaultMessageCodesResolver();

   @Test
   void messageCodesResolverObject() {
     String[] messageCodes = codesResolver.resolveMessageCodes("required", "item");
     assertThat(messageCodes).containsExactly("required.item", "required");
   }
   
   @Test
   void messageCodesResolverField() {
     String[] messageCodes = codesResolver.resolveMessageCodes("required", "item", "itemName", String.class);
     assertThat(messageCodes).containsExactly(
           "required.item.itemName",
           "required.itemName",
           "required.java.lang.String",
           "required"
       );
   }
}

MessageCodesResolver

• 검증 오류 코드로 메시지 코드들을 생성한다.
• MessageCodesResolver 인터페이스이고 DefaultMessageCodesResolver 는 기본 구현체이다.
• 주로 다음과 함께 사용 ObjectError , FieldError

DefaultMessageCodesResolver의 기본 메시지 생성 규칙

# 객체 오류

객체 오류의 경우 다음 순서로 2가지 생성
1.: code + "." + object name
2.: code

예) 오류 코드: required, object name: item
1.: required.item
2.: required

# 필드 오류

필드 오류의 경우 다음 순서로 4가지 메시지 코드 생성

1.: code + "." + object name + "." + field
2.: code + "." + field
3.: code + "." + field type
4.: code

예) 오류 코드: typeMismatch, object name "user", field "age", field type: int
1. "typeMismatch.user.age"
2. "typeMismatch.age"
3. "typeMismatch.int"
4. "typeMismatch"

# 동작 방식

• rejectValue() , reject() 는 내부에서 MessageCodesResolver 를 사용한다. 여기에서 메시지 코드들을 생성한다.
• FieldError , ObjectError 의 생성자를 보면, 오류 코드를 하나가 아니라 여러 오류 코드를 가질 수 있다.
  • MessageCodesResolver 를 통해서 생성된 순서대로 오류 코드를 보관한다.
• 이 부분을 BindingResult 의 로그를 통해서 확인해보자.
  • codes [range.item.price, range.price, range.java.lang.Integer, range]

# FieldError rejectValue("itemName", "required")

다음 4가지 오류 코드를 자동으로 생성

• required.item.itemName
• required.itemName
• required.java.lang.String
• required

# ObjectError reject("totalPriceMin")

다음 2가지 오류 코드를 자동으로 생성

• totalPriceMin.item
• totalPriceMin

# 오류 메시지 출력

타임리프 화면을 렌더링 할 때 th:errors 가 실행된다.
만약 이때 오류가 있다면 생성된 오류 메시지 코드를 순서대로 돌아가면서 메시지를 찾는다. 그리고 없으면 디폴트 메시지를 출력한다.

오류 코드와 메시지 처리5

오류 코드 관리 전략

핵심은 구체적인 것에서! 덜 구체적인 것으로!

MessageCodesResolver 는 required.item.itemName 처럼 구체적인 것을 먼저 만들어주고, required 처럼 덜 구체적인 것을 가장 나중에 만든다.
이렇게 하면 앞서 말한 것 처럼 메시지와 관련된 공통 전략을 편리하게 도입할 수 있다.

왜 이렇게 복잡하게 사용하는가? 🤔

모든 오류 코드에 대해서 메시지를 각각 다 정의하면 개발자 입장에서 관리하기 너무 힘들다.
크게 중요하지 않은 메시지는 범용성 있는 requried 같은 메시지로 끝내고, 정말 중요한 메시지는 꼭 필요할 때 구체적으로 적어서 사용하는 방식이 더 효과적이다.

정리

1. rejectValue()호출
2. MessageCodesResolver 를 사용해서 검증 오류 코드로 메시지 코드들을 생성
3. new FieldError() 를 생성하면서 메시지 코드들을 보관
4. th:erros 에서 메시지 코드들로 메시지를 순서대로 메시지에서 찾고, 노출

오류 코드와 메시지 처리6

스프링이 직접 만든 오류 메시지 처리

검증 오류 코드는 다음과 같이 2가지로 나눌 수 있다.

1. 개발자가 직접 설정한 오류 코드 rejectValue() 를 직접 호출
2. 스프링이 직접 검증 오류에 추가한 경우(주로 타입 정보가 맞지 않음)

🔍지금까지 학습한 메시지 코드 전략의 강점을 지금부터 확인해보자.

price 필드에 문자 "A"를 입력해보자.
로그를 확인해보면 BindingResult 에 FieldError 가 담겨있고, 다음과 같은 메시지 코드들이 생성된
것을 확인할 수 있다.

codes[typeMismatch.item.price,typeMismatch.price,typeMismatch.java.lang.Integer,typeMismatch]

다음과 같이 4가지 메시지 코드가 입력되어 있다.

• typeMismatch.item.price
• typeMismatch.price
• typeMismatch.java.lang.Integer
• typeMismatch

스프링은 타입 오류가 발생하면 typeMismatch 라는 오류 코드를 사용한다.
이 오류 코드가 MessageCodesResolver 를 통하면서 4가지 메시지 코드가 생성된 것이다.

실행해보자

아직 errors.properties 에 메시지 코드가 없기 때문에 스프링이 생성한 기본 메시지가 출력된다.

Failed to convert property value of type java.lang.String to required type 
java.lang.Integer for property price; nested exception is 
java.lang.NumberFormatException: For input string: "A"

error.properties 에 다음 내용을 추가하자

#추가
typeMismatch.java.lang.Integer=숫자를 입력해주세요.
typeMismatch=타입 오류입니다.

다시 실행해보면

결과적으로 소스코드를 하나도 건들지 않고, 원하는 메시지를 단계별로 설정할 수 있다.

Validator 분리1

목표

복잡한 검증 로직을 별도로 분리하자.

컨트롤러에서 검증 로직이 차지하는 부분은 매우 크다.
이런 경우 별도의 클래스로 역할을 분리하는 것이좋다. 그리고 이렇게 분리한 검증 로직을 재사용 할 수도 있다

ItemValidator

@Component
public class ItemValidator implements Validator {
     
     @Override
     public boolean supports(Class<?> clazz) {
       return Item.class.isAssignableFrom(clazz);
     }
    
     @Override
     public void validate(Object target, Errors errors) {
     
       Item item = (Item) target;
       ValidationUtils.rejectIfEmptyOrWhitespace(errors, "itemName", "required");
       if (item.getPrice() == null || item.getPrice() < 1000 || item.getPrice() > 1000000) {
           errors.rejectValue("price", "range", new Object[]{1000, 1000000}, null);
     }
     
     if (item.getQuantity() == null || item.getQuantity() > 10000) {
         errors.rejectValue("quantity", "max", new Object[]{9999}, null);
     }
     
     //특정 필드 예외가 아닌 전체 예외
     if (item.getPrice() != null && item.getQuantity() != null) {
         int resultPrice = item.getPrice() * item.getQuantity();
         if (resultPrice < 10000) {
             errors.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
          }
       }
    }
}

스프링은 검증을 체계적으로 제공하기 위해 다음 인터페이스를 제공한다.

public interface Validator {
  boolean supports(Class<?> clazz);
  void validate(Object target, Errors errors);
}

• supports() {} : 해당 검증기를 지원하는 여부 확인(뒤에서 설명)
• validate(Object target, Errors errors) : 검증 대상 객체와 BindingResult

ItemValidator 직접 호출하기

ValidationItemControllerV2 - addItemV5()

private final ItemValidator itemValidator;

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

   itemValidator.validate(item, bindingResult);

   if (bindingResult.hasErrors()) {
       log.info("errors={}", 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}";
  }

• ItemValidator 를 스프링 빈으로 주입 받아서 직접 호출했다.

실행

실행해보면 기존과 완전히 동일하게 동작하는 것을 확인할 수 있다. 검증과 관련된 부분이 깔끔하게 분리되었다

Validator 분리2

스프링이 Validator 인터페이스를 별도로 제공하는 이유는 체계적으로 검증 기능을 도입하기 위해서다.
앞에서는 검증기를 직접 불러서 사용했고, 이렇게 사용해도 된다.

💫 Validator 인터페이스를 사용해서 검증기를 만들면 스프링의 추가적인 도움을 받을 수 있다.

WebDataBinder를 통해서 사용하기

WebDataBinder 는 스프링의 '파라미터 바인딩'의 역할을 해주고 '검증 기능'도 내부에 포함한다.

ValidationItemControllerV2에 다음 코드를 추가

@InitBinder
public void init(WebDataBinder dataBinder) {
   log.info("init binder {}", dataBinder);
   dataBinder.addValidators(itemValidator);
}

• 이렇게 WebDataBinder 에 검증기를 추가하면 해당 컨트롤러에서는 검증기를 자동으로 적용할 수 있다.
• @InitBinder 해당 컨트롤러에만 영향을 준다. 글로벌 설정은 별도로 해야한다.

@Validated 적용

ValidationItemControllerV2 - addItemV6()

@PostMapping("/add")
public String addItemV6(@Validated @ModelAttribute Item item, BindingResult 
bindingResult, RedirectAttributes redirectAttributes) {
   
   if (bindingResult.hasErrors()) {
       log.info("errors={}", 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}";
}

• validator를 직접 호출하는 부분이 사라지고, 대신에 검증 대상 앞에 @Validated 가 붙었다

동작 방식

@Validated 는 검증기를 실행하라는 애노테이션이다.
1. 이 애노테이션이 붙으면 앞서 WebDataBinder 에 등록한 검증기를 찾아서 실행한다
➞ 그런데 여러 검증기를 등록한다면 그 중에 어떤 검증기가 실행되어야 할지 구분이 필요하다.
2. 이때supports() 가 사용된다.
3. 여기서는 supports(Item.class) 호출되고,
4. 결과가 true 이므로 ItemValidator 의 validate() 가 호출된다.

🌎글로벌 설정

글로벌 설정 - 모든 컨트롤러에 다 적용

@SpringBootApplication
public class ItemServiceApplication implements WebMvcConfigurer {
 
   public static void main(String[] args) {
       SpringApplication.run(ItemServiceApplication.class, args);
   }
   
   @Override
   public Validator getValidator() {
       return new ItemValidator();
   }
}

주의

글로벌 설정을 하면 다음에 설명할 BeanValidator가 자동 등록되지 않는다.
글로벌 설정 부분은 주석처리 해두자. 참고로 글로벌 설정을 직접 사용하는 경우는 드물다.

📌 참고

• 검증시 @Validated @Valid 둘다 사용가능하다.
• javax.validation.@Valid를 사용하려면 build.gradle 의존관계 추가가 필요하다.
  implementation 'org.springframework.boot:spring-boot-starter-validation'
• @Validated 는 스프링 전용 검증 애노테이션이고, @Valid 는 자바 표준 검증 애노테이션이다.

---

섹션5. 검증2 - Bean Validation

Bean Validation - 소개

검증 기능을 지금처럼 매번 코드로 작성하는 것은 상당히 번거롭다.
특히 특정 필드에 대한 검증 로직은대부분 빈 값인지 아닌지, 특정 크기를 넘는지 아닌지와 같이 매우 일반적인 로직이다.

Bean Validation 이란?

먼저 Bean Validation은 특정한 구현체가 아니라 Bean Validation 2.0(JSR-380)이라는 기술 표준이다.
쉽게 이야기해서 검증 애노테이션과 여러 인터페이스의 모음이다. 마치 JPA가 표준 기술이고 그 구현체로 하이버네이트가 있는 것과 같다.
Bean Validation을 구현한 기술중에 일반적으로 사용하는 구현체는 하이버네이트 Validator이다.
이름이 하이버네이트가 붙어서 그렇지 ORM과는 관련이 없다.

Bean Validation - 시작

Bean Validation - 시작

먼저 스프링과 통합하지 않고, 순수한 Bean Validation 사용법 부터 테스트 코드로 알아보자.

의존관계 추가

build.gradle

implementation 'org.springframework.boot:spring-boot-starter-validation'

Item - Bean Validation 애노테이션 적용

@Data
public class Item {

   private Long id;

   @NotBlank
   private String itemName;
   
   @NotNull
   @Range(min = 1000, max = 1000000)
   private Integer price;
   
   @NotNull
   @Max(9999)
   private Integer quantity;
   
   public Item() {
   }
   
   public Item(String itemName, Integer price, Integer quantity) {
       this.itemName = itemName;
       this.price = price;
       this.quantity = quantity;
   }
}

검증 애노테이션

@NotBlank : 빈값 + 공백만 있는 경우를 허용하지 않는다.
@NotNull : null 을 허용하지 않는다.
@Range(min = 1000, max = 1000000) : 범위 안의 값이어야 한다.
@Max(9999) : 최대 9999까지만 허용한다.

📌 참고
javax.validation.constraints.NotNull
org.hibernate.validator.constraints.Range

javax.validation 으로 시작하면 특정 구현에 관계없이 제공되는 표준 인터페이스이고,
org.hibernate.validator 로 시작하면 하이버네이트 validator 구현체를 사용할 때만 제공되는 검증 기능이다.
실무에서 대부분 하이버네이트 validator를 사용하므로 자유롭게 사용해도 된다.

BeanValidationTest - Bean Validation 테스트 코드 작성

public class BeanValidationTest {
 
   @Test
   void beanValidation() {
       ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
       Validator validator = factory.getValidator();
       
       Item item = new Item();
       item.setItemName(" "); //공백
       item.setPrice(0);
       item.setQuantity(10000);
       
       Set<ConstraintViolation<Item>> violations = validator.validate(item);
       for (ConstraintViolation<Item> violation : violations) {
           System.out.println("violation=" + violation);
           System.out.println("violation.message=" + violation.getMessage());
     }
   }
}

# 검증기 생성

다음 코드와 같이 검증기를 생성한다. 이후 스프링과 통합하면 우리가 직접 이런 코드를 작성하지는 않으므로, 이렇게 사용하는구나 정도만 참고하자.

ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
Validator validator = factory.getValidator();

# 검증 실행

검증 대상( item )을 직접 검증기에 넣고 그 결과를 받는다. Set 에는 ConstraintViolation 이라는 검증 오류가 담긴다.
➞ 따라서 결과가 비어있으면 검증 오류가 없는 것이다.

Set<ConstraintViolation<Item>> violations = validator.validate(item);

정리

이렇게 빈 검증기(Bean Validation)를 직접 사용하는 방법을 알아보았다.
아마 지금까지 배웠던 스프링 MVC 검증 방법에 빈 검증기를 어떻게 적용하면 좋을지 여러가지 생각이 들 것이다.
🌟 스프링은 이미 개발자를 위해 빈 검증기를 스프링에 완전히 통합해두었다.

Bean Validation - 스프링 적용

스프링 MVC는 어떻게 Bean Validator를 사용? 🤔

스프링 부트가 spring-boot-starter-validation 라이브러리를 넣으면 자동으로 Bean Validator를 인지하고 스프링에 통합한다.

스프링 부트는 자동으로 글로벌 Validator로 등록한다.

LocalValidatorFactoryBean 을 글로벌 Validator로 등록한다.
이 Validator는 @NotNull 같은 애노테이션을 보고 검증을 수행한다.
➞ 이렇게 글로벌 Validator가 적용되어 있기 때문에, @Valid , @Validated 만 적용하면 된다.
➞ 검증 오류가 발생하면, _FieldError , ObjectError 를 생성해서 BindingResult 에 담아준다.

검증 순서

1. @ModelAttribute 각각의 필드에 타입 변환 시도
   1.) 성공하면 다음으로
   2.) 실패하면 typeMismatch 로 FieldError 추가
2. Validator 적용

바인딩에 성공한 필드만 Bean Validation 적용

BeanValidator는 바인딩에 실패한 필드는 BeanValidation을 적용하지 않는다.
생각해보면 타입 변환에 성공해서 바인딩에 성공한 필드여야 BeanValidation 적용이 의미 있다.
(일단 모델 객체에 바인딩 받는 값이 정상으로 들어와야 검증도 의미가 있다.)

@ModelAttribute ➞ 각각의 필드 타입 변환시도 ➞ 변환에 성공한 필드만 BeanValidation 적용

예)

• itemName 에 문자 "A" 입력 ➞ 타입 변환 성공 ➞ itemName 필드에 BeanValidation 적용
• price 에 문자 "A" 입력 ➞ "A"를 숫자 타입 변환 시도 실패 ➞ typeMismatch FieldError 추가 ➞ price 필드는 BeanValidation 적용 X

Bean Validation - 에러 코드

Bean Validation이 기본으로 제공하는 오류 메시지를 좀 더 자세히 변경하고 싶으면 어떻게 하면 될까? 🤔

Bean Validation을 적용하고 bindingResult 에 등록된 검증 오류 코드를 보자.
오류 코드가 애노테이션 이름으로 등록된다. 마치 typeMismatch 와 유사하다.
NotBlank 라는 오류 코드를 기반으로 MessageCodesResolver 를 통해 다양한 메시지 코드가 순서대로 생성된다.

[@NotBlank]

• NotBlank.item.itemName
• NotBlank.itemName
• NotBlank.java.lang.String
• NotBlank

[@Range]

• Range.item.price
• Range.price
• Range.java.lang.Integer
• Range

메시지 등록

errors.properties

#Bean Validation 추가
NotBlank={0} 공백X 
Range={0}, {2} ~ {1} 허용
Max={0}, 최대 {1}

• {0} 은 필드명이고, {1} , {2} ...은 각 애노테이션 마다 다르다

BeanValidation 메시지 찾는 순서

1. 생성된 메시지 코드 순서대로 messageSource 에서 메시지 찾기
2. 애노테이션의 message 속성 사용
   ➞ @NotBlank(message = "공백! {0}")
3. 라이브러리가 제공하는 기본 값 사용
   ➞ 공백일 수 없습니다.

Bean Validation - 오브젝트 오류

Bean Validation에서 특정 필드( FieldError )가 아닌 해당 오브젝트 관련 오류( ObjectError )는 어떻게 처리할 수 있을까? 🤔

@ScriptAssert() - 권장x

@Data
@ScriptAssert(lang = "javascript", script = "_this.price * _this.quantity >= 10000")
public class Item {
 //...
}

메시지 코드
ScriptAssert.item
ScriptAssert

📌 권장 하지 않는다👿🙅‍♀️

• 실제 사용해보면 제약이 많고 복잡하다.
  ➞ 실무에서는 검증 기능이 해당 객체의 범위를 넘어서는 경우들도 종종 등장하는데, 그런 경우 대응이 어렵다.

• 권장하는 방법은?🤔
  ➞ 오브젝트 오류(글로벌 오류)의 경우 @ScriptAssert 을 억지로 사용하는 것 보다는 다음과 같이 '오브젝트 오류 관련' 부분만 직접 자바 코드로 작성하는 것을 권장한다.

ValidationItemControllerV3 - 글로벌 오류 추가

@PostMapping("/add")
public String addItem(@Validated @ModelAttribute Item item, BindingResult 
                      bindingResult, RedirectAttributes redirectAttributes) {
    
     //특정 필드 예외가 아닌 전체 예외
     if (item.getPrice() != null && item.getQuantity() != null) {
         int resultPrice = item.getPrice() * item.getQuantity();
         if (resultPrice < 10000) {
         bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
       }
     }
     
     if (bindingResult.hasErrors()) {
         log.info("errors={}", bindingResult);
         return "validation/v3/addForm";
     }
     
     //성공 로직
     Item savedItem = itemRepository.save(item);
     redirectAttributes.addAttribute("itemId", savedItem.getId());
     redirectAttributes.addAttribute("status", true);
     return "redirect:/validation/v3/items/{itemId}";
}

Bean Validation - 수정에 적용

상품 수정에도 빈 검증(Bean Validation)을 적용한다.

• ValidationItemControllerV3 - edit() 변경
  • Item 모델 객체에 @Validated 를 추가하자.
• 검증 오류가 발생하면 editForm 으로 이동하는 코드 추가

Bean Validation - 한계

수정시 검증 요구사항

데이터를 등록할 때와 수정할 때는 요구사항이 다를 수 있다.

등록시 기존 요구사항

• 타입 검증
  • 가격, 수량에 문자가 들어가면 검증 오류 처리
• 필드 검증
  • 상품명: 필수, 공백X
  • 가격: 1000원 이상, 1백만원 이하
  • 수량: 최대 9999
• 특정 필드의 범위를 넘어서는 검증
  • 가격 * 수량의 합은 10,000원 이상

수정시 요구사항

• 등록시에는 quantity 수량을 최대 9999까지 등록할 수 있지만, 수정시에는 수량을 무제한으로 변경할 수 있다.
• 등록시에는 id 에 값이 없어도 되지만, 수정시에는 id 값이 필수이다.

수정 요구사항 적용

@Data
public class Item {
 @NotNull //수정 요구사항 추가
 private Long id;

 @NotBlank
 private String itemName;
 
 @NotNull
 @Range(min = 1000, max = 1000000)
 private Integer price;
 
 @NotNull
 //@Max(9999) //수정 요구사항 추가
 private Integer quantity;
 //...
}

• id : @NotNull 추가
• quantity : @Max(9999) 제거

문제 발생

1. 수정은 잘 동작하지만 등록에서 문제가 발생

등록시에는 id 에 값도 없고, quantity 수량 제한 최대 값인 9999도 적용되지 않는 문제가 발생한다

2. 등록시 화면이 넘어가지 않으면서 다음과 같은 오류를 볼 수 있다.

'id': rejected value [null];
등록시에는 id 에 값이 없다. 따라서 @NotNull id 를 적용한 것 때문에 검증에 실패하고 다시
폼 화면으로 넘어온다. 결국 등록 자체도 불가능하고, 수량 제한도 걸지 못한다.

결과적으로 item 은 등록과 수정에서 검증 조건의 충돌이 발생하고, 등록과 수정은 같은 BeanValidation 을 적용할 수 없다.

이 문제를 어떻게 해결할 수 있을까? 🤔

Bean Validation - groups

방법 2가지

1. BeanValidation의 groups 기능을 사용한다.
2. Item을 직접 사용하지 않고, ItemSaveForm, ItemUpdateForm 같은 폼 전송을 위한 별도의 모델 객체를 만들어서 사용한다.

groups 적용

1. 저장용, 수정용 groups 인터페이스 생성

• 저장용 groups 생성 public interface SaveCheck {}
• 수정용 groups 생성 public interface UpdateCheck {}

2. 앞에 만든 인터페이스를 Item에 적용한다.

Item - groups 적용

@Data
public class Item {

 @NotNull(groups = UpdateCheck.class) //수정시에만 적용
 private Long id;
 
 @NotBlank(groups = {SaveCheck.class, UpdateCheck.class})
 private String itemName;
 
 @NotNull(groups = {SaveCheck.class, UpdateCheck.class})
 @Range(min = 1000, max = 1000000, groups = {SaveCheck.class, UpdateCheck.class})
 private Integer price;
 
 @NotNull(groups = {SaveCheck.class, UpdateCheck.class})
 @Max(value = 9999, groups = SaveCheck.class) //등록시에만 적용
 private Integer quantity;
 
 public Item() {
 }
 
 public Item(String itemName, Integer price, Integer quantity) {
     this.itemName = itemName;
     this.price = price;
     this.quantity = quantity;
   }
}

3. 컨트롤러 각각의 저장로직/ 수정로직에 Groups 적용해준다.

• 저장 로직에 SaveCheck Groups 적용

@PostMapping("/add")
public String addItemV2(@Validated(SaveCheck.class) @ModelAttribute Item item,
BindingResult bindingResult, RedirectAttributes redirectAttributes) {
 //...
}

• 수정 로직에 UpdateCheck Groups 적용

@PostMapping("/{itemId}/edit")
public String editV2(@PathVariable Long itemId, @Validated(UpdateCheck.class)
@ModelAttribute Item item, BindingResult bindingResult) {
 //...
}

📌 참고: @Valid 에는 groups를 적용할 수 있는 기능이 없다.
➞ 따라서 groups를 사용하려면 @Validated 를 사용해야 한다.

정리

groups 기능을 사용해서 등록과 수정시에 각각 다르게 검증을 할 수 있었다.
그런데 groups 기능을 사용하니 Item 은 물론이고, 전반적으로 복잡도가 올라갔다.
사실 groups 기능은 실제 잘 사용되지는 않는데, 그 이유는 실무에서는 주로 다음에 등장하는 등록용 폼객체와 수정용 폼 객체를 분리해서 사용하기 때문이다.

Form 전송 객체 분리

소개

실무에서는 groups 를 잘 사용하지 않는데, 그 이유가 다른 곳에 있다.
바로 등록시 폼에서 전달하는 데이터가 Item 도메인 객체와 딱 맞지 않기 때문이다.
소위 "Hello World" 예제에서는 폼에서 전달하는 데이터와 Item 도메인 객체가 딱 맞는다.
하지만 실무에서는 회원 등록시 회원과 관련된 데이터만 전달받는 것이 아니라, 약관 정보도 추가로 받는 등 Item 과 관계없는 수 많은 부가 데이터가 넘어온다.

그래서 보통 Item 을 직접 전달받는 것이 아니라, 복잡한 폼의 데이터를 컨트롤러까지 전달할 별도의객체를 만들어서 전달한다.

예를 들면 ItemSaveForm 이라는 폼을 전달받는 전용 객체를 만들어서 @ModelAttribute 로 사용한다.
이것을 통해 컨트롤러에서 폼 데이터를 전달 받고, 이후 컨트롤러에서필요한 데이터를 사용해서 Item 을 생성한다.

폼 데이터 전달에 Item 도메인 객체 사용

HTML Form -> Item -> Controller -> Item -> Repository

• 장점: Item 도메인 객체를 컨트롤러, 리포지토리 까지 직접 전달해서 중간에 Item을 만드는 과정이 없어서 간단하다.
• 단점: 간단한 경우에만 적용할 수 있다. 수정시 검증이 중복될 수 있고, groups를 사용해야 한다.

폼 데이터 전달을 위한 별도의 객체 사용

HTML Form -> ItemSaveForm -> Controller -> Item 생성 -> Repository

• 장점: 전송하는 폼 데이터가 복잡해도 거기에 맞춘 별도의 폼 객체를 사용해서 데이터를 전달 받을 수 있다.
  • 보통 등록과, 수정용으로 별도의 폼 객체를 만들기 때문에 검증이 중복되지 않는다.
• 단점: 폼 데이터를 기반으로 컨트롤러에서 Item 객체를 생성하는 변환 과정이 추가된다.

QnA 추가적인 질문

Q: 이름은 어떻게 지어야 하나요?

이름은 의미있게 지으면 된다. ItemSave 라고 해도 되고, ItemSaveForm , ItemSaveRequest , ItemSaveDto 등으로 사용해도 된다. 중요한 것은 일관성이다.

Q: 등록, 수정용 뷰 템플릿이 비슷한데 합치는게 좋을까요?

한 페이지에 그러니까 뷰 템플릿 파일을 등록과 수정을 합치는게 좋을지 고민이 될 수 있다. 각각 장단점이 있으므로 고민하는게 좋지만, 어설프게 합치면 수 많은 분기문(등록일 때, 수정일 때) 때문에 나중에 유지보수에서 고통을 맛본다.
이런 어설픈 분기문들이 보이기 시작하면 분리해야 할 신호이다.

개발

1. 이제 Item 의 검증은 사용하지 않으므로 검증 코드를 제거

ITEM 원복

@Data
public class Item {

   private Long id;
   private String itemName;
   private Integer price;
   private Integer quantity;
}

2. ItemUpdateForm(수정용) / ItemSaveForm(저장용) 만들어서 검증사항 넣어주기

ItemSaveForm - ITEM 저장용 폼

@Data
public class ItemSaveForm {

   @NotBlank
   private String itemName;

   @NotNull
   @Range(min = 1000, max = 1000000)
   private Integer price;

   @NotNull
   @Max(value = 9999)
   private Integer quantity;
}

ItemUpdateForm - ITEM 수정용 폼

@Data
public class ItemUpdateForm {

   @NotNull
   private Long id;
   
   @NotBlank
   private String itemName;
   
   @NotNull
   @Range(min = 1000, max = 1000000)
   private Integer price;
   //수정에서는 수량은 자유롭게 변경할 수 있다.
   private Integer quantity;
}

3. 이제 등록, 수정용 폼 객체를 사용하도록 컨트롤러를 수정.

ValidationItemControllerV4

@Slf4j
@Controller
@RequestMapping("/validation/v4/items")
@RequiredArgsConstructor
public class ValidationItemControllerV4 {

   private final ItemRepository itemRepository;
   
   @GetMapping
   public String items(Model model) {
       List<Item> items = itemRepository.findAll();
       model.addAttribute("items", items);
       return "validation/v4/items";
   }
   
   @GetMapping("/{itemId}")
   public String item(@PathVariable long itemId, Model model) {
       Item item = itemRepository.findById(itemId);
       model.addAttribute("item", item);
       return "validation/v4/item";
   }
   
   @GetMapping("/add")
   public String addForm(Model model) {
       model.addAttribute("item", new Item());
       return "validation/v4/addForm";
   }
   
   @PostMapping("/add")
   public String addItem(@Validated @ModelAttribute("item") ItemSaveForm form,
  BindingResult bindingResult, RedirectAttributes redirectAttributes) {
  
       //특정 필드 예외가 아닌 전체 예외
       if (form.getPrice() != null && form.getQuantity() != null) {
           int resultPrice = form.getPrice() * form.getQuantity();
           if (resultPrice < 10000) {
           bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
         }
   	  }
   
       if (bindingResult.hasErrors()) {
           log.info("errors={}", bindingResult);
           return "validation/v4/addForm";
       }
       
       //성공 로직
       Item item = new Item();
       item.setItemName(form.getItemName());
       item.setPrice(form.getPrice());
       item.setQuantity(form.getQuantity());
       
       Item savedItem = itemRepository.save(item);
       redirectAttributes.addAttribute("itemId", savedItem.getId());
       redirectAttributes.addAttribute("status", true);
       return "redirect:/validation/v4/items/{itemId}";
     }
  
     @GetMapping("/{itemId}/edit")
     public String editForm(@PathVariable Long itemId, Model model) {
         Item item = itemRepository.findById(itemId);
         model.addAttribute("item", item);
         return "validation/v4/editForm";
     }
     
     @PostMapping("/{itemId}/edit")
     public String edit(@PathVariable Long itemId, @Validated
    @ModelAttribute("item") ItemUpdateForm form, BindingResult bindingResult) {
  
          //특정 필드 예외가 아닌 전체 예외
         if (form.getPrice() != null && form.getQuantity() != null) {
             int resultPrice = form.getPrice() * form.getQuantity();
             if (resultPrice < 10000) {
             bindingResult.reject("totalPriceMin", new Object[]{10000, resultPrice}, null);
         }
     }
     
     if (bindingResult.hasErrors()) {
         log.info("errors={}", bindingResult);
         return "validation/v4/editForm";
     }
     
     Item itemParam = new Item();
     itemParam.setItemName(form.getItemName());
     itemParam.setPrice(form.getPrice());
     itemParam.setQuantity(form.getQuantity());

     itemRepository.update(itemId, itemParam);
     return "redirect:/validation/v4/items/{itemId}";
   }
}

• 기존 코드 제거: addItem(), addItemV2()
• 기존 코드 제거: edit(), editV2()
• 추가: addItem() , edit()

폼 객체 바인딩

@PostMapping("/add")
public String addItem(@Validated @ModelAttribute("item") ItemSaveForm form,
BindingResult bindingResult, RedirectAttributes redirectAttributes) {
 //...
}

• Item 대신에 ItemSaveform 을 전달 받는다. 그리고 @Validated 로 검증도 수행하고, BindingResult 로 검증 결과도 받는다.

📌 주의

• @ModelAttribute("item") 에 item 이름을 넣어준 부분을 주의하자.
  • 이것을 넣지 않으면 ItemSaveForm 의 경우 규칙에 의해 itemSaveForm 이라는 이름으로 MVC Model에 담기게 된다.
  • 이렇게 되면 뷰 템플릿에서 접근하는 th:object 이름도 함께 변경해주어야 한다.

폼 객체를 Item으로 변환

//성공 로직
Item item = new Item();
item.setItemName(form.getItemName());
item.setPrice(form.getPrice());
item.setQuantity(form.getQuantity());
Item savedItem = itemRepository.save(item);

• 폼 객체의 데이터를 기반으로 Item 객체를 생성한다. 이렇게 폼 객체 처럼 중간에 다른 객체가 추가되면 변환하는 과정이 추가된다.

수정

@PostMapping("/{itemId}/edit")
public String edit(@PathVariable Long itemId, @Validated
@ModelAttribute("item") ItemUpdateForm form, BindingResult bindingResult) {
 //...
}

• 수정의 경우도 등록과 같다. 그리고 폼 객체를 Item 객체로 변환하는 과정을 거친다.

Bean Validation - HTTP 메시지 컨버터

@Valid , @Validated 는 HttpMessageConverter ( @RequestBody )에도 적용할 수 있다.

📌 참고

• @ModelAttribute 는 HTTP 요청 파라미터(URL 쿼리 스트링, POST Form)를 다룰 때 사용한다.
• @RequestBody 는 HTTP Body의 데이터를 객체로 변환할 때 사용한다.
  • 주로 API JSON 요청을 다룰 때 사용한다.

ValidationItemApiController 생성

@Slf4j
@RestController
@RequestMapping("/validation/api/items")
public class ValidationItemApiController {
 
   @PostMapping("/add")
   public Object addItem(@RequestBody @Validated ItemSaveForm form,
                         BindingResult bindingResult) {
     log.info("API 컨트롤러 호출");
       if (bindingResult.hasErrors()) {
           log.info("검증 오류 발생 errors={}", bindingResult);
           return bindingResult.getAllErrors();
     }
     log.info("성공 로직 실행");
     return form;
   }
}

API의 경우 3가지 경우를 나누어 생각해야 한다.

• 성공 요청: 성공
• 실패 요청: JSON을 객체로 생성하는 것 자체가 실패함
• 검증 오류 요청: JSON을 객체로 생성하는 것은 성공했고, 검증에서 실패함

1.성공 요청

2. 실패 요청

price 의 값에 숫자가 아닌 문자를 전달해서 실패하게 만들어보자

3. 검증 오류 요청

검증 오류 결과

return bindingResult.getAllErrors();는 ObjectError 와 FieldError 를 반환한다.
스프링이 이 객체를 JSON으로 변환해서 클라이언트에 전달했다.
여기서는 예시로 보여주기 위해서 검증 오류 객체들을 그대로 반환했다.
실제 개발할 때는 이 객체들을 그대로 사용하지 말고, 필요한 데이터만 뽑아서 별도의 API
스펙을 정의하고 그에 맞는 객체를 만들어서 반환해야 한다.

@ModelAttribute vs @RequestBody

• HTTP 요청 파리미터를 처리하는 @ModelAttribute 는 각각의 필드 단위로 세밀하게 적용된다.
  그래서 특정 필드에 타입이 맞지 않는 오류가 발생해도 나머지 필드는 정상 처리할 수 있었다.
• HttpMessageConverter 는 @ModelAttribute 와 다르게 각각의 필드 단위로 적용되는 것이 아니라, 전체 객체 단위로 적용된다.
  따라서 메시지 컨버터의 작동이 성공해서 ItemSaveForm 객체를 만들어야 @Valid , @Validated 가 적용된다.

정리

• @ModelAttribute 는 필드 단위로 정교하게 바인딩이 적용된다.
  특정 필드가 바인딩 되지 않아도 나머지 필드는 정상 바인딩 되고, Validator를 사용한 검증도 적용할 수 있다.
• @RequestBody 는 HttpMessageConverter 단계에서 JSON 데이터를 객체로 변경하지 못하면 이후 단계 자체가 진행되지 않고 예외가 발생한다.
  컨트롤러도 호출되지 않고, Validator도 적용할 수 없다.

---

섹션6. 로그인 처리1 - 쿠키, 세션

로그인 요구사항

• 홈 화면 - 로그인 전
  • 회원 가입
  • 로그인
• 홈 화면 - 로그인 후
  • 본인 이름(누구님 환영합니다.)
  • 상품 관리
  • 로그 아웃
• 보안 요구사항
  • 로그인 사용자만 상품에 접근하고, 관리할 수 있음
  • 로그인 하지 않은 사용자가 상품 관리에 접근하면 로그인 화면으로 이동
• 회원 가입, 상품 관리

화면들

홈 화면 - 로그인 전

홈 화면 - 로그인 후

회원 가입

로그인

상품 관리

패키지 구조 설계

package 구조

• hello.login
• domain
  • item
  • member
  • login
• web
  • item
  • member
  • login

도메인이 가장 중요하다.

• 도메인 = 화면, UI, 기술 인프라 등등의 영역은 제외한 시스템이 구현해야 하는 핵심 비즈니스 업무 영역을 말함

향후 web을 다른 기술로 바꾸어도 도메인은 그대로 유지할 수 있어야 한다.
이렇게 하려면 web은 domain을 알고있지만 domain은 web을 모르도록 설계해야 한다.
이것을 web은 domain을 의존하지만, domain은 web을 의존하지 않는다고 표현한다. 예를 들어 web 패키지를 모두 삭제해도 domain에는 전혀 영향이 없도록 의존관계를 설계하는 것이 중요하다. 반대로 이야기하면 domain은 web을 참조하면 안된다.

홈 화면

홈 화면을 개발하자.

HomeController - home() 수정
@GetMapping("/")
public String home() {
 return "home";
}

회원 가입

Member

@Data
public class Member {
 private Long id;
 @NotEmpty
 private String loginId; //로그인 ID
 @NotEmpty
 private String name; //사용자 이름
 @NotEmpty
 private String password;
}

MemberRepository

/**
 * 동시성 문제가 고려되어 있지 않음, 실무에서는 ConcurrentHashMap, AtomicLong 사용 고려
 */
@Slf4j
@Repository
public class MemberRepository {

     private static Map<Long, Member> store = new HashMap<>(); //static 사용
     private static long sequence = 0L; //static 사용
     
     public Member save(Member member) {
         member.setId(++sequence);
         log.info("save: member={}", member);
         store.put(member.getId(), member);
         return member;
     }
     
     public Member findById(Long id) {
         return store.get(id);
     }
     public Optional<Member> findByLoginId(String loginId) {
         return findAll().stream()
                 .filter(m -> m.getLoginId().equals(loginId))
                 .findFirst();
     }
     
     public List<Member> findAll() {
         return new ArrayList<>(store.values());
     }
     
     public void clearStore() {
         store.clear();
     }
}

MemberController

@Controller
@RequiredArgsConstructor
@RequestMapping("/members")
public class MemberController {

   private final MemberRepository memberRepository;

   @GetMapping("/add")
   public String addForm(@ModelAttribute("member") Member member) {
       return "members/addMemberForm";
   }
   
   @PostMapping("/add")
   public String save(@Valid @ModelAttribute Member member, BindingResult result) {
       if (result.hasErrors()) {
           return "members/addMemberForm";
   }
   
   memberRepository.save(member);
   return "redirect:/";
   }
}

TestDataInit

@Component
@RequiredArgsConstructor
public class TestDataInit {
 private final ItemRepository itemRepository;
 private final MemberRepository memberRepository;
 /**
 * 테스트용 데이터 추가
 */
 @PostConstruct
 public void init() {
 itemRepository.save(new Item("itemA", 10000, 10));
 itemRepository.save(new Item("itemB", 20000, 20));
 Member member = new Member();
 member.setLoginId("test");
 member.setPassword("test!");
 member.setName("테스터");
 memberRepository.save(member);
 }
}

• 회원용 테스트 데이터 추가
  • loginId : test
  • password : test!
  • name : 테스터

로그인 기능

로그인 기능을 개발해보자. 지금은 로그인 ID, 비밀번호를 입력하는 부분에 집중하자.

LoginService

@Service
@RequiredArgsConstructor
public class LoginService {

     private final MemberRepository memberRepository;
     
     /**
     * @return null이면 로그인 실패
     */
     public Member login(String loginId, String password) {
       return memberRepository.findByLoginId(loginId)
             .filter(m -> m.getPassword().equals(password))
             .orElse(null);
     }
}

• 로그인의 핵심 비즈니스 로직은
  • 회원을 조회한 다음에 '파라미터'로 넘어온 password와 비교해서
    ➞ 같으면 회원을 반환하고,
    ➞ 만약 password가 다르면 null 을 반환한다.

LoginController

@Slf4j
@Controller
@RequiredArgsConstructor
public class LoginController {

   private final LoginService loginService;
   
   @GetMapping("/login")
   public String loginForm(@ModelAttribute("loginForm") LoginForm form) {
     return "login/loginForm";
   }
   @PostMapping("/login")
   
   public String login(@Valid @ModelAttribute LoginForm form, BindingResult bindingResult) {
     if (bindingResult.hasErrors()) {
       return "login/loginForm";
     }
     
   Member loginMember = loginService.login(form.getLoginId(), form.getPassword());
     log.info("login? {}", loginMember);
     if (loginMember == null) {
         bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
         return "login/loginForm";
     }
     //로그인 성공 처리 TODO
     return "redirect:/";
   }
}

• 로그인 컨트롤러는 로그인 서비스를 호출해서 로그인에 성공하면 홈 화면으로 이동하고,
  로그인에 실패하면 bindingResult.reject() 를 사용해서 글로벌 오류( ObjectError )를 생성한다.
• 그리고 정보를 다시 입력하도록 로그인 폼을 뷰 템플릿으로 사용한다.

실행

실행해보면 로그인이 성공하면 홈으로 이동하고,
➞ 로그인에 실패하면 "아이디 또는 비밀번호가 맞지않습니다."라는 경고와 ➞ 로그인 폼이 나타난다.

그런데 아직 로그인이 되면 홈 화면에 고객 이름이 보여야 한다는 요구사항을 만족하지 못한다. 😥

로그인의 상태를 유지하면서, 로그인에 성공한 사용자는 홈 화면에 접근시 고객의 이름을 보여주려면 어떻게 해야할까? 🤔

로그인 처리하기 - 쿠키 사용

로그인 상태 유지하기

로그인의 상태를 어떻게 유지할 수 있을까?🤔

HTTP 강의에서 일부 설명했지만, 쿼리 파라미터를 계속 유지하면서 보내는 것은 매우 어렵고 번거로운 작업이다. 쿠키를 사용해보자

쿠키🍪

서버에서 로그인에 성공하면 HTTP 응답에 쿠키를 담아서 브라우저에 전달하자. 그러면 브라우저는 앞으로 해당 쿠키를 지속해서 보내준다.

1. 쿠키생성

2. 클라이언트 쿠키 전달1

3. 클라이언트 쿠키 전달2

쿠키의 종류

쿠키에는 영속 쿠키와 세션 쿠키가 있다.

• 영속 쿠키: 만료 날짜를 입력하면 해당 날짜까지 유지
• 세션 쿠키: 만료 날짜를 생략하면 브라우저 종료시 까지만 유지 ➞ 지금 우리에게 필요한 쿠키

LoginController - login()

로그인 성공시 세션 쿠키를 생성

@PostMapping("/login")
public String login(@Valid @ModelAttribute LoginForm form, BindingResult bindingResult, HttpServletResponse response) {
   if (bindingResult.hasErrors()) {
     return "login/loginForm";
   }
   
 Member loginMember = loginService.login(form.getLoginId(), form.getPassword());
   log.info("login? {}", loginMember);
   
   if (loginMember == null) {
         bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
         return "login/loginForm";
   }
   
   //로그인 성공 처리
   //쿠키에 시간 정보를 주지 않으면 세션 쿠키(브라우저 종료시 모두 종료)
   Cookie idCookie = new Cookie("memberId", String.valueOf(loginMember.getId()));
   response.addCookie(idCookie);
   return "redirect:/";
}

쿠키 생성 로직

Cookie idCookie = new Cookie("memberId", String.valueOf(loginMember.getId()));
response.addCookie(idCookie);

• 로그인에 성공하면 쿠키를 생성하고 HttpServletResponse 에 담는다.
  - 쿠키 이름은 'memberId' 이고, 값은 회원의 'id' 를 담아둔다.
• 웹 브라우저는 종료 전까지 회원의 id 를 서버에 계속 보내줄 것이다.

홈 - 로그인 처리

로그인 성공시, 로그인 한 사용자 전용 홈 화면

@Slf4j
@Controller
@RequiredArgsConstructor
public class HomeController {
 
   private final MemberRepository memberRepository;
   
  // @GetMapping("/")
   public String home() {
  	 return "home";
   }
   @GetMapping("/")
   public String homeLogin( 
   			@CookieValue(name = "memberId", required = false) Long memberId, Model model) {
       if (memberId == null) {
           return "home";
     }
     
     //로그인
     Member loginMember = memberRepository.findById(memberId);
       if (loginMember == null) {
       return "home";
     }
     model.addAttribute("member", loginMember);
     return "loginHome";
   }
}

• @CookieValue 를 사용하면 편리하게 쿠키를 조회할 수 있다.
• 로그인 하지 않은 사용자도 홈에 접근할 수 있기 때문에 required = false 를 사용한다.

로직 분석

• 로그인 쿠키( memberId )가 없는 사용자는 기존 home 으로 보낸다.
  • 추가로 로그인 쿠키가 있어도 회원이 없으면 home 으로 보낸다.
• 로그인 쿠키( memberId )가 있는 사용자는 로그인 사용자 전용 홈 화면인 loginHome 으로 보낸다.
  • 추가로 홈 화면에 화원 관련 정보도 출력해야 해서 member 데이터도 모델에 담아서 전달한다.

실행

• 로그인에 성공하면 사용자 이름이 출력되면서 상품 관리, 로그아웃 버튼을 확인할 수 있다.
• 로그인에 성공시 세션 쿠키가 지속해서 유지되고, 웹 브라우저에서 서버에 요청시 memberId 쿠키를 계속 보내준다.

로그아웃 기능

이번에는 로그아웃 기능을 만들어보자.

로그아웃 방법

1. 세션 쿠키이므로 웹 브라우저 종료시
2. 서버에서 해당 쿠키의 종료 날짜를 0으로 지정

LoginController - logout 기능 추가

@PostMapping("/logout")
public String logout(HttpServletResponse response) {
     expireCookie(response, "memberId");
     return "redirect:/";
}
private void expireCookie(HttpServletResponse response, String cookieName) {
     Cookie cookie = new Cookie(cookieName, null);
     cookie.setMaxAge(0);
     response.addCookie(cookie);
}

로그아웃도 응답 쿠키를 생성하는데 Max-Age=0 를 확인할 수 있다. 해당 쿠키는 즉시 종료된다.

쿠키와 보안 문제

보안 문제

• 쿠키 값은 임의로 변경할 수 있다.
  • 클라이언트가 쿠키를 강제로 변경하면 다른 사용자가 된다.
  • 실제 웹브라우저 개발자모드 ➞ Application ➞ Cookie 변경으로 확인
  • Cookie: memberId=1 ➞ Cookie: memberId=2 (다른 사용자의 이름이 보임)
• 쿠키에 보관된 정보는 훔쳐갈 수 있다.
  • 만약 쿠키에 개인정보나, 신용카드 정보가 있다면?
  • 이 정보가 웹 브라우저에도 보관되고, 네트워크 요청마다 계속 클라이언트에서 서버로 전달된다.
  • 쿠키의 정보가 나의 로컬 PC에서 털릴 수도 있고, 네트워크 전송 구간에서 털릴 수도 있다.
• 해커가 쿠키를 한번 훔쳐가면 평생 사용할 수 있다.
  • 해커가 쿠키를 훔쳐가서 그 쿠키로 악의적인 요청을 계속 시도할 수 있다.

대안

• 쿠키에 중요한 값을 노출하지 않고, 사용자 별로 예측 불가능한 임의의 토큰(랜덤 값)을 노출한다.
  • 서버에서 토큰과 사용자 id를 매핑해서 인식한다.
  • 서버에서 토큰을 관리한다.
• 토큰은 해커가 임의의 값을 넣어도 찾을 수 없도록 예상 불가능 해야 한다.
• 해커가 토큰을 털어가도 시간이 지나면 사용할 수 없도록 서버에서 해당 토큰의 만료시간을 짧게 (예: 30분) 유지한다.
  • 또는 해킹이 의심되는 경우 서버에서 해당 토큰을 강제로 제거하면 된다.

로그인 처리하기 - 세션 동작 방식

목표

앞서 쿠키에 중요한 정보를 보관하는 방법은 여러가지 보안 이슈가 있었다.
이 문제를 해결하려면 결국 중요한 정보를 모두 서버에 저장해야 한다. 그리고 클라이언트와 서버는 추정 불가능한 임의의 식별자 값으로 연결해야 한다.

이렇게 서버에 중요한 정보를 보관하고 연결을 유지하는 방법을 '세션'이라 한다.

세션 동작 방식

세션을 어떻게 개발할지 먼저 개념을 이해해보자.

[로그인]

• 사용자가 loginId , password 정보를 전달하면 서버에서 해당 사용자가 맞는지 확인한다.

[세션 생성]

• 세션 ID를 생성하는데, 추정 불가능해야 한다.
• UUID는 추정이 불가능하다.
  • Cookie: mySessionId=zz0101xx-bab9-4b92-9b32-dadb280f4b61
• 생성된 세션 ID와 세션에 보관할 값( memberA )을 서버의 세션 저장소에 보관한다.

[세션id를 응답 쿠키로 전달]

클라이언트와 서버는 결국 쿠키로 연결이 되어야 한다.

• 서버는 클라이언트에 mySessionId 라는 이름으로 세션ID 만 쿠키에 담아서 전달한다.
• 클라이언트는 쿠키 저장소에 mySessionId 쿠키를 보관한다.

📌 중요

• 여기서 중요한 포인트는 회원과 관련된 정보는 전혀 클라이언트에 전달하지 않는다는 것이다.
• 오직 추정 불가능한 세션 ID만 쿠키를 통해 클라이언트에 전달한다.

[클라이언트의 세션id 쿠키 전달]

• 클라이언트는 요청시 항상 mySessionId 쿠키를 전달한다.
• 서버에서는 클라이언트가 전달한 mySessionId 쿠키 정보로 세션 저장소를 조회해서 로그인시 보관한 세션 정보를 사용한다.

정리

'세션'을 사용해서 서버에서 중요한 정보를 관리하게 되었다. 덕분에 다음과 같은 보안 문제들을 해결할 수 있다.

• 쿠키 값을 변조 가능
  ➞ 예상 불가능한 복잡한 세션Id를 사용한다.
• 쿠키에 보관하는 정보는 클라이언트 해킹시 털릴 가능성이 있다.
  ➞ 세션Id가 털려도 여기에는 중요한 정보가 없다.
• 쿠키 탈취 후 사용
  ➞ 해커가 토큰을 털어가도 시간이 지나면 사용할 수 없도록 서버에서 세션의 만료시간을 짧게(예: 30분) 유지한다.
  ➞ 또는 해킹이 의심되는 경우 서버에서 해당 세션을 강제로 제거하면 된다.

로그인 처리하기 - 세션 직접 만들기

세션을 직접 개발해서 적용해보자.

세션 관리는 크게 다음 3가지 기능을 제공하면 된다.

세션 생성

• sessionId 생성 (임의의 추정 불가능한 랜덤 값)
• 세션 저장소에 sessionId와 보관할 값 저장
• sessionId로 응답 쿠키를 생성해서 클라이언트에 전달

세션 조회

• 클라이언트가 요청한 sessionId 쿠키의 값으로, 세션 저장소에 보관한 값 조회

세션 만료

• 클라이언트가 요청한 sessionId 쿠키의 값으로, 세션 저장소에 보관한 sessionId와 값 제거

SessionManager - 세션 관리

/**
 * 세션 관리
 */
@Component
public class SessionManager {

   public static final String SESSION_COOKIE_NAME = "mySessionId";
   private Map<String, Object> sessionStore = new ConcurrentHashMap<>();
   
   /**
   * 세션 생성
   */
   public void createSession(Object value, HttpServletResponse response) {
     //세션 id를 생성하고, 값을 세션에 저장
     String sessionId = UUID.randomUUID().toString();
     sessionStore.put(sessionId, value);
     //쿠키 생성
     Cookie mySessionCookie = new Cookie(SESSION_COOKIE_NAME, sessionId);
     response.addCookie(mySessionCookie);
   }
   
   /**
   * 세션 조회
   */
   public Object getSession(HttpServletRequest request) {
     Cookie sessionCookie = findCookie(request, SESSION_COOKIE_NAME);
     if (sessionCookie == null) {
       return null;
   	 }
     return sessionStore.get(sessionCookie.getValue());
   }
   
   /**
   * 세션 만료
   */
   public void expire(HttpServletRequest request) {
     Cookie sessionCookie = findCookie(request, SESSION_COOKIE_NAME);
     if (sessionCookie != null) {
       sessionStore.remove(sessionCookie.getValue());
     }
   }
   private Cookie findCookie(HttpServletRequest request, String cookieName) {
     if (request.getCookies() == null) {
       return null;
   }
   
   return Arrays.stream(request.getCookies())
         .filter(cookie -> cookie.getName().equals(cookieName))
         .findAny()
         .orElse(null);
   }
}

• @Component : 스프링 빈으로 자동 등록한다.
• ConcurrentHashMap : HashMap 은 동시 요청에 안전하지 않다.
  • 동시 요청에 안전한 ConcurrentHashMap 를 사용했다

로그인 처리하기 - 직접 만든 세션 적용

지금까지 개발한 세션 관리 기능을 실제 웹 애플리케이션에 적용해보자.

LoginController - loginV2()

@PostMapping("/login")
public String loginV2(@Valid @ModelAttribute LoginForm form, BindingResult 
bindingResult, HttpServletResponse response) {
 if (bindingResult.hasErrors()) {
 return "login/loginForm";
 }
 Member loginMember = loginService.login(form.getLoginId(),
form.getPassword());
 log.info("login? {}", loginMember);
 if (loginMember == null) {
 bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
 return "login/loginForm";
 }
 //로그인 성공 처리
 //세션 관리자를 통해 세션을 생성하고, 회원 데이터 보관
 sessionManager.createSession(loginMember, response);
 return "redirect:/";
}

• private final SessionManager sessionManager; 주입
• sessionManager.createSession(loginMember, response);
  로그인 성공시 세션을 등록한다. 세션에 loginMember 를 저장해두고, 쿠키도 함께 발행한다.

LoginController - logoutV2()

@PostMapping("/logout")
public String logoutV2(HttpServletRequest request) {
 sessionManager.expire(request);
 return "redirect:/";
}

로그 아웃시 해당 세션의 정보를 제거한다.

HomeController - homeLoginV2()

@GetMapping("/")
public String homeLoginV2(HttpServletRequest request, Model model) {

 //세션 관리자에 저장된 회원 정보 조회
 Member member = (Member)sessionManager.getSession(request);
   if (member == null) {
   return "home";
   }
 //로그인
   model.addAttribute("member", member);
   return "loginHome";
}

• private final SessionManager sessionManager; 주입

'세션 관리자'에서 저장된 회원 정보를 조회한다.
만약 회원 정보가 없으면, 쿠키나 세션이 없는 것 이므로 로그인 되지 않은 것으로 처리한다.

정리

이번 시간에는 세션과 쿠키의 개념을 명확하게 이해하기 위해서 직접 만들어보았다.
사실 세션이라는 것이 뭔가 특별한 것이 아니라 단지 쿠키를 사용하는데, 서버에서 데이터를 유지하는 방법일 뿐이라는 것을 이해했을 것이다.

• 그런데 프로젝트마다 이러한 세션 개념을 직접 개발하는 것은 상당히 불편할 것이다.
  • 그래서 서블릿도 '세션' 개념을 지원한다.
• 이제 직접 만드는 세션 말고, 서블릿이 공식 지원하는 세션을 알아보자.
  서블릿이 공식 지원하는 세션은 우리가 직접 만든 세션과 동작 방식이 거의 같다.
  추가로 세션을 일정시간 사용하지 않으면 해당 세션을 삭제하는 기능을 제공한다.

로그인 처리하기

서블릿 HTTP 세션1

서블릿은 세션을 위해 HttpSession 이라는 기능을 제공하는데, 지금까지 나온 문제들을 해결해준다.
우리가 직접 구현한 세션의 개념이 이미 구현되어 있고, 더 잘 구현되어 있다.

HttpSession 소개

서블릿이 제공하는 HttpSession 도 결국 우리가 직접 만든 SessionManager 와 같은 방식으로 동작한다.

• 서블릿을 통해 HttpSession 을 생성하면 다음과 같은 '쿠키'를 생성한다.
• 쿠키 이름이 JSESSIONID 이고, 값은 추정 불가능한 랜덤 값이다.
  Cookie: JSESSIONID=5B78E23B513F50164D6FDD8C97B0AD05

HttpSession 사용

서블릿이 제공하는 HttpSession 을 사용하도록 개발해보자.

• HttpSession 에 데이터를 보관하고 조회할 때, 같은 이름이 중복 되어 사용되므로, 상수를 하나 정의했다

LoginController - loginV3()

@PostMapping("/login")
public String loginV3(@Valid @ModelAttribute LoginForm form, BindingResult 
  bindingResult, HttpServletRequest request) {
   if (bindingResult.hasErrors()) {
       return "login/loginForm";
   }
 
 Member loginMember = loginService.login(form.getLoginId(), form.getPassword());
   log.info("login? {}", loginMember);
   
   if (loginMember == null) {
       bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
       return "login/loginForm";
   }
 
   //로그인 성공 처리
   //세션이 있으면 있는 세션 반환, 없으면 신규 세션 생성
   HttpSession session = request.getSession();

   //세션에 로그인 회원 정보 보관
   session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);
   return "redirect:/";
}

세션 생성과 조회

세션을 생성하려면 request.getSession(true) 를 사용하면 된다.
public HttpSession getSession(boolean create);

세션의 create 옵션에 대해 알아보자.

• request.getSession(true)
  • 세션이 있으면 기존 세션을 반환한다.
  • 세션이 없으면 새로운 세션을 생성 해서 반환한다.
• request.getSession(false)
  • 세션이 있으면 기존 세션을 반환한다.
  • 세션이 없으면 새로운 세션을 생성하지 않는다.➞ null 을 반환한다.
• request.getSession() : 신규 세션을 생성하는 request.getSession(true) 와 동일하다.

세션에 로그인 회원 정보 보관

session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);
세션에 데이터를 보관하는 방법은 request.setAttribute(..)``` 와 비슷하다.
하나의 세션에 여러 값을 저장할 수 있다.

LoginController - logoutV3()

@PostMapping("/logout")
public String logoutV3(HttpServletRequest request) {
 //세션을 삭제한다.
 HttpSession session = request.getSession(false);
 if (session != null) {
   session.invalidate();
 }
 return "redirect:/";
}

• session.invalidate() : 세션을 제거한다.

@GetMapping("/")
public String homeLoginV3(HttpServletRequest request, Model model) {

   //세션이 없으면 home
   HttpSession session = request.getSession(false);
   if (session == null) {
     return "home";
   }
   Member loginMember = (Member) session.getAttribute(SessionConst.LOGIN_MEMBER);
   
   //세션에 회원 데이터가 없으면 home
   if (loginMember == null) {
     return "home";
   }
   //세션이 유지되면 로그인으로 이동
   model.addAttribute("member", loginMember);
   return "loginHome";
}

• request.getSession(false) : request.getSession() 를 사용하면 기본 값이 create: true이므로,
  ➞ 로그인 하지 않을 사용자도 의미없는 세션이 만들어진다.
• 따라서 세션을 찾아서 사용하는 시점에는
  ➞ create: false 옵션을 사용해서 세션을 생성하지 않아야 한다.

서블릿 HTTP 세션2

@SessionAttribute

스프링은 세션을 더 편리하게 사용할 수 있도록 @SessionAttribute 을 지원한다.

HomeController - homeLoginV3Spring()

@GetMapping("/")
public String homeLoginV3Spring(
 @SessionAttribute(name = SessionConst.LOGIN_MEMBER, required = false) Member loginMember, Model model) {

 //세션에 회원 데이터가 없으면 home
 if (loginMember == null) {
   return "home";
 }
 
 //세션이 유지되면 로그인으로 이동
 model.addAttribute("member", loginMember);
   return "loginHome";
}

• @SessionAttribute(name = "loginMember", required = false) Member loginMember
  이미 로그인 된 사용자를 찾을 때는 다음과 같이 사용하면 된다. 참고로 이 기능은 세션을 생성하지 않는다.

TrackingModes

로그인을 처음 시도하면 URL이 다음과 같이 jsessionid 를 포함하고 있는 것을 확인할 수 있다.

이것은 웹 브라우저가 쿠키를 지원하지 않을 때 쿠키 대신 URL을 통해서 세션을 유지하는 방법이다.

• 이 방법을 사용하려면 URL에 이 값을 계속 포함해서 전달해야 한다.
  타임리프 같은 템플릿은 엔진을 통해서 링크를 걸면 jsessionid 를 URL에 자동으로 포함해준다.
  서버 입장에서 웹 브라우저가 쿠키를 지원하는지 하지 않는지 최초에는 판단하지 못하므로, 쿠키 값도 전달하고, URL에 jsessionid 도 함께 전달한다.

👀 URL 전달 방식을 끄고 항상 쿠키를 통해서만 세션을 유지하고 싶으면 다음 옵션을 넣어주면 된다. 이렇게 하면 URL에 jsessionid 가 노출되지 않는다.

세션 정보와 타임아웃 설정

세션 정보 확인

세션이 제공하는 정보들을 확인해보자.

SessionInfoController

@Slf4j
@RestController
public class SessionInfoController {

 @GetMapping("/session-info")
 public String sessionInfo(HttpServletRequest request) {
   HttpSession session = request.getSession(false);
   
   if (session == null) {
     return "세션이 없습니다.";
   }
   
 //세션 데이터 출력
 session.getAttributeNames().asIterator()
        .forEachRemaining(name -> log.info("session name={}, value={}", 
        				 name, session.getAttribute(name)));
        
 log.info("sessionId={}", session.getId());
 log.info("maxInactiveInterval={}", session.getMaxInactiveInterval());
 log.info("creationTime={}", new Date(session.getCreationTime()));
 log.info("lastAccessedTime={}", new Date(session.getLastAccessedTime()));
 log.info("isNew={}", session.isNew());
 return "세션 출력";
 }
}

• sessionId : 세션Id, JSESSIONID 의 값이다.
  예) 34B14F008AA3527C9F8ED620EFD7A4E1
• maxInactiveInterval : 세션의 유효 시간,
  예) 1800초, (30분)
• creationTime : 세션 생성일시
• lastAccessedTime : 세션과 연결된 사용자가 최근에 서버에 접근한 시간, 클라이언트에서 서버로 sessionId ( JSESSIONID )를 요청한 경우에 갱신된다.
• isNew : 새로 생성된 세션인지, 아니면 이미 과거에 만들어졌고, 클라이언트에서 서버로
  sessionId ( JSESSIONID )를 요청해서 조회된 세션인지 여부

세션 타임아웃 설정

세션은 사용자가 로그아웃을 직접 호출해서 session.invalidate() 가 호출 되는 경우에 삭제된다.
그런데 대부분의 사용자는 로그아웃을 선택하지 않고, 그냥 웹 브라우저를 종료한다.
문제는 HTTP가 비연결성(ConnectionLess)이므로 서버 입장에서는 해당 사용자가 웹 브라우저를 종료한 것인지 아닌지를 인식할 수 없다.
➞ 따라서 서버에서 세션 데이터를 언제 삭제해야 하는지 판단하기가 어렵다.

이 경우 남아있는 세션을 무한정 보관하면 다음과 같은 문제가 발생할 수 있다.

• 세션과 관련된 쿠키( JSESSIONID )를 탈취 당했을 경우 오랜 시간이 지나도 해당 쿠키로 악의적인 요청을 할 수 있다.
• 세션은 기본적으로 메모리에 생성된다.
  ➞ 메모리의 크기가 무한하지 않기 때문에 꼭 필요한 경우만 생성해서 사용해야 한다.
  10만명의 사용자가 로그인하면 10만개의 세션이 생성되는 것이다.

세션의 종료 시점

• 세션 생성 시점이 아니라 사용자가 서버에 최근에 요청한 시간을 기준으로 30분 정도를
  유지해주는 것이다. 이렇게 하면 사용자가 서비스를 사용하고 있으면, 세션의 생존 시간이 30분으로 계속 늘어나게 된다.
  ➞ 따라서 30분 마다 로그인해야 하는 번거로움이 사라진다. HttpSession 은 이 방식을 사용한다.

세션 타임아웃 설정

스프링 부트로 글로벌 설정
application.properties

• server.servlet.session.timeout=60 : 60초, 기본은 1800(30분)
• 글로벌 설정은 분 단위로 설정해야 한다. 60(1분), 120(2분), ...
  

세션 타임아웃 발생

세션의 타임아웃 시간은 해당 세션과 관련된 JSESSIONID 를 전달하는 HTTP 요청이 있으면 '현재 시간'으로 다시 초기화 된다.
이렇게 초기화 되면 세션 타임아웃으로 설정한 시간동안 세션을 추가로 사용할 수 있다.

• session.getLastAccessedTime() : 최근 세션 접근 시간

LastAccessedTime 이후로 timeout 시간이 지나면, WAS가 내부에서 해당 세션을 제거한다.

정리

서블릿의 HttpSession 이 제공하는 타임아웃 기능 덕분에 세션을 안전하고 편리하게 사용할 수 있다.

실무에서 주의할 점은 세션에는 최소한의 데이터만 보관해야 한다는 점이다.
➞ 보관한 데이터 용량 * 사용자 수
세션의 메모리 사용량이 급격하게 늘어나서 장애로 이어질 수 있다.

• 추가로 세션의 시간을 너무 길게 가져가면 메모리 사용이 계속 누적 될 수 있으므로 적당한 시간을 선택하는 것이 필요하다.
• 기본이 30분이라는 것을 기준으로 고민하면 된다

---

섹션7. 로그인 처리2 - 필터, 인터셉터

서블릿 필터 - 소개

공통 관심 사항

요구사항을 보면 로그인 한 사용자만 상품 관리 페이지에 들어갈 수 있어야 한다.
앞에서 로그인을 하지 않은 사용자에게는 상품 관리 버튼이 보이지 않기 때문에 문제가 없어 보인다.
그런데 문제는 로그인 하지 않은 사용자도 다음 URL을 직접 호출하면 상품 관리 화면에 들어갈 수 있다는 점이다

공통 관심사(cross-cutting concern)

상품 관리 컨트롤러에서 로그인 여부를 체크하는 로직을 하나하나 작성하면 되겠지만, 등록, 수정, 삭제, 조회 등등 상품관리의 모든 컨트롤러 로직에 공통으로 로그인 여부를 확인해야 한다.
더 큰 문제는 향후 로그인과 관련된 로직이 변경될 때 이다. 작성한 모든 로직을 다 수정해야 할 수 있다.

이렇게 애플리케이션 여러 로직에서 공통으로 관심이 있는 있는 것을 공통 관심사(cross-cutting concern)라고 한다.
여기서는 등록, 수정, 삭제, 조회 등등 여러 로직에서 공통으로 인증에 대해서 관심을 가지고 있다.

이러한 공통 관심사는 스프링의 AOP로도 해결할 수 있지만, 웹과 관련된 공통 관심사는 지금부터 설명할 서블릿 필터 또는 스프링 인터셉터를 사용하는 것이 좋다.
웹과 관련된 공통 관심사를 처리할 때는 HTTP의 헤더나 URL의 정보들이 필요한데, 서블릿 필터나 스프링 인터셉터는 HttpServletRequest 를 제공한다.

서블릿 필터

필터는 서블릿이 지원하는 수문장이다.

필터를 적용하면 필터가 호출 된 다음에 서블릿이 호출된다. 그래서 모든 고객의 요청 로그를 남기는 요구사항이 있다면 필터를 사용하면 된다.

• 참고로 필터는 특정 URL 패턴에 적용할 수 있다.
  /* 이라고하면 모든 요청에 필터가 적용된다.

참고로 스프링을 사용하는 경우 여기서 말하는 서블릿은 스프링의 디스패처 서블릿으로 생각하면 된다.

• 필터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다. 그래서 로그인 여부를 체크하기에 딱 좋다.

• 필터는 체인으로 구성되는데, 중간에 필터를 자유롭게 추가할 수 있다.
  예) 로그를 남기는 필터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 필터를 만들 수 있다.

필터 인터페이스

public interface Filter {
   public default void init(FilterConfig filterConfig) throws ServletException{
  }

   public void doFilter(ServletRequest request, ServletResponse response,
          FilterChain chain) throws IOException, ServletException;

   public default void destroy() {}
}

필터 인터페이스를 구현하고 등록하면 '서블릿 컨테이너'가 필터를 싱글톤 객체로 생성하고, 관리한다.

• init() : 필터 초기화 메서드, 서블릿 컨테이너가 생성될 때 호출된다.
• doFilter() : 고객의 요청이 올 때 마다 해당 메서드가 호출된다. 필터의 로직을 구현하면 된다.
• destroy() : 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다.

서블릿 필터 - 요청 로그

필터가 정말 수문장 역할을 잘 하는지 확인하기 위해 가장 단순한 필터인, 모든 요청을 로그로 남기는 필터를 개발하고 적용해보자.

@Slf4j
public class LogFilter implements Filter {

   @Override
   public void init(FilterConfig filterConfig) throws ServletException {
     log.info("log filter init");
   }
   
   @Override
   public void doFilter(ServletRequest request, ServletResponse response,
  						FilterChain chain) throws IOException, ServletException {
     HttpServletRequest httpRequest = (HttpServletRequest) request;
     String requestURI = httpRequest.getRequestURI();
     
     String uuid = UUID.randomUUID().toString();
     try {
         log.info("REQUEST [{}][{}]", uuid, requestURI);
         chain.doFilter(request, response);
     } catch (Exception e) {
         throw e;
     } finally {
         log.info("RESPONSE [{}][{}]", uuid, requestURI);
     }
   }
   @Override
   public void destroy() {
       log.info("log filter destroy");
   }
}

• public class LogFilter implements Filter {}

  • 필터를 사용하려면 필터 인터페이스를 구현해야 한다.

• doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

  • HTTP 요청이 오면 doFilter 가 호출된다.
  • ServletRequest request 는 HTTP 요청이 아닌 경우까지 고려해서 만든 인터페이스이다.
    ➞ HTTP를 사용하면 HttpServletRequest httpRequest = (HttpServletRequest) request; 와 같이 다운 케스팅 하면 된다.

• String uuid = UUID.randomUUID().toString();
  HTTP 요청을 구분하기 위해 요청당 임의의 uuid 를 생성해둔다.

• log.info("REQUEST [{}][{}]", uuid, requestURI);

  • uuid 와 requestURI 를 출력한다.

• chain.doFilter(request, response);

  • 이 부분이 가장 중요하다. 다음 필터가 있으면 필터를 호출하고, 필터가 없으면 서블릿을 호출한다.
    ➞ 만약 이 로직을 호출하지 않으면 다음 단계로 진행되지 않는다.

WebConfig - 필터 설정

@Configuration
public class WebConfig {

   @Bean
   public FilterRegistrationBean logFilter() {
     FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();

     filterRegistrationBean.setFilter(new LogFilter());
     filterRegistrationBean.setOrder(1);
     filterRegistrationBean.addUrlPatterns("/*");
     return filterRegistrationBean;
   }
}

필터를 등록하는 방법은 여러가지가 있지만, 스프링 부트를 사용한다면 FilterRegistrationBean 을 사용해서 등록하면 된다.

• setFilter(new LogFilter()) : 등록할 필터를 지정한다.
• setOrder(1) : 필터는 체인으로 동작한다. 따라서 순서가 필요하다. 낮을 수록 먼저 동작한다.
• addUrlPatterns("/*") : 필터를 적용할 URL 패턴을 지정한다. 한번에 여러 패턴을 지정할 수 있다.

📌 참고
@ServletComponentScan @WebFilter(filterName = "logFilter", urlPatterns = "/*") 로
필터 등록이 가능하지만 필터 순서 조절이 안된다. 따라서 FilterRegistrationBean 을 사용하자.

실행 로그

hello.login.web.filter.LogFilter: REQUEST [0a2249f2-cc70-4db4-98d1-492ccf5629dd][/items]
hello.login.web.filter.LogFilter: RESPONSE [0a2249f2-cc70-4db4-98d1-492ccf5629dd][/items]

• 필터를 등록할 때 urlPattern 을 /* 로 등록했기 때문에 모든 요청에 해당 필터가 적용된다.

  📌 참고
  실무에서 HTTP 요청시 같은 요청의 로그에 모두 같은 식별자를 자동으로 남기는 방법은 logback mdc로 검색해보자.

서블릿 필터 - 인증 체크

드디어 인증 체크 필터를 개발해보자.
로그인 되지 않은 사용자는 상품 관리 뿐만 아니라 미래에 개발될 페이지에도 접근하지 못하도록 하자.

@Slf4j
public class LoginCheckFilter implements Filter {

   private static final String[] whitelist = {"/", "/members/add", "/login", "/logout","/css/*"};

   @Override
   public void doFilter(ServletRequest request, ServletResponse response,
 		 FilterChain chain) throws IOException, ServletException {
   HttpServletRequest httpRequest = (HttpServletRequest) request;
   String requestURI = httpRequest.getRequestURI();
   
   HttpServletResponse httpResponse = (HttpServletResponse) response;
   
   try {
     log.info("인증 체크 필터 시작 {}", requestURI);
     
     if (isLoginCheckPath(requestURI)) {
       log.info("인증 체크 로직 실행 {}", requestURI);
       HttpSession session = httpRequest.getSession(false);
       if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
         log.info("미인증 사용자 요청 {}", requestURI);
         //로그인으로 redirect
         httpResponse.sendRedirect("/login?redirectURL=" + requestURI);
         return; //여기가 중요, 미인증 사용자는 다음으로 진행하지 않고 끝!
       }
     }
     
     chain.doFilter(request, response);
   } catch (Exception e) {
     throw e; //예외 로깅 가능 하지만, 톰캣까지 예외를 보내주어야 함
   } finally {
     log.info("인증 체크 필터 종료 {}", requestURI);
   }
  }
   /**
   * 화이트 리스트의 경우 인증 체크X
   */
   private boolean isLoginCheckPath(String requestURI) {
     return !PatternMatchUtils.simpleMatch(whitelist, requestURI);
   }
}

• whitelist = {"/", "/members/add", "/login", "/logout","/css/*"};
  인증 필터를 적용해도 홈, 회원가입, 로그인 화면, css 같은 리소스에는 접근할 수 있어야 한다.
  이렇게 화이트 리스트 경로는 인증과 무관하게 항상 허용한다. 화이트 리스트를 제외한 나머지 모든 경로에는 인증 체크 로직을 적용한다.
  

• isLoginCheckPath(requestURI)
  화이트 리스트를 제외한 모든 경우에 인증 체크 로직을 적용한다.

• httpResponse.sendRedirect("/login?redirectURL=" + requestURI);
  미인증 사용자는 로그인 화면으로 리다이렉트 한다.
  그런데 로그인 이후에 다시 홈으로 이동해버리면, 원하는 경로를 다시 찾아가야 하는 불편함이 있다.
  예를 들어서 상품 관리 화면을 보려고 들어갔다가 로그인 화면으로 이동하면, 로그인 이후에 다시 상품 관리 화면으로 들어가는 것이 좋다.
  이런 부분이 개발자 입장에서는 좀 귀찮을 수 있어도 사용자 입장으로 보면 편리한 기능이다. 이러한 기능을 위해 현재 요청한 경로인 requestURI 를 /login 에 쿼리 파라미터로 함께 전달한다.
  물론 /login 컨트롤러에서 로그인 성공시 해당 경로로 이동하는 기능은 추가로 개발해야 한다.

• return; 🌟
  여기가 중요하다. 필터를 더는 진행하지 않는다.
  이후 필터는 물론 서블릿, 컨트롤러가 더는 호출되지 않는다.
  ➞ 앞서 redirect 를 사용했기 때문에 redirect 가 응답으로 적용되고 요청이 끝난다.

WebConfig - loginCheckFilter() 추가

@Bean
public FilterRegistrationBean loginCheckFilter() {
 FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
 
 filterRegistrationBean.setFilter(new LoginCheckFilter());
 filterRegistrationBean.setOrder(2);
 filterRegistrationBean.addUrlPatterns("/*");
 
 return filterRegistrationBean;
}

• setFilter(new LoginCheckFilter())
  로그인 '필터'를 등록한다.
• setOrder(2)
  순서를 2번으로 잡았다. 로그 필터 다음에 로그인 필터가 적용된다.
• addUrlPatterns("/*")
  모든 요청에 로그인 필터를 적용한다

RedirectURL 처리

로그인에 성공하면 처음 요청한 URL로 이동하는 기능을 개발해보자.

LoginController - loginV4()

/**
 * 로그인 이후 redirect 처리
 */
@PostMapping("/login")
public String loginV4(
     @Valid @ModelAttribute LoginForm form, BindingResult bindingResult,
     @RequestParam(defaultValue = "/") String redirectURL,
     HttpServletRequest request) {
 if (bindingResult.hasErrors()) {
     return "login/loginForm";
 }
 
 Member loginMember = loginService.login(form.getLoginId(), form.getPassword());
 log.info("login? {}", loginMember);

 if (loginMember == null) {
     bindingResult.reject("loginFail", "아이디 또는 비밀번호가 맞지 않습니다.");
     return "login/loginForm";
 }
 
 //로그인 성공 처리
 //세션이 있으면 있는 세션 반환, 없으면 신규 세션 생성
 HttpSession session = request.getSession();
 //세션에 로그인 회원 정보 보관
 session.setAttribute(SessionConst.LOGIN_MEMBER, loginMember);
 
 //redirectURL 적용
 return "redirect:" + redirectURL;
}

• 로그인 체크 필터에서, 미인증 사용자는 요청 경로를 포함해서 /login 에 redirectURL 요청 파라미터를 추가해서 요청했다.
  ➞ 이 값을 사용해서 로그인 성공시 해당 경로로 고객을 redirect 한다.

정리

서블릿 필터를 잘 사용한 덕분에 로그인 하지 않은 사용자는 나머지 경로에 들어갈 수 없게 되었다.
공통 관심사를 서블릿 필터를 사용해서 해결한 덕분에 향후 로그인 관련 정책이 변경되어도 이 부분만 변경하면 된다.

스프링 인터셉터 - 소개

스프링 인터셉터도 서블릿 필터와 같이 웹과 관련된 공통 관심 사항을 효과적으로 해결할 수 있는 기술이다.
서블릿 필터가 서블릿이 제공하는 기술이라면, 스프링 인터셉터는 스프링 MVC가 제공하는 기술이다.
둘다 웹과 관련된 공통 관심 사항을 처리하지만, 적용되는 순서와 범위, 그리고 사용방법이 다르다.

[스프링 인터셉터 흐름]

• 스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출 된다.
• 스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다.
  ➞ 스프링 MVC의 시작점이 디스패처 서블릿이라고 생각해보면 이해가 될 것이다.
• 스프링 인터셉터에도 URL 패턴을 적용할 수 있는데, 서블릿 URL 패턴과는 다르고, 매우 정밀하게 설정할 수 있다.
  

[스프링 인터셉터 제한]

• 인터셉터에서 적절하지 않은 요청이라고 판단하면 거기에서 끝을 낼 수도 있다.
  ➞ 그래서 로그인 여부를 체크하기에 딱 좋다.

[스프링 인터셉터 체인]

• 스프링 인터셉터는 체인으로 구성되는데, 중간에 인터셉터를 자유롭게 추가할 수 있다.
  예를 들어서 로그를 남기는 인터셉터를 먼저 적용하고, 그 다음에 로그인 여부를 체크하는 인터셉터를 만들 수 있다.

무엇이 다른가? (필터와 인터페이스) 🤔

지금까지 내용을 보면 서블릿 필터와 호출 되는 순서만 다르고, 제공하는 기능은 비슷해 보인다. 앞으로 설명하겠지만, 스프링 인터셉터는 서블릿 필터보다 편리하고, 더 정교하고 다양한 기능을 지원한다.

스프링 인터셉터 인터페이스

public interface HandlerInterceptor {

default boolean preHandle(HttpServletRequest request, HttpServletResponse 
response, Object handler) throws Exception {}

default void postHandle(HttpServletRequest request, HttpServletResponse response,
Object handler, @Nullable ModelAndView modelAndView)
throws Exception {}

default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) 
 throws Exception {}
}

• 서블릿 필터의 경우 단순하게 doFilter() 하나만 제공된다.

• 인터셉터는 컨트롤러 호출 전( preHandle ), 호출 후( postHandle ), 요청 완료 이후( afterCompletion )와 같이 단계적으로 잘 세분화 되어 있다.

• 서블릿 필터의 경우 단순히 request , response 만 제공했지만, 인터셉터는 어떤 컨트롤러( handler )가 호출되는지 호출 정보도 받을 수 있다.
  그리고 어떤 modelAndView 가 반환되는지 응답 정보도 받을 수 있다.

스프링 인터셉터 호출 흐름

정상 흐름

• preHandle : 컨트롤러 호출 전에 호출된다. (더 정확히는 핸들러 어댑터 호출 전에 호출된다.)
  • 응답값이 true 이면 다음으로 진행
  • 응답값이 false 이면 더는 진행하지 않는다X.
    ➞ false 인 경우 나머지 인터셉터는 물론이고, 핸들러 어댑터도 호출되지 않는다.
    그림에서 1번에서 끝이 나버린다.
• postHandle : 컨트롤러 호출 후에 호출된다. (더 정확히는 핸들러 어댑터 호출 후에 호출된다.)
• afterCompletion : 뷰가 렌더링 된 이후에 호출된다.

스프링 인터셉터 예외 상황

예외가 발생시

• preHandle : 컨트롤러 호출 전에 호출된다.
• postHandle : 컨트롤러에서 예외가 발생하면 postHandle 은 호출되지 않는다.
• afterCompletion : afterCompletion 은 항상 호출된다.
  이 경우 예외( ex )를 파라미터로 받아서 어떤 예외가 발생했는지 로그로 출력할 수 있다.

afterCompletion은 예외가 발생해도 호출된다.

• 예외가 발생하면 postHandle() 는 호출되지 않으므로 예외와 무관하게 공통 처리를 하려면 afterCompletion() 을 사용해야 한다.
• 예외가 발생하면 afterCompletion() 에 예외 정보( ex )를 포함해서 호출된다.

정리

인터셉터는 스프링 MVC 구조에 특화된 필터 기능을 제공한다고 이해하면 된다.
스프링 MVC를 사용하고, 특별히 필터를 꼭 사용해야 하는 상황이 아니라면 인터셉터를 사용하는 것이 더 편리하다.

스프링 인터셉터 - 요청 로그

LogInterceptor - 요청 로그 인터셉터

@Slf4j
public class LogInterceptor implements HandlerInterceptor {

 public static final String LOG_ID = "logId";

 @Override
 public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 
     String requestURI = request.getRequestURI();

     String uuid = UUID.randomUUID().toString();
     request.setAttribute(LOG_ID, uuid);

     //@RequestMapping: HandlerMethod
     //정적 리소스: ResourceHttpRequestHandler
     if (handler instanceof HandlerMethod) {
     HandlerMethod hm = (HandlerMethod) handler; //호출할 컨트롤러 메서드의 모든 정보가 포함되어 있다.
	 }
     
     log.info("REQUEST [{}][{}][{}]", uuid, requestURI, handler);
     return true; //false 진행X
   }
 
   @Override
   public void postHandle(HttpServletRequest request, HttpServletResponse 
  response, Object handler, ModelAndView modelAndView) throws Exception {
   log.info("postHandle [{}]", modelAndView);
   }
 
   @Override
   public void afterCompletion(HttpServletRequest request, HttpServletResponse 
        response, Object handler, Exception ex) throws Exception {
    
     String requestURI = request.getRequestURI();
     String logId = (String)request.getAttribute(LOG_ID);
     log.info("RESPONSE [{}][{}]", logId, requestURI);
     if (ex != null) {
         log.error("afterCompletion error!!", ex);
     }
   }
}

• String uuid = UUID.randomUUID().toString()
  요청 로그를 구분하기 위한 uuid 를 생성한다.

• request.setAttribute(LOG_ID, uuid)

  • 서블릿 필터의 경우 지역변수로 해결이 가능하지만, 스프링 인터셉터는 호출 시점이 완전히 분리되어 있다.
    ➞ 따라서 preHandle 에서 지정한 값을 postHandle , afterCompletion 에서 함께 사용하려면 어딘가에 담아두어야 한다.
  • LogInterceptor 도 싱글톤 처럼 사용되기 때문에 맴버변수를 사용하면 위험하다.
    ➞ 따라서 request 에 담아두었다. 이 값은 afterCompletion 에서 request.getAttribute(LOG_ID) 로 찾아서 사용한다.

• return true
  true 면 정상 호출이다. 다음 인터셉터나 컨트롤러가 호출된다.

HandlerMethod

핸들러 정보는 어떤 핸들러 매핑을 사용하는가에 따라 달라진다.
스프링을 사용하면 일반적으로 @Controller , @RequestMapping 을 활용한 핸들러 매핑을 사용하는데, 이 경우 핸들러 정보로 HandlerMethod 가 넘어온다.

ResourceHttpRequestHandler

@Controller 가 아니라 /resources/static 와 같은 정적 리소스가 호출 되는 경우 ResourceHttpRequestHandler 가 핸들러 정보로 넘어오기 때문에 타입에 따라서 처리가 필요하다.

postHandle, afterCompletion

종료 로그를 postHandle 이 아니라 afterCompletion 에서 실행한 이유는, 예외가 발생한 경우
postHandle 가 호출되지 않기 때문이다.
afterCompletion 은 예외가 발생해도 호출 되는 것을 보장한다.

WebConfig - 인터셉터 등록

인터셉터와 필터가 중복되지 않도록 필터를 등록하기 위한 logFilter() 의 @Bean 은 주석처리

@Configuration
public class WebConfig implements WebMvcConfigurer {

   @Override
   public void addInterceptors(InterceptorRegistry registry) {
       registry.addInterceptor(new LogInterceptor())
               .order(1)
               .addPathPatterns("/**")
               .excludePathPatterns("/css/**", "/*.ico", "/error");
   }
   //...
}

WebMvcConfigurer 가 제공하는 addInterceptors() 를 사용해서 인터셉터를 등록할 수 있다.

• egistry.addInterceptor(new LogInterceptor()) : 인터셉터를 등록한다.
• order(1) : 인터셉터의 호출 순서를 지정한다. 낮을 수록 먼저 호출된다.
• addPathPatterns("/**") : 인터셉터를 적용할 URL 패턴을 지정한다.
• excludePathPatterns("/css/**", "/*.ico", "/error") : 인터셉터에서 제외할 패턴을 지정한다.

필터와 비교해보면 인터셉터는 addPathPatterns , excludePathPatterns 로 매우 정밀하게 URL 패턴을 지정할 수 있다.

실행 로그

REQUEST [6234a913-f24f-461f-a9e1-85f153b3c8b2][/members/add]
[hello.login.web.member.MemberController#addForm(Member)]
postHandle [ModelAndView [view="members/addMemberForm"; 
model={member=Member(id=null, loginId=null, name=null, password=null), 
org.springframework.validation.BindingResult.member=org.springframework.validat
ion.BeanPropertyBindingResult: 0 errors}]]
RESPONSE [6234a913-f24f-461f-a9e1-85f153b3c8b2][/members/add]

스프링의 URL 경로

스프링이 제공하는 URL 경로는 서블릿 기술이 제공하는 URL 경로와 완전히 다르다. 더욱 자세하고, 세밀하게 설정할 수 있다.

📌 참고 링크:
https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/util/pattern/PathPattern.html

스프링 인터셉터 - 인증 체크

서블릿 필터에서 사용했던 인증 체크 기능을 스프링 인터셉터로 개발해보자.

@Slf4j
public class LoginCheckInterceptor implements HandlerInterceptor {

   @Override
   public boolean preHandle(HttpServletRequest request, HttpServletResponse 
  response, Object handler) throws Exception {
   
   String requestURI = request.getRequestURI();
   
   log.info("인증 체크 인터셉터 실행 {}", requestURI);
   HttpSession session = request.getSession(false);
   
   if (session == null || session.getAttribute(SessionConst.LOGIN_MEMBER) == null) {
     log.info("미인증 사용자 요청");
     //로그인으로 redirect
     response.sendRedirect("/login?redirectURL=" + requestURI);
     return false;
    }
   return true;
  }
}

• 서블릿 필터와 비교해서 코드가 매우 간결하다. 인증이라는 것은 컨트롤러 호출 전에만 호출되면 된다.
  ➞ 따라서 preHandle 만 구현하면 된다.

순서 주의, 세밀한 설정 가능

@Configuration
public class WebConfig implements WebMvcConfigurer {

   @Override
   public void addInterceptors(InterceptorRegistry registry) {
     registry.addInterceptor(new LogInterceptor())
             .order(1)
             .addPathPatterns("/**")
             .excludePathPatterns("/css/**", "/*.ico", "/error");

     registry.addInterceptor(new LoginCheckInterceptor())
             .order(2)
             .addPathPatterns("/**")
             .excludePathPatterns(
             "/", "/members/add", "/login", "/logout",
             "/css/**", "/*.ico", "/error");
     }
   //...
}

• 인터셉터를 적용하거나 하지 않을 부분은 addPathPatterns 와 excludePathPatterns 에 작성하면 된다.

정리

'서블릿 필터'와 스'프링 인터셉터'는 웹과 관련된 공통 관심사를 해결하기 위한 기술이다.
서블릿 필터와 비교해서 스프링 인터셉터가 개발자 입장에서 훨씬 편리하다는 것을 코드로 이해했을
것이다.
특별한 문제가 없다면 인터셉터를 사용하는 것이 좋다.

ArgumentResolver 활용

MVC1편 6. 스프링 MVC - 기본 기능 ➞ 요청 매핑 헨들러 어뎁터 구조에서 ArgumentResolver 를 학습했다.
이번 시간에는 해당 기능을 사용해서 로그인 회원을 조금 편리하게 찾아보자.

HomeController - 추가

@GetMapping("/")
public String homeLoginV3ArgumentResolver(@Login Member loginMember, Model model) {

 //세션에 회원 데이터가 없으면 home
 if (loginMember == null) {
     return "home";
 }
 //세션이 유지되면 로그인으로 이동
 model.addAttribute("member", loginMember);
 return "loginHome";
}

• 다음에 설명하는 @Login 애노테이션을 만들어야 컴파일 오류가 사라진다.

@Login 애노테이션 생성

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Login {
}

• @Target(ElementType.PARAMETER) : 파라미터에만 사용
• @Retention(RetentionPolicy.RUNTIME) : 리플렉션 등을 활용할 수 있도록 런타임까지 애노테이션 정보가 남아있음

LoginMemberArgumentResolver 생성

MVC1에서 학습한 HandlerMethodArgumentResolver 를 구현해보자.

@Slf4j
public class LoginMemberArgumentResolver implements
HandlerMethodArgumentResolver {

   @Override
   public boolean supportsParameter(MethodParameter parameter) {
  
     log.info("supportsParameter 실행");
     boolean hasLoginAnnotation =  parameter.hasParameterAnnotation(Login.class);
     boolean hasMemberType = Member.class.isAssignableFrom(parameter.getParameterType());
   
   return hasLoginAnnotation && hasMemberType;
   }
   
   @Override
   public Object resolveArgument(MethodParameter parameter,
                                ModelAndViewContainer mavContainer, NativeWebRequest webRequest,
                                WebDataBinderFactory binderFactory) throws Exception {
                                
     log.info("resolveArgument 실행");
   
     HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
     HttpSession session = request.getSession(false);
  
    if (session == null) {
       return null;
   }
   return session.getAttribute(SessionConst.LOGIN_MEMBER);
   }
}

• supportsParameter() : @Login 애노테이션이 있으면서 Member 타입이면 해당 ArgumentResolver 가 사용된다.
• resolveArgument() : 컨트롤러 호출 직전에 호출 되어서 필요한 파라미터 정보를 생성해준다.
  여기서는 세션에 있는 로그인 회원 정보인 member 객체를 찾아서 반환해준다.
  ➞ 이후 스프링MVC는 컨트롤러의 메서드를 호출하면서 여기에서 반환된 member 객체를 파라미터에 전달해준다.

WebMvcConfigurer에 설정 추가

@Configuration
public class WebConfig implements WebMvcConfigurer {

 @Override
 public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
   resolvers.add(new LoginMemberArgumentResolver());
 }
 //...
}

실행

실행해보면, 결과는 동일하지만, 더 편리하게 로그인 회원 정보를 조회할 수 있다.
이렇게 ArgumentResolver 를 활용하면 공통 작업이 필요할 때 컨트롤러를 더욱 편리하게 사용할 수 있다.