[Spring] 타임리프 - 스프링 통합과 폼

영우·약 14시간 전
MVCSpringThymeleaf

입력 폼 처리

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

  • 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}" />

등록 폼

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>
  • th:object="${item}" : <form> 에서 사용할 객체를 지정한다. 선택 변수 식(*{...} )을 적용할 수 있다.
  • th:field="*{itemName}"
    • *{itemName} 는 선택 변수 식을 사용했는데, ${item.itemName} 과 같다.
    • th:field 는 id , name , value 속성을 모두 자동으로 만들어준다.
      • id : th:field 에서 지정한 변수 이름과 같다. id="itemName"
      • name : th:field 에서 지정한 변수 이름과 같다. name="itemName"
      • value : th:field 에서 지정한 변수의 값을 사용한다. value=""

렌더링 전

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

렌더링 후

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

수정 폼

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" th:field="*{id}" class="form-control"
    readonly>
  </div>
  <div>
    <label for="itemName">상품명</label>
    <input type="text" id="itemName" th:field="*{itemName}" class="form-
    control">
  </div>
  <div>
    <label for="price">가격</label>
    <input type="text" id="price" th:field="*{price}" class="form-
    control">
  </div>
  <div>
    <label for="quantity">수량</label>
    <input type="text" id="quantity" th:field="*{quantity}" class="form-
    control">
  </div>

수정 폼의 경우 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">

체크 박스 - 단일1

단순 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(Item item, RedirectAttributes redirectAttributes) {
  log.info("item.open={}", item.getOpen());
  ...
}

실행 로그

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

체크 박스를 체크하면 HTML Form에서 open=on 이라는 값이 넘어간다.
스프링은 on 이라는 문자를 true 타입으로 변환해준다.

주의 - 체크 박스를 선택하지 않을 때
HTML에서 체크 박스를 선택하지 않고 폼을 전송하면 open 이라는 필드 자체가 서버로 전송되지 않는다.

이런 문제를 해결하기 위해서 스프링 MVC는 약간의 트릭을 사용하는데, 히든 필드를 하나 만들어서, _open 처럼 기존체크 박스 이름 앞에 언더스코어(_ )를 붙여서 전송하면 체크를 해제했다고 인식할 수 있다.

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

체크 박스 - 단일2

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

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

<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 생성 결과

<div>판매 여부</div>
<div>
  <div class="form-check">
    <input type="checkbox" id="open" class="form-check-input" name="open"
    value="true">
    <input type="hidden" name="_open" value="on"/>
    <label for="open" class="form-check-label">판매 오픈</label>
  </div>
</div>
  • <input type="hidden" name="_open" value="on"/>
    타임리프를 사용하면 체크 박스의 히든 필드와 관련된 부분도 함께 해결해준다.

실행로그

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

체크 박스 - 멀티

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

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 - 추가

```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">

타임리프는 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 값"> 에 지정된 id 가 checkbox 에서 동적으로 생성된 regions1 , regions2 ,regions3 에 맞추어 순서대로 입력된 것을 확인할 수 있다.

라디오 버튼

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

FormItemController - 추가

@ModelAttribute("itemTypes")
public ItemType[] itemTypes() {
  return ItemType.values();
}

itemTypes 를 등록 폼, 조회, 수정 폼에서 모두 사용하므로 @ModelAttribute 의 특별한 사용법을 적용하자. ItemType.values() 를 사용하면 해당 ENUM의 모든 정보를 배열로 반환한다.

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=FOOD //음식 선택, 선택하지 않으면 아무 값도 넘어가지 않는다.

실행 로그

item.itemType=FOOD: 값이 있을 때
item.itemType=null: 값이 없을 때

셀렉트 박스

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

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;
}

addForm.html - 추가

```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

<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>
profile
영우
이전 포스트

[Spring] 타임리프 - 기본기능

0개의 댓글