개발일기
타임리프- 기본 기능 본문
타임리프 특징
- 서버 사이드 HTML 렌더링(SSR)
- 네츄럴 템플릿
- 스프릿 통합 지원
서버사이드 렌더링이란?
서버쪽에서 화면을 렌더링하여 보여주는 방식을 말한다.
타임리프는 백엔드 서버에서 HTML을 동적으로 랜더링하는 용도로 사용된다.
네츄럴 템플릿
타임리프는 순수 HTML을 최대한 유지하는 특징이 있다.
타임리프로 작성한 파일은 HTML을 유지하기 때문에 웹 브라우저에서 파일을 직접 열어도 내용을 확인할 수 있고, 서버를 통해 뷰 템플릿을 거치며 동적으로 변경된 결과를 확인할 수 있음.
스프링 통합 지원
타임 리프는 스프링과 자연스럽게 통합되고, 스프링의 다양한 기능을 편리하게 사용할 수 있게 지원한다.
타임리프 사용선언
<html xmlns:th="http://www.thymeleaf.org">
기본 표현식
간단한 표현:
변수 표현식 : ${...}
선택 변수 표현식 : *{...}
메시지 표현식 : #{...}
링크 URL 표현식 : @{...}
조각 표현식 : ~{...}
리터럴:
텍스트: 'one text', 'Another one!' , ....
숫자: 0, 34, 3.0, 12.3, ...
불린: true, flase
널: null
리터럴 토큰: one, sometext, main, ...
문자 연산:
문자 합치기: +
리터럴 대체: |The name is ${name}|
산술 연산:
Binary operators: +, 0, *, /, %
Minus sign(unary operator) : -
불린 연산:
Binary operators: and, or
Boolean negation (unary operator)
비교와 동등:
비교: >, <, >=, <= (gt, lt, ge, le)
동등 연산: ==, != (eq, ne)
조건 연산:
If-then: (if) ? (then)
If-then-else: (if) ? (then) : (else)
Default: (value) ?: (defaultValue)
특별한 토큰:
No-Operation: _
텍스트 - text , utext <-텍스트를 출력하는 기능
HTML 콘텐츠에 데이터를 출력할 때, <span th:text="${data}">
HTML 태그의 속성이 아니라 HTML 콘텐츠 영역안에서 직접 데이터를 출력하고 싶으면 다음과 같이 [[...]] 를 사용하면 된다.
컨텐츠 안에서 직접 출력하기 = [[${data}]]
@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 문서는 <,> 같은 특수 문자를 기반으로 정의된다.
Hello Spring! -> Hello <b>Spring! </b> 로 변경해보자.
- 웹 브라우저: Hello <b>Spring!</b>
- 소스보기 : Hello <b>Spring!</b>
HTML 엔티티
웹 브라우저 < 를 태그의 시작으로 인식. 이러한 이유 때문에 <를 태그 시작이 아닌 문자로 인식할 필요성이 있는데 이런게 바로 HTML 엔티티이다. HTML에서 사용하는 특수문자로 HTML 엔티티로 변경하는 것을 이스케이프라 함.
UnEscape
이스케이프를 사용하지 않기 위해 타임리프는 두가지 경우의 수를 제공한다.
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 cs 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>
변수 - SpringEL
타임리프에서 변수를 사용할 때는 변수 표현식을 사용한다.
변수 표현식: ${...}
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";
}User
@Data
static class User {
private String username;
private int age;
public User(String username, int age) {
this.username = username;
this.age = age;
}
}
<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>
SpringEL 다양한 표현식
Object
- user.username: user의 username을 프로퍼티 접근
- user['username] -> user.getUsername()과 같음
- user.getUsername() : user의 getUsername()을 직접 호출
List
- users[0].username: List에서 첫 번째 회원을 찾고 username 프로퍼티 접근 -> list.get(0).getUsername()
- users[0]['username'] : 위와 같음
- users[0].getUsername()
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}
${#response}
${#session}
${#servletContext}
${#locale}
locale빼고는 spring boot 3.0에서는 지원하지 않음.
스프링 부트 3.0이라면 직접 Model 객체에 추가해서 사용해야함.
- HTTP 요청 파라미터 접근: param
- 예) ${param.paramData}
- HTTP 세션 접근: session
- 예) ${session.sessionData}
- 스프링 빈 접근 : @
- 예) ${@helloBean.hello('Spring!')}
<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>
public String basicObjects(Model model, HttpServletRequest request, HttpServletReponse 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;
}
}
유틸리티 객체와 날짜
타임리프는 문자, 숫자, 날짜, URI등을 편리하게 다루는 다양한 유틸리티 객체들을 제공한다.
타임리프 유틸리티 객체들
- #message: 메시지, 국제화 처리
- #uris: URI 이스케이프 지원
- #dates: java.util.Date 서직지원
- #calendars: java.util.Calendar 서식 지원
- #temporals: 자바 8 날짜 서식 지원
- #numbers: 숫자 서식 지원
- #strings: 문자 관련 편의 기능제공
- #objects: 객체 관련 기능 제공
- #bools: boolean 관련 기능 제공
- #arrays: 배열 관련 기능 제공
- #lists, #sets, #maps: 컬렉션 관련 기능 제공
- #ids: 아이디 처리 관련 기능 제공
날짜 - temporals
<span th:text="${#temporals.format(localDateTime, 'yyy-MM-dd HH:mm:ss')}"> </span>
controller
@GetMapping("/calendar")
public String date(Model model){
model.addAtrribute("localDateTime", new LocalDateTime.now());
return "basic/date";
}
html
<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, 'yyy-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(localDatTime)}"></span></li>
<li>${#temporals.dayOfWeekNameShort(localDateTime)} = <span th:text="${#temporals.dayOfWeekNameShort(localDatTime)}"></span></li>
<li>${#temporals.hour(localDateTime)} = <span th:text="${#temporals.hour(localDatTime)}"></span></li>
<li>${#temporals.minute(localDateTime)} = <span th:text="${#temporals.minute(localDatTime)}"></span></li>
<li>${#temporals.nanosecond(localDateTime)} = <span th:text="${#temporals.nanosecond(localDatTime)}"></span></li>
</ul>
@GetMapping("/link")
Public String link(Model model) {
model.addAttribute("param1", "data1");
model.addAttribute("param2", "data2");
return "basic/link";
}
<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 varialbe + query parameter</a></li>
</ul>
단순한 URL
- @{/hello} -> /hello
쿼리 파라미터
- @{/hello(param1=${param1}, param2=${param2})}
- /hello?param1=data1¶m2=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,20는 숫자 리터럴이다.
String a = "Hello"
int a = 10 * 20
- 문자: 'hello'
- 숫자: 10
- 불린: true, false
- null: null
타임리프에서 문자 리터럴은 항상 '(작은 따옴표)로 감싸야한다.
<span th:text="'hello'">
@GetMapping("/literal")
public String literal(Model model) {
model.addAttribute("data", "Spring!!");
return "basic/literal";
}
<h1>리터럴</h1>
<ul>
<li>'hello' + ' world!' = <span th:text="'hello' + ' world!'"></span></li>
<li>'hello world!' = <span th:text="'hello world!'"></span></li>K
<li>'hello ' + ${data} = <span th:text="'hello ' + ${data}"></span></li>
<li>리터럴 대체 |hello ${data}| = <span th:text="|hello ${data}|"></span></li>
</ul>리터럴 대체(Literal substitutions)
<span th:text="|hello ${data}|">
@GetMapping("/operation")
public String operation(Model model) {
model.addAttribute("nullData", null);
model.addAttribute("data", "Spring!");
return "basic/operation";
}
<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 > 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>
- 비교연산: HTML 엔티티를 사용해야 하는 부분을 주의하자,
- >(gt), <(lt), >= (ge), <= (le) , !(not), ==(eq), !=(neq, ne)
- 조건식 자바의 조건식과 유사하다.
- Elvis 연산자: 조건식의 편의 버전
- No-Operation: _인 경우 마치 타임리프가 실행되지 않는 것처럼 동작함.
속성 값 설정 타임리프 태그 속성(Attribute)
타임리프는 주로 HTML 태그에 th:* 속성을 지정하는 방식으로 동작
<input type="text" name="mock" th:name="userA" />
<h1>속성 추가</h1>
- th:attrappend = <input type="text" class="text" th:attrappend="class='large'" /> <br/>
- th:attrappend = <input type="text" class="text" th:attrappend="class='large'"/> <br/>
- th:attrappend = <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/>
th:name="userA" -> name="userA"
th:attrappend 속성 값 뒤에 값을 추가
th:attrprepend 속성 값의 앞에 값을 추가
th:classappend: class 속성에 자연스럽게 추가
checked 처리 => checkd라는 속성이 있으면 체크가 됨 th:checked는 false인 경우 checked 속성 자체 제거
반복
@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);
}
<tr th:each="user : ${users}">
<td th:text="${user.username}"> username</td>
<td th:text="${user.age}">0</td>
</tr><tr th:each="user, userStat : ${users}">
<td th:text="${userStat.count}">user count</td>
<td th:text="${userStat.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 th:each="user : ${users}">
${users}에서 값 뽑아서 user태그에 담아준다.
th:each는 List, Iterable, Enumeration을 구현한 모든 객체를 반복 사용 가능, Map도 사용가능 한데 이때, Map.Entry
반복 상태 유지
<tr th:each="user, userStat : ${users}">
반복의 두번째 파라미터를 설정해서 반복의 상태를 확인
index` : 0부터 시작하는 값
count` : 1부터 시작하는 값
size` : 전체 사이즈
even` , `odd` : 홀수, 짝수 여부( `boolean` ) `
first` , `last` :처음, 마지막 여부( `boolean` )
current` : 현재 객체
조건부 평가
If, unless(if의 반대)
<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><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>
'Spring > 백엔드 웹 개발 활용 기술' 카테고리의 다른 글
| 스프링과 통합과 폼 (0) | 2024.05.20 |
|---|