[Spring MVC 2편] 1. Thymeleaf

HJ·2023년 1월 13일

Spring MVC 2편

목록 보기

1/13

김영한 님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 강의를 보고 작성한 내용입니다.
https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

1. Thymeleaf

서버 사이드 렌더링 기법( SSR ) : 백엔드 서버에서 HTML을 동적으로 렌더링 하는 템플릿 엔진
스프링 통합 지원 : 스프링의 기능들을 사용할 수 있도록 지원함
타임리프는 순수 HTML을 최대한 유지하기 때문에 웹 브라우저에서 파일을 직접 열어서 내용을 확인할 수 있고, 서버에서 view template을 거치면 동적으로 변경된 내용으로 확인 가능하다
- JSP의 경우, 웹 브라우저로 열게 되면 JSP 코드와 자바 코드가 섞여 있어 파일이 깨지기 때문에 서버를 통해 JSP가 렌더링되고 HTML 응답 결과를 받아야 웹 브라우저에서 확인할 수 있다
타임리프는 HTML 태그의 속성에 기능을 정의해서 동작한다
- HTML 태그들은 기본적으로 id, name과 같이 사용할 수 있는 속성들이 존재하는데 다른 속성들처럼 태그 안에 th:XXX처럼 기능을 정의한다
- th:XXX = " "처럼 타임리프에 해당하는 값은 큰따옴표로 감싸주어야한다

타임리프를 사용하려면 아래 코드처럼 사용 선언이 필요하다
- <html xmlns:th="http://www.thymeleaf.org">

참고> Thymeleaf 튜토리얼

2. 텍스트 출력

2-1. 텍스트 출력

HTML 태그의 속성을 이용하기
- 위에서 타임리프는 th:XXX를 HTML 태그의 속성에 정의한다고 헀는데 텍스트의 경우 th:text를 사용한다
태그 속성을 사용하지 않고 직접 출력하기
- 태그를 사용하지 않고 직접 출력할 때는 [[...]] 를 사용한다

2-2. 텍스트 출력 예시

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

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

<!-- 페이지 소스 보기 -->
<li>th:text 사용 <span>Hello Spring</span> </li>
<li>컨텐츠 안에서 직접 출력하기 = Hello Spring</li>

span 태그에 아무것도 작성하지 않았는데 해당 url로 접속 시, 모델에서 전달된 데이터가 출력되는 것을 확인
li 태그에 역시 모델에서 전달된 내용이 출력된 것을 확인

2-3. HTML 엔티티

웹 브라우저는 < 를 HTML 태그로 인식하기 때문에 개발자가 < 기호를 화면에 그대로 출력하기 위한 방법이 필요

HTML에서 사용하는 문자를 그대로 출력하기 위한 문자들을 HTML 엔티티라고 부른다

이스케이프( escape ) : HTML에서 사용하는 특수 문자를 HTML 엔티티로 변경하는 것
- th:text 와 [[...]] 의 경우 자동으로 이스케이프 처리

Unescape : 이스케이프 처리하지 않는 것
- th:text ➜ th:utext
- [[...]] ➜ [(...)]

이스케이프가 자동으로 처리되는 이유 : 만약 이스케이프가 자동이 아닌 경우, 사용자가 임의로 HTML 태그를 사용했다고 가정했을 때 올바른 HTML 태그가 아닌 경우 HTML이 깨지게 되기 때문에 HTML에서 사용되는 특수문자들을 모두 이스케이프 처리하여 이를 방지하는 것이다

2-4. 이스케이프 예시

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

<!-- 페이지 소스 보기 -->
<li>th:text 사용 <span>Hello &lt;b&gt;Spring&lt;/b&gt;</span> </li>
<li>컨텐츠 안에서 직접 출력하기 = Hello &lt;b&gt;Spring&lt;/b&gt;</li>

Hello Spring에서 Spring을 강조하기 위해 Thymeleaf의 코드를 변경하지 않고 Controller 에서 b 태그를 붙이게 되면
- 웹 브라우저에는 Hello <b>Spring</b>으로 출력
- 페이지 소스를 보면 < 부분이 &lt로, > 부분이 &gt 로 변경됨
- 즉, HTML 태그로 사용되는 < 기호가 이스케이프 처리되어 &lt로 변경되고 화면에 < 기호가 그대로 출력되었다

