타임리프 - 스프링 통합과 폼

LeeKyoungChang·2022년 1월 24일
0
post-thumbnail

'스프링 MVC 2편 - 백엔드 웹 개발 활용 기술' 수업을 듣고 정리한 내용입니다.

 

📚 1. 프로젝트 설정

  • MVC 1편에서 개발한 상품 관리 프로젝트를 다듬어서 form-start프로젝트에 들어가 있다! 이용하자!

 

프로젝트 설정 순서
(1) form-start 의 폴더 이름을 form 로 변경하자.
(2) 프로젝트 임포트
File Open → 해당 프로젝트의 build.gradle 을 선택하자. 그 다음에 선택창이 뜨는데, Open as Project를 선택하자.
(3) ItemServiceApplication.main() 을 실행해서 프로젝트가 정상 수행되는지 확인하자.

 

실행

  • http://localhost:8080
  • http://localhost:8080/form/items

 

📚 2. 타임리프 스프링 통합

타임리프 2가지 메뉴얼

 

스프링으로 백엔드를 개발하는 개발자 입장에서 타임리프를 선택한 이유 : 타임리프는 스프링 없이도 동작하지만, 스프링과 통합을 위한 다양한 기능을 편리하게 제공한다.

 

📖 A. 스프링 통합으로 추가되는 기능들

  • 스프링의 SpringEL 문법 통합
  • ${@myBean.doSomething()} 처럼 스프링 빈 호출 지원
  • 편리한 폼 관리를 위한 추가 속성
    ➡️ th:object (기능 강화, 폼 커맨드 객체 선택)
    ➡️ th:field , th:errors , th:errorclass
  • 폼 컴포넌트 기능
    ➡️ checkbox, radio button, List 등을 편리하게 사용할 수 있는 기능 지원
  • 스프링의 메시지, 국제화 기능의 편리한 통합
  • 스프링의 검증, 오류 처리 통합
  • 스프링의 변환 서비스 통합(ConversionService)

 

📖 B. 설정 방법

타임리프 템플릿 엔진을 스프링 빈에 등록하고, 타임리프용 뷰 리졸버를 스프링 빈으로 등록하는 방법

  • https://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html#the-springstandard- dialect
  • https://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html#views-and-view- resolvers

 

위 내용을 등록할 필요가 없다.
스프링 부트는 위 설정 방법을 모두 자동화 해준다.
builde.gradle에 다음을 추가해주면 된다.


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

시행시, gradle은 타임리프와 관련된 라이브러리를 다운로드 받고, 스프링 부트는 타임리프와 관련된 설정용 스프링 빈을 자동으로 등록해준다.

 

스프링 부트가 제공하는 타임리프 설정, thymeleaf 검색
https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application- properties.html#common-application-properties-templating

 

📚 3. 입력 폼 처리

타임리프가 제공하는 입력 폼 기능을 적용해서 기존 프로젝트의 폼 코드를 타임리프가 지원하는 기능을 사용해서 효율적으로 개선할 수 있다.

 

  • th:object : 커맨드 객체를 지정한다.
  • *{...} : 선택 변수 식이라고 한다. th:object 에서 선택한 객체에 접근한다.
  • th:field
    ➡️ HTML 태그의 id , name , value 속성을 자동으로 처리해준다.

 

🔒렌더링 전
<input type="text" th:field="*{itemName}" />

 

🗝렌더링 후
<input type="text" id="itemName" name="itemName" th:value="*{itemName}" />

 

📖 A. 등록 폼

  • th:object 를 적용하려면 먼저 해당 오브젝트 정보를 넘겨주어야 한다.
  • 등록 폼이기 때문에 데이터가 비어있는 빈 오브젝트를 만들어서 뷰에 전달하자.

 

FormItemController 변경

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

 

form/addForm.html

타임리프 등록 폼 변경

    <form action="item.html" th:action th:object="${item}" method="post">
        <div>
            <label for="itemName">상품명</label>
            <input type="text" id="itemName" th:field="*{itemName}" class="form-control" placeholder="이름을 입력하세요">
        </div>
        <div>
            <label for="price">가격</label>
            <input type="text" id="price" th:field="*{price}" class="form-control" placeholder="가격을 입력하세요">
        </div>
        <div>
            <label for="quantity">수량</label>
            <input type="text" id="quantity" th:field="*{quantity}" class="form-control" placeholder="수량을 입력하세요">
        </div>

        <hr class="my-4">

        <div class="row">
            <div class="col">
                <button class="w-100 btn btn-primary btn-lg" type="submit">상품 등록</button>
            </div>
            <div class="col">
                <button class="w-100 btn btn-secondary btn-lg"
                        onclick="location.href='items.html'"
                        th:onclick="|location.href='@{/form/items}'|"
                        type="button">취소</button>
            </div>
        </div>

    </form>
