[SPRING] 타임리프 - 2. 스프링 통합과 폼 (체크박스, 라디오버튼, 셀렉트 박스)
타임리프 스프링 통합
타임리프는 크게 2가지 메뉴얼을 제공한다.
타임리프는 스프링 없이도 동작하지만, 스프링과 통합을 위한 다양한 기능을 편리하게 제공한다.
그리고 이런 부분은 스프링으로 백엔드를 개발하는 개발자 입장에서 타임리프를 선택하는 하나의 이유가 된다.
스프링 통합으로 추가되는 기능들
- 스프링의 SpringEL 문법 통합
${@myBean.doSomething()}처럼 스프링 빈 호출 지원- 편리한 폼 관리를 위한 추가 속성
-th:object(기능 강화, 폼 커맨드 객체 선택)
-th:field,th:errors,th:errorclass - 폼 컴포넌트 기능
- checkbox, radio button, List 등을 편리하게 사용할 수 있는 기능 지원 - 스프링의 메시지, 국제화 기능의 편리한 통합 스프링의 검증, 오류 처리 통합
- 스프링의 변환 서비스 통합(ConversionService)
설정 방법
타임리프 템플릿 엔진을 스프링 빈에 등록하고, 타임리프용 뷰 리졸버를 스프링 빈으로 등록하는 방법
스프링 부트는 이런 부분을 모두 자동화 해준다.
build.gradle 에 다음 한줄을 넣어주면 Gradle은 타임리프와 관련된 라이브러리를 다운로드 받고, 스프링 부트는 앞서 설명한 타임리프와 관련된 설정용 스프링 빈을 자동으로 등록해준다.
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
입력 폼 처리
지금부터 타임리프가 제공하는 입력 폼 기능을 적용해서 기존 프로젝트의 폼 코드를 타임리프가 지원하는 기능을 사용해서 효율적으로 개선해보자.
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 를 적용하려면 먼저 해당 오브젝트 정보를 넘겨주어야 한다. 등록 폼이기 때문에 데이터가 비어있는 빈 오브젝트를 만들어서 뷰에 전달하자.
@Controller
@RequestMapping("/form/items")
@RequiredArgsConstructor
public class FormItemController {
@GetMapping("/add")
public String addForm(Model model) {
model.addAttribute("item", new Item()); // 추가
return "form/addForm";
}
}
뷰
addForm.html
resources/templates/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:object로item을 선택했기 때문에 선택 변수 식을 적용할 수 있다.th:field는id,name,value속성을 모두 자동으로 만들어준다.
•id:th:field에서 지정한 변수 이름과 같다.id="itemName"
•name:th:field에서 지정한 변수 이름과 같다.name="itemName"
•value:th:field에서 지정한 변수의 값을 사용한다.value=""
참고로 해당 예제에서 id 속성을 제거해도 th:field 가 자동으로 만들어준다.
✔️ 상품 수정 폼
컨트롤러
컨트롤러는 기존 코드와 동일하다.
@Controller
@RequestMapping("/form/items")
@RequiredArgsConstructor
public class FormItemController {
@GetMapping("/{itemId}/edit")
public String editForm(@PathVariable Long itemId, Model model) {
Item item = itemRepository.findById(itemId);
model.addAttribute("item", item);
return "form/editForm";
}
}
뷰
editForm.html
resources/templates/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>
...
수정 폼은 앞서 설명한 내용과 같다. 수정 폼의 경우 id , name , value 를 모두 신경써야 했는데, 많은 부분이 th:field 덕분에 자동으로 처리되는 것을 확인할 수 있다.
- 이전 코드와의 차이점
실행 결과 (소스 보기) - 상품 수정
정리
th:object , th:field 덕분에 폼을 개발할 때 약간의 편리함을 얻었다.
사실 이것의 진짜 위력은 뒤에 설명할 검증(Validation)에서 나타난다. 이후 검증 부분에서 폼 처리와 관련된 부분을 더 깊이있게 알아보자.
요구 사항 추가
타임리프를 사용해서 폼에서 체크박스, 라디오 버튼, 셀렉트 박스를 편리하게 사용하는 방법을 학습해보자. 기존 상품 서비스에 다음 요구사항이 추가되었다.
- 판매 여부
• 판매 오픈 여부
• 체크 박스로 선택할 수 있다. - 등록 지역
• 서울, 부산, 제주
• 체크 박스로 다중 선택할 수 있다. - 상품 종류
• 도서, 식품, 기타
• 라디오 버튼으로 하나만 선택할 수 있다. - 배송 방식
• 빠른 배송
• 일반 배송
• 느린 배송
• 셀렉트 박스로 하나만 선택할 수 있다.
ItemType.java - 상품 종류
public enum ItemType {
BOOK("도서"), FOOD("음식"), ETC("기타");
private final String description;
ItemType(String description) {
this.description = description;
}
}
상품 종류는 ENUM 을 사용한다. 설명을 위해 description 필드를 추가했다.
DeliveryCode.java - 배송 방식
/**
* FAST: 빠른 배송
* NORMAL: 일반 배송
* SLOW: 느린 배송
*/
@Data
@AllArgsConstructor
public class DeliveryCode {
private String code;
private String displayName;
}
배송 방식은 DeliveryCode 라는 클래스를 사용한다. code 는 FAST 같은 시스템에서 전달하는 값이고, displayName 은 빠른 배송 같은 고객에게 보여주는 값이다.
Item.java - 상품
@Data
public class Item {
private Long id;
private String itemName;
private Integer price;
private Integer quantity;
private Boolean open; // 판매 여부
private List<String> regions; // 등록 지역
private ItemType itemType; // 상품 종류
private String deliveryCode; // 배송 방식
public Item() {
}
public Item(String itemName, Integer price, Integer quantity) {
this.itemName = itemName;
this.price = price;
this.quantity = quantity;
}
}
ENUM , 클래스, String 같은 다양한 상황을 준비했다. 각각의 상황에 어떻게 폼의 데이터를 받을 수 있는지 하나씩 알아보자.
1. 체크 박스
💫 단일 1 - 순수 HTML (히든 필드 수동 추가)
뷰
addForm.html
resources/templates/form/addForm.html
아래 코드를 추가한다.
<!-- 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>
컨트롤러
상품이 등록되는 곳에 다음과 같이 로그를 남겨서 값이 잘 넘어오는지 확인해보자.
@Slf4j // 애노테이션 추가
@Controller
@RequestMapping("/form/items")
@RequiredArgsConstructor
public class FormItemController {
@PostMapping("/add")
public String addItem(@ModelAttribute Item item, RedirectAttributes redirectAttributes) {
log.info("item.open={}", item.getOpen()); // 로그 추가
Item savedItem = itemRepository.save(item);
redirectAttributes.addAttribute("itemId", savedItem.getId());
redirectAttributes.addAttribute("status", true);
return "redirect:/form/items/{itemId}";
}
}
실행 로그
FormItemController : item.open=true //체크 박스를 선택하는 경우
FormItemController : item.open=null //체크 박스를 선택하지 않는 경우
체크 박스를 체크하면 HTML Form에서 open=on 이라는 값이 넘어간다. 스프링은 on 이라는 문자를 true 타입으로 변환해준다. (스프링 타입 컨버터가 이 기능을 수행하는데, 뒤에서 설명한다.)
🚨 주의 - 체크 박스를 선택하지 않을 때
HTML에서 체크 박스를 선택하지 않고 폼을 전송하면open이라는 필드 자체가 서버로 전송되지 않는다.
HTML checkbox는 선택이 안되면 클라이언트에서 서버로 값 자체를 보내지 않는다.
수정의 경우에는 상황에 따라서 이 방식이 문제가 될 수 있다.
사용자가 의도적으로 체크되어 있던 값을 체크를 해제해도 저장시 아무 값도 넘어가지 않기 때문에, 서버 구현에 따라서 값이 오지 않은 것으로 판단해서 값을 변경하지 않을 수도 있다.
이런 문제를 해결하기 위해서 스프링 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>
실행 로그
FormItemController : item.open=true //체크 박스를 선택하는 경우
FormItemController : item.open=false //체크 박스를 선택하지 않는 경우
히든 필드 적용 후
- 체크 박스 체크
-open=on&_open=on
- 체크 박스를 체크하면 스프링 MVC가open에 값이 있는 것을 확인하고 사용한다. 이때_open은 무시한다.- 체크 박스 미체크
-_open=on
- 체크 박스를 체크하지 않으면 스프링 MVC가_open만 있는 것을 확인하고,open의 값이 체크되지 않았다고 인식한다.
- 이 경우 서버에서Boolean타입을 찍어보면 결과가null이 아니라false인 것을 확인할 수 있다.
💫 단일 2 - 타임리프 사용 (히든 필드 자동 추가)
개발할 때 마다 이렇게 히든 필드를 추가하는 것은 상당히 번거롭다. 타임리프가 제공하는 폼 기능을 사용하면 이런 부분을 자동으로 처리할 수 있다.
뷰
addForm.html
resources/templates/form/addForm.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>
실행 결과 (소스 보기) - 상품 등록
<input type="hidden" name="_open" value="on"/>
타임리프를 사용하면 체크 박스의 히든 필드와 관련된 부분도 함께 해결해준다. HTML 생성 결과를 보면 히든 필드 부분이 자동으로 생성되어 있다.
실행 로그
FormItemController : item.open=true //체크 박스를 선택하는 경우
FormItemController : item.open=false //체크 박스를 선택하지 않는 경우
item.html
resources/templates/form/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 를 사용해서 상품 상세에서는 체크 박스가 선택되지 않도록 했다.
타임리프의 체크 확인
checked="checked"
체크 박스에서 판매 여부를 선택해서 저장하면, 조회시에 checked 속성이 추가된 것을 확인할 수 있다.
이런 부분을 개발자가 직접 처리하려면 상당히 번거롭다.
타임리프의 th:field 를 사용하면, 값이 true 인 경우 체크를 자동으로 처리해준다.
editForm.html
resources/templates/form/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>
실행해보면 체크 박스를 수정해도 반영되지 않는다.
실제 반영되도록 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.setRegions(updateParam.getRegions());
findItem.setItemType(updateParam.getItemType());
findItem.setDeliveryCode(updateParam.getDeliveryCode());
}
open 이외에 나머지 필드도 업데이트 되도록 미리 넣어 두었다.
💫 멀티
체크 박스를 멀티로 사용해서, 하나 이상을 체크할 수 있도록 해보자.
- 등록 지역
- 서울, 부산, 제주
- 체크 박스로 다중 선택할 수 있다.
컨트롤러
@Controller
@RequestMapping("/form/items")
@RequiredArgsConstructor
public class 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 )에 담기게 된다.
(마치 model.addAttribute("regions", regions);를 하는 것 처럼..)
물론 이렇게 사용하지 않고, 각각의 컨트롤러 메서드에서 모델에 직접 데이터를 담아서 처리해도 된다.
뷰
addForm.html & editForm.html
resources/templates/form/addForm.html
resources/templates/form/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>
실행 결과 (소스 보기) - 상품 등록
<input type="hidden" name="_regions" value="on"/>
이전과 마찬가지로, 타임리프를 사용하였기 때문에 HTML 생성 결과를 보면 히든 필드 부분이 자동으로 생성되어 있다.
웹 브라우저에서 체크를 하나도 하지 않았을 때, 클라이언트가 서버에 아무런 데이터를 보내지 않는 것을 방지한다.
참고로 (타임리프를 사용하지 않고 순수한 HTML을 이용해)_regions조차 보내지 않으면 결과는null이 된다.
(_regions가 체크박스 숫자만큼 생성될 필요는 없지만, 타임리프가 생성되는 옵션 수 만큼 생성해서 그런 것이니 무시하자.)
#ids.prev() - 동적으로 id 생성
th:for="${#ids.prev('regions')}"
멀티 체크박스는 같은 이름의 여러 체크박스를 만들 수 있다. 그런데 문제는 이렇게 반복해서 HTML 태그를 생성할 때, 생성된 HTML 태그 속성에서 name 은 같아도 되지만, id 는 모두 달라야 한다.
따라서 타임리프는 체크박스를 each루프 안에서 반복해서 만들 때 임의로 1,2,3 숫자를 뒤에 붙여준다
HTML의 id 가 타임리프에 의해 동적으로 만들어지기 때문에 <label for="id 값"> 으로 label 의 대상이 되는 id 값을 임의로 지정하는 것은 곤란하다.
📍 타임리프는 ids.prev(...) , ids.next(...) 을 제공해서 동적으로 생성되는 id 값을 사용할 수 있도록 한다.
렌더링 된 페이지의 소스를 보면 <label for="id 값"> 에 지정된 id 가 checkbox 에서 동적으로 생성된 regions1 , regions2 , regions3 에 맞추어 순서대로 입력된 것을 확인할 수 있다.
item.html
resources/templates/form/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 를 사용해서 상품 상세에서는 체크 박스가 선택되지 않도록 했다.
타임리프의 체크 확인
checked="checked"
멀티 체크 박스에서 등록 지역을 선택해서 저장하면, 조회시에 checked 속성이 추가된 것을 확인할 수 있다.
타임리프는 th:field 에 지정한 값과 th:value 의 값을 비교해서 체크를 자동으로 처리해준다.
(th:value의 값이 th:field(배열)에 들어있으면 checked 속성을 넣는다.)
2. 라디오 버튼 (ENUM 사용)
라디오 버튼은 여러 선택지 중에 하나를 선택할 때 사용할 수 있다. 이번시간에는 라디오 버튼을 자바 ENUM을 활용해서 개발해보자.
- 상품 종류
- 도서, 식품, 기타
- 라디오 버튼으로 하나만 선택할 수 있다.
컨트롤러
@Controller
@RequestMapping("/form/items")
@RequiredArgsConstructor
public class FormItemController {
...
@ModelAttribute("itemTypes")
public ItemType[] itemTypes(){
return ItemType.values(); // values(): ENUM 안에 있는 값들을 배열로 넘겨준다.
}
...
}
itemTypes를 등록 폼, 조회, 수정 폼에서 모두 사용하므로@ModelAttribute의 특별한 사용법을 적용하자.ItemType.values()를 사용하면 해당 ENUM의 모든 정보를 배열로 반환한다. 예)[BOOK, FOOD, ETC]
뷰
addForm.html & editForm.html
resources/templates/form/addForm.html
resources/templates/form/editForm.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>
체크 박스는 수정시 체크를 해제하면 아무 값도 넘어가지 않기 때문에, 별도의 히든 필드로 이런 문제를 해결했다.
라디오 버튼은 이미 선택이 되어 있다면, 수정시에도 항상 하나를 선택하도록 되어 있으므로 체크 박스와 달리 별도의 히든 필드를 사용할 필요가 없다.
item.html
resources/templates/form/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 를 사용해서 상품 상세에서는 체크 박스가 선택되지 않도록 했다.
3. 셀렉트 박스 (자바 객체 활용)
셀렉트 박스는 여러 선택지 중에 하나를 선택할 때 사용할 수 있다. 이번시간에는 셀렉트 박스를 자바 객체를 활용해서 개발해보자.
- 배송 방식
- 빠른 배송
- 일반 배송
- 느린 배송
셀렉트 박스로 하나만 선택할 수 있다.
컨트롤러
@Controller
@RequestMapping("/form/items")
@RequiredArgsConstructor
public class 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;
}
...
}
이전에는 ENUM을 사용했다면, 이번에는 DeliveryCode 라는 자바 객체를 사용하는 방법으로 진행한다.
DeliveryCode 를 등록 폼, 조회, 수정 폼에서 모두 사용하므로 @ModelAttribute 의 특별한 사용법을 적용하자.
참고 💡
@ModelAttribute가 있는deliveryCodes()메서드는 컨트롤러가 호출 될 때 마다 사용되므로deliveryCodes객체도 계속 생성된다.
이런 부분은static으로 어딘가에 미리 생성해두고 재사용하는 것이 더 효율적이다.
뷰
addForm.html & editForm.html
resources/templates/form/addForm.html
resources/templates/form/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">
실행 결과 (소스 보기) - 상품 수정
selected="selected"
빠른 배송을 선택한 예시인데, 선택된 샐랙트 박스가 유지되는 것을 확인할 수 있다.
item.html
resources/templates/form/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>
<hr class="my-4">
주의 🚨
item.html에는th:object를 사용하지 않았기 때문에th:field부분에${item.deliveryCode}으로 적어주어야 한다.
disabled 를 사용해서 상품 상세에서는 체크 박스가 선택되지 않도록 했다.
💛 개인 공부 기록용 블로그입니다. 👻