Spring Thymeleaf basic

강정우·2023년 12월 11일

Spring

Spring-boot

목록 보기

36/73

Thymeleaf

기본 표현식

간단한 표현:
- 변수 표현식: ${...}
- 선택 변수 표현식: *{...}
- 메시지 표현식: #{...}
- 링크 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

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

텍스트를 출력하는 2가지 방법이다.

escape 개념

만약 위 코드에서 data의 값에 <br> 태그가 들어있다고 가정해보자.
그렇다면 html은 <br>을 "렌더링" 하는 것이 아닌 해당 문자열을 "문자" 로 치환한다.
이는 HTML 문서는 < , > 같은 특수 문자를 기반으로 정의되는데 따라서 뷰 템플릿으로 HTML 화면을 생성할 때는 출력하는 데이터에 이러한 특수 문자가 있는 것을 주의해서 사용해야 한다.

웹 브라우저: Hello <b>Spring!</b>
소스보기: Hello &lt;b&gt;Spring!&lt;/b&gt;

그래서 위에 이상한 문자열이 바로 HTML entity라고 한다.(ex&nbsp)
해당 "문자"자체로 치환해버리는 이러한 개념이 바로 "escape 한다" 라고 한다.
그래서 th:text, [[...]] 는 기본적으로 이스케이프 (escape)를 제공한다.
그럼 이거 말고 그냥 문자열을 "랜더링" 해주고 싶다면 어떻게 할까?

Unescape

th:utext, [(...)] 바로 이 문법을 사용하면 해당 문자열 그대로 랜더링 해준다.

escape를 기본으로 하고, 꼭 필요한 때만 unescape를 사용하자.

th:inline="none"

만약 테그 안에 이 속성이 들있다면 라임리프가 해석하지 말라는 옵션이다.

변수 접근 방법 - springEl

3가지 객체 타입에 대한 접근법

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 를 사용하면 지역 변수를 선언해서 사용할 수 있다.
지역 변수는 선언한 테그 안에서만 사용할 수 있다.

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

기본 객체들

