Thymeleaf 기본 기능 정리

2023. 6. 24. 19:51ㆍSpring

728x90

타임리프 특징

  • 서버 사이드 HTML 렌더링(SSR)
  • 네츄럴 템플릿
  • 스프링 통합 지원

1. 서버 사이드 HTML 렌더링 (SSR)

타임리프는 백엔드 서버에서 HTML을 동적으로 렌더링 하는 용도로 사용된다.

2. 네츄럴 템플릿

타임리프는 순수 HTML을 최대한 유지하는 특징이 있음. 타임리프로 작성한 파일은 HTML을 유지하기 때문에 웹 브라우저에서 파일을 직접 열어도 내용을 확인할 수 있고, 서버를 통해 뷰 템플릿을 거치면 동적으로 변경된 결과를 확인할 수 있다.

JSP를 포함한 다른 뷰 템플릿들은 해당 파일을 열면 예를 들어 JSP 파일 자체를 그대로 웹 브라우저에서 열어보면 JSP 소스 코드와 HTML이 뒤죽박죽 섞여서 웹 브라우저에서 정상적인 HTML 결과를 확인할 수 없다. 오직 서버를 통해 JSP가 렌더링 되고 HTML 응답 결과를 받아야 화면을 확인할 수 있음.

반면 타임리프로 작성된 파일은 해당 파일을 그대로 웹 브라우저에서 열어도 정상적인 HTML 결과를 확인할 수 있다.

물론 이 경우 동적으로 결과가 렌더링 되지는 않음. 하지만 HTML 마크업 결과가 어떻게 되는지 파일만 열어도 확인이 가능함.

이렇게 순수 HTML을 그대로 유지하면서 뷰 템플릿도 사용할 수 있는 타임리프의 특징을 네츄럴 템플릿 이라고 한다.

3. 스프링 통합 지원

타임리프는 스프링과 자연스럽게 통합되고 스프링의 다양한 기능을 편리하게 사용할 수 있게 지원해준다.

타임리프 기본 기능

타임리프를 사용하려면 아래와 같이 선언을 하면 된다.

<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의 콘텐츠에 데이터를 출력할 때는 아래와 같이 th: text를 사용하면 된다.

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

 

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

[[${data}]]

<ul>
    <li>th:text 사용 <span th:text="${data}"></span></li>
    <li>컨텐츠 안에서 직접 출력하기 = [[${data}]]</li>
</ul>

 

 

Escape

HTML 문서는 '<' , '>' 같은 특수 문자를 기반으로 정의된다. 따라서 뷰 템플릿으로 HTML 화면을 생성할 때는 출력하는 데이터에 이러한 특수 문자가 있는 것을 주의해서 사용해야 한다.

Controller를 아래와 같이 변경해서 다시 실행해보자.

  @Controller
  @RequestMapping("/basic")
  public class BasicController {
      @GetMapping("/text-basic")
      public String textBasic(Model model) {
          model.addAttribute("data", "Hello <b>Spring!</b>"); // <b></b> 태그를 사용해서 spring! 단어를 진하게 나오도록 설정.
          return "basic/text-basic";
      }
}

위에 코드의 결과가 아래와 같이 나오는 것을 확인할 수 있다.

 

HTML 엔티티

웹 브라우저는 '<'를 HTML 태그의 시작으로 인식한다. 따라서 '<'를 태그의 시작이 아니라 문자로 표현할 수 있는 방법이 필요한데

이것을 HTML 엔티티라고 한다. HTML에서 사용하는 특수 문자를 HTML 엔티티로 변경하는 것을 escape라고 한다.

그리고 타임리프가 제공하는 th:text, [[...]]는 기본적으로 escape를 제공함.

 

Unescape

이스케이프를 사용하지 않으려면

th:text -> th:utext

[[...]] -> [(...)]

와 같이 변경해줘야 한다.

<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>
  • th:inline="none"은 타임리프는 [[...]]를 해석하기 때문에 화면에 [[...]]글자를 보여줄 수 없다.
  • 이 태그 안에서는 타임리프가 해석하지 않게 해주는 옵션이다.

위에 코드를 실행 해보면 아래와 같이 우리가 원하던 결과가 나오는 것을 확인할 수 있다.

