no image
[Thymeleaf] 스프링 통합과 폼
이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다. 타임리프 스프링 통합 타임리프 기본 메뉴얼 : https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html 스프링 통합 메뉴얼 : https://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html 스프링 통합으로 추가되는 기능 스프링의 SpringEL 문법 ${@myBean.doSomething()} 처럼 스프링 빈 호출 지원 편리한 폼 관리를 위한 추가 속성 → th:object (기능 강화, 폼 커맨드 객체 선택) → th:field , th:errors , th:errorclass 폼 컴포넌트 기능 →c..
2024.03.09
no image
[Thymeleaf] 타임리프 레이아웃
이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다. 타임리프(Thymeleaf)에서 템플릿 레이아웃은 웹 애플리케이션의 다양한 페이지에서 공통적으로 사용되는 레이아웃 구조를 재사용할 수 있도록 도와준다. 이를 통해 개발자는 중복 코드를 줄이고, 일관된 레이아웃을 유지할 수 있다. 예를 들어서 layoutExtend.html 메인 컨텐츠 common_header(~{::title},~{::link}) 이 부분이 핵심이다. ::title 은 현재 페이지의 title 태그들을 전달한다. ::link 는 현재 페이지의 link 태그들을 전달한다. 결과 메인 컨텐츠 메인 타이틀이 전달한 부분으로 교체되었다. 공통 부분은 그대로 유지되고, 추가 부분에 전달한 들이 포함된 ..
2024.03.08
no image
[Thymeleaf] 템플릿 조각
이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다. 타임리프(Thymeleaf)의 템플릿 조각 기능은 HTML 문서의 특정 부분을 재사용 가능한 형태로 정의하고, 이를 다른 템플릿에서 삽입하여 사용할 수 있게 해준다. 이 기능은 중복을 줄이고, 템플릿의 유지보수를 용이하게 만들어준다. 템플릿 조각은 주로 헤더, 푸터, 네비게이션 바 등의 반복적으로 사용되는 UI 컴포넌트를 만들 때 유용하다. 템플릿 조각 정의하기 템플릿 조각은 th:fragment 속성을 사용하여 정의한다. 예를 들어, 하나의 HTML 파일 내에 여러 조각을 정의할 수 있다. 부분 포함 부분 포함 insert 부분 포함 replace 부분 포함 단순 표현식 파라미터 사용 결과 부분 포함 부분 포..
2024.03.07
no image
[Thymeleaf] 타임리프 기본 기능
이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다. 타임리프 공식 사이트 : https://www.thymeleaf.org/ 공식 메뉴얼 - 기본 기능 : https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html 공식 메뉴얼 - 스프링 통합 : https://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html 타임리프 사용 선언 ` 기본 표현식 간단한 표현 ◦ 변수 표현식: ${...} ◦ 선택 변수 표현식: *{...} ◦ 메시지 표현식: #{...} ◦ 링크 URL 표현식: @{...} ◦ 조각 표현식: ~{...} 리터럴 ◦ 텍스트: 'one text..
2024.03.06
no image
[Thymeleaf] 타임리프 특징과 기본 사용법
타임리프란? 타임리프(Thymeleaf)는 자바 웹 애플리케이션 개발에 사용되는 모던 서버사이드 Java 템플릿 엔진 중 하나이다. HTML, XML, 텍스트, 자바스크립트, CSS 등 다양한 마크업 파일을 생성할 수 있으며, 주로 웹 애플리케이션에서 동적인 뷰를 생성하는 데 사용된다. 타임리프의 가장 큰 특징 중 하나는 natural templates 을 지원한다는 것으로, 애플리케이션이 실행되지 않는 상태에서도 HTML 파일을 웹 브라우저에서 직접 열어볼 수 있다. 이는 개발 과정을 보다 효율적으로 만들어준다. 타임리프의 주요 특징 네츄럴 템플릿: 타임리프 템플릿은 실행되지 않는 상태에서도 HTML 파일로서 자연스럽게 보여질 수 있어, 디자이너와 개발자 간의 협업을 용이하게 한다. 서버 사이드 렌더링..
2024.02.24

이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다.


타임리프 스프링 통합

타임리프 기본 메뉴얼 : https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html

스프링 통합 메뉴얼 : https://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html

 

스프링 통합으로 추가되는 기능

  • 스프링의 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}" />

 

 

등록 폼

<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 가 자동으로 만들어준다.

 

렌더링 전

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

 

렌더링 후

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

 

체크박스, 라디오 버튼, 셀렉트 박스

 

ItemType - 상품 종류

public enum ItemType {
    BOOK("도서"), FOOD("식품"), ETC("기타");
         private final String description;
         ItemType(String description) {
             this.description = description;
    }
         public String getDescription() {
             return description;
    }
}

 

DeliveryCode - 배송 방식

/**
* FAST: 빠른 배송
* NORMAL: 일반 배송 * SLOW: 느린 배송 */
 @Data
 @AllArgsConstructor
 public class DeliveryCode {
     private String code;
     private String displayName;
 }

 

Item - 상품

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

 

타임리프 - 체크 박스 코드

<!-- 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 생성 결과를 보면 히든 필드 부분이 자동으로 생성되어 있다.

따라서 체크박스를 선택하지 않아도 null로 전송되는 것을 해결할 수 있다.

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

 

체크 박스 - 멀티

컨트롤러

@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 를 컨트롤러 클래스에서 별도의 메서드에 붙이면 해당 컨트롤러를 요청할 때 regions 에서 반환한 값이 자동으로 모델에 담기게 된다.

 

타임리프

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

이 과정에서 중요한 것은 th:field를 사용하여 Model의 특정 필드와 체크박스를 연결하고, th:value를 사용하여 각 체크박스의 값을 지정하는 것이다.

  • th:each를 사용한 반복: regions 컬렉션에 대한 반복을 통해 각 지역에 대한 체크박스를 동적으로 생성한다. region 변수는 현재 반복 중인 지역을 나타낸다.
  • th:field의 사용: th:field="*{regions}"는 폼의 백엔드 모델에 있는 regions 필드와 체크박스 그룹을 바인딩한다. 이를 통해 체크박스의 선택 상태가 해당 모델 필드에 자동으로 반영된다.
  • th:value를 통한 값 지정: 각 체크박스에 th:value="${region.key}"를 사용하여 값을 지정한다. 이 값은 체크박스가 선택될 때 모델의 regions 필드에 저장될 식별 값이다.
  • th:text와 th:label을 사용한 레이블 설정: th:text를 사용하여 체크박스 옆에 표시될 지역 이름을 설정한다. th:label은 체크박스와 연결된 레이블을 지정하는데, th:for="${#ids.prev('regions')}"는 생성된 체크박스의 id를 레이블의 for 속성과 연결하여, 레이블 클릭 시 해당 체크박스가 선택되도록 한다.

 

th:for="${#ids.prev('regions')}"

→ 멀티 체크박스는 같은 이름의 여러 체크박스를 만들 수 있다. 그런데 문제는 이렇게 반복해서 HTML 태그를 생성할 때, 생성된 HTML 태그 속성에서 name 은 같아도 되지만, id 는 모두 달라야 한다. 따라서 타임리프는 체크박스를 each 루프 안에서 반복해서 만들 때 임의로 1 ,2 ,3 숫자를 뒤에 붙여준다.

 <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 값을 사용할 수 있도록 한다.

 

서울, 부산 선택

regions=SEOUL&_regions=on&regions=BUSAN&_regions=on&_regions=on

 

지역 선택X

_regions=on&_regions=on&_regions=on

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

 

라디오 버튼

DeliveryCode

@Data
@AllArgsConstructor
public class DeliveryCode {
    private String code;
    private String displayName;
}

 

컨트롤러

@ModelAttribute("itemTypes")
 public ItemType[] itemTypes() {
     return ItemType.values();
 }
ItemType.values() 를 사용하면 해당 ENUM의 모든 정보를 배열로 반환한다. 예) [BOOK, FOOD, ETC]

 

타임리프

<!-- 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>
  • th:each를 사용한 반복: itemTypes 컬렉션에 대한 반복을 통해 각 상품 종류에 대한 라디오 버튼을 동적으로 생성한다. type 변수는 현재 반복 중인 상품 종류를 나타낸다.
  • th:field의 사용: th:field="${item.itemType}"는 폼의 백엔드 모델에 있는 itemType 필드와 라디오 버튼 그룹을 바인딩한다. 이를 통해 선택된 라디오 버튼의 값이 해당 모델 필드에 자동으로 반영된다.
  • th:value를 통한 값 지정: 각 라디오 버튼에 th:value="${type.name()}"를 사용하여 값을 지정한다. 이 값은 라디오 버튼이 선택될 때 모델의 itemType 필드에 저장될 값이다.
  • th:text와 th:label을 사용한 레이블 설정: th:text를 사용하여 라디오 버튼 옆에 표시될 상품 종류의 설명을 설정한다. th:label은 라디오 버튼과 연결된 레이블을 지정하는데, th:for="${#ids.prev('itemType')}"는 생성된 라디오 버튼의 id를 레이블의 for 속성과 연결하여, 레이블 클릭 시 해당 라디오 버튼이 선택되도록 한다.
  • disabled 속성의 사용: 라디오 버튼에 disabled 속성이 추가되어 있다. 이는 사용자가 해당 라디오 버튼을 선택하거나 변경할 수 없음을 의미한다. 특정 조건하에만 라디오 버튼을 활성화하려면, 서버 측 또는 클라이언트 측 스크립트를 사용하여 이 속성을 동적으로 제어할 수 있다.

 

