[spring boot] 아주 간단하게 Thymeleaf 사용해보기

템플릿 엔진이란?

템플릿 양식과 특정 데이터 모델에 따른 입력 자료를 결합하여 원하는 결과 문서를 출력하는 소프트웨어(또는 컴포넌트)를 말한다.

주로 View를 만들 때 사용한다.

동적 컨텐츠를 생성해서 제공해야할 때 템플릿 엔진을 유용하게 사용할 수 있다.

Code Generation / Email Template 등에 사용된다.

스프링 부트가 자동 설정을 지원하는 템플릿 엔진

FreeMarker

Groovy

Thymeleaf (추천) ㅡ> 비교적 최근에 만들어진 템플릿 엔진이다.

Mustache

JSP를 권장하지 않는 이유

spring boot가 지향하는 바를 충족시키기 못한다.

spring boot는 독립적으로 실행가능한 embeded tomcat으로 application을 쉽고 빠르게 만들어 배포하길 바란다.

JSP는 JAR 패키징 할 때는 동작하지 않고, WAR 패키징 해야 한다.

서블릿 엔진 중에 가장 최근에 만들어진, Jboss 진영에서 만든 Undertow는 JSP를 지원하지 않는다.

또한 의존성에서 문제가 발생할 수 있다.

이 링크는 공식문서가 말하는 jsp의 제약사항이다. #

Thymeleaf 사용하기

의존성 추가

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

@RestController가 아닌 @Controller로, 본문의 내용이 아닌 뷰 이름을 전달한다.

package com.jueun.springmvcdemo;

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

@Controller
public class SampleController {

    @GetMapping("/hello")
    public String hello(Model model){
        model.addAttribute("name", "jueun");// model을 Map처럼 사용
        return "helloEveryone";
    }
}

템플릿 파일 위치: /src/main/resources/template/helloEveryone.html

xmlns:th="http://www.thymeleaf.org : thymeleaf namespace를 추가했다.

<h1 th:text="${name}">Name</h1> : 모델에 name을 키로 저장해둔 내용을 꺼내 쓴다.

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>hello</title>
</head>
<body>
<h1 th:text="${name}">Name</h1>
</body>
</html>

Test 해보기

요청 "/hello"
응답
- model에 담은 내용: name : jueun
- view 이름 : helloEveryone

@RunWith(SpringRunner.class)
@WebMvcTest(SampleController.class)
public class SampleControllerTest {

    @Autowired
    MockMvc mockMvc;

    @Test
    public void hello() throws Exception {
        mockMvc.perform(get("/hello"))
                .andExpect(status().isOk())
                .andDo(print()) // 렌더링 본문 확인 가능
                // 타임리프 엔진은 서블릿 컨테이너에 독립적인 엔진이기에 view에 렌더링 결과값도 확인할 수 있다.
                .andExpect(view().name("helloEveryone"))
                .andExpect(model().attribute("name", "jueun"))
                .andExpect(content().string(containsString("jueun")));
    }
}

.andDo(print()): print() 함수를 통해 렌더링 본문을 확인할 수 있다.

서블릿 엔진이 개입을 해야만 응답으로 내보낼 최종적인 view를 확인할 수 있다. 즉 렌더링한다.

타임리프 엔진은 서블릿 컨테이너에 독립적인 엔진을 가지고 있다. 그렇기에 view에 렌더링 결과값도 확인할 수 있다고 한다.

아래는 hello() 테스트를 통과하고 기록된 내용이다.

Body 중 <h1 th:text="${name}">Name</h1>에서 값이 jueun으로 잘 렌더링된 것을 확인할 수 있다.

MockHttpServletRequest:
      HTTP Method = GET
      Request URI = /hello
       Parameters = {}
          Headers = []
             Body = null
    Session Attrs = {}

Handler:
             Type = com.jueun.springmvcdemo.SampleController
           Method = com.jueun.springmvcdemo.SampleController#hello(Model)

Async:
    Async started = false
     Async result = null

Resolved Exception:
             Type = null

ModelAndView:
        View name = helloEveryone
             View = null
        Attribute = name
            value = jueun

FlashMap:
       Attributes = null

MockHttpServletResponse:
           Status = 200
    Error message = null
          Headers = [Content-Language:"en", Content-Type:"text/html;charset=UTF-8"]
     Content type = text/html;charset=UTF-8
             Body = <!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>hello</title>
</head>
<body>
<h1>jueun</h1>
</body>
</html>
    Forwarded URL = null
   Redirected URL = null
          Cookies = []

Thymeleaf 공식 홈페이지 #

Thymeleaf 5분 튜토리얼 #

Thymeleaf 예제 #

'Springboot' 카테고리의 다른 글

[spring boot] HATEOAS 간단하게 사용해보기 (0)	2021.01.17
[spring boot] index.html, favicon (0)	2021.01.10
[spring boot] WebJars 중 jquery 추가해보기 (0)	2021.01.10
[spring boot] 정적 리소스 지원 (0)	2021.01.10
[spring boot] HttpMessageConverters (0)	2021.01.10
[spring boot] Test (0)	2021.01.09

dev. 달팽이🐌