Link Search Menu Expand Document
melodist Dev Records

타임리프 - 기본 기능

타임리프 소개

  • 공식 사이트: 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 렌더링 (SSR)
  • 네츄럴 템플릿
  • 스프링 통합 지원

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

네츄럴 템플릿 타임리프는 순수 HTML을 최대한 유지하는 특징이 있다. 타임리프로 작성한 파일은 HTML을 유지하기 때문에 웹 브라우저에서 파일을 직접 열어도 내용을 확인할 수 있고, 서버를 통해 뷰 템플릿을 거치면 동적으로 변경된 결과를 확인할 수 있다. JSP를 포함한 다른 뷰 템플릿들은 해당 파일을 열면, 예를 들어서 JSP 파일 자체를 그대로 웹 브라우저에서 열어보면 JSP 소스코드와 HTML이 뒤죽박죽 섞여서 웹 브라우저에서 정상적인 HTML 결과를 확인할 수 없다. 오직 서버를 통해서 JSP가 렌더링 되고 HTML 응답 결과를 받아야 화면을 확인할 수 있다. 반면에 타임리프로 작성된 파일은 해당 파일을 그대로 웹 브라우저에서 열어도 정상적인 HTML 결과를 확인할 수 있다. 물론 이 경우 동적으로 결과가 렌더링 되지는 않는다. 하지만 HTML 마크업 결과가 어떻게 되는지 파일만 열어도 바로 확인할 수 있다. 이렇게 순수 HTML을 그대로 유지하면서 뷰 템플릿도 사용할 수 있는 타임리프의 특징을 네츄럴 템플릿 (natural templates)이라 한다.

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

타임리프 기본 기능

타임리프 사용 선언 <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)

참고: https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#standardexpression-syntax

텍스트 - text, utext

타임리프는 기본적으로 HTML 테그의 속성에 기능을 정의해서 동작한다. HTML의 콘텐츠(content)에 데이터를 출력할 때는 다음과 같이 th:text 를 사용하면 된다. <span th:text="${data}"> HTML 테그의 속성이 아니라 HTML 콘텐츠 영역안에서 직접 데이터를 출력하고 싶으면 다음과 같이 [[...]] 를 사용하면 된다. 컨텐츠 안에서 직접 출력하기 = [[${data}]]

Escape

  • HTML 엔티티: <를 테그의 시작이 아니라 문자로 표현할 수 있는 방법
  • Escape: HTML에서 사용하는 특수 문자를 HTML 엔티티로 변경
  • 타임리프가 제공하는 th:text , [[...]] 는 기본적으로 이스케이프(escape)를 제공

Unescape

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

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

변수 - SpringEL

  • 변수 표현식 : ${...}
  • 변수 표현식에는 SpringEL이라는 스프링에서 제공하는 표현식 사용 가능

SpringEL 다양한 표현식 사용

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를 사용하면 지역 변수를 선언해서 사용할 수 있음
  • 지역 변수는 선언한 태그 안에서만 사용 가능

기본 객체들

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

이런 점을 해결하기 위해 편의 객체도 제공

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

유틸리티 객체와 날짜

타임리프 유틸리티 객체들

  • #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-utilityobjects

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

자바8 날짜

  • 타임리프에서 자바8 날짜인 LocalDate, LocalDateTime, Instant를 사용하려면 추가 라이브러리가 필요
  • 스프링 부트 타임리프를 사용하면 해당 라이브러리가 자동으로 추가되고 통합
  • 타임리프 자바8 날짜 지원 라이브러리: thymeleaf-extras-java8time
  • 자바8 날짜용 유틸리티 객체: #temporals

URL 링크

단순한 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 : 상대 경로 참고: https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#link-urls

리터럴

Literals: 소스 코드상에 고정된 값

타임리프 지원 리터럴

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

리터럴 대체(Literal substitutions) <span th:text="|hello ${data}|">

연산

비교연산

  • HTML 엔티티를 사용해야 하는 부분을 주의
  • > (gt), < (lt), >= (ge), <= (le), ! (not), == (eq), != (neq, ne)

조건식

  • 자바의 조건식과 유사

Elvis 연산자

  • 조건식의 편의 버전
  • A ?: B: A가 참일 경우 A를 반환, 거짓일 경우 B를 반환
  • A ? A : B와 동치

No-Operation

  • _ 인 경우 마치 타임리프가 실행되지 않는 것 처럼 동작
  • 이것을 잘 사용하면 HTML 의 내용 그대로 활용할 수 있음

속성 값 설정

속성 설정

  • 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" />
  • HTML에서 checked 속성은 checked 속성의 값과 상관없이 checked 라는 속성만 있어도 체크됨 타임리프의 th:checked 는 값이 false 인 경우 checked 속성 자체를 제거 <input type="checkbox" name="active" th:checked="false" /> -> 타임리프 렌더링 후: <input type="checkbox" name="active" />

반복

반복 기능