실행 결과, 폼 전송

itemType=FOOD //음식 선택, 선택하지 않으면 아무 값도 넘어가지 않는다. 

 

로그 추가

log.info("item.itemType={}", item.getItemType());

 

실행 로그

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

체크 박스는 수정시 체크를 해제하면 아무 값도 넘어가지 않기 때문에, 별도의 히든 필드로 이런 문제를 해결했다.

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

 

셀렉트 박스

컨트롤러

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

 

타임리프

<!-- 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>
  • th:field를 사용한 바인딩: th:field="${item.deliveryCode}"는 <select> 요소를 폼의 백엔드 모델에 있는 deliveryCode 필드와 바인딩한다. 이를 통해 사용자가 선택한 옵션의 값이 해당 모델 필드에 자동으로 반영된다.
  • 첫 번째 option 요소: 첫 번째 option 요소는 사용자에게 기본 안내 메시지를 제공한다. value=""는 실제 선택 가능한 옵션이 아님을 나타낸다.
  • th:each를 사용한 옵션의 동적 생성: th:each="deliveryCode : ${deliveryCodes}"를 사용하여 deliveryCodes 컬렉션의 각 항목에 대해 <option> 요소를 동적으로 생성한다. deliveryCode 변수는 현재 반복 중인 배송 코드 객체를 나타낸다.
  • th:value와 th:text를 통한 옵션 설정: th:value="${deliveryCode.code}"를 사용하여 각 <option>의 값을 설정한다. 이 값은 사용자가 해당 옵션을 선택했을 때 deliveryCode 필드에 저장될 식별 값이다. th:text="${deliveryCode.displayName}"를 사용하여 드롭다운 메뉴에 표시될 배송 방식의 이름을 설정한다.
  • disabled 속성: <select> 요소에 disabled 속성이 추가되어 있다는 것은 사용자가 드롭다운 메뉴에서 선택을 변경할 수 없음을 의미한다. 특정 조건에서만 이 드롭다운을 활성화하려면, 서버 측 또는 클라이언트 측 스크립트를 사용하여 이 속성을 동적으로 제어할 수 있다.

 

 

이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다.


타임리프(Thymeleaf)에서 템플릿 레이아웃은 웹 애플리케이션의 다양한 페이지에서 공통적으로 사용되는 레이아웃 구조를 재사용할 수 있도록 도와준다.

이를 통해 개발자는 중복 코드를 줄이고, 일관된 레이아웃을 유지할 수 있다.

 

예를 들어서 <head> 에 공통으로 사용하는 css , javascript 같은 정보들이 있는데, 이러한 공통 정보들을 한 곳 에 모아두고, 공통으로 사용하지만, 각 페이지마다 필요한 정보를 더 추가해서 사용하고 싶다면 다음과 같이 사용하면 된다.

 

컨트롤러

@GetMapping("/layout")
public String layout() {
    return "template/layout/layoutMain";
}

 

base.html

<html xmlns:th="http://www.thymeleaf.org">

<!-- common_header 를 호출해서 이 페이지의 title 태그와 link 태그를 대체함 -->
<!-- title 과 links 는 단순 파라미터 이름 -->
<head th:fragment="common_header(title,links)">
    <title th:replace="${title}">레이아웃 타이틀</title>

    <!-- 공통 -->
    <link rel="stylesheet" type="text/css" media="all" th:href="@{/css/awesomeapp.css}">
    <link rel="shortcut icon" th:href="@{/images/favicon.ico}">
    <script type="text/javascript" th:src="@{/sh/scripts/codebase.js}"></script>

    <!-- 추가 -->
    <th:block th:replace="${links}" />
</head>

 

layoutExtend.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">

    <!-- base.html로 common_header 라는 이름으로 타이틀과 링크 태그를 파라미터로 넘김 -->
    <!-- 타이틀 태그와 링크 태그를 파라미터로 넘길 수 있음 -->
    <head th:replace="template/layout/base :: common_header(~{::title},~{::link})">
        <title>메인 타이틀</title>
        <link rel="stylesheet" th:href="@{/css/bootstrap.min.css}">
        <link rel="stylesheet" th:href="@{/themes/smoothness/jquery-ui.css}">
    </head>
    <body> 메인 컨텐츠 </body>
</html>

common_header(~{::title},~{::link}) 이 부분이 핵심이다.

  • ::title 은 현재 페이지의 title 태그들을 전달한다.
  • ::link 는 현재 페이지의 link 태그들을 전달한다.

 

결과

<!DOCTYPE html>
<html>

    <!-- base.html로 common_header 라는 이름으로 타이틀과 링크 태그를 파라미터로 넘김 -->
    <!-- 타이틀 태그와 링크 태그를 파라미터로 넘길 수 있음 -->
    <head>
        <title>메인 타이틀</title>

        <!-- 공통 -->
        <link rel="stylesheet" type="text/css" media="all" href="/css/awesomeapp.css">
        <link rel="shortcut icon" href="/images/favicon.ico">
        <script type="text/javascript" src="/sh/scripts/codebase.js"></script>

        <!-- 추가 -->
        <link rel="stylesheet" href="/css/bootstrap.min.css"><link rel="stylesheet" href="/themes/smoothness/jquery-ui.css">
	</head>
    <body> 메인 컨텐츠 </body>
</html>

메인 타이틀이 전달한 부분으로 교체되었다.

공통 부분은 그대로 유지되고, 추가 부분에 전달한 <link> 들이 포함된 것을 확인할 수 있다.

 

<head> 정도에만 적용하는게 아니라 <html> 전체에 적용할 수도 있다.

컨트롤러

@GetMapping("/layoutExtend")
public String layoutExtends() {
    return "template/layoutExtend/layoutExtendMain";
}

 

layoutFile.html

<!DOCTYPE html>
<!-- layout 을 호출해서 이 페이지의 title 태그와 div 태그를 대체함 -->
<!-- title->title, div->section 으로 대체 -->
<!-- title 과 content 는 단순 파라미터 이름 -->
<html th:fragment="layout (title, content)" xmlns:th="http://www.thymeleaf.org">
    <head>
        <title th:replace="${title}">레이아웃 타이틀</title>
    </head>
    <body>
        <h1>레이아웃 H1</h1>
        <div th:replace="${content}">
            <p>레이아웃 컨텐츠</p>
        </div>
        <footer> 레이아웃 푸터 </footer>
    </body>
</html>

 

layoutExtendMain.html

<!DOCTYPE html>
<!-- layoutFile.html로 layout 라는 이름으로 타이틀과 섹션 태그를 파라미터로 넘김 -->
<!-- 타이틀 태그와 섹션 태그를 파라미터로 넘길 수 있음 -->
<html th:replace="~{template/layoutExtend/layoutFile :: layout(~{::title},~{::section})}" xmlns:th="http://www.thymeleaf.org">
    <head>
        <title>메인 페이지 타이틀</title>
    </head>
    <body>
        <section>
            <p>메인 페이지 컨텐츠</p>
            <div>메인 페이지 포함 내용</div>
        </section>
    </body>
</html>

 

결과

<!DOCTYPE html>
<!-- layoutFile.html로 layout 라는 이름으로 타이틀과 섹션 태그를 파라미터로 넘김 -->
<!-- 타이틀 태그와 섹션 태그를 파라미터로 넘길 수 있음 -->
<html>
    <head>
        <title>메인 페이지 타이틀</title>
    </head>
    <body>
        <h1>레이아웃 H1</h1>
        <section>
            <p>메인 페이지 컨텐츠</p>
            <div>메인 페이지 포함 내용</div>
        </section>
        <footer> 레이아웃 푸터 </footer>
    </body>
</html>

이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다.


타임리프(Thymeleaf)의 템플릿 조각 기능은 HTML 문서의 특정 부분을 재사용 가능한 형태로 정의하고, 이를 다른 템플릿에서 삽입하여 사용할 수 있게 해준다.

이 기능은 중복을 줄이고, 템플릿의 유지보수를 용이하게 만들어준다. 템플릿 조각은 주로 헤더, 푸터, 네비게이션 바 등의 반복적으로 사용되는 UI 컴포넌트를 만들 때 유용하다.

 

템플릿 조각 정의하기

템플릿 조각은 th:fragment 속성을 사용하여 정의한다. 예를 들어, 하나의 HTML 파일 내에 여러 조각을 정의할 수 있다.

<!-- header.html -->
<div th:fragment="headerFragment">
  <header>
    <!-- 헤더 내용 -->
  </header>
</div>

<div th:fragment="footerFragment">
  <footer>
    <!-- 푸터 내용 -->
  </footer>
</div>

 

템플릿 조각 사용하기

다른 템플릿에서 이 조각을 사용하고 싶다면 th:replace 또는 th:insert 속성을 사용하여 해당 조각을 삽입한다.

  • th:replace는 현재 태그를 대상 템플릿 조각으로 완전히 대체한다.
  • th:insert는 대상 템플릿 조각을 현재 태그 내부에 삽입한다.
<!-- index.html -->
<div th:replace="header.html::headerFragment"></div>
<div th:insert="footer.html::footerFragment"></div>

 

조각 표현식

템플릿 조각을 참조할 때 사용하는 표현식은 템플릿명::조각명 형식을 따른다. 템플릿명은 조각이 정의된 파일의 이름이며, 조각명은 해당 파일 내에서 th:fragment로 정의된 조각의 이름이다.