<!-- Thymeleaf -->
<li>th:utext = <span th:utext="${data}"></span></li>
li><span th:inline="none">[(...)] = </span>[(${data})]</li>

<!-- 페이지 소스 보기 -->
<li>th:utext = <span>Hello <b>Spring</b></span></li>
<li><span>[(...)] = </span>Hello <b>Spring</b></li>

Thymeleaf의 코드를 위처럼 변경하면 Controller에 b 태그를 사용했을 때 의도했던대로 Spring 부분이 b 태그로 감싸지게 된다

3. 변수 표현식과 스프링 EL

3-1. 변수 표현식

변수 표현식 : ${...}
Spring EL(Expression Language) : https://docs.spring.io/spring-framework/docs/3.0.x/reference/expressions.html
- ${모델명.속성} : 프로퍼티 접근, 모델명.getXXX()와 동일, XXX는 필드이름
- ${모델명['속성']} : 모델명.getXXX()와 동일
- ${모델명.getXXX()} : 직접 메서드를 호출하여 조회

3-2. 변수 표현식 예시 ( 특정 데이터 조회 )

// Controller
@Data
static class User {
    private String username;
    private int age;

    ...
}

@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);  // user라는 이름으로 userA를 삽입
    model.addAttribute("users", list);
    model.addAttribute("userMap", map);

    return "basic/variable";
}

<!-- Thymeleaf -->
<!-- 단일 조회 -->
<li><span th:text="${user.username}"></span></li>
<li><span th:text="${user['username']}"></span></li>
<li><span th:text="${user.getUsername()}"></span></li>

<!-- List에서 특정 데이터 조회 -->
<li><span th:text="${users[0].username}"></span></li>
...

<!-- Map에서 특정 데이터 조회 -->
<li><span th:text="${userMap['userA'].username}"></span></li>
...

리스트의 경우, 인덱스를 통해 첫 번째 회원을 찾고, 회원의 이름을 조회
Map의 경우, key로 userA를 찾고 회원의 이름을 조회

3-3. 지역변수

<!-- Thymeleaf -->
<div th:with="first=${users[0]}">
    <p>List의 첫 번째 회원의 이름 <span th:text="${first.username}"></span></p>
</div>

th:with : 지역 변수 선언
- " " 안에서 지역 변수 이름 지정 & 초기화 진헹
- 위의 예시로 보면 first가 지역 변수의 이름, list의 첫 번째 회원을 지역 변수에 저장
지역 변수는 선언한 태그 내부에서만 사용할 수 있다

4. 기본 객체

4-1. 기본 객체