스크린샷 2022-01-24 오후 12 46 38
  • th:object="${item}" : <form> 에서 사용할 객체를 지정한다. 선택 변수 식( *{...} )을 적용할 수 있다.
  • th:field="*{itemName}"
    • *{itemName} 는 선택 변수 식을 사용했는데, ${item.itemName} 과 같다. 앞서 th:objectitem을 선택했기 때문에 선택 변수 식을 적용할 수 있다.
    • th:fieldid , name , value 속성을 모두 자동으로 만들어준다.
      ➡️ id : th:field 에서 지정한 변수 이름과 같다. id="itemName"
      ➡️ name : th:field 에서 지정한 변수 이름과 같다. name="itemName"
      ➡️ value : th:field 에서 지정한 변수의 값을 사용한다. value=""

 

💡 참고
예제에서 id 속성을 제거해도 th:field가 자동으로 만들어준다.

 

렌더링 전

<input type="text" id="itemName" th:field="*{itemName}" class="form-control" placeholder="이름을 입력하세요">

 

렌더링 후

<input type="text" id="itemName" class="form-control" placeholder="이름을 입력하세요" name="itemName" value="">

 

📖 B. 수정 폼

FormItemController 유지

    @GetMapping("/{itemId}/edit")
    public String editForm(@PathVariable Long itemId, Model model) {
        Item item = itemRepository.findById(itemId);
        model.addAttribute("item", item);
        return "form/editForm";
    }

 

form/editForm.html 변경 코드 부분

<form action="item.html" th:action th:object="${item}" method="post">
        <div>
            <label for="id">상품 ID</label>
            <input type="text" id="id"  class="form-control" th:field="*{id}" readonly>
        </div>
        <div>
            <label for="itemName">상품명</label>
            <input type="text" id="itemName" class="form-control" th:field="*{itemName}">
        </div>
        <div>
            <label for="price">가격</label>
            <input type="text" id="price" class="form-control" th:field = "*{price}">
        </div>
        <div>
            <label for="quantity">수량</label>
            <input type="text" id="quantity" class="form-control" th:field="*{quantity}">
        </div>
스크린샷 2022-01-24 오후 12 59 28

 

수정 폼의 경우 id, name, value를 모두 신경써야 했지만, 많은 부분이 th:field 덕분에 자동으로 처리되는 것을 확인할 수 있다.

 

렌더링 전

<input type="text" id="itemName" th:field="*{itemName}" class="form-control">

 

렌더링 후

<input type="text" id="itemName" class="form-control" name="itemName" value="itemA">

 

📌 정리

  • th:object, th:field 덕분에 폼을 개발할 때 약간의 편리함을 얻었다.
  • 사실 이것의 진짜 위력은 뒤에 설명할 검증(Validation)에서 나타난다.
  • 이후 검증 부분에서 폼 처리와 관련된 부분을 더 깊이있게 알아보자.

 

📚 4. 요구사항 추가

타임리프를 사용해서 폼에서 체크박스, 라디오 버튼, 셀렉트 박스를 편리하게 사용하는 방법을 학습해보자.

 

(1) 판매 여부

  • 판매 오픈 여부
  • 체크 박스로 선택할 수 있다.

(2) 등록 지역

  • 서울, 부산, 제주
  • 체크 박스로 다중 선택할 수 있다.

(3) 상품 종류

  • 도서, 식품, 기타
  • 라디오 버튼으로 하나만 선택할 수 있다.

(4) 배송 방식

  • 빠른 배송
  • 일반 배송
  • 느린 배송
  • 셀렉트 박스로 하나만 선택할 수 있다.

 

ex) 위 예시

스크린샷 2022-01-24 오후 1 21 28

 

ItemType - 상품 종류

package hello.itemservice.domain.item;

public enum ItemType {

    BOOK("도서"), FOOD("음식"), ETC("기타");

    private final String description;

    ItemType(String description) {
        this.description = description;
    }

