스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 4

Spring 정리 2022. 6. 3. 23:27

인프런 강의 43일차.

 - 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 1 (김영한 강사님)

 - 1편에서 배운 MVC를 활용할 수 있는 기술 습득

 - 타입 컨버터, 파일 업로드, 활용, 쿠키, 세션, 필터, 인터셉터, 예외 처리, 타임리프, 메시지, 국제화, 검증 등등

 

1.14 블록

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

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

  - hello.thymeleaf.basic.BasicController.java

  - 타임리프 블록 처리 메소드

 

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

  - resources.templates.basic.block.html

  - 타임리프 block 사용 html

 

  * 타임리프의 특성상 HTML 태그안에 속성으로 기능을 정의해서 사용하는데, 위 예처럼 애매한 경우에 사용하면 된다.

   - 1개의 div 안에 사용자 이름, 나이, 요약을 같이 표시하면 th:each로 한번에 표시가 가능하나 사용자가 (이름, 나이), (요약) 이렇게 div 2개로 구분해서 표시하고 싶은 경우 th:block을 통해서 반복시켜야 한다.

   - th:block은 렌더링시 제거된다 (th:each 만으로 해결이 어려운 경우에 사용)

 

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

  - block.html 실행 결과 HTML

 

1.15 자바스크립트 인라인

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

  - 자바스크립트 인라인 기능은 다음과 같이 적용하면 된다

<script th:inline="javascript">

 

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

  - hello.thymeleaf.basic.BasicController.java

  - 타임리프 자바스크립트 처리 메소드

 

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

  - resources.templates.basic.javascript.html

  - 타임리프 javascript 사용 html

 

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

<script>
    var username = userA;		//var username = "[[${user.username}]]"; 사용 시 "userA"로 렌더링됨(다만 개발자가 문자일 경우 매번 챙겨야하는 귀찮음이 생김)
    var age = 10;
    //자바스크립트 내추럴 템플릿
    var username2 = /*userA*/ "test username";
    //객체
    var user = BasicController.User(username=userA, age=10);	//객체.toString() 결과
</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가 변수명으로 사용되어서 자바스크립트 오류가 발생한다.

   - username 다음에 나오는 age의 경우에는 " 가 필요 없는 숫자이기 때문에 정상 렌더링 된다.

   - 인라인 사용 후 렌더링 결과를 보면 문자 타입인 경우 " 를 포함해준다.

   - 추가로 자바스크립트에서 문제가 될 수 있는 문자가 포함되어 있으면 이스케이프 처리도 해준다. 예) " \"

   - BasicController에서 new User("User\"A\"", 10)으로 생성 시 User에 "User\A\" 가 원하는 값임. 타임리프는 제대로 렌더링해서 처리해준다.

 

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

   - 타임리프는 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 -->