기본 객체 : Controller에서 model을 통해 넘겨주지 않아도 기본적으로 사용할 수 있는 객체
- ${#request} : HttpServletRequest 객체가 그대로 제공
- ${#response}
- ${#session}
- ${#servletContext}
- ${#locale}

session : 사용자가 로그인 했을 때 웹 브라우저를 닫지 않으면 로그인이 계속 유지되는 기능 ( 데이터가 계속 유지 )
주의!!!> 스프링부트 3.0 부터는 위의 locale을 제외한 나머지는 제공하지 않는다

4-2. 기본 객체 예시

<!-- Thymeleaf -->
<li>request = <span th:text="${#request}"></span></li>
<li>response = <span th:text="${#response}"></span></li>
<li>session = <span th:text="${#session}"></span></li>

4-3. 편의 객체

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

<!-- Thymeleaf -->

<!-- 기본 객체의 불편한 부분 -->
<li>request = <span th:text="${#request.getParameter('paramData')}"></span></li>

<!-- 편의 객체로 조회 -->
<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>

url을 ?paramData=HelloParam라고 가정했을 때 요청 파라미터를 조회하는 방법
- ${#request}를 사용하는 경우 ${#request.getParameter('paramData')}를 통해 조회해야한다
- 편의 객체를 사용하면 더 편하게 조회할 수 있다

위와 같은 불편함을 해소하고 간단하게 조회할 수 있도록 하는 객체들이 편의 객체
- ${param} : 파라미터 조회 / ${param.파라미터이름}
- ${session} : 세션 조회 / ${session.넘어온정보이름}
- ${@} : 스프링 빈에 직접 접근 / ${@스프링빈이름}

4-4. 스프링부트 3.0

// Controller
public String test(HttpServletRequest request, Model model) {
    model.addAttribute("request", request);
    ...
}

<!-- Thymeleaf -->
<li>request = <span th:text="${request}"></span></li>

위에서 스프링부트 3.0부터는 ${#request}, ${#response} 등 일부 객체들이 제공되지 않는다고 했는데 직접 추가해서 사용할 수 있다
Controller에서 model에 HttpServletRequest 객체를 담고 model 이름을 request로 설정하면 ${#request}가 아니라 #이 빠진 ${request}로 사용 가능하다

5. 유틸리티 객체

5-1. 유틸리티 객체

유틸리티 객체는 #XXX으로 정의되어 있음 ( XXX는 객체이름 )
- #message : 메시지, 국제화 처리
- #temporals : 자바 8 날짜 서식 지원
유틸리티 객체 : 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

5-2. 날짜 유틸리티 객체 예시

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

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

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

6. 링크 표현식

6-1. 링크 표현식

기본적으로 @{...}를 사용한다
링크 표현식은 단순한 링크 뿐만 아니라 경로 변수, 쿼리 파라미터도 처리할 수 있다
절대경로와 상대경로
- 절대경로는 / 로 시작
- 상대경로는 바로 경로이름으로 시작

6-2. 예시

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

<!-- Thymeleaf -->
<li><a th:href="@{/hello}">절대경로</a></li>
<li><a th:href="@{hello}">상대경로</a></li>
<li><a th:href="@{/hello(param1=${param1}, param2=${param2})}">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>

첫 번째 : /basic/link ➜ /hello
두 번째 : /basic/link ➜ /basic/hello
세 번째 : /basic/link ➜ /hello?param1=data1&param2=data2
- ( ) 안에 있는 부분은 쿼리 파라미터로 처리된다
- ( ) 안의 ${param1}은 Controller를 통해 넘어온 model의 값으로 치환된다
네 번째 : /basic/link ➜ /hello/data1/data2
- 경로 변수를 지정하고 경로 변수에 들어가는 값이 무엇인지 명시
다섯 번째 : /basic/link ➜ /hello/data1?param2=data2
- 경로변수로 지정된 param1은 ( ) 안의 param1의 값으로 치환되고, 치환되지 않은 param2는 쿼리 파라미터로 처리된다

7. 리터럴

7-1. 리터럴

리터럴 : 소스 코드 상의 고정된 값을 말하는 요어

타임리프의 리터럴 : 문자 / 숫자 / boolean / null

문자 리터럴
- 작은 따옴표를 사용해서 묶어준다
- 공백없이 계속 이어지는 경우 작은 따옴표를 생략할 수 있다
- + 기호를 통해 문자 리터럴이나 변수 표현식과 결합할 수 있다
- 리터럴 대체를 사용해서 변수 표현식과의 결합을 더 쉽게 할 수 있다

리터럴 대체 : | ... |
- 변수 표현식을 값으로 치환하고 문자로 처리해준다

7-2. 예시

<!-- Thymeleaf -->
<li><span th:text="'hello world!'"></span></li>
<li><span th:text="'hello' + ' world!'"></span></li>  
<li><span th:text="'hello ' + ${data}"></span></li>
<li>리터럴 대체<span th:text="|hello ${data}|"></span></li>

8. 연산

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

<!-- Thymeleaf -->
<li>1 > 10 = <span th:text="1 &gt; 10"></span></li>
<li>(10 % 2 == 0)? '짝수':'홀수' = <span th:text="(10 % 2 == 0)?'짝수':'홀수'"></span></li>
<li>${data}?: '데이터가 없습니다.' = <span th:text="${data}?: '데이터가 없습니다.'"></span></li>
<li>${data}?: _ = <span th:text="${data}?: _">데이터가 없습니다.</span></li>
<li>${nullData}?: _ = <span th:text="${nullData}?: _">데이터가 없습니다.</span></li>

비교연산
- <, >, !=, == 와 같은 연산자를 사용
- <, > 와 같이 HTML 태그와 동일한 특수문자가 들어간 경우 HTML 엔티티를 사용해야한다

조건식 : 자바의 조건식( 삼항연산자 )과 유사

Elvis 연산자
- ?: 연산자
- 데이터가 있으면 데이터를 출력하고, 없으면 뒤에 작성한 텍스트가 출력

No-Operation
- _ 인 경우 operation을 수행하지 않는다 ( 타임리프 태그의 효과를 무효화 )
- 마지막 두 번째 예시의 경우 data가 있기 때문에 data가 출력되지만 마지막 예시의 경우, 데이터가 없기 때문에 타임리프 태그가 무효화되고 뒤에 적힌 "데이터가 없습니다" 라는 텍스트가 출력된다

9. 속성 값 설정

9-1. 타임리프 속성

타임리프는 HTML 태그에 th:XXX 속성을 지정하는 방식으로 동작

타임리프가 렌더링될 때 th:XXX 속성이 기존 속성을 대체
- 기존 속성이 없으면 새로 만든다

속성 추가
- th:attrappend : 지정한 속성 뒤에 추가
- th:prepend : 지정한 속성 앞에 추가
- th:classappend : class 속성에 추가

checked 처리
- <input type="checkbox" name="active" checked="false" />
- 위의 코드에 대해 HTML은 checked라는 속성이 있기 때문에 true, false에 관계 없이 체크가 된 것으로 처리 해버린다
- checked 속성을 th:checked로 변경하고 false로 설정하면 타임리프가 렌더링될 때, checked 속성을 아예 제거해버린다

9-2. 예시

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

<input type="text" class="text" th:attrappend="class=' large'" /><br/>
<input type="text" class="text" th:attrprepend="class='large '" /><br/>
<input type="text" class="text" th:classappend="large" /><br/>

<input type="checkbox" name="active" th:checked="true" /><br/>
<input type="checkbox" name="active" th:checked="false" /><br/>
<input type="checkbox" name="active" checked="false" /><br/>

<!-- 페이지 소스 보기 -->
<input type="text" name="userA" />

<input type="text" class="text large" /><br/>
<input type="text" class="large text" /><br/>
<input type="text" class="text large" /><br/>

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

checked 예시를 보면 th:checked가 true이기 때문에 checked 속성이 checked로 남아 있고, false인 경우에는 아예 사라졌으며, 그냥 checked를 사용헀을 때 속성이 유지되어 있다
- 즉, 서버를 동작시키면 첫 번째와 세 번째 체크 박스에 체크가 되어 있다

10. 반복

10-1. 반복

타임리프에서 th:each를 사용해서 반복한다
- th:each="반복변수 : ${모델명}" 형태
- 3-2번 예시에서 model에 List를 받았지만 인덱스를 지정하며 하나만 출력했는데 반복을 이용해서 모든 내용을 출력하도록 할 수 있다

List 뿐만 아니라 java.util.Iterable , java.util.Enumeration 을 구현한 모든 객체를 반복에 사용할 수 있다

Map 역시 사용할 수 있지만 이 때 반복 변수에 담기는 것은 Map.Entry이다

10-2. 반복 예시

<!-- Thymeleaf -->
<tr th:each="user : ${users}">
    <td th:text="${user.username}">username</td>
    <td th:text="${user.age}">0</td>
</tr>

<!-- 페이지 소스 보기 -->
<tr>
    <td>UserA</td>
    <td>10</td>
</tr>
<tr>
    <td>UserB</td>
    <td>20</td>
</tr>
<tr>
    <td>UserC</td>
    <td>30</td>
</tr>

users에 3개의 user가 담겨있기 때문에 3번이 반복되어 user에 대한 정보가 출력되었다

10-3. 반복 상태

반복을 할 때, 현재 반복이 어떻게 되고 있는지 상태를 알려주는 것들이 제공된다

th:each="반복변수, 상태변수 : ${모델명}" 형태
- 첫 번째 매개변수에 모델의 정보가 들어가고
- 두 번째 매개변수에 반복의 상태 정보가 들어간다
- 상태변수.XXX 형태로 사용한다
- 상태변수를 생략하면 반복변수 + Stat로 상태변수 이름이 자동으로 설정된다

조회 가능한 상태 정보
- index : 0부터 시작하는 값
- count : 1부터 시작하는 값
- size : 전체 사이즈
- even , odd : 홀수, 짝수 여부( boolean )
- first , last :처음, 마지막 여부( boolean )
- current : 현재 객체

10-4. 반복 상태 예시

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

<!-- 페이지 소스 보기 -->
<tr>
    <td>1</td>
    <td>UserA</td>
    <td>10</td>
    <td>
      index = <span>0</span>
      count = <span>1</span>
      size = <span>3</span>
      even? = <span>false</span>
      odd? = <span>true</span>
      first? = <span>true</span>
      last? = <span>false</span>
      current = <span>BasicController.User(username=UserA, age=10)</span>
    </td>
</tr>
...

11. 조건부 평가

<!-- Thymeleaf -->
<!-- if, unless -->
<tr th:each="user, userStat : ${users}">
    <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>

<!-- switch, case -->
<tr th:each="user, userStat : ${users}">
    <td th:switch="${user.age}">
      <span th:case="10">10살</span>
      <span th:case="20">20살</span>
      <span th:case="*">기타</span>
    </td>
</tr>

<!-- 페이지 소스 보기 -->
<!-- if, unless -->
<tr>
    <td>
      <span>10</span>
      <span>미성년자</span>
      <span>미성년자</span>
    </td>
</tr>

<tr>
    <td>
      <span>20</span>
      
      
    </td>
</tr>
...

<!-- switch, case -->
<tr>
    <td>
      
      <span>20살</span>
      
    </td>
</tr>


<tr>
    <td>
      

      <span>기타</span>
    </td>
</tr>

th:if, th:unless
- 조건을 충족하거나 충족하지 않아야 태그가 출력
- 위의 예시에서 20살인 경우, 미성년자가 아니기 때문에 조건이 붙은 두 개의 태그가 렌더링 되지 않고 사라진다

th:switch, th:case
- th:case="*" 은 만족되는 조건이 없을 때 사용되는 디폴트
- 이 역시 만족되지 않는 태그는 사라진다

12. 주석

12-1. 주석

HTML 주석
- 
- 타임리프가 렌더링 하지 않고 그대로 남겨둔다
- HTML 파일을 열었을 때나, 서버를 동작시켜 열었을 때나 동일하게 주석으로 남아있다

타임리프 파서 주석
- 
- 렌더링에서 주석을 제거한다
- 즉, HTML 파일을 열면 주석이 그대로 남아있지만 서버를 동작시키고 열면 아무것도 출력되지 않는다

타임리프 프로토타입 주석
- 
- HTML 파일을 열면 주석으로 처리되어 있음
- 타임리프로 렌더링 됐을 때만 주석 내부의 내용이 출력된다

12-2. 예시

<!-- Thymeleaf -->

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

<!-- 단순 HTML 파일로 열고 페이지 소스 보기 -->

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

13. 블록

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

<!-- 페이지 소스 보기 -->
  <div>
    사용자 이름1 <span>UserA</span>
    사용자 나이1 <span>10</span>
  </div>
  <div>
    요약 <span>UserA / 10</span>
  </div>
  ...

th:block
- HTML 태그가 아닌 유일한 타임리프 자체 태그
- 렌더링 결과에서는 사라진다 ( 페이지 소스 보기를 했을 때 나타나지 않는다 )

태그 내부의 속성으로 처리하기 애매한 경우에 사용
- 위의 예시의 경우, 하나의 div 태그 내의 속성으로 반복시키면 아래의 div 태그에는 출력되지 않기 때문에 th:block를 사용

14. 자바스크립트 인라인

14-1. 자바스크립트 인라인

자바스크립트에서 타임리프를 편리하게 사용할 수 있는 자바스크립트 인라인 기능을 제공
<script th:inline="javascript">로 적용한다
태그의 속성을 활용하는 것이 아닌 자바스크립트이기 때문에 정보를 직접 출력하는 [[...]] 를 사용

14-2. 텍스트 렌더링 문제

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

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

<!-- 페이지 소스 보기 -->
<!-- 자바스크립트 인라인 사용 전 -->
<script>
  var username = UserA;
</script>

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

자바스크립트 인라인 사용 전
- var username = UserA;로 렌더링 된 것은 타임리프 입장에서는 정확하게 렌더링한 것임
- but> 자바스크립트에서 문자로 처리되지 않았기 때문에 위처럼 작성하면 UserA가 정의되지 않았다는 오류가 발생

자바스크립트 인라인 사용 후
- 렌더링 된 값이 문자인 경우, 타임리프가 자동으로 문자로 처리해주었다
- 자바스크립트에서 문제가 될 수 있는 문자가 포함되어 있으면 이스케이프 처리도 해준다

14-3. 내추럴 템플릿

<!-- Thymeleaf -->
<!-- 자바스크립트 인라인 사용 전 -->
<script>
  var username2 = /*[[${user.username}]]*/ "test username";
</script>

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

<!-- 페이지 소스 보기 -->
<!-- 자바스크립트 인라인 사용 전 -->
<script>
  var username2 = /*UserA*/ "test username";
</script>

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

자바스크립트 인라인 사용 전
- 타임리프로 렌더링해도 내추럴 템플릿 기능을 사용할 수 없다
- 렌더링되어 주석으로 처리된 부분에 값은 제대로 값은 들어갔지만 자바스크립트 변수에 userA가 할당되지 않고 "test username"이 할당되었다

자바스크립트 인라인 사용 후
- 타임리프는 HTML 파일을 직접 열어도 동작하는 내추럴 템플릿 기능을 제공 & 자바스크립트 인라인 기능을 사용하면 주석을 활용해서 이 기능을 수행할 수 있다
- var username2 = /*[[${user.username}]]*/ "test username";의 경우, 주석으로 감싸게 되면 렌더링 될 때 주석 내부의 값이 사용되게 된다
- UserA가 렌더링되어, username2라는 변수에 할당되었다

14-4. 객체

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

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

<!-- 페이지 소스 보기 -->
<!-- 자바스크립트 인라인 사용 전 -->
<script>
  var user = BasicController.User(username=UserA, age=10);
</script>

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

자바스크립트 인라인 사용 전
- var user = [[${user}]];를 하게 되면 객체의 toString()이 동작해서 객체에 대한 정보가 할당되기 때문에 user의 정보를 제대로 활용하기 어렵다

자바스크립트 인라인 사용 후
- 객체의 경우, JSON 으로 변환해준다

14-5. each

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

[# ] 내부에 반복에 해당하는 th:each를 작성
user가 객체이기 때문에 JSON 형식으로 전달

15. 템플릿 조각

15-1. 템플릿 조각

타임리프는 파일을 분할하고 이를 가져와서 사용할 수 있도록 지원한다
- 여러 파일에서 공통적으로 쓰이는 부분이 있는 경우, 따로 파일을 만들고 이를 불러와서 사용
태그에 th:fragment로 이름을 지정하고, 다른 파일에서 이름으로 태그를 불러서 사용한다
다른 파일에서 이름으로 태그 부르는 방법
- th:insert="~{ 경로 :: 이름 }" : 현재 태그 내부에 가져온 태그를 작성
- th:replace="~{ 경로 :: 이름 }" : 현재 태그를 가져온 태그로 대체
- ~{ ... }내부에 작성하는 이름은 다른 파일에서 th:fragment로 지정한 이름을 의미한다
- 템플릿 조각을 사용하는 코드가 단순하면 ~{ ... } 생략 가능

15-2. 예시

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

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

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

<!-- fragmentMain.html -->
<h2>부분 포함 insert</h2>
<div th:insert="~{template/fragment/footer :: copy}"></div>


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


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

<!-- 페이지 소스 보기 -->
<h2>부분 포함 insert</h2>
<div><footer>
  푸터 자리 입니다.
</footer></div>


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


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

template/fragment/footer :: copy의 의미는 template/fragment/footer 템플릿의 th:fragment="copy" 라는 부분을 템플릿 조각으로 가져와서 사용한다는 의미
파라미터를 전달해서 동적으로 조각을 렌더링 할 수도 있다
과정
- Controller ➜ fragmentMain.html
- fragmentMain.html에서 footer.html 내부의 태그들 중 원하는 태그를 가져와서 사용

16. 템플릿 레이아웃 - 일부

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

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

<!-- layoutMain.html -->
<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>

<!-- 페이지 소스 보기 -->
<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>

설명
- 코드 조각을 레이아웃에 넘겨서 사용한다
- 페이지마다 필요한 정보를 더 추가해서 사용한다
- 레이아웃 개념을 두고, 그 레이아웃에 필요한 코드 조각을 전달해서 완성
- 즉, 여러 페이지가 있다고 가정했을 때, 페이지의 모양은 동일해야하는데 내용은 달라야하는 경우에 사용

common_header(~{::title},~{::link})
- ::title 은 현재 페이지의 title 태그들을 전달
- ::link 는 현재 페이지의 link 태그들을 전달

과정
- Controller ➜ layoutMain.html
- layoutMain.html의 head 태그를 template/layout/base의 common_header라고 이름 붙여진 태그로 replace
- layoutMain.html에서 common_header를 부를 때 title과 link 태그를 넘겨준다
  - layoutMain.html의 title 태그 자체를 ::title로 넘긴다
- base.html의 기본 형태( 레이아웃 )는 유지되지만 넘어온 title, link 태그로 대체 ( base.html의 title과 link가 replace이기 때문에 )
- 변화된 base.html의 태그들이 layoutMain.html의 head 태그를 replace
즉, layoutMain.html이 base.html의 common_header로 replace되는데 기본 레이아웃은 유지하되, title과 link 태그는 layoutMain.html이 넘겨준대로 변화

17. 템플릿 레이아웃 - 전체

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

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

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

과정
- Controller ➜ layoutExtendMain.html
- layoutExtendMain.html의 전체를 template/layoutExtend/layoutFile의 layout이라고 이름 붙여진 태그로 replace
- layoutExtendMain.html에서 layout을 부를 때 title과 section 태그를 넘겨준다
- layoutFile.html의 title 태그와 div 태그가 넘어온 태그들로 replace 된다
즉, layoutExtendMain.html이 layoutFile.html의 layout으로 replace되는데 기본 레이아웃은 유지하되, title과 div 태그는 layoutExtendMain.html이 넘겨준대로 변화

공부한 내용을 정리해서 기록하고 다시 보기 위한 공간

다음 포스트

[Spring MVC 2편] 1. Thymeleaf

Spring MVC 2편

1. Thymeleaf

2. 텍스트 출력

2-1. 텍스트 출력

2-2. 텍스트 출력 예시

2-3. HTML 엔티티

2-4. 이스케이프 예시

3. 변수 표현식과 스프링 EL

3-1. 변수 표현식

3-2. 변수 표현식 예시 ( 특정 데이터 조회 )

3-3. 지역변수

4. 기본 객체

4-1. 기본 객체

4-2. 기본 객체 예시

4-3. 편의 객체

4-4. 스프링부트 3.0

5. 유틸리티 객체

5-1. 유틸리티 객체

5-2. 날짜 유틸리티 객체 예시

6. 링크 표현식

6-1. 링크 표현식

6-2. 예시

7. 리터럴

7-1. 리터럴

7-2. 예시

8. 연산

9. 속성 값 설정

9-1. 타임리프 속성

9-2. 예시

10. 반복

10-1. 반복

10-2. 반복 예시

10-3. 반복 상태

10-4. 반복 상태 예시

11. 조건부 평가

12. 주석

12-1. 주석

12-2. 예시

13. 블록

14. 자바스크립트 인라인

14-1. 자바스크립트 인라인

14-2. 텍스트 렌더링 문제

14-3. 내추럴 템플릿

14-4. 객체

14-5. each

15. 템플릿 조각

15-1. 템플릿 조각

15-2. 예시

16. 템플릿 레이아웃 - 일부

17. 템플릿 레이아웃 - 전체

[Spring MVC 2편] 2. Thymeleaf Form

0개의 댓글