    public String getDescription() {
        return description;
    }
}
  • 상품 종류는 ENUM을 사용한다.
  • 설명을 위해 description 필드를 추가했다!

 

배송 방식 - DeliveryCode

package hello.itemservice.domain.item;

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * FAST : 빠른 배송
 * NORMAL : 일반 배송
 * SLOW : 느린 배송
 */

@Data
@AllArgsConstructor
public class DeliveryCode {

    private String code;
    private String displayName;
}
  • 배송 방식은 DeliveryCode 라는 클래스를 사용한다.
  • codeFAST 같은 시스템에서 전달하는 값이고, displayName빠른 배송 같은 고객에게 보여주는 값이다.

 

Item - 상품

package hello.itemservice.domain.item;

import lombok.Data;

import java.util.List;

@Data
public class Item {

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

    private Boolean open; // 판매 여부
    private List<String> regisons; // 등록 지역
    private ItemType itemType; // 상품 종류
    private String delivertyCode; // 배송 방식

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

 

  • ENUM , 클래스, String 같은 다양한 상황을 준비했다.
  • 각각의 상황에 어떻게 폼의 데이터를 받을 수 있는지 하나씩 알아보자.

 

📚 5. 체크 박스 - 단일 1

단순 HTML 체크 박스
resources/templates/form/addForm.html

        <hr class="my-4">

        <!-- single checkbox -->
        <div>판매 여부</div>
        <div>
            <div class = "form-check">
                <input type = "checkbox" id = "open" name = "open" class = "form-check-input">
                <label for = "open" class = "form-check-label">판매 오픈</label>
            </div>
        </div>

 

FormItemController 추가
상품이 등록되는 곳에 다음과 같이 로그를 남겨서 값이 잘 넘어오는지 확인해보자.

    @PostMapping("/add")
    public String addItem(@ModelAttribute Item item, RedirectAttributes redirectAttributes) {
        log.info("item.oepn={}", item.getOpen());
		...
		}
  • FormItemController@Slf4j 애노테이션 추가

 

실행 로그


FormItemController : item.open=true //체크 박스를 선택하는 경우 
FormItemController : item.open=null //체크 박스를 선택하지 않는 경우
  • 체크 박스를 체크하면 HTML Form에서 open=on 이라는 값이 넘어간다. 스프링은 on 이라는 문자를 true 타입으로 변환해준다.
  • 체크 박스를 선택하지 않았을 때
    ➡️ HTML에서 체크 박스를 선택하지 않고 폼을 전송하면 open 이라는 필드 자체가 서버로 전송되지 않는다.
    ➡️ 선택하지 않았을 때 false가 출력되기를 원한다.

 

📖 A. HTTP 요청 메시지 로깅

HTTP 요청 메시지를 서버에 보고 싶으면 다음 설정을 추가하면 된다.

 

application.properties

logging.level.org.apache.coyote.http11=debug

 

HTTP 메시지 바디를 보면 open 의 이름도 전송이 되지 않는 것을 확인할 수 있다.

itemName=itemA&price=10000&quantity=10

 

서버에서 Boolean 타입을 찍어보면 결과가 null 인 것을 확인할 수 있다.

log.info("item.open={}", item.getOpen());

스크린샷 2022-01-24 오후 1 42 03

 

HTML checkbox

  • 선택이 안되면 클라이언트에서 서버로 값 자체를 보내지 않는다. 수정의 경우에는 상황에 따라서 이 방식이 문제가 될 수 있다. 사용자가 의도적으로 체크되어 있던 값을 체크를 해제해도 저장시 아무 값도 넘어가지 않기 때문에, 서버 구현에 따라서 값이 오지 않은 것으로 판단해서 값을 변경하지 않을 수도 있다.

 

📖 B. 히든 필드

위 문제들을 해결하기 위해서 스프링 MVC는 약간의 트릭을 사용하는데, 히든 필드를 하나 만들어서, _open처럼 기존 체크 박스 이름 앞에 언더스코어(_)를 붙여서 전송하면 체크를 해제했다고 인식할 수 있다. 히든 필드는 항상 전송된다. 따라서 체크를 해제한 경우 여기에서 open 은 전송되지 않고, _open 만 전송되는데, 이 경우 스프링 MVC는 체크를 해제했다고 판단한다.

 

체크 해제를 인식하기 위한 히든 필드
<input type="hidden" name="_open" value="on"/>

 

기존 코드에 히든 필드 추가