실제 서비스를 개발하다 보면 escape를 사용하지 않아서 HTML이 정상 렌더링 되지 않는 많은 문제가 발생하는 경우가 있다.

escape를 기본으로 하고, 꼭 필요할 때만 unescape를 사용하도록 하자!

 

변수 - SpringEL

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

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

그리고 이 변수 표현식에는 스프링 EL이라는 스프링이 제공하는 표현식 사용 가능.

<h1>SpringEL 표현식</h1>
<ul>Object는 아래 3개의 형식으로 출력 가능.
  <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는 아래 3개의 형식으로 출력 가능.
  <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은 아래 3개의 형식으로 출력 가능.
  <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>

<!-- th:with를 사용하면 지역변수를 선언해서 사용할 수 있다. 지역 변수는 선언한 태그 안에서만 사용할 수 있다. -->
<h1>지역 변수 - (th:with)</h1>
<div th:with="first=${users[0]}">
	<p>처음 사람의 이름은 <span th:text="${first.username}"></span></p> 
</div>

</body>
</html>

 

 

기본 객체들

타임리프는 기본 객체들을 제공함.( ${#locale} 빼고는 스프링 부트 3.0부터 제공 X )

  • ${#request}
  • ${#response}
  • ${#session}
  • ${#servletContext}
  • ${#locale}

${#request}는 HttpServletRequest 객체가 그대로 제공되기 때문에 데이터를 조회하려면 request.getParameter("data") 처럼 불편하게 접근해야 하는데 이런 점을 해결하기 위해 편의 객체도 제공함.

  • Http 요청 파라미터 접근 : param
    • ex.) ${param.paramData}
  • Http 세션 접근 : session
    • ex.) ${session.sessionData}
  • 스프링 빈 접근 : @
    • ex.) ${@helloBean.hello('spring!')}

 

유틸리티 객체와 날짜

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

타임리프 유틸리티 객체들

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

타임리프 유틸리티 객체 메뉴얼

 

Tutorial: Using Thymeleaf

1 Introducing Thymeleaf 1.1 What is Thymeleaf? Thymeleaf is a modern server-side Java template engine for both web and standalone environments, capable of processing HTML, XML, JavaScript, CSS and even plain text. The main goal of Thymeleaf is to provide a

www.thymeleaf.org

타임리프 유틸리티 객체 예시 메뉴얼

 

Tutorial: Using Thymeleaf

1 Introducing Thymeleaf 1.1 What is Thymeleaf? Thymeleaf is a modern server-side Java template engine for both web and standalone environments, capable of processing HTML, XML, JavaScript, CSS and even plain text. The main goal of Thymeleaf is to provide a

www.thymeleaf.org

 

자바8 날짜

타임리프에서 자바8 날짜인 LocalDate, LocalDateTime, Instant를 사용하려면 "thymeleaf-extras-java8time"라이브러리가 필요한데 스프링 부트 타임리프를 사용하면 해당 라이브러리는 자동으로 추가되고 통합된다.

 

자바8 날짜용 유틸리티 객체

#temporals

사용예시

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

 

URL 링크

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

<h1>URL 링크</h1>

<ul>
  <li><a th:href="@{/hello}">basic url</a></li>
  <!-- 단순한 URL : /hello -->
  
  <li><a th:href="@{/hello(param1=${param1}, param2=${param2})}">hello queryparam</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 -->
  
  <li><a th:href="@{/hello/{param1}(param1=${param1}, param2=${param2})}">path variable + query parameter</a></li>
  <!-- 경로 변수 + 쿼리 파라미터 : /hello/data1?param2=data2 -->
</ul>

URL 링크 참고 메뉴얼

리터럴(Literals)

리터럴은 소스 코드상에 고정된 값을 말한다.

예를 들어

String a = "Hello" : "Hello"는 문자 리터럴

int a = 10 * 20 : 10,20은 숫자 리터럴이다.

 

타임리프는 아래와 같은 리터럴이 있음.

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

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

ex.) <span th:text="'hello'">

 

만약 문자가 공백 없이 쭉 이어진다면 타임리프는 하나의 의미있는 토큰으로 인지해서 아래와 같이 작은 따옴표 생략 가능.

ex.) <span th:text="hello"> 가능

ex.) <span th:text="hello world"> 문자 리터럴은 '로 감싸야 하는데 중간에 공백이 있어서 오류가 발생한다.

ex.) <span th:text="'hello world'"> 위 오류 리터럴을 수정하려면 '로 감싸면 된다.

 

리터럴 대체(Literal substitutions)

<span th:text="'hello ' + ${data}"></span> 이 방법을

<span th:text="|hello ${data}|"> 처럼 | |으로 리터럴 대체 문법을 사용하는 방법도 있다.

 

연산

타임리프 연산은 자바와 크게 다르지 않은데 HTML 안에서 사용하기 때문에 HTML 엔터티를 사용하는 부분만 주의하면 된다.

  • 산술연산 : 
<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>
  • 비교연산(HTML 엔터티 사용) : >(gt), <(lt), >=(ge), <=(le), !(not), ==(eq), !=(neq,ne)
<li>비교 연산
    <ul>
      <li>1 > 10 = <span th:text="1 &gt; 10"></span></li>
      <li>1 gt 10 = <span th:text="1 gt 10"></span></li>
      <li>1 >= 10 = <span th:text="1 >= 10"></span></li>
      <li>1 ge 10 = <span th:text="1 ge 10"></span></li>
      <li>1 == 1 = <span th:text="1 == 10"></span></li>
      <li>1 != 1 = <span th:text="1 != 10"></span></li>
    </ul>
</li>
  • 조건식 : 자바의 조건식과 유사함.
<li>조건식
    <ul>
      <!-- 10 % 2 == 0 이면 짝수 아니면 홀수 출력 -->
      <li>(10 % 2 == 0)? '짝수':'홀수' = <span th:text="(10 % 2 == 0)? '짝수':'홀수'"></span></li>
    </ul>
</li>
  • Elvis 연산자 : 조건식의 편의 버전임
<li>Elvis 연산자
    <ul>
      <!-- ${data}에 데이터가 있으면 데이터 출력, 데이터가 없으면 데이터가 없습니다. 출력.  -->
      <li>${data}?: '데이터가 없습니다.' = <span th:text="${data}?: '데이터가 없습니다.'"></span></li>
      <li>${nullData}?: '데이터가 없습니다.' = <span th:text="${nullData}?: '데이터가 없습니다.'"></span></li>
    </ul>
</li>
  • No-Operation : _ 인 경우 마치 타임리프가 실행되지 않는 것 처럼 동작한다.
<li>No-Operation
    <ul>
      <!-- ${data}에 데이터가 있으면 데이터 출력, 데이터가 없으면 <span>데이터가 없습니다.</span> 같이 출력됨. -->
      <li>${data}?: _ = <span th:text="${data}?: _">데이터가 없습니다.</span></li>
      <li>${nullData}?: _ = <span th:text="${nullData}?: _">데이터가 없습니다.</span></li>
    </ul>
</li>

 

속성 값 설정

속성 설정

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

ex.) <input type="text" name="mock" th:name="userA" /> 코드를 타임리프가 렌더링 하면