<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 : 현재 객체

조건부 평가

if, unless

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

switch

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

주석

렌더링 전

<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>
<!--/*/
<span th:text="${data}">html data</span>
/*/-->

결과

<h1>1. 표준 HTML 주석</h1>
<!--
<span th:text="${data}">html data</span>
-->
<h1>2. 타임리프 파서 주석</h1>
<h1>3. 타임리프 프로토타입 주석</h1>
<span>Spring!</span>
  1. 표준 HTML 주석 자바스크립트의 표준 HTML 주석은 타임리프가 렌더링 하지 않고, 그대로 남겨둠
  2. 타임리프 파서 주석 타임리프 파서 주석은 타임리프의 진짜 주석 렌더링에서 주석 부분을 제거
  3. 타임리프 프로토타입 주석
    • 타임리프 프로토타입은 약간 특이한데, HTML 주석에 약간의 구문을 더함
    • HTML 파일을 웹 브라우저에서 그대로 열어보면 HTML 주석이기 때문에 이 부분이 웹 브라우저가 렌더링하지 않음
    • 타임리프 렌더링을 거치면 이 부분이 정상 렌더링 됨
    • 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>
  • 타임리프의 특성상 HTML 태그안에 속성으로 기능을 정의해서 사용하는데, 이렇게 사용하기 애매한 경우에 사용
  • <th:block> 은 렌더링시 제거됨

자바스크립트 인라인

  • HTML 내 자바스크립트에서 아래와 같이 타임리프를 사용할 수 있음 <script th:inline="javascript">

텍스트 렌더링

  • var username = [[${user.username}]];
    • 인라인 사용 전 → var username = userA;
    • 인라인 사용 후 → var username = "userA";
  • 인라인 사용 후 렌더링 결과를 보면 문자 타입인 경우 “ 를 포함
  • 자바스크립트에서 문제가 될 수 있는 문자가 포함되어 있으면 이스케이프 처리
    • 예) " → \"

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

  • HTML 파일을 직접 열어도 동작하는 내추럴 템플릿 기능 제공
  • var username2 = /*[[${user.username}]]*/ "test username";
    • 인라인 사용 전 → var username2 = /*userA*/ "test username";
    • 인라인 사용 후 → var username2 = "userA";
  • 인라인 사용 전 결과를 보면 내추럴 템플릿 기능이 동작하지 않음
  • 인라인 사용 후 결과를 보면 주석 부분이 제거되고, 기대한 “userA”가 정확하게 적용
  • 렌더링이 되지 않았을 경우 HTML 파일을 열어 보면 “test username”만 보임

객체

  • var user = [[${user}]];
    • 인라인 사용 전 → var user = BasicController.User(username=userA, age=10);
    • 인라인 사용 후 → var user = {"username":"userA","age":10};
  • 인라인 사용 전은 객체의 toString()이 호출된 값
  • 인라인 사용 후는 객체를 JSON으로 변환

자바스크립트 인라인 each

<!-- 자바스크립트 인라인 each -->
<script th:inline="javascript">
  
  [# th:each="user, stat : ${users}"]
  var user[[${stat.count}]] = [[${user}]];
  [/]
   
</script>

템플릿 조각

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

footer.html 의 copy 부분

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

부분 포함 insert <div th:insert="~{template/fragment/footer :: copy}"></div>

<h2>부분 포함 insert</h2>
<div>
  <footer>
    푸터 자리 입니다.
  </footer>
</div>

th:insert 를 사용하면 현재 태그( div ) 내부에 추가

부분 포함 replace <div th:replace="~{template/fragment/footer :: copy}"></div>

<h2>부분 포함 replace</h2>
<footer>
  푸터 자리 입니다.
</footer>

th:replace 를 사용하면 현재 태그( div )를 대체

부분 포함 단순 표현식 <div th:replace="template/fragment/footer :: copy"></div>

<h2>부분 포함 단순 표현식</h2>
<footer>
  푸터 자리 입니다.
</footer>

~{...} 를 사용하는 것이 원칙이지만 템플릿 조각을 사용하는 코드가 단순하면 이 부분을 생략 가능

파라미터 사용 다음과 같이 파라미터를 전달해서 동적으로 조각을 렌더링 가능 <div th:replace="~{template/fragment/footer :: copyParam ('데이터1', '데이터2')}"></div>

<h1>파라미터 사용</h1>
<footer>
  <p>파라미터 자리 입니다.</p>
  <p>데이터1</p>
  <p>데이터2</p>
</footer>

템플릿 레이아웃

/resources/templates/template/layout/base.html

<html xmlns:th="http://www.thymeleaf.org">
<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>

/resources/templates/template/layout/layoutMain.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<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>

결과

<!DOCTYPE html>
<html>
<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>
  • common_header(~{::title},~{::link})
    • ::title 은 현재 페이지(layoutMain.html)의 title 태그들을 전달
    • ::link 는 현재 페이지의 link 태그들을 전달