        <!-- single checkbox -->
        <div>판매 여부</div>
        <div>
            <div class = "form-check">
                <input type = "checkbox" id = "open" name = "open" class = "form-check-input">
                <input type = "hidden" name = "_open" value = "on"/> <!-- 히든 필드 추가 -->
                <label for = "open" class = "form-check-label">판매 오픈</label>
            </div>
        </div>

 

실행
(1) 체크 한 경우
스크린샷 2022-01-24 오후 1 41 29

 

(2) 체크하지 않은 경우
스크린샷 2022-01-24 오후 1 41 41

 

(3) 결과
스크린샷 2022-01-24 오후 1 48 10

 

실행 로그

FormItemController : item.open=true //체크 박스를 선택하는 경우
FormItemController : item.open=false //체크 박스를 선택하지 않는 경우
 

 

체크 박스 체크 open=on&_open=on

  • 체크 박스를 체크하면 스프링 MVC가 open 에 값이 있는 것을 확인하고 사용한다. 이때 _open 은 무시한다.
스크린샷 2022-01-24 오후 3 52 39

 

체크 박스 미체크 _open=on

  • 체크 박스를 체크하지 않으면 스프링 MVC가 _open 만 있는 것을 확인하고, open 의 값이 체크되지
    않았다고 인식한다.
  • 이 경우 서버에서 Boolean 타입을 찍어보면 결과가 null 이 아니라 false 인 것을 확인할 수 있다.
스크린샷 2022-01-24 오후 3 52 19

 

📚 6. 체크 박스 - 단일2

  • 개발할 때 마다 이렇게 히든 필드를 추가하는 것은 상당히 번거롭다.
  • 타임리프가 제공하는 폼 기능을 사용하면 이런 부분을 자동으로 처리할 수 있다.

 

(1) 타임리프 - 체크 박스 코드 추가

        <!-- single checkbox -->
        <div>판매 여부</div>
        <div>
            <div class = "form-check">
                <input type = "checkbox" id = "open" th:field="*{open}" class = "form-check-input">
                <label for = "open" class = "form-check-label">판매 오픈</label>
            </div>
        </div>
  • 체크 박스의 기존 코드를 제거하고 타임리프가 제공하는 체크 박스 코드로 변경하자!

     

    타임리프 체크 박스 HTML 생성 결과
    스크린샷 2022-01-24 오후 4 22 51

<input type="hidden" name="_open" value="on"/>

  • 타임리프를 사용하면 체크 박스의 히든 필드와 관련된 부분도 함께 해결해준다.
  • HTML 생성 결과를 보면 히든 필드 부분이 자동으로 생성되어 있다.

 

실행 로그
스크린샷 2022-01-24 오후 4 24 37

FormItemController : item.open=true // 체크 박스를 선택하는 경우
FormItemController : item.open=false // 체크 박스를 선택하지 않는 경우

 

(2) 상품 상세에 적용

item.html

    <!-- single checkbox -->
    <div>판매 여부</div>
    <div>
        <div class = "form-check">
            <input type = "checkbox" id = "open" th:field="${item.open}" class = "form-check-input" disabled>
            <label for = "open" class = "form-check-label">판매 오픈</label>
        </div>
    </div>
  • 주의 : item.html 에는 th:object 를 사용하지 않았기 때문에 th:field 부분에 ${item.open} 으로 적어주어야 한다.
  • disabled를 사용해서 상품 상세에서는 체크 박스가 선택되지 않도록 했다.

 

HTML 생성 결과
(1) 체크한 경우
스크린샷 2022-01-24 오후 4 29 59

스크린샷 2022-01-24 오후 4 30 12

 

(2) 체크안한 경우
스크린샷 2022-01-24 오후 4 41 14

스크린샷 2022-01-24 오후 4 30 23

 

타임리프의 체크 확인 - checked="checked"

  • 체크 박스에서 판매 여부를 선택해서 저장하면, 조회시에 checked 속성이 추가된 것을 확인할 수 있다.
  • 이런 부분을 개발자가 직접 처리하려면 상당히 번거롭다. 타임리프의 th:field 를 사용하면, 값이 true 인 경우 체크를 자동으로 처리해준다.

 

(3) 상품 수정

editForm.html

