[study] 스프링MVC2 - 1. 타임리프

스터디/2023_스프링부트

[study] 스프링MVC2 - 1. 타임리프

Hotsan 2023. 8. 8. 15:01

김영한님의 스프링 mvc2편 - 벡엔트 웹 개발 활용 기술 을 듣고 정리한 내용입니다.

타임리프

타임리프 특징

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

백엔드 서버에서 HTML 을 동적으로 렌더링 하는 용도로 사용

2. 네츄럴 템플릿

순수 HTML을 최대한 유지하는 특징이 있다.

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

JSP를 포함 다른 뷰 템플릿들은 해당 파일을 열면 JSP소스코드와 HTML이 뒤섞여서
웹 브라우저에서 정상적인 HTML 결과를 확인하기 어렵다.
오직 서버를 통해 JSP 렌더링 된 이후 HTML응답결과를 받아야 화면 확인이 가능하다.

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

3. 스프링 통합지원

스프링과 자연스럽게 통합되고, 스프링의 다양한 기능을 편리하게 사용 가능하다.

https://www.thymeleaf.org/doc/tutorials/3.0/thymeleafspring.html

Tutorial: Thymeleaf + Spring

Preface This tutorial explains how Thymeleaf can be integrated with the Spring Framework, especially (but not only) Spring MVC. Note that Thymeleaf has integrations for both versions 3.x and 4.x of the Spring Framework, provided by two separate libraries c

www.thymeleaf.org

타입리프 기본 기능

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

타입리프를 사용하려면 기본적인 선언이 필요하다.

텍스트 - text, utext

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

HTML의 콘텐츠에 데이터를 출력할 때는 th:text를 사용한다.

HTML태그의 속성이 아니라 HTML 콘텐츠 영역에서 직접 데이터 출력을 원하면 [[...]] 를 사용하면 된다.

HTML 엔티티

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

이것을 HTML 엔티티라고 한다.

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

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

Unescape

타임리프에서 이스케이프 기능을 사용하지 않으려면

th:utext
[(...)]

기능을 사용하면 된다.

실제 서비스 개발 시에는 escape를 사용하지 않아 정상 렌더링 되지 않는 경우도 있다고 하니
escape를 기본으로 하고 꼭 필요시에만 unescape를 사용하자.

변수 - SpringEL

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

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

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

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

th:with을 사용하면 지역변수를 선언해서 사용이 가능하다.

기본객체들