=> <input type="text" name="userA" /> 로 된다.

속성  추가

th:attrappend : 속성 값의 뒤에 값을 추가.

th:attrprepend : 속성 값의 앞에 값을 추가.

th:classappend : class 속성에 자연스럽게 추가.

ex.)

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

- th:attrprepend = <input type="text" class="text" th:attrprepend="class='large '" /><br/>
<!-- 결과 : text large -->

- th:classappend = <input type="text" class="text" th:classappend="large" /><br/>
<!-- 결과 : text large -->

 

checked 처리

HTML에서는 <input type="checkbox" name="active" checked="false" /> 이 경우에 checked 속성이 들어있기 때문에 checked 처리가 된다.

 

HTML에서 checked 속성은 checked 속성의 값과 상관 없이 속성만 있어도 체크가 되는 불편함이 있다.

 

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

<input type="checkbox" name="active" th:checked="false" />를 타임리프가 렌더링하면

=> <input type="checkbox" name="active" />로 된다.

ex.)

<h1>checked 처리</h1>
- checked o <input type="checkbox" name="active" th:checked="true" /><br/>
<!-- 렌더링 후 <input type="checkbox" name="active" checked="checked" />가 되어서 checked 처리 됨. -->

- checked x <input type="checkbox" name="active" th:checked="false" /><br/>
<!-- 렌더링 후 <input type="checkbox" name="active" />가 되어서 checked 속성 제거됨. -->