        <!-- single checkbox -->
        <div>판매 여부</div>
        <div>
            <div class = "form-check">
                <input type = "checkbox" id = "open" th:field="*{open}" class = "form-check-input">
                <label for = "open" class = "form-check-label">판매 오픈</label>
            </div>
        </div>

상품 수정도 th:object , th:field 를 모두 적용해야 한다.

 

이와 같이 실행시, 체크 박스를 수정해도 반영되지 않는다. 실제 수정이 반영되도록 다음 코드를 수정하자.

 

ItemRepository - update() 코드를 다음과 같이 수정하자

    public void update(Long itemId, Item updateParam) {
        Item findItem = findById(itemId);
        findItem.setItemName(updateParam.getItemName());
        findItem.setPrice(updateParam.getPrice());
        findItem.setQuantity(updateParam.getQuantity());
        findItem.setOpen(updateParam.getOpen());
        findItem.setRegisons(updateParam.getRegisons());
        findItem.setItemType(updateParam.getItemType());
        findItem.setDelivertyCode(updateParam.getDelivertyCode());
    }
  • open이외에 나머지 필드도 업데이트 되도록 미리 넣어두자!

 

📚 7. 체크 박스 - 멀티

  • 체크 박스를 멀티로 사용해서, 하나 이상을 체크할 수 있도록 해보자!

 

등록 지역

  • 서울, 부산, 제주
  • 체크 박스로 다중 선택할 수 있다.

 

FormItemController - 추가

    @ModelAttribute("regions")
    public Map<String, String> regions() {
        Map<String, String> regions = new LinkedHashMap<>();
        regions.put("SEOUL", "서울");
        regions.put("BUSAN", "부산");
        regions.put("JEJU", "제주");
        return regions;
    }

 

@ModelAttribute의 특별한 사용법

  • 등록 폼, 상세화면, 수정 폼에서 모두 서울, 부산, 제주라는 체크 박스를 반복해서 보여주어야 한다.
  • 이렇게 하려면 각각의 컨트롤러에서 model.addAttribute(...) 을 사용해서 체크 박스를 구성하는 데이터를 반복해서 넣어주어야 한다.
  • @ModelAttribute 는 이렇게 컨트롤러에 있는 별도의 메서드에 적용할 수 있다.
  • 이렇게하면 해당 컨트롤러를 요청할 때 regions 에서 반환한 값이 자동으로 모델( model )에 담기게 된다.
  • 물론 이렇게 사용하지 않고, 각각의 컨트롤러 메서드에서 모델에 직접 데이터를 담아서 처리해도 된다.

 

addForm.html - 추가

        <!-- multi checkbox -->
        <div>
            <div>등록 지역</div>
            <div th:each="region : ${regions}" class="form-check form-check-inline">
                <input type="checkbox" th:field="*{regions}" th:value="${region.key}" class="form-check-input">
                <label th:for="${#ids.prev('regions')}"
                       th:text="${region.value}" class="form-check-label">서울</label>
            </div>
        </div>

th:for="${#ids.prev('regions')}"
➡️ 멀티 체크박스는 같은 이름의 여러 체크박스를 만들 수 있다. 그런데 문제는 이렇게 반복해서 HTML 태그를 생성할 때, 생성된 HTML 태그 속성에서 name 은 같아도 되지만, id 는 모두 달라야 한다. 따라서 타임리프는 체크박스를 each루프 안에서 반복해서 만들 때 임의로 1,2,3 숫자를 뒤에 붙여준다.

 

each로 체크박스가 반복 생성된 결과 - id 뒤에 숫자가 추가

<input type="checkbox" value="SEOUL" class="form-check-input" id="regions1" name="regions">
<input type="checkbox" value="BUSAN" class="form-check-input" id="regions2" name="regions">
<input type="checkbox" value="JEJU" class="form-check-input" id="regions3" name="regions">

HTML의 id 가 타임리프에 의해 동적으로 만들어지기 때문에 <label for="id 값"> 으로 label 의 대상이 되는 id 값을 임의로 지정하는 것은 곤란하다. 타임리프는 ids.prev(...) , ids.next(...) 을 제공해서 동적으로 생성되는 id 값을 사용할 수 있도록 한다.

 

타임리프 HTML 생성 결과