${#request} - 스프링 부트 3.0부터 제공 x
${#response} - 스프링 부트 3.0부터 제공 x
${#session} - 스프링 부트 3.0부터 제공 x
${#servletContext} - 스프링 부트 3.0부터 제공 x
${#locale}

스프링 부트 3.0 미만

@GetMapping("/basic-objects")
public String basicObjects(HttpSession session) {
    session.setAttribute("sessionData", "Hello Session");
    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://localhost:8080/basic/basic-objects?paramData=HelloParam 경로로 접속 시.

http://localhost:8080/basic/basic-objects?paramData=HelloParam 접속 결과

타입리프 유틸리티 객체

#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

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

유틸리티 객체 예시

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

Tutorial: Using Thymeleaf

www.thymeleaf.org

자바 8 날짜

타임리프에서 자바 8에서 사용하는 날짜인

LocalDate, LocalDateTime, Instant를 사용하려면 추가 라이브러리가 필요하다.

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

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

thymeleaf-extras-java8time

예시 )

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

URL 링크

URL 을 생성 시 @{...} 문법을 사용한다.

예시)

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

결과

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>URL 링크</h1>
<ul>
    <li><a href="/hello">basic url</a></li>
    <li><a href="/hello?param1=data1&amp;param2=data2">hello query param</a></li>
    <li><a href="/hello/data1/data2">path variable</a></li>
    <li><a href="/hello/data1?param2=data2">path variable + query parameter</a></li>
</ul>
</body>
</html>

단순 URL

@{/hello}

결과 : /hello

쿼리 파라미터

@{/hello(param1=${param1}, param2=${param2})}

/hello?param1=data1&param2=data2

경로변수

@{/hello(param1=${param1}, param2=${param2})}

결과 : /hello/data1/data2

경로변수 + 쿼리 파라미터

@{/hello/{param1}(param1=${param1}, param2=${param2})}

결과 : /hello/data1?param2=data2
경로 변수와 쿼리 파라미터를 함께 사용할 수 있다.

리터럴

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

타임리프 리터럴 예시

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

문자를 항상 작은따옴표로 ' 감싸는 것은 귀찮다.
공백없이 문자가 이어진다면 작은따옴표 생략이 가능하다.

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

리터럴 대체 (literal substitutions)

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

리터럴 대체 문법을 사용하면 편하다.

연산

타임리프연산은 HTML 안에서 사용하기 때문에 HTML 엔티티를 사용하는 부분을 주의한다.

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

비교연산

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

조건식 : 자바의 조건식과 유사

Elvis 연산자 : 조건식의 편의버전

No-Operation : _ 인 경우 전달받은 데이터가 없는경우 해당 부분이 그대로 출력되게 한다.

속성 값 설정

타임리프 태그 속성 Attribute

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

th:* 로 속성을 적용 시 기존 속성 대체한다.

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

결과)

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

<h1>속성 설정</h1>
<input type="text" name="userA" />

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

<h1>checked 처리</h1>
- checked o <input type="checkbox" name="active" checked="checked" /><br/>
- checked x <input type="checkbox" name="active" /><br/>
- checked=false <input type="checkbox" name="active" checked="false" /><br/>

</body>
</html>

속성설정

th:* 속성을 지정 시 타임리프는 기존 속성을 th:* 지정한 속성으로 대체한다.

속성추가

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

checked 처리

HTML에서는 checked 속성은 checked 속성 값과 상관없이 checked라는 속성이 포함되어있는것만으로도 체크가 된다.

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

반복

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

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

@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>
<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을 구현한 모든 객체를 반복에 사용할 수 있다.

반복 상태 유지

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

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

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

반복상태 유지 기능

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

조건부 평가

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

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

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

switch

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

주석

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

결과 )

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

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


</body>
</html>

1. 표준 HTML 주석

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

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

2. 타임리프 파서 주석

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

타임리프의 진짜 주석, 렌더링에서 주석 부분 제거한다.

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

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

HTML 주석에 약간의 구문을 더한 형태

HTML 파일을 웹 브라우저에서 그대로 열어보면 HTML이 주석이기 때문에 웹브라우저에서 렌더링 X

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

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

블록

<th:block> 태그는 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>

결과 )

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>


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


</body>
</html>

자바스크립트 인라인

<script th:inline="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}]];
</script>

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

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

    //객체
    var user = [[${user}]];
</script>

<!-- 자바스크립트 인라인 each -->
<script th:inline="javascript">

    [# 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);
</script>

<!-- 자바스크립트 인라인 사용 후 -->
<script>
    var username = "UserA";
    var age = 10;

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

    //객체
    var user = {"username":"UserA","age":10};
</script>

<!-- 자바스크립트 인라인 each -->
<script>

    
    var user1 = {"username":"UserA","age":10};
    var user2 = {"username":"UserB","age":20};
    var user3 = {"username":"UserC","age":30};
    

</script>

</body>
</html>

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

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

var username2 = /*[[${user.username}]]*/ "test username";
//인라인 사용 전 var username2 = /*userA*/ "test username";
//인라인 사용 후 var username2 = "userA";

객체

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

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

템플릿 조각

웹페이지를 개발할때에는 공통영역이 많다.

상단영역이나, 하단 영역, 좌측 카테고리 등 여러 페이지에서 함께 사용하는 영역의 코드를 복사해서 사용한다면

변경 시 여러 페이지를 다 수정해야 하므로 상당히 비효율 적이다. 타임리프는 이런 문제를 해결하기 위해 템플릿 조각과 레이아웃 기능을 지원한다.

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

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>

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>

결과)

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>부분 포함</h1>
<h2>부분 포함 insert</h2>
<div><footer>
    푸터 자리 입니다.
</footer></div>

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

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

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

<head> 같은 부분에 공통으로 사용하는 css,javascript를 한곳에 모아놓고 공통으로 쓰려면 이렇게 정의하면된다.

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>

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>

템플릿 레이아웃 확장

해당 개념을 <head> 태그 정도에만 적용하는게 아니라 html 전체도 적용 가능하다.

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>

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>

결과)

<!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 속성이 정의되어있다.

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

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

웹 애플리케이션 개발에 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. MVC 2편에서는 MVC 1편의 핵심 원리와 구조 위에 실무 웹 개발에 필요한 모든 활용 기술들을 학습할 수 있

www.inflearn.com

저작자표시 비영리 (새창열림)