<script th:inline="javascript">
    [# th:each="user, stat : ${users}"]
    var user[[${stat.count}]] = [[${user}]];
    [/]
</script>

  - resources.templates.basic.javascript.html 추가

  - 타임리프 javascript 인라인 each 추가

 

  * 자바스크립트 인라인 each 결과

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

  - 반복문의 [[${stat.count}]]가 1,2,3으로 변환된다.

  - [[${user}]] 값이 JSON으로 할당된다.

 

1.16 템플릿 조각

  - 웹 페이지를 개발할 때는 공통 영역이 많이 있다. 이런 부분을 코드를 복사해서 사용한다면 변경시 여러 페이지를 다 수정해야 하므로 상당히 비효율 적이다. 타임리프는 이런 문제를 해결하기 위해 템플릿 조각과 레이아웃 기능을 지원한다.

 

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

  - hello.thymeleaf.basic.TemplateController.java

  - 타임리프 템플릿 처리 컨트롤러

 

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

  - resources.templates.template.fragement.footer.html 추가

  - 타임리프 공통 템플릿 footer 처리 HTML

  - th:fragment 가 있는 태그는 다른곳에 포함되는 코드 조각으로 이해하면 된다.

 

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

  - resources.templates.template.fragement.fragementMain.html 추가

  - 타임리프 공통 템플릿 처리 Main HTML

  - template/fragment/footer :: copy

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

 

  * footer.html 의 copy 부분

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

 

  * 부분 포함 insert

<h2>부분 포함 insert</h2>   <!-- insert는 div 태그 안에 가져온 값을 넣는 것 -->
<div th:insert="~{template/fragment/footer :: copy}"></div>

 - HTML 렌더링 결과 

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

 

  * 부분 포함 replace

<h2>부분 포함 replace</h2>  <!-- replace는 div 태그를 없애고 가져온 값을 넣는 것 -->
<div th:replace="~{template/fragment/footer :: copy}"></div>

  - HTML 렌더링 결과 

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

 

  * 부분 포함 단순 표현식

<h2>부분 포함 단순 표현식</h2>   <!-- 단순 표현식은 '~{}' 를 사용하지 않는 것. 복잡해지면 어차피 못 씀 -->
<div th:replace="template/fragment/footer :: copy"></div>

  - HTML 렌더링 결과

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

 

  * 파라미터 사용

<h1>파라미터 사용</h1>            <!-- 공통 소스 호출 시 파라미터를 사용할 수 있다 -->
<div th:replace="~{template/fragment/footer :: copyParam ('데이터1', '데이터2')}"></div>

  - HTML 렌더링 결과

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

 

  * footer.html 의 copyParam 부분

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

 

1.17 템플릿 레이아웃

  - 개념을 더 확장해서 코드 조각을 레이아웃에 넘겨서 사용하는 방법에 대해서 알아보자

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

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

  - hello.thymeleaf.basic.TemplateController.java 추가

  - 타임리프 레이아웃 처리 메소드

 

<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.base.html 추가

  - 타임리프 공통 레이아웃 처리 HTML

  - ${title}은 th:replace이므로 전달된 title 태그로 교체된다.

  - ${links}는 th:block th:replace 태그 부분에 교체된다.

 

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

  - resources.templates.template.layout.layoutMain.html 추가

  - 타임리프 공통 레이아웃 처리 Main HTML

  - common_header(~{::title},~{::link}) 이 부분이 핵심이다.

    > ::title 은 현재 페이지의 title 태그들을 전달한다. (HTML 태그를 바로 전달한다 <title>메인 타이틀</title>)

    > ::link 는 현재 페이지의 link 태그들을 전달한다.

 

  * 생성 결과 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>

  - 메인 타이틀이 전달한 부분으로 교체되었다

  - 공통 부분은 그대로 유지되고, 추가 부분에 전달한 들이 포함된 것을 확인할 수 있다

  - 앞서 배운 코드 조각을 조금 더 적극적으로 사용하는 방식이다. 쉽게 이야기해서 레이아웃 개념을 두고, 그 레이아웃에 필요한 코드 조각을 전달해서 완성하는 것으로 이해하면 된다

  - base는 하나의 거대한 레이아웃이고, layoutMain은 가변적으로 사용하고 싶은 리소스를 넘기는 페이지이다.

 

1.18 템플릿 레이아웃

  - 레이아웃을 <head> 외에 <html> 전체에 적용할 수 있다.

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

  - hello.thymeleaf.basic.TemplateController.java 추가

  - 타임리프 레이아웃 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.layoutExend.layoutFile.html 추가

  - 타임리프 공통 레이아웃 html 전체 처리 HTML

  - 내가 원하는 결과가 타이틀은 각 페이지마다 달라야하고, div 부분(컨텐츠 영역)만 변경되어야 하는 결과임.

 

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

  - resources.templates.template.layoutExtend.layoutExtendMain.html

  - 타임리프 공통 레이아웃 html 전체 처리 Main HTML

  - html 자체를 th:replace를 통해 전체를 교체해버리는데, 이 때 title과 section은 값으로 넘겨서 가변적으로 적용한다.

 

  * 생성 결과 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 로 변경한다.