        <!-- multi checkbox -->
        <div>
            <div>등록 지역</div>
            <div class="form-check form-check-inline">
                <input type="checkbox" value="SEOUL" class="form-check-input" id="regions1" name="regions"><input type="hidden" name="_regions" value="on"/>
                <label for="regions1"
                       class="form-check-label">서울</label>
            </div>
            <div class="form-check form-check-inline">
                <input type="checkbox" value="BUSAN" class="form-check-input" id="regions2" name="regions"><input type="hidden" name="_regions" value="on"/>
                <label for="regions2"
                       class="form-check-label">부산</label>
            </div>
            <div class="form-check form-check-inline">
                <input type="checkbox" value="JEJU" class="form-check-input" id="regions3" name="regions"><input type="hidden" name="_regions" value="on"/>
                <label for="regions3"
                       class="form-check-label">제주</label>
            </div>
        </div>
  • <label for="id 값"> 에 지정된 idcheckbox 에서 동적으로 생성된 regions1 , regions2 , regions3 에 맞추어 순서대로 입력된 것을 확인할 수 있다.

 

로그 출력
FormItemController.addItem()에 코드 추가

log.info("item.regions={}", item.getRegions());

 

서울, 부산 선택
스크린샷 2022-01-24 오후 5 39 57
스크린샷 2022-01-24 오후 5 40 12

 

로그 : item.regions=[SEOUL, BUSAN]

스크린샷 2022-01-24 오후 5 40 22
regions=SEOUL&_regions=on&regions=BUSAN&_regions=on&_regions=on

 

지역선택하지 않았을 시
스크린샷 2022-01-24 오후 6 14 50

 

로그: item.regions=[]

스크린샷 2022-01-24 오후 6 16 25
_regions=on&_regions=on&_regions=on

 

  • _regions 는 앞서 설명한 기능이다.
  • 웹 브라우저에서 체크를 하나도 하지 않았을 때, 클라이언트가 서버에 아무런 데이터를 보내지 않는 것을 방지한다.
  • 참고로 _regions 조차 보내지 않으면 결과는 null 이 된다.
  • _regions 가 체크박스 숫자만큼 생성될 필요는 없지만, 타임리프가 생성되는 옵션 수 만큼 생성해서 그런 것이니 무시하자!

 

item.html - 추가

    <!-- multi checkbox -->
    <div>
        <div>등록 지역</div>
        <div th:each="region : ${regions}" class="form-check form-check-inline">
            <input type="checkbox" th:field="${item.regions}" th:value="${region.key}" class="form-check-input" disabled>
            <label th:for="${#ids.prev('regions')}"
                   th:text="${region.value}" class="form-check-label">서울</label>
        </div>
    </div>

 

⚠️ 주의

  • item.html 에는 th:object 를 사용하지 않았기 때문에 th:field 부분에 ${item.regions} 으로 적어주어야 한다.
  • disabled 를 사용해서 상품 상세에서는 체크 박스가 선택되지 않도록 했다.

 

📖 A. 타임리프의 체크 확인

checked="checked"

  • 멀티 체크 박스에서 등록 지역을 선택해서 저장하면, 조회시에 checked 속성이 추가된 것을 확인할 수 있다.
  • 타임리프는 th:field 에 지정한 값과 th:value 의 값을 비교해서 체크를 자동으로 처리해준다.

 

editForm.html - 추가

        <!-- multi checkbox -->
        <div>
            <div>등록 지역</div>
            <div th:each="region : ${regions}" class="form-check form-check-inline">
                <input type="checkbox" th:field="*{regions}" th:value="${region.key}" class="form-check-input">
                <label th:for="${#ids.prev('regions')}"
                       th:text="${region.value}" class="form-check-label">서울</label>
            </div>
        </div>

 

📚 8. 라디오 버튼

  • 라디오 버튼은 여러 선택지 중에 하나를 선택할 때 사용할 수 있다.
  • 라디오 버튼을 자바 ENUM을 활용해서 개발해보자.

 

상품 종류

  • 도서, 식품, 기타
  • 라디오 버튼으로 하나만 선택할 수 있다.

 

FormItemController - 추가

    @ModelAttribute("itemTypes")
    public ItemType[] itemTypes(){
        return ItemType.values();
    }
  • itemTypes 를 등록 폼, 조회, 수정 폼에서 모두 사용하므로 @ModelAttribute 의 특별한 사용법을 적용하자.
  • ItemType.values() 를 사용하면 해당 ENUM의 모든 정보를 배열로 반환한다. 예) [BOOK, FOOD, ETC]
스크린샷 2022-01-24 오후 7 01 23

 