타임리프는 기본 객체들을 제공한다.
- ${#request} - 스프링 부트 3.0부터 제공하지 않는다.
- ${#response} - 스프링 부트 3.0부터 제공하지 않는다.
- ${#session} - 스프링 부트 3.0부터 제공하지 않는다.
- ${#servletContext} - 스프링 부트 3.0부터 제공하지 않는다.
- ${#locale}

스프링 부트 3.0 이상
스프링 부트 3.0 부터는 ${#request} , ${#response} , ${#session} , ${#servletContext} 를 지원하
지 않는다. 만약 사용하게 되면 다음과 같은 오류가 발생한다.
Caused by: java.lang.IllegalArgumentException: The
'request','session','servletContext' and 'response' expression utility objects
are no longer available by default for template expressions and their use is not
recommended. In cases where they are really needed, they should be manually
added as context variables.
따라서 스프링 부트 3.0에서 위 객체가 필요하다면 직접 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";
}

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

편의 객체

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

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

파라미터 객체, 세션 객체, 빈 을 기본적으로 제공한다.

유틸리티 객체

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

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

URL 링크

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 : 상대 경로

리터럴

문자: 'hello' -> 항상 작은 따옴표
숫자: 10
boolean: true , false
null: null

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

리터럴 대체(Literal substitutions)

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

리터럴 대체 문법을 사용하면 마치 템플릿을 사용하는 것 처럼 편리하다.

연산

역시 대소비교연산이 HTML entity와 같기 때문에 주의하여 사용하면 된다.
- 비교연산: HTML 엔티티를 사용해야 하는 부분을 주의하자,
  > (gt), < (lt), >= (ge), <= (le), ! (not), == (eq), != (neq, ne)

Elvis 연산자

마치 JS의 ?? 연산자와 같은 역할을 한다.

<li>${data}?: '데이터가 없습니다.' = <span th:text="${data}?: '데이터가 없습니다.'"></span></li>
<li>${nullData}?: '데이터가 없습니다.' = <span th:text="${nullData}?: '데이터가 없습니다.'"></span></li>

No-Operation

<li>${data}?: _ = <span th:text="${data}?: _">데이터가 없습니다.</span></li>
<li>${nullData}?: _ = <span th:text="${nullData}?: _">데이터가 없습니다.</span></li>

_ 인 경우 마치 타임리프가 실행되지 않는 것 처럼 동작한다. 이것을 잘 사용하면 HTML의 내용 그대로 활용할 수 있다. 마지막 예를 보면 "데이터가 없습니다." 부분이 그대로 출력된다.

속성값

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

<input type="text" name="mock" th:name="userA" />

렌더링 후

<input type="text" name="userA" />

이렇게 변화한다.

속성 추가

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

이때 attrappend, attrprepend 는 문자 그대로 "바로" 붙기 때문에 띄어쓰기를 써야한다.

checked 처리

HTML에서는 아래 경우에도 checked 속성이 있기 때문에 checked 처리가 되어버린다.

<input type="checkbox" name="active" checked="false" />

HTML에서 checked 속성은 checked 속성의 값과 상관없이 checked 라는 속성만 있어도 체크가 된다. 이런 부분이 true , false 값을 주로 사용하는 개발자 입장에서는 불편하다.
그래서 타임리프의 th:checked 는 값이 false 인 경우 checked 속성 자체를 제거한다.

<input type="checkbox" name="active" th:checked="false" />
<!-- 위 코드가 아래 코드로 변환 -->
<input type="checkbox" name="active" />

반복

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

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

반복 상태 유지

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

반복의 두번째 파라미터를 설정해서 반복의 상태를 확인 할 수 있다.
두번째 파라미터는 생략 가능한데, 생략하면 자동으로 지정한 변수명( user ) + Stat 이 된다.
참고로 위 코드는 어차피 똑같으니까 생략해도 괜찮다.

반복 상태 유지 기능

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

조건

if, unless(!if임)
타임리프는 해당 조건이 맞지 않으면 태그 자체를 렌더링하지 않는다.
만약 다음 조건이 false 인 경우 <span>...</span> 부분 자체가 렌더링 되지 않고 사라진다.

<span th:text="'미성년자'" th:if="${user.age lt 20}"></span>
<span th:text="'미성년자'" th:unless="${user.age ge 20}"></span>

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

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

주석

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

아래는 개발자 도구에서 본 Dom Tree

<h1>예시</h1>
<span>Spring!</span>
<h1>1. 표준 HTML 주석</h1>
<!--
<span th:text="${data}">html data</span>
-->
<h1>2. 타임리프 파서 주석</h1>
<h1>3. 타임리프 프로토타입 주석</h1>
<span>Spring!</span>

표준 HTML 주석
자바스크립트의 표준 HTML 주석은 타임리프가 렌더링 하지 않고, 그대로 남겨둔다.
타임리프 파서 주석
타임리프 파서 주석은 타임리프의 진짜 주석이다. 렌더링에서 주석 부분을 제거한다.
타임리프 프로토타입 주석
HTML 파일을 그대로 열어보면 주석처리가 되지만, 타임리프를 렌더링 한 경우에만 보이는 기능이다.

블록

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

타임리프의 특성상 HTML 태그안에 속성으로 기능을 정의해서 사용하는데, 아래 코드처럼 이렇게 사용하기 애매한 경우에 사용하면 된다.

<div>
사용자 이름1 <span>userA</span>
사용자 나이1 <span>10</span>
</div>
<div>
요약 <span>userA / 10</span>
</div>

<div>
사용자 이름1 <span>userB</span>
사용자 나이1 <span>20</span>
</div>
<div>
요약 <span>userB / 20</span>
</div>

<div>
사용자 이름1 <span>userC</span>
사용자 나이1 <span>30</span>
</div>
<div>
요약 <span>userC / 30</span>
</div>

<th:block> 은 렌더링시 제거된다.

강정우

智(지)! 德(덕)! 體(체)!

이전 포스트

Spring mvc 웹 프로젝트 작성 법

다음 포스트