- checked=false <input type="checkbox" name="active" checked="false" /><br/>
<!-- HTML에서 checked 속성값이 false여도 checked 속성만 있어도 checked 처리 됨. -->

 

반복

타임리프에서 반복은 th:each를 사용한다. 추가로 반복에서 사용할 수 있는 여러 상태 값을 지원한다.

반복 기능

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

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

ex.)

<tr th:each="user : ${users}"> <!-- users에 담긴 리스트 값들을 user에 하나씩 담아줌 -->
    <td th:text="${user.username}">username</td>
    <td th:text="${user.age}">0</td>
</tr>

반복 상태 유지

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

반복의 두번째 파라미터를 설정해서 반복의 상태를 확인 가능.

두번째 파라미터(userStat)는 생략 가능한데, 생략하면 지정한 변수명 (user) + Stat가 된다.

여기서는 user + Stat = userStat이므로 생략 가능.

반복 상태 유지 기능

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

ex.)

<tr th:each="user, userStat : ${users}"> <!-- userStat 생략 가능 -->
    <td th:text="${userStat.count}">username</td>
    <td th:text="${user.username}">username</td>
    <td th:text="${user.age}">0</td>
    <td>
        index = <span th:text="${userStat.index}"></span>
        count = <span th:text="${userStat.count}"></span>
        size = <span th:text="${userStat.size}"></span>
        even? = <span th:text="${userStat.even}"></span>
        odd? = <span th:text="${userStat.odd}"></span>
        first? = <span th:text="${userStat.first}"></span>
        last? = <span th:text="${userStat.last}"></span>
        current = <span th:text="${userStat.current}"></span>
    </td>
</tr>

 

조건부 평가

타임리프의 조건식

if, unless(if의 반대)

if, unless

타임리프는 해당 조건이 맞지 않으면 태그 자체를 렌더링하지 않음.

만약 조건이 false인 경우 <span>...</span> 부분 자체가 렌더링 되지 않고 사라진다.

ex.)

<td>
    <span th:text="${user.age}">0</span>
    <span th:text="'미성년자'" th:if="${user.age lt 20}"></span> <!-- 만약 user.age가 20보다 작으면 미성년자 출력. -->
    <span th:text="'미성년자'" th:unless="${user.age ge 20}"></span> <!-- 만약 user.age가 20보다 크지 않으면 미성년자 출력. -->
</td>

switch

*은 만족하는 조건 없을 때 사용하는 기본값.

ex.)

<td th:switch="${user.age}">
    <span th:case="10">10살</span> <!-- user.age가 10이면 10살 출력. -->
    <span th:case="20">20살</span> <!-- user.age가 20이면 20살 출력. -->
    <span th:case="*">기타</span> <!-- user.age가 위 조건들을 만족하지 않으면 기타 출력. -->
</td>

 

주석

1. 표준 HTML 주석

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

ex.)

<!--
<span th:text="${data}">html data</span>
-->

페이지 소스 보기를 해보면 아래와 같이 나옴.

2. 타임리프 파서 주석

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

ex.)

<!--/* [[${data}]] */-->

<!--/*-->
<span th:text="${data}">html data</span>
<!--*/-->

 

 

3. 타임리프 프로토타입 주석

타임리프 프로토타입은 HTML 주석에 약간의 구문을 더했음.

HTML 파일을 웹 브라우저에서 그대로 열어보면 HTML 주석이기 때문에 이 부분이 웹 브라우저가 렌더링 하지 않는데,

타임리프 렌더링을 거치면 이 부분이 정상 렌더링 된다.

HTML 파일을 그대로 열어보면 주석처리가 되지만, 타임리프를 렌더링 한 경우에만 보이는 기능임.

ex.)

<!--/*/
<span th:text="${data}">html data</span>
/*/-->

 

블록

<th:block>은 HTML 태그가 아닌 타임리프의 유일한 자체 태그다.

ex.)

<th:block th:each="user : ${users}"> <!-- block으로 div 2개를 묶어서 반복을 하고 싶을때 사용. -->
    <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>

위 코드의 결과로 block으로 묶은 <div> 태그 2개를 반복해서 출력.