📖 A. 상품 등록 폼에 기능을 추가

addForm.html - 추가

        <!-- radio button -->
        <div>
            <div>상품 종류</div>
            <div th:each="type : ${itemTypes}" class="form-check form-check-inline">
                <input type="radio" th:field="*{itemType}" th:value="${type.name()}" class="form-check-input">
                <label th:for="${#ids.prev('itemType')}" th:text="${type.description}" class="form-check-label">
                    BOOK
                </label>
            </div>
        </div>

 

실행 결과, 폼 전송

itemType=ETC // 기타 선택, 선택하지 않으면 아무 값도 넘어가지 않는다.
스크린샷 2022-01-24 오후 7 03 29

 

로그 추가

log.info("item.itemType={}", item.getItemType());
스크린샷 2022-01-24 오후 7 06 06

 

실행 로그

item.itemType=ETC: 값이 있을 때
item.itemType=null: 값이 없을 때
스크린샷 2022-01-24 오후 7 04 15
  • 체크 박스는 수정시 체크를 해제하면 아무 값도 넘어가지 않기 때문에, 별도의 히든 필드를 사용해 이런 문제를 해결했다.
  • 라디오 버튼은 이미 선택이 되어 있다면, 수정시에도 항상 하나를 선택하도록 되어 있으므로 체크 박스와 달리 별도의 히든 필드를 사용할 필요가 없다.

 

📖 B. 상품 상세, 수정에도 기능 추가

item.html

    <!-- radio button -->
    <div>
        <div>상품 종류</div>
        <div th:each="type : ${itemTypes}" class="form-check form-check-inline">
            <input type="radio" th:field="${item.itemType}" th:value="${type.name()}" class="form-check-input" disabled>
            <label th:for="${#ids.prev('itemType')}" th:text="${type.description}" class="form-check-label">
                BOOK
            </label>
        </div>
    </div>

 

⚠️ 주의

  • item.html 에는 th:object 를 사용하지 않았기 때문에 th:field 부분에 ${item.itemType} 으로 적어주어야 한다.
  • disabled 를 사용해서 상품 상세에서는 라디오 버튼이 선택되지 않도록 했다.

 

editForm.html

        <!-- radio button -->
        <div>
            <div>상품 종류</div>
            <div th:each="type : ${T(hello.itemservice.domain.item.ItemType).values()}" class="form-check form-check-inline">
                <input type="radio" th:field="*{itemType}" th:value="${type.name()}" class="form-check-input">
                <label th:for="${#ids.prev('itemType')}" th:text="${type.description}" class="form-check-label">
                    BOOK
                </label>
            </div>
        </div>

 

타임리프로 생성된 HTML
스크린샷 2022-01-24 오후 7 15 02

스크린샷 2022-01-24 오후 7 15 10
  • 선택한 식품( FOOD )에 checked="checked" 가 적용된 것을 확인할 수 있다.

 

📖 C. 타임리프에서 ENUM 직접 사용하기

스크린샷 2022-01-24 오후 7 01 23
    @ModelAttribute("itemTypes")
    public ItemType[] itemTypes(){
        return ItemType.values();
    }
  • 이렇게 모델에 ENUM을 담아서 전달하는 대신에 타임리프는 자바 객체에 직접 접근할 수 있다.

 

타임리프에서 ENUM 직접 접근

<div th:each="type : ${T(hello.itemservice.domain.item.ItemType).values()}">
  • ${T(hello.itemservice.domain.item.ItemType).values()} 스프링EL 문법으로 ENUM을 직접 사용할 수 있다.
  • ENUMvalues() 를 호출하면 해당 ENUM의 모든 정보가 배열로 반환된다.
  • 그런데 이렇게 사용하면 ENUM의 패키지 위치가 변경되거나 할때 자바 컴파일러가 타임리프까지 컴파일 오류를 잡을 수 없으므로 추천하지는 않는다.

 

💡 정리
그래서 라디오 버튼이란?

  • 라디오 버튼 선택하지 않고 실행할 시, null이 된다.
  • 라디오 버튼은 이미 선택이 되어 있다면, 수정시에도 항상 하나를 선택하도록 되어 있으므로 체크 박스와 달리 별도의 히든 필드를 사용할 필요가 없다.

 

📚 9. 셀렉트 박스

  • 셀렉트 박스는 여러 선택지 중에 하나를 선택할 때 사용할 수 있다.
  • 이번시간에는 셀렉트 박스를 자바 객체를 활용해서 개발해보자.

 

