본문 바로가기
Tech/Spring | Spring Boot

[Spring][스프링 MVC 2편 - 백엔드 웹 개발 활용 기술] 1. 타임리프 - 기본 기능

by 싱브이 2024. 1. 25.
728x90
반응형

 

 

 

김영한님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 강의 내용을 정리한 것입니다.

 

 

 

 

프로젝트 생성

  • 프로젝트 
    Project: Gradle - Groovy
    Language: Java
    Spring Boot: 3.2.2
  • Project Metadata
    Group: hello
    Artifact: thymeleaf-basic
    Name: thymeleaf-basic
    Package name: hello.thymeleaf 
    Packaging: Jar
    Java: 17
  • Dependencies: Spring Web, Lombok , Thymeleaf

 

타임리프 소개

 

타임리프 특징

  • 서버 사이드 HTML 렌더링 (SSR)
    타임리프는 백엔드 서버에서 HTML을 동적으로 렌더링하는 용도로 사용
  • 네츄럴 템플릿
    순수 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: _

 

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

 

텍스트 - text, utext

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

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

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

 

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

컨텐츠 안에서 직접 출력하기 = [[${data}]]`

 

[BasicController]

package hello.thymeleaf.basic;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/basic")
public class BasicController {

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

 

[/resources/templates/basic/text-basic.html]

<!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 문서는 < , > 같은 특수 문자를 기반으로 정의된다.

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

변경 전
"Hello Spring!"

변경 후

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

개발자가 의도한 것은 <b>가 있으면 해당 부분을 강조하는 것이 목적이었다.

그런데 <b>테그가 그대로 나온다. 소스보기를 하면 < 부분이 &lt; 로 변경된 것을 확인할 수 있다.

 

 

HTML 엔티티

웹브라우저는 < 를 HTML 테그의 시작으로 인식한다.

HTML 엔티티는 < 를 테그의 시작이 아니라 문자로 표현할 수 있도록 하는 것이다. 

그리고 이렇게 HTML에서 사용하는 특수 문자를 HTML 엔티티로 변경하는 것을 이스케이프(escape)라 한다.

그리고 타임리프가 제공하는 th:text , [[...]] 는 기본적으로 이스케이프 (escape)를 제공한다.

  • <  →  &lt;
  • > →  &gt;
  • 기타 수 많은 HTML 엔티티가 있다.

 

 

이스케이프 기능을 사용하지 않으려면 어떻게 해야할까? 

 

 

Unescape

타임리프는 다음 두 기능을 제공한다.

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

 

[BasicController]

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

 

[/resources/templates/basic/text-unescaped.html]

<!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를 사용해야한다 !

 

변수 - SpringEL

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

 

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

 

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

 

[BasicController]

    @GetMapping("/variable")
    public String variavle(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;
        }

 

[/resources/templates/basic/variable.html]

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

</body>
</html>

 

 

[결과]

 

 

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 를 사용하면 지역 변수를 선언해서 사용할 수 있다.

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

 

[/resources/templates/basic/variable.html]

<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 부터는 ${#request} , ${#response} , ${#session} , ${#servletContext} 를 지원하지 않는다.

스프링 부트 3.0이라면 직접 model 에 해당 객체를 추가해서 사용해야 한다. 

 

[BasicController]

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

 

[/resources/templates/basic/basic-objects.html]

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

 

[결과]

 

유틸리티 객체와 날짜

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

타임리프 유틸리티 객체들

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

  • #ids : 아이디 처리 관련 기능 제공, 뒤에서 설명

 

자바8 날짜

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

스프링 부트 타임리프를 사용하면 해당 라이브러리가 자동으로 추가되고 통합된다. 그러니까 기본적으로 들어가있다.

 

타임리프 자바8 날짜 지원 라이브러리

thymeleaf-extras-java8time

 

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

#temporals

 

사용 예시

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

 

[BasicController]

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

 

[/resources/templates/basic/date.html]

<!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을 생성할 때는 @{...} 문법을 사용하면 된다.

 

[BasicController]

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

 

[/resources/templates/basic/link.html]

<!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>
  <li><a th:href="@{/hello(param1=${param1}, param2=${param2})}">hello query param</a></li>
  <li><a th:href="@{/hello/{param1}/{param2}(param1=${param1}, param2=${param2})}">path variable</a></li>
  <li><a th:href="@{/hello/{param1}(param1=${param1}, param2=${param2})}">path variable + query parameter</a></li>
</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 : 상대 경로

 리터럴(Literals)

리터럴은 소스 코드상에 고정된 값을 말하는 용어이다.

  • 문자: '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>

 

' 로 감싸면 정상 동작한다.

 

[BasicController]

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

 

[/resources/templates/basic/literal.html]

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

 

 

[결과]

 

리터럴 대체(Literal substitutions)

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

 

 | |

 

 

연산

HTML 엔티티를 사용하는 부분을 주의!!

 

[BasicController]

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

 

[/resources/templates/basic/operation.html]

<!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>
    <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 == 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>
  </ul> </li>
  <li>No-Operation
    <ul>
      <li>${data}?: _ = <span th:text="${data}?: _">데이터가 없습니다.</span></li>
      <li>${nullData}?: _ = <span th:text="${nullData}?: _">데이터가 없습니다.</span></li>
    </ul>
  </li> </ul>

</body>
</html>

 

[결과]

 

  • 비교연산: HTML 엔티티를 사용해야 하는 부분을 주의
    > (gt), < (lt), >= (ge), <= (le), ! (not), == (eq), != (neq, ne)
  • 조건식: 자바의 조건식과 유사하다.
  • Elvis 연산자: 조건식의 편의 버전
  • No-Operation: _ 인 경우 타임리프가 무효화된다. 이것을 잘 사용하면 HTML의 내용 그대로 활용할 수 있다. 마지막 예를 보면 데이터가 없습니다. 부분이 그대로 출력된다.

 

 

속성 값 설정

타임리프 태그 속성(Attribute)

타임리프는 주로 HTML 태그에 th:* 속성을 지정하는 방식으로 동작한다.

th:* 로 속성을 적용하면 기존 속성을 대체한다. 기존 속성이 없으면 새로 만든다.

 

 

[BasicController]

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

 

[/resources/templates/basic/attribute.html]

<!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/>
- th:attrprepend = <input type="text" class="text" th:attrprepend="class='large '" /><br/>
- th:classappend = <input type="text" class="text" th:classappend="large" /><br/ >

<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/> - checked=false <input type="checkbox" name="active" checked="false" /><br/>

</body>
</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" />    →    이 경우에도 checked 속성이 있기 때문에 checked 처리가 되어버린다.

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

 

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

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



 

반복 

타임리프에서 반복은 th:each 를 사용한다. 추가로 반복에서 사용할 수 있는 여러 상태 값을 지원한다. 예를들어 몇번째 반복인지 등등 !

 

[BasicController]

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

 

[/resources/templates/basic/each.html]

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>기본 테이블</h1> <table border="1">
    <tr>
        <th>username</th>
        <th>age</th>
    </tr>
    <tr th:each="user : ${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>
        <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>
</table>
</body>
</html>

 

 

[결과]

 

 

반복 기능

<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 ( if 의 반대)

 

[BasicController]

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

 

[/resources/templates/basic/condition.html]

<!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> <span th:text="'미성년자'" th:unless="${user.age ge 20}"></span>
    </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>

 

 

[결과]

 

 

if, unless

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

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

 

switch

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

 

주석

 

[BasicController]

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

[/resources/templates/basic/condition.html]

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

 

[결과]

 

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

 

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

 

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

 

블록

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

 

[BasicController]

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

 

[/resources/templates/basic/condition.html]

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

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

 

[결과]

 

타임리프의 특성상 HTML 태그안에 속성으로 기능을 정의해서 사용하는데,

위의 예시처럼 사용하기 애매한 경우에 사용하면 된다.<th:block> 은 렌더링시 제거된다.

 

자바스크립트 인라인

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

<script th:inline="javascript">

 

[BasicController]

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

[/resources/templates/basic/javascript.html]

<!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}]];
</script>

<!-- 자바스크립트 인라인 사용 후 --> 
<script th:inline="javascript">
  var username = [[${user.username}]];
  var age = [[${user.age}]];
  //자바스크립트 내추럴 템플릿
  var username2 = /*[[${user.username}]]*/ "test username";
  //객체
  var user = [[${user}]];
</script>

</body>
</html>

 

[자바스크립트 인라인 사용 전 - 결과]

<script>
var username = userA;
var age = 10;

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

//객체
var user = BasicController.User(username=userA, age=10);

</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의 경우에는 " 가 필요 없기 때문에 정상 렌더링 된다.

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

 

 

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

타임리프는 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

 

[/resources/templates/basic/javascript.html]

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

 

[결과]

<script>
 var user1 = {"username":"userA","age":10};
 var user2 = {"username":"userB","age":20};
 var user3 = {"username":"userC","age":30};
</script>

 

 

템플릿 조각

웹 페이지를 개발할 때는 공통 영역이 많이 있다. 예를 들어서 상단 영역이나 하단 영역, 좌측 카테고리 등등 여러 페이 지에서 함께 사용하는 영역들이 있다. 이런 부분을 코드를 복사해서 사용한다면 변경시 여러 페이지를 다 수정해야 하므로 상당히 비효율적이다.

타임리프는 이런 문제를 해결하기 위해 템플릿 조각과 레이아웃 기능을 지원한다.

 

[TemplateController]

package hello.thymeleaf.basic;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/template")
public class TemplateController {
    @GetMapping("/fragment")
    public String template() {
        return "template/fragment/fragmentMain";
    }
}

[/resources/templates/template/fragment/footer.html]

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<body>
<footer th:fragment="copy"> 푸터 자리 입니다.
</footer>
<footer th:fragment="copyParam (param1, param2)"> <p>파라미터 자리 입니다.</p>
    <p th:text="${param1}"></p>
    <p th:text="${param2}"></p>
</footer>
</body>
</html>

 

th:fragment 가 있는 태그는 다른곳에 포함되는 코드 조각 !!!

여러 페이지에 footere를 다 넣을 때 사용하는 코드 조각이다.

 

[/resources/templates/template/fragment/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>
<h2>부분 포함 replace</h2>
<div th:replace="~{template/fragment/footer :: copy}"></div>
<h2>부분 포함 단순 표현식</h2>
<div th:replace="template/fragment/footer :: copy"></div>
<h1>파라미터 사용</h1>
<div th:replace="~{template/fragment/footer :: copyParam ('데이터1', '데이터2')}"></div>
</body>
</html>

 

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

 

 

 

부분 포함 insert

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

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

 

 

부분 포함 replace

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

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

 

 

부분 포함 단순 표현식

<div th:replace="template/fragment/footer :: copy"></div>

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

 

파라미터 사용

파라미터를 전달해서 동적으로 조각을 렌더링 

<div th:replace="~{template/fragment/footer :: copyParam ('데이터1', '데이터2')}"></ div>

 

 

템플릿 레이아웃

코드 조각을 레이아웃에 넘겨서 사용 하는 방법

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

 

[TemplateController]

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

[/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 은 현재 페이지의 title 태그들을 전달
  • ::link 는 현재 페이지의 link 태그들을 전달

결과를 보면 메인 타이틀이 전달한 부분으로 교체되었다.

공통 부분은 그대로 유지되고, 추가 부분에 전달한 <link> 들이 포함되어 있다. 
이 방식은 코드 조각을 조금 더 적극적으로 사용하는 방식이다.

→  레이아웃 개념을 두고, 그 레이아웃에 필요한 코드 조각을 전달해서 완성

 

 

 

템플릿 레이아웃 확장

<html>전체에 적용할 수도 있다.

 

[TemplateController]

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

[/resources/templates/template/layoutExtend/layoutFile.html]

<!DOCTYPE html>
<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>

[/resources/templates/template/layoutExtend/layoutExtendMain.html]

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

 

 

[결과]

<!DOCTYPE html>
<html>
<head>
<title>메인 페이지 타이틀</title> </head>
<body>
<h1>레이아웃 H1</h1>
<section>
<p>메인 페이지 컨텐츠</p> 
<div>메인 페이지 포함 내용</div>
</section>
<footer> 레이아웃 푸터 </footer>
</body>
</html>

 

layoutFile.html 을 보면 기본 레이아웃을 가지고 있는데, <html>에 th:fragment 속성이 정의되어 있다.

이 레이아웃 파일을 기본으로 하고 여기에 필요한 내용을 전달해서 부분부분 변경한다.

layoutExtendMain.html는 현재 페이지인데, <html> 자체를 th:replace 를 사용해서 변경한다.

→   layoutFile.html에 필요한 내용을 전달하면서 <html> 자체를 layoutFile.html 로 변경한다.

 

 

 

 

728x90
반응형

'Tech > Spring | Spring Boot' 카테고리의 다른 글

[Spring][스프링 MVC 2편 - 백엔드 웹 개발 활용 기술] 3. 메시지, 국제화  (0) 2024.01.30
[Spring][스프링 MVC 2편 - 백엔드 웹 개발 활용 기술] 2. 스프링 통합과 폼  (1) 2024.01.29
[Spring][스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술] 7. 스프링 MVC - 웹 페이지 만들기  (1) 2024.01.01
[Spring][스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술] 6. 스프링 MVC - 기본 기능  (2) 2023.12.22
[Spring][스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술] 5. 스프링 MVC - 구조 이해  (0) 2023.12.15

관련글

댓글

티스토리툴바