타임리프의 특성상 HTML 태그안에 속성으로 기능을 정의해서 사용하는데, 위 예처럼 사용하기 애매한 경우에 사용하면 된다. <th:block>는 렌더링시 제거됨.

 

자바스크립트 인라인

타임리프는 자바스크립트에서 타임리프를 편하게 사용할 수 있는 자바스크립트 인라인 기능을 제공함.

자바스크립트 인라인 기능은 <script th:inline="javascript">로 적용하면 됨.

ex.)

<!-- 자바스크립트 인라인 사용 전 -->
<script>
    var username = [[${user.username}]];
    var age = [[${user.age}]];

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

    //객체
    var user = [[${user}]];
</script>
<!-- 자바스크립트 인라인 사용 전 결과 -->
<script>
var username = userA;
var age = 10;
//자바스크립트 내추럴 템플릿
var username2 = /*userA*/ "test username";
//객체
var user = BasicController.User(username=userA, age=10);
</script>

<!-- 자바스크립트 인라인 사용 후 -->
<script th:inline="javascript">
    var username = [[${user.username}]];
    var age = [[${user.age}]];

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

    //객체
    var user = [[${user}]];
</script>
<!-- 자바스크립트 인라인 사용 후 결과 -->
<script>
var username = "userA";
var age = 10;
//자바스크립트 내추럴 템플릿 var username2 = "userA";
//객체
var user = {"username":"userA","age":10};
</script>

텍스트 렌더링

  • var username = [[${user.username}]];
    • 인라인 사용 전 => var username = userA;
    • 인라인 사용 후 => var username = "userA"
  • 인라인 사용 전 렌더링 결과를 보면 userA변수 이름이 그대로 남아있다. 타임리프 입장에서는 정확하게 렌더링 했지만 개발자가 기대한 "userA"랑 결과가 다르다. 결과적으로 userA가 변수명으로 사용되어서 자바스크립트 오류가 발생함. 숫자 age의 경우에는 "가 필요 없기 때문에 정상 렌더링이 된다.
  • 인라인 사용 후 렌더링 결과를 보면 문자 타입인 경우 "를 포함해주고 자바스크립트에서 문제가 될 수 있는 문자가 포함되어 있으면 이스케이프 처리도 해줌. ex.) " => \"

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

타임리프는 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으로 변환해준다.

자바스크립트 인라인 each

자바스크립트 인라인은 each를 지원해준다.

ex.) 자바스크립트 인라인안에 아래와 같이 [# th:each=""] [/]를 사용해서 each를 사용한다. 

<!-- 자바스크립트 인라인 each -->
<script th:inline="javascript"> 
    [# th:each="user, stat : ${users}"]
    var user[[${stat.count}]] = [[${user}]];
    [/]
</script>
<!-- 자바스크립트 인라인 each 결과 -->
 <script>
var user1 = {"username":"userA","age":10};
var user2 = {"username":"userB","age":20};
var user3 = {"username":"userC","age":30};
</script>

 

템플릿 조각

웹 페이지를 개발할 때 공통 영역이 많이 있다. 예를 들어 상단, 하단, 좌측 카테고리 등등 여러 페이지에서 함께 사용하는 영역들이 있음.

이런 부분들을 코드를 복사해서 사용하면 변경시 여러 페이지를 다 수정해야 해서 비효율적이다. 타임리프는 이런 문제를 해결하기 위해 템플릿 조각과 레이아웃 기능을 지원한다.

ex.)

footer.html   

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

<footer th:fragment="copy">
    푸터 자리 입니다.
</footer>

<footer th:fragment="copyParam (param1, param2)">
    <p>파라미터 자리 입니다.</p>
    <p th:text="${param1}"></p>
    <p th:text="${param2}"></p>
</footer>

footer를 사용할 html

template/fragment/footer :: copy 부분은 template/fragment/footer.html에 있는 th:fragment="copy" 라는 부분을 템플릿 조각으로 가져와서 사용한다는 의미.

<h2>부분 포함 insert</h2>
<div th:insert="~{template/fragment/footer :: copy}"></div>
<!-- 결과 : th:insert를 사용하면 현재 태그(div) 내부에 추가함. -->
<div><footer>
    푸터 자리 입니다.
</footer></div>


<h2>부분 포함 replace</h2>
<div th:replace="~{template/fragment/footer :: copy}"></div>
<!-- 결과 : th:replace를 사용하면 현재 태그(div)를 대체해줌. -->
<footer>
    푸터 자리 입니다.
</footer>


<h2>부분 포함 단순 표현식</h2>
<div th:replace="template/fragment/footer :: copy"></div>
<!-- 경로를 설정할 때 ~{...}를 사용하는 것이 원칙이지만 템플릿 조각을 사용하는 코드가 단순하면 이 부분 생략 가능. -->



<h1>파라미터 사용</h1>
<div th:replace="~{template/fragment/footer :: copyParam ('데이터1', '데이터2')}"></div>
<!-- 이런식으로 파라미터를 전달해서 동적으로 조각을 렌덜링 할 수도 있다. -->
<!-- footer.html에 copyParam 부분가져다 씀 -->
<!-- 결과 -->
<footer>
    <p>파라미터 자리 입니다.</p>
    <p>데이터1</p>
    <p>데이터2</p>
</footer>

 

템플릿 레이아웃1

이전에는 일부 코드 조각을 가지고와서 사용했다면, 이번엔 개념을 더 확장해서 코드 조각을 레이아웃에 넘겨서 사용하는 방법을 알아보자.

 

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

ex.)