배송 방식

  • 빠른 배송
  • 일반 배송
  • 느린 배송
    ➡️ 셀렉트 박스로 하나만 선택할 수 있다.

 

FormItemController - 추가

    @ModelAttribute("deliveryCodes")
    public List<DeliveryCode> deliveryCodes(){
        List<DeliveryCode> deliveryCodes = new ArrayList<>();
        deliveryCodes.add(new DeliveryCode("FAST", "빠른 배송"));
        deliveryCodes.add(new DeliveryCode("NORMAL", "일반 배송"));
        deliveryCodes.add(new DeliveryCode("SLOW", "느린 배송"));
        return deliveryCodes;
    }
  • DeliveryCode 라는 자바 객체를 사용하는 방법으로 진행하겠다.
  • DeliveryCode 를 등록 폼, 조회, 수정 폼에서 모두 사용하므로 @ModelAttribute 의 특별한 사용법을 적용하자.

 

💡 참고

  • @ModelAttribute 가 있는 deliveryCodes() 메서드는 컨트롤러가 호출 될 때 마다 사용되므로 deliveryCodes 객체도 계속 생성된다.
  • 이런 부분은 미리 생성해두고 재사용하는 것이 더 효율적이다.

 

📖 A. 상품 등록 폼에 기능을 추가

addForm.html - 추가

        <!-- SELECT -->
        <div>
            <div>배송 방식</div>
            <select th:field="*{deliveryCode}" class="form-select"> <option value="">==배송 방식 선택==</option>
                <option th:each="deliveryCode : ${deliveryCodes}" th:value="${deliveryCode.code}" th:text="${deliveryCode.displayName}">FAST</option>
            </select>
        </div>

        <hr class="my-4">

 

타임리프로 생성된 HTML

        <!-- SELECT -->
        <div>
            <div>배송 방식</div>
            <select class="form-select" id="deliveryCode" name="deliveryCode"> 
				<option value="">==배송 방식 선택==</option>
                <option value="FAST">빠른 배송</option>
                <option value="NORMAL">일반 배송</option>
                <option value="SLOW">느린 배송</option>
            </select>
        </div>
스크린샷 2022-01-24 오후 7 42 23 스크린샷 2022-01-24 오후 8 06 50

 

📖 B. 상품 상세, 수정에도 기능 추가

item.html

    <!-- SELECT -->
    <div>
        <div>배송 방식</div>
        <select th:field="${item.deliveryCode}" class="form-select" disabled>
            <option value="">==배송 방식 선택==</option>
            <option th:each="deliveryCode : ${deliveryCodes}" th:value="${deliveryCode.code}" th:text="${deliveryCode.displayName}">FAST</option>
        </select>
    </div>
스크린샷 2022-01-24 오후 7 42 35

 

⚠️ 주의

  • item.html 에는 th:object 를 사용하지 않았기 때문에 th:field 부분에 $ {item.deliveryCode} 으로 적어주어야 한다.
  • disabled 를 사용해서 상품 상세에서는 셀렉트 박스가 선택되지 않도록 했다.

 

editForm.html

        <!-- SELECT -->
        <div>
            <div>배송 방식</div>
            <select th:field="*{deliveryCode}" class="form-select">
                <option value="">==배송 방식 선택==</option>
                <option th:each="deliveryCode : ${deliveryCodes}" th:value="${deliveryCode.code}" th:text="${deliveryCode.displayName}">FAST</option>
            </select>
        </div>

        <hr class="my-4">
스크린샷 2022-01-24 오후 7 42 44

 

타임리프로 생성된 HTML

    <!-- SELECT -->
    <div>
        <div>배송 방식</div>
        <select class="form-select" disabled id="deliveryCode" name="deliveryCode">
            <option value="">==배송 방식 선택==</option>
            <option value="FAST">빠른 배송</option>
            <option value="NORMAL" selected="selected">일반 배송</option>
            <option value="SLOW">느린 배송</option>
        </select>
    </div>
스크린샷 2022-01-24 오후 7 43 33

 

  • selected="selected" : 빠른 배송을 선택한 예시인데, 선택된 샐랙트 박스가 유지되는 것을 확인할 수 있다.

 

profile
"야, (오류 만났어?) 너두 (해결) 할 수 있어"

0개의 댓글