th:fragment 가 있는 태그는 다른곳에 포함되는 코드 조각으로 이해하면 된다.

 

파라미터 전달하기

템플릿 조각에 파라미터를 전달하여 동적인 내용을 생성할 수도 있다. 이를 위해 조각을 정의할 때 파라미터를 명시하고, 조각을 사용할 때 파라미터 값을 전달한다.

<!-- header.html -->
<div th:fragment="headerFragment (title)">
  <header>
    <h1 th:text="${title}">기본 타이틀</h1>
  </header>
</div>

<!-- index.html에서 조각 사용하며 파라미터 전달 -->
<div th:replace="header.html::headerFragment (${pageTitle})"></div>

 

예시

컨트롤러

@GetMapping("/fragment")
public String template() {
    return "template/fragment/fragmentMain";
}

 

footer/html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <body>
        <footer th:fragment="copy"> <!-- 이렇게 설정하면 함수 쓰듯이 copy 라는 이름으로 호출할 수 있다. (템플릿 조각) -->
            푸터 자리 입니다.
        </footer>

        <footer th:fragment="copyParam (param1, param2)"> <!-- copyParam 라는 이름으로 파라미터를 사용할 수 있게 해준다.(템플릿 조각) -->
            <p>파라미터 자리 입니다.</p>
            <p th:text="${param1}"></p>
            <p th:text="${param2}"></p>
        </footer>
    </body>
</html>

 

fragmentMain.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
    <body>
        <h1>부분 포함</h1>

        <h2>부분 포함 insert</h2>
        <div th:insert="~{template/fragment/footer :: copy}"></div> <!-- div 태그 안에 copy 를 넣음 -->

        <h2>부분 포함 replace</h2>
        <div th:replace="~{template/fragment/footer :: copy}"></div> <!-- div 태그를 copy 가 대체함 -->

        <h2>부분 포함 단순 표현식</h2>
        <div th:replace="template/fragment/footer :: copy"></div> <!-- copy 가 단순하다면 ~{} 생략 가능 -->

        <h1>파라미터 사용</h1>
        <div th:replace="~{template/fragment/footer :: copyParam ('데이터1', '데이터2')}"></div> <!-- copyParam 템플릿 조각 으로 div 태그 대체 -->
    </body>
</html>

 

결과

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
    <body>
        <h1>부분 포함</h1>

        <h2>부분 포함 insert</h2>
        <div><footer> <!-- 이렇게 설정하면 함수 쓰듯이 copy 라는 이름으로 호출할 수 있다. (템플릿 조각) -->
            푸터 자리 입니다.
        </footer></div> <!-- div 태그 안에 copy 를 넣음 -->

        <h2>부분 포함 replace</h2>
        <footer> <!-- 이렇게 설정하면 함수 쓰듯이 copy 라는 이름으로 호출할 수 있다. (템플릿 조각) -->
            푸터 자리 입니다.
        </footer> <!-- div 태그를 copy 가 대체함 -->

        <h2>부분 포함 단순 표현식</h2>
        <footer> <!-- 이렇게 설정하면 함수 쓰듯이 copy 라는 이름으로 호출할 수 있다. (템플릿 조각) -->
            푸터 자리 입니다.
        </footer> <!-- copy 가 단순하다면 ~{} 생략 가능 -->

        <h1>파라미터 사용</h1>
        <footer> <!-- copyParam 라는 이름으로 파라미터를 사용할 수 있게 해준다.(템플릿 조각) -->
            <p>파라미터 자리 입니다.</p>
            <p>데이터1</p>
            <p>데이터2</p>
        </footer> <!-- copyParam 템플릿 조각 으로 div 태그 대체 -->
    </body>
</html>

이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다.


타임리프

공식 사이트 : https://www.thymeleaf.org/

공식 메뉴얼 - 기본 기능 : https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html

공식 메뉴얼 - 스프링 통합 : https://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html

 

타임리프 사용 선언