base.html

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

base를 사용할 html

<!-- template/layout/base에 th:fragment가 common_header인 템플릿 조각을 가져다 씀 -->
<!-- ::title은 현재 페이지의 title태그들을 전달함. -->
<!-- ::link는 현재 페이지의 link태그들을 전달함. -->
<head th:replace="template/layout/base :: common_header(~{::title},~{::link})">
    <title>메인 타이틀</title> <!-- ::title에 넘길 값 -->
    <!-- ::link에 넘길 값 -->
    <link rel="stylesheet" th:href="@{/css/bootstrap.min.css}">
    <link rel="stylesheet" th:href="@{/themes/smoothness/jquery-ui.css}">
</head>
<body>
메인 컨텐츠
</body>

결과

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

 

위 결과를 보면.

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

이 방식은 앞에서 배운 코드 조각을 조금 더 적극적으로 사용하는 방식이다.

레이아웃 개념을 두고, 그 레이아웃에 필요한 코드 조각을 전달해서 완성하는 것으로 이해하면 됨.

 

템플릿 레이아웃2

템플릿 레이아웃 확장

템플릿 레이아웃1에서 이야기한 개념을 <head> 정도에만 적용하는게 아닌 <html> 전체에 적용할 수도 있다.

ex.)

layoutFile.html

<!-- html에 th:fragment 속성이 정의되어 있다. 이 레이아웃 파일을 기본으로 하고 여기에 필요한 내용을 전달해서 부분부분 변경하는 것으로 이해하면 됨. -->
<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>

layoutFile.html을 사용할 html

<!-- template/layoutExtend/layoutFile에 th:fragment가 layout을 가져다 씀. -->
<!-- th:replace를 사용해서 <html>자체를 변경한다. 결국 layoutFile.html에 필요한 내용을 전달하면서 <html>자체를 layoutFile.html로 변경한다. -->
<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>

결과

<html>
<head>
<title>메인 페이지 타이틀</title> 
</head>
<body>
<h1>레이아웃 H1</h1>

<section>
<p>메인 페이지 컨텐츠</p> 
<div>메인 페이지 포함 내용</div> 
</section>

<footer> 
레이아웃 푸터
</footer>

</body>
</html>

위 결과를 보면.

  • 메인 타이틀이 전달한 title로 교체됨.
  • 공통 부분은 그대로 유지되고, 추가 부분에 전달한 <section>이 포함된 것을 확인할 수 있다.
728x90
저작자표시 비영리 변경금지 (새창열림)

'Spring' 카테고리의 다른 글

SpringBoot + JPA 과제 중 구현 로직에 대한 고민 정리.  (2) 2023.11.08
tymeleaf 스프링 통합과 폼 정리  (0) 2023.06.29
Spring Boot 프로젝트 Swagger로 API 문서화 하기.  (0) 2023.06.20
JWT(JSON Web Token) 개념 정리와 발급받는 과정.  (0) 2022.10.29

관련글

티스토리툴바