<html xmlns:th="http://www.thymeleaf.org">`

 

 

기본 표현식

간단한 표현
◦ 변수 표현식: ${...}
◦ 선택 변수 표현식: *{...} ◦ 메시지 표현식: #{...}
◦ 링크 URL 표현식: @{...} ◦ 조각 표현식: ~{...}

 리터럴
◦ 텍스트: 'one text', 'Another one!',... ◦ 숫자: 0, 34, 3.0, 12.3,...
◦ 불린: true, false
◦ 널: null
◦ 리터럴 토큰: one, sometext, main,...

문자연산
◦ 문자 합치기: +
◦ 리터럴 대체: |The name is ${name}|

산술연산
◦ Binary operators: +, -, *, /, %
◦ Minus sign (unary operator): -

불린연산
◦ Binary operators: and, or
◦ Boolean negation (unary operator): !, not

비교와 동등
◦ 비교:>,<,>=,<=(gt,lt,ge,le)
◦ 동등 연산: ==, != (eq, ne)

조건연산
◦ If-then: (if) ? (then)
◦ If-then-else: (if) ? (then) : (else)
◦ Default: (value) ?: (defaultvalue)

 특별한 토큰:
◦ No-Operation: _

 

텍스트

text, utext

타임리프는 기본적으로 HTML 테그의 속성에 기능을 정의해서 동작한다.

 

HTML의 콘텐츠(content)에 데이터를 출력 할 때는 다음과 같이 th:text 를 사용하면 된다.

  • <span th:text="${data}">

HTML 테그의 속성이 아니라 HTML 콘텐츠 영역안에서 직접 데이터를 출력하고 싶으면 다음과 같이 [[...]] 를 사 용하면 된다.

  • [[${data}]]

 

컨트롤러

@GetMapping("/text-basic")
public String textBasic(Model model) {
    model.addAttribute("data", "Hello Spring!");
    return "basic/text-basic";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>컨텐츠에 데이터 출력하기</h1>
    <ul>
        <li>th:text 사용 <span th:text="${data}"></span></li>
        <li>컨텐츠 안에서 직접 출력하기 = [[${data}]]</li>
    </ul>
</body>
</html>

 

결과

 

Escape

뷰 템플릿으로 HTML 화면을 생성할 때는 출력하는 데이터에 < 과 > 같은 특수 문자가 있는 것을 주의해서 사용해야 한다.

  • "Hello <b>Spring!</b>"

 

이렇게 작성한 코드는 아래와 같이 변환된다.

  • Hello &lt;b&gt;Spring!&lt;/b&gt;

 

HTML 엔티티

웹브라우저는 < 를HTML테그의 시작으로 인식한다. 따라서 < 를 태그의 시작이 아니라 문자로 표현할 수 있는 방법이 필요한데, 이것을 HTML 엔티티라 한다. 그리고 이렇게 HTML에서 사용하는 특수 문자를 HTML 엔티티로 변경하는 것을 이스케이프(escape)라 한다.
그리고 타임리프가 제공하는 th:text , [[...]] 는 기본적으로 이스케이프 (escape)를 제공한다.

∙ <  → &lt;
∙ > → &gt;
∙ 기타 수 많은 HTML 엔티티가 존재

 

 

Unescape

이스케이프 기능을 사용하지 않으면  Unescape 기능을 사용하면 된다.

타임리프는 아래의 두 기능을 제공한다.

  • th:text → th:utext
  • [[...]] → [(...)]

 

컨트롤러

@GetMapping("/text-unescaped")
 public String textUnescaped(Model model) {
     model.addAttribute("data", "Hello <b>Spring!</b>");
     return "basic/text-unescaped";
 }

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>text vs utext</h1>
    <ul>
        <li>th:text = <span th:text="${data}"></span></li>
        <li>th:utext = <span th:utext="${data}"></span></li>
    </ul>
    <h1><span th:inline="none">[[...]] vs [(...)]</span></h1>
    <ul>
        <li><span th:inline="none">[[...]] = </span>[[${data}]]</li>
        <li><span th:inline="none">[(...)] = </span>[(${data})]</li>
    </ul>
</body>
</html>
  • th:inline="none" : 타임리프는 [[...]] 를 해석하기 때문에, 화면에 [[...]] 글자를 보여줄 수 없다. 이 태그 안에서는 타임리프가 해석하지 말라는 옵션이다.

 

결과

주의

실제 서비스를 개발하다 보면 escape를 사용하지 않아서 HTML이 정상 렌더링 되지 않는 수 많은 문제가 발생한다. escape를 기본으로 하고, 꼭 필요한 때만 unescape를 사용하는 것이 좋다.

 

변수

변수 표현식

타임리프에서 변수를 사용할 때는 변수 표현식을 사용한다.

  • 변수 표현식 : ${...}

이 변수 표현식에는  Spring EL 이라는 스프링이 제공하는 표현식을 사용할 수 있다.

 

Spring EL 다양한 표현식

Object

  • user.username : user의 username을 프로퍼티 접근 → user.getUsername()
  • user['username'] : 위와 같음 → user.getUsername()
  • user.getUsername() : user의 getUsername() 을 직접 호출

 

List

  • users[0].username : List에서 첫 번째 회원을 찾고 username 프로퍼티 접근 → list.get(0).getUsername()
  • users[0]['username'] : 위와 같음
  • users[0].getUsername() : List에서 첫 번째 회원을 찾고 메서드 직접 호출

 

Map

  • userMap['userA'].username : Map에서 userA를 찾고, username 프로퍼티 접근 → map.get("userA").getUsername()
  • userMap['userA']['username'] : 위와 같음
  • userMap['userA'].getUsername() : Map에서 userA를 찾고 메서드 직접 호출

 

지역 변수

th:with 를 사용하면 지역 변수를 선언해서 사용할 수 있다.

지역 변수는 선언한 테그 안에서만 사용할 수 있다.

 

 

컨트롤러

@GetMapping("/variable")
public String variable(Model model) {
    User userA = new User("userA", 10);
    User userB = new User("userB", 20);
    List<User> list = new ArrayList<>();
    list.add(userA);
    list.add(userB);
    Map<String, User> map = new HashMap<>();
    map.put("userA", userA);
    map.put("userB", userB);
    model.addAttribute("user", userA);
    model.addAttribute("users", list);
    model.addAttribute("userMap", map);
    return "basic/variable";
}
@Data
static class User {
    private String username;
    private int age;
    public User(String username, int age) {
        this.username = username;
        this.age = age;
    }
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
    <body>
    <h1>SpringEL 표현식</h1>
        <ul>Object
            <li>${user.username} = <span th:text="${user.username}"></span></li>
            <li>${user['username']} = <span th:text="${user['username']}"></span></li>
            <li>${user.getUsername()} = <span th:text="${user.getUsername()}"></span></li>
        </ul>
        <ul>List
            <li>${users[0].username} = <span th:text="${users[0].username}"></span></li>
            <li>${users[0]['username']} = <span th:text="${users[0]['username']}"></span></li>
            <li>${users[0].getUsername()} = <span th:text="${users[0].getUsername()}"></span></li>
        </ul>
        <ul>Map
            <li>${userMap['userA'].username} = <span th:text="${userMap['userA'].username}"></span></li>
            <li>${userMap['userA']['username']} = <span th:text="${userMap['userA']['username']}"></span></li>
            <li>${userMap['userA'].getUsername()} = <span th:text="${userMap['userA'].getUsername()}"></span></li>
        </ul>

    <h1>지역 변수 - (th:with)</h1>
        <div th:with="first=${users[0]}">
            <p>처음 사람의 이름은 <span th:text="${first.username}"></span></p>
        </div>
    </body>
</html>

 

결과

 

기본 객체

타임리프는 기본 객체들을 제공한다.

  • ${#request} - 스프링 부트 3.0부터 제공하지 않는다.
  • ${#response} - 스프링 부트 3.0부터 제공하지 않는다.
  • ${#session} - 스프링 부트 3.0부터 제공하지 않는다.
  • ${#servletContext} - 스프링 부트 3.0부터 제공하지 않는다.
  • ${#locale}

스프링 부트 3.0 부터는 ${#request} , ${#response} , ${#session} , ${#servletContext} 를 지원하지 않는다.

따라서 직접 model 에 해당 객체를 추가해서 사용해야 한다.

 

컨트롤러

@GetMapping("/basic-objects")
public String basicObjects(Model model, HttpServletRequest request, HttpServletResponse response, HttpSession session) {
    session.setAttribute("sessionData", "Hello Session");
    model.addAttribute("request", request);
    model.addAttribute("response", response);
    model.addAttribute("servletContext", request.getServletContext());
    return "basic/basic-objects";
}

@Component("helloBean")
static class HelloBean {
    public String hello(String data) {
        return "Hello " + data;
    }
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>식 기본 객체 (Expression Basic Objects)</h1> <ul>
        <li>request = <span th:text="${request}"></span></li>
        <li>response = <span th:text="${response}"></span></li>
        <li>session = <span th:text="${session}"></span></li>
        <li>servletContext = <span th:text="${servletContext}"></span></li>
        <li>locale = <span th:text="${#locale}"></span></li>
    </ul>

    <h1>편의 객체</h1>
    <ul>
        <li>Request Parameter = <span th:text="${param.paramData}"></span></li>
        <li>session = <span th:text="${session.sessionData}"></span></li>
        <li>spring bean = <span th:text="${@helloBean.hello('Spring!')}"></span></li>
    </ul>
    </body>
</html>

 

HTTP 요청 파라미터 접근: param

  • 예) ${param.paramData}

HTTP 세션 접근: session

  • 예) ${session.sessionData}

스프링 빈 접근: @

  • 예) ${@helloBean.hello('Spring!')}

 

결과

 

유틸리티 객체와 날짜

타임리프는 문자, 숫자, 날짜, URI등을 편리하게 다루는 다양한 유틸리티 객체들을 제공한다.

 

타임리프 유틸리티 객체

  • message : 메시지, 국제화 처리
  • uris : URI 이스케이프 지원
  • dates : java.util.Date 서식 지원
  • calendars : java.util.Calendar 서식 지원
  • temporals : 자바8 날짜 서식 지원
  • numbers : 숫자 서식 지원
  • strings : 문자 관련 편의 기능
  • objects : 객체 관련 기능 제공
  • bools : boolean 관련 기능 제공
  • arrays : 배열 관련 기능 제공
  • lists , sets , maps : 컬렉션 관련 기능 제공
  • ids : 아이디 처리 관련 기능 제공

 

자세한 내용은 아래의 링크에서 확인

https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#expression-utility- objects

 

유틸리티 객체 예시
https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#appendix-b- expression-utility-objects

 

자바8 날짜

타임리프에서 자바8 날짜인 LocalDate , LocalDateTime , Instant 를 사용하려면 추가 라이브러리가 필요하다.

스프링 부트 타임리프를 사용하면 해당 라이브러리가 자동으로 추가되고 통합된다.

 

예시

 <span th:text="${#temporals.format(localDateTime, 'yyyy-MM-dd HH:mm:ss')}"></span>

 

컨트롤러

@GetMapping("/date")
public String date(Model model) {
    model.addAttribute("localDateTime", LocalDateTime.now());
    return "basic/date";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <h1>LocalDateTime</h1>
            <ul>
                <li>default = <span th:text="${localDateTime}"></span></li>
                <li>yyyy-MM-dd HH:mm:ss = <span th:text="${#temporals.format(localDateTime,'yyyy-MM-dd HH:mm:ss')}"></span></li>
            </ul>

        <h1>LocalDateTime - Utils</h1>
            <ul>
                <li>${#temporals.day(localDateTime)} = <span th:text="${#temporals.day(localDateTime)}"></span></li>
                <li>${#temporals.month(localDateTime)} = <span th:text="${#temporals.month(localDateTime)}"></span></li>
                <li>${#temporals.monthName(localDateTime)} = <span th:text="${#temporals.monthName(localDateTime)}"></span></li>
                <li>${#temporals.monthNameShort(localDateTime)} = <span th:text="${#temporals.monthNameShort(localDateTime)}"></span></li>
                <li>${#temporals.year(localDateTime)} = <span th:text="${#temporals.year(localDateTime)}"></span></li>
                <li>${#temporals.dayOfWeek(localDateTime)} = <span th:text="${#temporals.dayOfWeek(localDateTime)}"></span></li>
                <li>${#temporals.dayOfWeekName(localDateTime)} = <span th:text="${#temporals.dayOfWeekName(localDateTime)}"></span></li>
                <li>${#temporals.dayOfWeekNameShort(localDateTime)} = <span th:text="${#temporals.dayOfWeekNameShort(localDateTime)}"></span></li>
                <li>${#temporals.hour(localDateTime)} = <span th:text="${#temporals.hour(localDateTime)}"></span></li>
                <li>${#temporals.minute(localDateTime)} = <span th:text="${#temporals.minute(localDateTime)}"></span></li>
                <li>${#temporals.second(localDateTime)} = <span th:text="${#temporals.second(localDateTime)}"></span></li>
                <li>${#temporals.nanosecond(localDateTime)} = <span th:text="${#temporals.nanosecond(localDateTime)}"></span></li>
            </ul>
    </body>
</html>

 

결과

 

URL 링크

타임리프에서 URL을 생성할 때는 @{...} 문법을 사용하면 된다.

 

컨트롤러

 @GetMapping("/link")
public String link(Model model) {
    model.addAttribute("param1", "data1");
    model.addAttribute("param2", "data2");
    return "basic/link";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <h1>URL 링크</h1> <ul>
            <li><a th:href="@{/hello}">basic url</a></li> <!-- @{/hello} -> /hello -->
            <li><a th:href="@{/hello(param1=${param1}, param2=${param2})}">hello query param</a></li> <!-- /hello?param1=data1&param2=data2, () 에 있는 부분은 쿼리 파라미터로 처리된다.-->
            <li><a th:href="@{/hello/{param1}/{param2}(param1=${param1}, param2=${param2})}">path variable</a></li> <!-- /hello/data1/data2 URL 경로상에 변수가 있으면 () 부분은 경로 변수로 처리된다. -->
            <li><a th:href="@{/hello/{param1}(param1=${param1}, param2=${param2})}">path variable + query parameter</a></li> <!-- /hello/data1?param2=data2, 경로 변수와 쿼리 파라미터를 함께 사용할 수 있다. -->
        </ul>
    </body>
</html>

 

 

단순한 URL

  • @{/hello} → /hello

 

쿼리 파라미터

  • @{/hello(param1=${param1}, param2=${param2})}
  • → /hello?param1=data1&param2=data2
  • () 에 있는 부분은 쿼리 파라미터로 처리된다.

 

경로 변수

  • @{/hello/{param1}/{param2}(param1=${param1}, param2=${param2})}
  • → /hello/data1/data2
  • URL 경로상에 변수가 있으면 () 부분은 경로 변수로 처리된다.

 

경로 변수 + 쿼리 파라미터

  • @{/hello/{param1}(param1=${param1}, param2=${param2})}
  • → /hello/data1?param2=data2
  • 경로 변수와 쿼리 파라미터를 함께 사용할 수 있다.

 

상대경로, 절대경로, 프로토콜 기준을 표현할 수도 있다.

  • /hello : 절대 경로
  • hello : 상대 경로

 

리터럴

리터럴은 소스 코드상에 고정된 값을 말하는 용어이다.
예를 들어서 다음 코드에서 "Hello" 는 문자 리터럴, 10 , 20 는 숫자 리터럴이다. 

String a = "Hello"
int a = 10 * 20

 

타임리프는 다음과 같은 리터럴이 있다.

  • 문자: 'hello'
  • 숫자: 10
  • 불린: true , false null: null

 

타임리프에서 문자 리터럴은 항상 ' (작은 따옴표)로 감싸야 한다.

  • <span th:text="'hello'">

 

그런데 문자를 항상 ' 로 감싸는 것은 너무 귀찮은 일이다. 공백 없이 쭉 이어진다면 하나의 의미 있는 토큰으로 인지하여 다음과 같이 작은 따옴표를 생략할 수 있다.

룰: A-Z, a-z, 0-9, [], . , - , _

  • <span th:text="hello">

 

오류

  • <span th:text="hello world!"></span>
  • 문자 리터럴은 원칙상 ' 로 감싸야 한다. 중간에 공백이 있어서 하나의 의미 있는 토큰으로도 인식되지 않는다.

 

수정

  • <span th:text="'hello world!'"></span>
  • 이렇게 ' 로 감싸면 정상 동작한다.

 

리터럴 대체(Literal substitutions)

  • <span th:text="|hello ${data}|">
  • 리터럴 대체 문법을 사용하면 변수와 리터럴을 편리하게 나타낼 수 있다.

 

컨트롤러

@GetMapping("/literal")
public String literal(Model model) {
    model.addAttribute("data", "Spring!");
    return "basic/literal";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body> <h1>리터럴</h1>
        <ul>
            <!-- <li>"hello world!" = <span th:text="hello world!"></span></li> 띄어쓰기가 있으면 '' 를 생략하면 안된다.-->
            <li>'hello' + ' world!' = <span th:text="'hello' + ' world!'"></span></li>
            <li>'hello world!' = <span th:text="'hello world!'"></span></li>
            <li>'hello ' + ${data} = <span th:text="'hello ' + ${data}"></span></li>
            <li>리터럴 대체 |hello ${data}| = <span th:text="|hello ${data}|"></span></li>
        </ul>
    </body>
</html>

 

결과

 

 

연산

타임리프 연산은 자바와 크게 다르지 않다.

HTML안에서 사용하기 때문에 HTML 엔티티를 사용하는 부분을 주의해야 한다.

 

비교연산

  • > (gt), < (lt), >= (ge), <= (le), ! (not), == (eq), != (neq, ne)

 

조건식

th:if

th:if는 지정된 조건이 참(True)일 때만 태그를 렌더링한다.

  • 예: <div th:if="${condition}">조건이 참일 때 보여질 내용</div>

 

th:unless

th:unless는 지정된 조건이 거짓(False)일 때 태그를 렌더링한다. th:if의 반대 역할을 한다.

  • 예: <div th:unless="${condition}">조건이 거짓일 때 보여질 내용</div>

 

th:switch와 th:case

th:switch와 함께 사용되는 th:case는 다중 조건을 처리할 때 사용된다.

switch 문과 유사하게 작동한다.

 

Elvis 연산자

타임리프에서 Elvis 연산자는 널 값을 안전하게 처리하는데 사용된다. 이 연산자는 표현식이 널(null)인 경우 대체 값을 제공하는 방법이다. 타임리프의 표현식에서 ?: 기호를 사용하여 Elvis 연산자를 구현한다. 첫 번째 피연산자가 널이 아닌 경우 해당 값을 반환하고, 널인 경우 두 번째 피연산자의 값을 반환한다.

예를 들어, 사용자의 이름을 표시하되, 이름이 없는 경우 기본값으로 "익명"을 표시하고자 할 때 타임리프에서는 다음과 같이 Elvis 연산자를 사용할 수 있다.

<span th:text="${user.name} ?: '익명'"></span>

 

No-Operation

No-Operation, 줄여서 NOP라고도 불리는 것은, 실행될 때 아무런 동작도 하지 않는 연산을 말한다. 프로그래밍에서 NOP은 주로 코드의 흐름을 변경하지 않으면서 자리를 채우기 위해 사용된다. 예를 들어, 조건문에서 특정 조건 하에 아무런 동작도 수행하지 않으려 할 때 유용하다.

타임리프에서는 특별한 동작을 하지 않는 표현식으로 _ (언더스코어)를 사용한다. 이는 타임리프의 No-Operation이다. 타임리프 템플릿 내에서 어떤 조건이 만족하지 않을 때 아무런 동작도 하지 않기를 원할 경우, 이 No-Operation 표현식을 사용할 수 있다.

 

컨트롤러

@GetMapping("/operation")
public String operation(Model model) {
    model.addAttribute("nullData", null);
    model.addAttribute("data", "Spring!");
    return "basic/operation";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <ul>
            <li>산술 연산
                <ul>
                    <li>10 + 2 = <span th:text="10 + 2"></span></li>
                    <li>10 % 2 == 0 = <span th:text="10 % 2 == 0"></span></li>
                </ul>
            </li>
            <li>비교 연산
                <ul>
                    <!-- > (gt), < (lt), >= (ge), <= (le), ! (not), == (eq), != (neq, ne) -->
                    <li>1 > 10 = <span th:text="1 &gt; 10"></span></li> <!-- HTML 문서에서 > 기호를 표시하고 싶을 때는 &gt;를 사용 -->
                    <li>1 gt 10 = <span th:text="1 gt 10"></span></li> <!-- 첫 번째 피연산자가 두 번째 피연산자보다 클 경우 참(true)을 반환 -->
                    <li>1 >= 10 = <span th:text="1 >= 10"></span></li>
                    <li>1 ge 10 = <span th:text="1 ge 10"></span></li> <!-- 첫 번째 피연산자가 두 번째 피연산자보다 크거나 같을 경우 참을 반환 -->
                    <li>1 == 10 = <span th:text="1 == 10"></span></li>
                    <li>1 != 10 = <span th:text="1 != 10"></span></li>
                </ul>
            </li>
            <li>조건식
                <ul>
                    <li>(10 % 2 == 0)? '짝수':'홀수' = <span th:text="(10 % 2 == 0)? '짝 수':'홀수'"></span></li> <!-- 삼항 연산자 -->
                </ul>
            </li>
            <li>Elvis 연산자
                <ul>
                    <li>${data}?: '데이터가 없습니다.' = <span th:text="${data}?: '데이터가 없습니다.'"></span></li> <!-- 삼항 연산자 축약 버전 -->
                    <li>${nullData}?: '데이터가 없습니다.' = <span th:text="${nullData}?: '데이터가 없습니다.'"></span></li> <!-- 변수의 값이 null 일 경우 거짓 처리 -->
                </ul>
            </li>
            <li>No-Operation
                <ul>
                    <li>${data}?: _ = <span th:text="${data}?: _">데이터가 없습니다.</span></li>
                    <li>${nullData}?: _ = <span th:text="${nullData}?: _">데이터가 없습니다.</span></li> <!-- 변수의 값이 null 일 경우  _를 통해 타임리프 문법 무효화 -->
                </ul>
            </li>
        </ul>
    </body>
</html>

 

결과

 

 

속성 값 설정

타임리프는 주로 HTML 태그에 th:* 속성을 지정하는 방식으로 동작한다. th:* 로 속성을 적용하면 기존 속성을 대체한다. 기존 속성이 없으면 새로 만든다.

 

속성 설정

th: 속성을 지정하면 타임리프는 기존 속성을 th: 로 지정한 속성으로 대체한다. 기존 속성이 없다면 새로 만든다. 

  • <input type="text" name="mock" th:name="userA" />
  • →타임리프 렌더링 후 <input type="text" name="userA" />

 

속성 추가

  • th:attrappend : 속성 값의 뒤에 값을 추가한다.
  • th:attrprepend : 속성 값의 앞에 값을 추가한다.
  • th:classappend : class 속성에 자연스럽게 추가한다.

 

checked 처리

HTML에서는 <input type="checkbox" name="active" checked="false" /> → checked 속성이 있기 때문에 checked 처리가 되어버린다.

 

HTML에서 checked 속성은 checked 속성의 값과 상관없이 checked 라는 속성만 있어도 체크가 된다. 이런 부분이 true , false 값을 주로 사용하는 개발자 입장에서는 불편하다.

 

타임리프의 th:checked 는 값이 false 인 경우 checked 속성 자체를 제거한다.

  • <input type="checkbox" name="active" th:checked="false" />
  • →타임리프 렌더링 후: <input type="checkbox" name="active" />

 

 

컨트롤러

    @GetMapping("/attribute")
    public String attribute() {
        return "basic/attribute";
    }

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <h1>속성 설정</h1>
        <input type="text" name="mock" th:name="userA" />

        <h1>속성 추가</h1>
        - th:attrappend = <input type="text" class="text" th:attrappend="class='large'" /><br/> <!-- class="textlarge" -->
        - th:attrprepend = <input type="text" class="text" th:attrprepend="class='large '" /><br/> <!-- class="large text" -->
        - th:classappend = <input type="text" class="text" th:classappend="large" /><br/> <!-- class="text large" -->

        <h1>checked 처리</h1>
        - checked o <input type="checkbox" name="active" th:checked="true" /><br/>
        - checked x <input type="checkbox" name="active" th:checked="false" /><br/>  <!-- 타임리프의 th:checked 는 값이 false 인 경우 checked 속성 자체를 제거 -->
        - checked=false <input type="checkbox" name="active" checked="false" /><br/> <!-- HTML에서 checked 속성은 checked 속성의 값과 상관없이 checked 라는 속성만 있어도 체크 -->
    </body>
</html>

 

결과

 

 

반복

타임리프에서 반복은 th:each 를 사용한다.

추가로 반복에서 사용할 수 있는 여러 상태 값을 지원한다.

 

반복 기능

<tr th:each="user : ${users}">

  • 반복시 오른쪽 컬렉션( ${users} )의 값을 하나씩 꺼내서 왼쪽 변수( user )에 담아서 태그를 반복 실행한다.
  • th:each 는 List 뿐만 아니라 배열, java.util.Iterable , java.util.Enumeration 을 구현 한 모든 객체를 반복에 사용할 수 있다.
  • Map 도 사용할 수 있는데 이 경우 변수에 담기는 값은 Map.Entry 이다.

 

반복 상태 유지

<tr th:each="user, userStat : ${users}">

  • 반복의 두번째 파라미터를 설정해서 반복의 상태를 확인 할 수 있다.
  • 두번째 파라미터는 생략 가능한데, 생략하면 지정한 변수명( user ) + Stat 가 된다.
  • 여기서는 user + Stat = userStat 이므로 생략 가능하다.

 

반복 상태 유지 기능

  • index : 0부터 시작하는 값
  • count : 1부터 시작하는 값
  • size : 전체 사이즈
  • even , odd : 홀수, 짝수 여부( boolean ) 
  • first , last :처음, 마지막 여부( boolean ) 
  • current : 현재 객체

 

컨트롤러

@GetMapping("/each")
public String each(Model model) {
    addUsers(model);
    return "basic/each";
}
private void addUsers(Model model) {
    List<User> list = new ArrayList<>();
    list.add(new User("userA", 10));
    list.add(new User("userB", 20));
    list.add(new User("userC", 30));
    model.addAttribute("users", list);
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <h1>기본 테이블</h1>
        <!-- tr : 헹, td : 열, th : 테이블 헤더(열의 제목) -->
        <table border="1">
            <tr>
                <th>username</th>
                <th>age</th>
            </tr>
            <tr th:each="user : ${users}"> <!-- users 리스트안에 수 만큼 반복 -->
                <td th:text="${user.username}">username</td>
                <td th:text="${user.age}">0</td>
            </tr>
        </table>

        <h1>반복 상태 유지</h1>
        <table border="1">
            <tr>
                <th>count</th>
                <th>username</th>
                <th>age</th>
                <th>etc</th>
            </tr>
            <tr th:each="user, userStat : ${users}"> <!-- 두번째 파라미터를 설정해서 반복의 상태를 확인 할 수 있다. -->
                <td th:text="${userStat.count}">username</td> <!-- count : 1부터 시작하는 값 -->
                <td th:text="${user.username}">username</td>
                <td th:text="${user.age}">0</td>
                <td>
                    index = <span th:text="${userStat.index}"></span> <!-- index : 0부터 시작하는 값 -->
                    , count = <span th:text="${userStat.count}"></span> <!-- count : 1부터 시작하는 값 -->
                    , size = <span th:text="${userStat.size}"></span> <!-- size : 반복 객체의 전체 사이즈 -->
                    , even? = <span th:text="${userStat.even}"></span> <!-- even : 짝수 여부 (Boolean) -->
                    , odd? = <span th:text="${userStat.odd}"></span> <!-- odd : 홀수 여부 (Boolean) -->
                    , first? = <span th:text="${userStat.first}"></span> <!-- first : 처음 여부 (Boolean) -->
                    , last? = <span th:text="${userStat.last}"></span> <!-- last : 마지막 여부 (Boolean) -->
                    , current = <span th:text="${userStat.current}"></span> <!-- current : 현재 객체 -->
                </td>
            </tr>
        </table>
    </body>
</html>

 

결과

 

조건부 평가

타임리프의 조건식

  • if
  • unless ( if 의 반대)

 

if, unless

  • 타임리프는 해당 조건이 맞지 않으면 태그 자체를 렌더링하지 않는다.
  • 만약 다음 조건이 false 인 경우 <span>...<span> 부분 자체가 렌더링 되지 않고 사라진다.
  • <span th:text="'미성년자'" th:if="${user.age lt 20}"></span>

 

switch

  • * 은 만족하는 조건이 없을 때 사용하는 디폴트이다.

 

컨트롤러

@GetMapping("/condition")
public String condition(Model model) {
    addUsers(model);
    return "basic/condition";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <h1>if, unless</h1>
        <table border="1">
            <tr>
                <th>count</th>
                <th>username</th>
                <th>age</th>
            </tr>
            <tr th:each="user, userStat : ${users}">
                <td th:text="${userStat.count}">1</td>
                <td th:text="${user.username}">username</td>
                <td>
                    <span th:text="${user.age}">0</span>
                    <!-- 타임리프는 해당 조건이 맞지 않으면 태그 자체를 렌더링하지 않는다. -->
                    <span th:text="'미성년자'" th:if="${user.age lt 20}"></span> <!-- 20이 더 크다면 -->
                    <span th:text="'미성년자'" th:unless="${user.age ge 20}"></span> <!-- user.age 가 더 크지 않다면 (unless 는 참과 거짓을 반전시킨다.) -->
                </td>
            </tr>
        </table>

        <h1>switch</h1>
        <table border="1">
            <tr>
                <th>count</th>
                <th>username</th>
                <th>age</th>
            </tr>
            <tr th:each="user, userStat : ${users}">
                <td th:text="${userStat.count}">1</td>
                <td th:text="${user.username}">username</td>
                <td th:switch="${user.age}">
                    <span th:case="10">10살</span>
                    <span th:case="20">20살</span>
                    <span th:case="*">기타</span> <!-- 나머지의 경우 -->
                </td>
            </tr>
        </table>
    </body>
</html>

 

 

결과

 

 

주석

표준 HTML 주석

  • 자바스크립트의 표준 HTML 주석은 타임리프가 렌더링 하지 않고, 그대로 남겨둔다.

 

타임리프 파서 주석

  • 타임리프 파서 주석은 타임리프의 진짜 주석이다. 렌더링에서 주석 부분을 제거한다.

 

타임리프 프로토타입 주석

  • HTML 파일을 웹 브라우저에서 그대로 열어보면 HTML 주석이기 때문에 이 부분이 웹 브라우저가 렌더링하지 않는다.
  • 타임리프 렌더링을 거치면 이 부분이 정상 렌더링 된다.
  • HTML 파일을 그대로 열어보면 주석처리가 되지만, 타임리프를 렌더링 한 경우에만 보이는 기능이다.

 

컨트롤러

@GetMapping("/comments")
public String comments(Model model) {
    model.addAttribute("data", "Spring!");
    return "basic/comments";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <h1>예시</h1>
        <span th:text="${data}">html data</span>
        <h1>1. 표준 HTML 주석</h1> <!-- 소스 보기에서 보임 -->
        <!-- <span th:text="${data}">html data</span> -->
        
        <h1>2. 타임리프 파서 주석</h1> <!-- 소스 보기에서 안보임 -->
        <!--/* [[${data}]] */-->
        
        <!-- 위는 한줄 아래는 여러 라인 -->
        
        <!--/*-->
        <span th:text="${data}">html data</span>
        <!--*/-->
        
        <h1>3. 타임리프 프로토타입 주석</h1>  <!-- 서버 사이드 렌더링시 보임, 단순 html 파일을 열었을 때는 안보임 -->
        <!--/*/ <span th:text="${data}">html data</span> /*/-->
    </body>
</html>

 

결과

 

블록

<th:block> 태그는 타임리프(Thymeleaf) 템플릿 엔진에서 사용하는 특별한 태그로, 실제 HTML 문서에 추가되지 않는 가상의 태그이다.

 

이 태그는 주로 그룹화된 표현식을 처리하거나, 템플릿 내에서 조건부 렌더링, 반복 등의 로직을 적용할 때 유용하게 사용된다.

 

<th:block>은 렌더링 결과에 포함되지 않기 때문에, HTML 문서의 구조에 영향을 주지 않으면서 타임리프의 다양한 기능을 활용할 수 있다는 장점이 있다.

예를 들어, 여러 태그에 걸쳐 같은 조건을 적용하고 싶은 경우나 반복문을 사용하여 여러 요소를 생성해야 할 때 <th:block>을 사용하여 이러한 로직을 간결하게 처리할 수 있다.

 

컨트롤러

@GetMapping("/block")
public String block(Model model) {
    addUsers(model);
    return "basic/block";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
    <!-- <th:block> 은 HTML 태그가 아닌 타임리프의 유일한 자체 태그 -->
    <th:block th:each="user : ${users}">
        <div>
            사용자 이름1 <span th:text="${user.username}"></span>
            사용자 나이1 <span th:text="${user.age}"></span>
        </div>
        <div>
            요약 <span th:text="${user.username} + ' / ' + ${user.age}"></span>
        </div>
    </th:block>
    </body>
<!-- 타임리프의 특성상 HTML 태그안에 속성으로 기능을 정의해서 사용하는데, 위 예처럼 이렇게 사용하기 애매한 경우에 사용하면 된다. <th:block> 은 렌더링시 제거된다. -->
</html>

 

결과

 

자바스크립트 인라인

타임리프(Thymeleaf)는 자바스크립트 내에서 서버 사이드 변수를 사용할 수 있도록 자바스크립트 인라인 기능을 제공한다.

이를 통해 HTML 템플릿 내부에서 자바스크립트 코드에 타임리프 변수와 표현식을 쉽게 삽입하고 처리할 수 있다. 자바스크립트 인라인을 사용하면, 서버에서 생성된 데이터를 자바스크립트 변수로 바로 할당하여 클라이언트 사이드에서 활용할 수 있다.

사용 방법

  • 자바스크립트 인라인은 th:inline="javascript" 속성을 사용하여 활성화할 수 있다. 이 속성을 <script> 태그에 추가하면, 태그 내부에서 타임리프 표현식을 자바스크립트 코드와 함께 사용할 수 있다.
`<script th:inline="javascript">`

 

텍스트 렌더링

var username = [[${user.username}]];

  • 인라인 사용 전: var username = userA;
  • 인라인 사용 후: var username = "userA";

인라인 사용 전 렌더링 결과를 보면 userA 라는 변수 이름이 그대로 남아있다. 타임리프 입장에서는 정확하게 렌더링 한 것이지만 아마 개발자가 기대한 것은 다음과 같은 "userA"라는 문자일 것이다.

결과적으로 userA 가 변수명으로 사용되어서 자바스크립트 오류가 발생한다. 다음으로 나오는 숫자 age의 경우에는 " 가 필요 없기 때문에 정상 렌더링 된다.

인라인 사용 후 렌더링 결과를 보면 문자 타입인 경우 " 를 포함해준다. 추가로 자바스크립트에서 문제가 될 수 있는 문자가 포함되어 있으면 이스케이프 처리도 해준다. 예) " → ₩"

 

자바스크립트 내추럴 템플릿

타임리프는 HTML 파일을 직접 열어도 동작하는 내추럴 템플릿 기능을 제공한다. 자바스크립트 인라인 기능을 사용하면 주석을 활용해서 이 기능을 사용할 수 있다.

var username2 = /*[[${user.username}]]*/ "test username";

  • 인라인 사용 전: var username2 = /*userA*/  "test username";
  • 인라인 사용 후: var username2 = "userA";

인라인 사용 전 결과를 보면 정말 순수하게 그대로 해석을 해버렸다. 따라서 내추럴 템플릿 기능이 동작하지 않고, 심지어 렌더링 내용이 주석처리 되어 버린다.

인라인 사용 후 결과를 보면 주석 부분이 제거되고, 기대한 "userA"가 정확하게 적용된다.

객체

타임리프의 자바스크립트 인라인 기능을 사용하면 객체를 JSON으로 자동으로 변환해준다.

var user = [[${user}]];

  • 인라인 사용 전: var user = BasicController.User(username=userA, age=10);
  • 인라인 사용 후: var user = {"username":"userA","age":10};

인라인 사용 전은 객체의 toString()이 호출된 값이다.

인라인 사용 후는 객체를 JSON으로 변환해준다.

 

 

 

컨트롤러

@GetMapping("/javascript")
public String javascript(Model model) {
    model.addAttribute("user", new User("userA", 10));
    addUsers(model);
    return "basic/javascript";
}

 

타임리프

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <!-- 자바스크립트 인라인 사용 전 -->
        <script>
            var username = [[${user.username}]]; <!-- 텍스트를 "로 감싸지 않아서 오류 발생 -->
            var age = [[${user.age}]];

            //자바스크립트 내추럴 템플릿
            var username2 = /*[[${user.username}]]*/ "test username";

            //객체
            var user = [[${user}]]; <!-- toString()이 호출됨 -->
        </script>

        <!-- 자바스크립트 인라인 사용 후 -->
        <script th:inline="javascript"> <!-- 자바스크립트 문법을 알아서 처리해줌 -->
            var username = [[${user.username}]];
            var age = [[${user.age}]];

            //자바스크립트 내추럴 템플릿
            var username2 = /*[[${user.username}]]*/ "test username";

            //객체
            var user = [[${user}]]; <!-- 인라인 사용 후는 객체를 JSON으로 변환 -->
        </script>

		<!-- 자바스크립트 인라인 each -->
        <script th:inline="javascript"> <!-- 객체를 JSON으로 변환 후 반복 -->
            [# th:each="user, stat : ${users}"]
            var user[[${stat.count}]] = [[${user}]];
            [/]
        </script>
    </body>
</html>

 

결과

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <!-- 자바스크립트 인라인 사용 전 -->
        <script>
            var username = userA; <!-- 텍스트를 "로 감싸지 않아서 오류 발생 -->
            var age = 10;

            //자바스크립트 내추럴 템플릿
            var username2 = /*userA*/ "test username";

            //객체
            var user = BasicController.User(username=userA, age=10); <!-- toString()이 호출됨 -->
        </script>

        <!-- 자바스크립트 인라인 사용 후 -->
        <script> <!-- 자바스크립트 문법을 알아서 처리해줌 -->
            var username = "userA";
            var age = 10;

            //자바스크립트 내추럴 템플릿
            var username2 = "userA";

            //객체
            var user = {"username":"userA","age":10}; <!-- 인라인 사용 후는 객체를 JSON으로 변환 -->
        </script>

        <script> <!-- 객체를 JSON으로 변환 후 반복 -->
            
            var user1 = {"username":"userA","age":10};
            var user2 = {"username":"userB","age":20};
            var user3 = {"username":"userC","age":30};
            
        </script>
    </body>
</html>

 

타임리프란?

타임리프(Thymeleaf)는 자바 웹 애플리케이션 개발에 사용되는 모던 서버사이드 Java 템플릿 엔진 중 하나이다.

 

HTML, XML, 텍스트, 자바스크립트, CSS 등 다양한 마크업 파일을 생성할 수 있으며, 주로 웹 애플리케이션에서 동적인 뷰를 생성하는 데 사용된다.

 

타임리프의 가장 큰 특징 중 하나는 natural templates 을 지원한다는 것으로, 애플리케이션이 실행되지 않는 상태에서도 HTML 파일을 웹 브라우저에서 직접 열어볼 수 있다.

 

이는 개발 과정을 보다 효율적으로 만들어준다.

 

타임리프의 주요 특징

네츄럴 템플릿: 타임리프 템플릿은 실행되지 않는 상태에서도 HTML 파일로서 자연스럽게 보여질 수 있어, 디자이너와 개발자 간의 협업을 용이하게 한다.

  • 서버 사이드 렌더링(SSR) : 타임리프는 백엔드 서버에서 HTML을 동적으로 렌더링하는 용도로 사용된다. 
  • 스프링 프레임워크와의 통합: 스프링 MVC와 뛰어난 통합성을 제공하여, 스프링 애플리케이션에서 뷰 레이어를 구성하는 데 적합하다.
  • 표준 기반: HTML5, XML 등의 웹 표준을 준수하며, 다양한 브라우저와 잘 호환된다.
  • 국제화(i18n) 지원: 다국어 애플리케이션을 개발하는 데 필요한 국제화 기능을 지원한다.
  • 풍부한 표현식: 변수 표현, 조건문, 반복문, URL 처리 등 다양한 표현식을 제공하여, 동적인 데이터 바인딩과 조작을 쉽게 할 수 있다.

 

사용법

타임리프 사용 선언

타임리프는 문서 최상단에 아래와 같은 코드를 넣어서 사용할 수 있다.

<html xmlns:th="http://www.thymeleaf.org">

 

타임리프 핵심

th:xxx가 붙은 부분은 서버사이드에서 렌더링 되고, 기존 것을 대체한다.

th:xxx이 없으면 기존 HTML의 xxx 속성이 그대로 사용된다.

HTML을 파일로 직접 열었을 때, th:xxx가 있어도 웹 브라우저는 th: 속성을 알지 못하므로 무시한다.

따라서 HTML 파일 보기를 유지하면서 템플릿 기능도 할 수 있다.

 

속성 변경

타임리프에서 속성 변경은 HTML 요소의 속성을 동적으로 변경하거나 추가하는 기능을 제공한다.

이를 통해 HTML 문서에 정적인 값을 직접 작성하는 대신, 서버에서 생성된 데이터를 기반으로 속성 값을 설정할 수 있다.

속성 변경은 주로 링크, 이미지 소스, 클래스, 스타일 등의 HTML 속성을 동적으로 조작할 때 사용된다.

 

링크(href) 속성 변경: th:href를 사용하여 a 태그의 href 속성을 변경한다.

<a th:href="@{/path/to/resource}">링크</a>

여기서 @{...}는 타임리프의 URL 표현식이며, 서블릿 컨텍스트 경로를 포함한 전체 URL을 생성한다.

 

th:href th:href="@{/css/bootstrap.min.css}"

 

href="value1"을 th:href="value2"의 값으로 변경한다.

 

타임리프 뷰 템플릿을 거치게 되면 원래 값을 th:xxx 값으로 변경한다.

만약 값이 없다면 새로 생성한다. HTML을 그대로 볼 때는 href 속성이 사용되고, 뷰 템플릿을 거치면 th:href의 값이 href로 대체되면서 동적으로 변경할 수 있다. 대부분의 HTML 속성을 th:xxx로 변경할 수 있다.

 

URL 링크 표현식 - @{...}

타임리프(Thymeleaf)의 URL 링크 표현식 @{...}은 웹 애플리케이션에서 동적으로 URL을 생성할 때 사용된다.

이 표현식을 사용하면 애플리케이션의 컨텍스트 경로를 자동으로 처리하고, URL 파라미터를 쉽게 추가할 수 있다.

URL 링크 표현식은 th:href, th:src, th:action 등 HTML 태그의 속성과 함께 사용되어, 리소스 링크, 이미지 소스, 폼 액션 등을 동적으로 설정한다.

 

상대 경로: @{/path/to/resource} 형식을 사용하여 애플리케이션의 루트 경로에 상대적인 URL을 생성한다.

<a th:href="@{/login}">로그인 페이지</a>

 

경로 변수: {variableName}를 사용하여 URL 경로에 변수를 포함시킨다. 경로 변수는 URL 표현식 내에서 괄호를 사용하여 전달한다.

<a th:href="@{/user/{id}(id=${user.id})}">사용자 아이디</a>

 

쿼리 파라미터: URL 뒤에 쿼리 파라미터를 추가하려면, 경로 변수와 유사한 방식으로 괄호 내에 쿼리 파라미터를 정의한다.

<a th:href="@{/search(name=${query})}">검색</a>

 

리터럴 대체: |...|를 사용하여 URL 표현식 내에서 직접 문자열을 결합할 수 있다. 이는 복잡한 URL을 생성할 때 유용하다.

<a th:href="@{|/user/${user.id}/profile|}">프로필</a>

 

 

리터럴 대체 - |...|

리터럴 대체는 타임리프(Thymeleaf)에서 문자열과 표현식을 편리하게 결합할 수 있는 기능이다.

기본적으로 타임리프 표현식 내에서 문자열과 변수를 결합하기 위해서는 + 연산자를 사용해야 한다.

하지만, 리터럴 대체를 사용하면 이러한 결합을 더욱 간결하게 표현할 수 있다. 리터럴 대체는 |...| 기호를 사용하여 표현된다.

 

다음과 같이 리터럴 대체 문법을 사용하면, 더하기 없이 편리하게 사용할 수 있다.

<span th:text="|Welcome to our application, ${user.name}!|">

 

리터럴 대체는 단순한 문자열 결합 뿐만 아니라, URL 생성과 같은 복잡한 문자열 표현에도 사용될 수 있다.

예를 들어, 다음과 같이 리터럴 대체를 사용하여 동적인 URL을 생성할 수 있다

<a th:href="@{|/user/${user.id}/profile|}">프로필 보기</a>

 

변수 표현식 - ${...}

타임리프(Thymeleaf)에서 변수 표현식은 데이터를 HTML 템플릿에 동적으로 삽입하기 위해 사용된다.

이 표현식은 모델에서 전달된 데이터나 세션, 요청 파라미터 등의 여러 소스에서 가져온 값을 HTML 문서 내에 표시할 때 활용된다.

변수 표현식은 ${...} 구문을 사용하여 정의된다.

 

변수 표현식을 사용하여 템플릿에 데이터를 삽입하는 기본 형태는 다음과 같다.

<p th:text="${message}">기본 메시지입니다.</p>

위 예제에서 th:text 속성을 사용하여 <p> 태그의 내용을 message 변수의 값으로 대체한다. 만약 message 변수가 모델에 존재하지 않으면, "기본 메시지입니다."라는 기본 텍스트가 표시된다.

 

객체의 프로퍼티 접근: 객체의 프로퍼티나 필드에 접근할 때는 점(.) 연산자를 사용한다.

<p th:text="${user.name}">사용자 이름</p>

 

리스트나 맵에서의 값 접근: 리스트의 특정 요소에 접근하거나 맵의 키에 해당하는 값을 가져올 때도 변수 표현식을 사용한다.

<p th:text="${users[0].name}">첫 번째 사용자의 이름</p>
<p th:text="${userMap['userKey'].name}">사용자 이름</p>

 

메소드 호출: 객체의 메소드를 호출하여 반환값을 활용할 수 있다.

<p th:text="${user.getFullName()}">사용자 전체 이름</p>

 

 

쿼리 파라미터 조회: 예를 들어, 클라이언트가 URL을 통해 http://example.com?status=active와 같은 요청을 보냈을 때, status 파라미터의 값을 타임리프 템플릿에서 다음과 같이 사용할 수 있다

<p>Status: <span th:text="${param.status}"></span></p>

 

반복 출력 - th:each

반복 출력은 th:each 속성을 사용하여 구현된다.

이 기능은 컬렉션의 각 항목에 대해 HTML 요소를 반복하여 렌더링하고자 할 때 사용된다. th:each는 배열, 리스트, 맵, 세트 등 자바의 모든 반복 가능한 컬렉션 타입에 사용할 수 있다.

 

th:each를 사용하여 반복 출력을 구현하는 기본 형태는 다음과 같다.

<ul>
    <li th:each="item : ${items}" th:text="${item}"></li>
</ul>

이 예제에서 ${items}는 컬렉션 객체를 참조하는 변수이며, item은 반복 중인 현재 항목의 임시 변수 이름이다. th:each 속성이 적용된 HTML 요소(<li>)는 컬렉션의 각 항목에 대해 반복되어 렌더링된다.

 

맵(Map) 객체를 반복할 때는 키(key)와 값(value)을 모두 사용할 수 있다.

<div th:each="entry : ${map}">
    <p>Key: <span th:text="${entry.key}"></span>, Value: <span th:text="${entry.value}"></span></p>
</div>

 

반복문에서 현재 항목의 인덱스를 사용하고 싶을 때는 반복 변수명 뒤에 index 또는 count를 추가한다. index는 0부터 시작하고, count는 1부터 시작한다.

<ul>
    <li th:each="item, iterStat : ${items}" th:text="|${iterStat.index} - ${item}|"></li>
</ul>

 

이 예제에서 iterStat는 반복 상태를 나타내는 객체로, 현재 인덱스(iterStat.index), 카운트(iterStat.count), 그리고 반복 중인 컬렉션의 사이즈(iterStat.size) 등 다양한 정보를 제공한다.

 

th:if와 같은 조건 속성과 함께 th:each를 사용하여 특정 조건을 만족하는 항목에 대해서만 요소를 렌더링할 수 있다.

<ul>
    <li th:each="item : ${items}" th:if="${item.active}" th:text="${item.name}"></li>
</ul>

이 예제에서는 item.active가 true인 항목에 대해서만 <li> 요소가 렌더링된다.

 

내용 변경 - th:text

th:text는 타임리프(Thymeleaf) 템플릿 엔진에서 HTML 요소의 텍스트 내용을 동적으로 설정하는 데 사용되는 속성이다.

이 속성을 사용하면 서버 사이드에서 생성된 데이터나 표현식의 결과를 웹 페이지의 특정 부분에 삽입할 수 있다

th:text를 사용함으로써 HTML 태그 내에 하드코딩된 텍스트 대신에, 애플리케이션의 모델이나 서비스 레이어에서 제공하는 동적인 데이터를 표시할 수 있다.

 

<td th:text="${item.price}">10000</td>

내용의 값을 th:text의 값으로 변경한다. 여기서는 10000을 ${item.price}의 값으로 변경한다.

 

th:text는 조건부 로직과 함께 사용될 수도 있다. 예를 들어, 사용자의 로그인 상태에 따라 다른 메시지를 표시하고 싶다면, 다음과 같이 작성할 수 있다.

<span th:text="${session.user != null} ? '로그인 상태입니다.' : '로그아웃 상태입니다.'">기본 텍스트</span>

 

조건식

th:if, th:unless

  • th:if는 조건이 참일 경우에만 요소가 렌더링된다.
  • th:unless는 조건이 거짓일 경우에만 요소가 렌더링된다.
<div th:if="${user != null}">
    사용자 이름은 <span th:text="${user.name}">사용자명</span>
</div>
<div th:unless="${user != null}">
    사용자 정보가 없습니다.
</div>

 

th:switch, th:case

  • th:switch는 여러 조건 중 하나를 선택해 렌더링할 때 사용된다.
  • th:case는 th:switch 내에서 각 조건을 정의한다.
<div th:switch="${user.role}">
    <p th:case="'admin'">관리자</p>
    <p th:case="'user'">일반 사용자</p>
    <p th:case="*">알 수 없는 역할</p>
</div>

 

인라인 조건식

인라인에서의 조건식 사용은 [(${condition}) ? '값1' : '값2'] 형태로, 인라인에서 직접 조건식을 사용할 수 있다는 것이다.

<p>상태: <span th:inline="text">[(${user.active}) ? '활성' : '비활성']</span></p>

'Java Category > Thymeleaf' 카테고리의 다른 글

[Thymeleaf] 스프링 통합과 폼  (0) 2024.03.09
[Thymeleaf] 타임리프 레이아웃  (0) 2024.03.08
[Thymeleaf] 템플릿 조각  (0) 2024.03.07
[Thymeleaf] 타임리프 기본 기능  (1) 2024.03.06