Spring/MVC

[Spring MVC] 07. 스프링 MVC - 웹 페이지 만들기(타임리프, PRG, RedirectAttribute)

lumana 2024. 12. 26. 15:51

 

 

7. 스프링 MVC - 웹 페이지 만들기(타임리프, PRG, RedirectAttribute)


정리


Item - 상품 객체, Repository

@Data
public class Item {
    private Long id;
    private String itemName;
    private Integer price;
    private Integer quantity;

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

리포지토리 코드/테스트 코드는 생략


BasicItemController

@Controller
@RequestMapping("/basic/items")
@RequiredArgsConstructor
public class BasicItemController {
    private final ItemRepository itemRepository;

    @GetMapping
    public String items(Model model) {
        List<Item> items = itemRepository.findAll();
        model.addAttribute("items", items);
        return "basic/items";
    }

    /**
     * 테스트용 데이터 추가
     */
    @PostConstruct
    public void init() {
        itemRepository.save(new Item("testA", 10000, 10));
        itemRepository.save(new Item("testB", 20000, 20));
    }
}

테스트용 데이터 추가

  • 테스트용 데이터가 없으면 회원 목록 기능이 정상 동작하는지 확인하기 어렵다.
  • @PostConstruct: 해당 빈의 의존관계가 모두 주입되고 나면 초기화 용도로 호출된다.
  • 여기서는 간단히 테스트용 데이터를 넣기 위해서 사용했다.

타임리프로 SSR


타임리프 사용 선언

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

  • th:xxx=“value2”
    • 원래 존재하던 xxx 태그(xxx=“value1”) 를 th:xxx의 값으로 변경한다(“value2”)
    • 핵심은 th:xxx가 붙은 부분은 서버사이드에서 렌더링 되고, 기존 것을 대체한다. th:xxx가 없으면 기존 HTML의 xxx 속성이 그대로 사용된다.
    • HTML을 파일로 직접 열었을 때, th:xxx가 있어도 웹 브라우저는 th: 속성을 알지 못하므로 무시한다.
    • 따라서 HTML을 파일 보기를 유지하면서 템플릿 기능도 할 수 있다.

JSP와 비교했을 때 HTML 코드가 오염되지 않는다는 것이 큰 특징이다. 이렇게 순수 HTML을 그대로 유지하면서 뷰 템플릿도 사용할 수 있는 타임리프의 특징을 네츄럴 템플릿(natural templates)이라 한다.


속성 변경 - th:href

th:href="@{/css/bootstrap.min.css}"

원래 경로는 ../css/bootstrap.min.css로 상대 경로였다. 하지만 타임리프를 통해 절대 경로로 치환하여 모든 곳에서 css 파일을 사용할 수 있도록 변경하였다.



URL 링크 표현식 - @{...}

th:href="@{/css/bootstrap.min.css}"


  • @{...}: 타임리프는 URL 링크를 사용하는 경우 @{...}를 사용한다. 이것을 URL 링크 표현식이라 한다.
  • URL 링크 표현식을 사용하면 서블릿 컨텍스트를 자동으로 포함한다.
    • 과거에는 Application을 WAR로 빌드해서 외부 톰캣 서버에 띄웠다. 그래서 Application마다 서블릿 컨텍스트가 존재했었다. 이 때 이 Application의 서블릿 컨텍스트를 포함하는 듯.

상품 등록 폼으로 이동

속성 변경 - th:onclick


  • onclick="location.href='addForm.html'"
  • th:onclick="|location.href='@{/basic/items/add}’|”

리터럴 대체 - |...|


|...| 이렇게 사용한다.


타임리프에서 문자와 표현식 등은 분리되어 있기 때문에 더해서 사용해야 한다.

<span th:text="'Welcome to our application, ' + ${user.name} + '!'">

다음과 같이 리터럴 대체 문법을 사용하면, 더하기 없이 템플릿 치환하듯이 편리하게 사용할 수 있다.

<span th:text="|Welcome to our application, ${user.name}!|">

반복 출력 - th:each

<tr th:each="item : ${items}">

  • 반복은 th:each를 사용한다. 이렇게 하면 모델에 포함된 items 컬렉션 데이터가 item 변수에 하나씩 포함되고, 반복문 안에서 item 변수를 사용할 수 있다.
  • 컬렉션의 수 만큼 <tr>..</tr>이 하위 태그를 포함해서 생성된다.


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

<td th:text="${item.price}">10000</td>

  • 모델에 포함된 값이나, 타임리프 변수로 선언한 값을 조회할 수 있다.
    • (<tr th:each="item : ${items}">) 여기서 item이 타임리프 변수로 선언한 값이다.
  • 프로퍼티 접근법을 사용한다. (item.getPrice())


내용 변경 - th:text


<td th:text="${item.price}">10000</td>
  • 내용의 값을 th:text의 값으로 변경한다.
  • 여기서는 10000을 ${item.price}의 값으로 변경한다.


URL 링크 표현식2 - @{...}


th:href="@{/basic/items/{itemId}(itemId=${item.id})}"

  • 상품 ID를 선택하는 링크를 확인해보자.
  • URL 링크 표현식을 사용하면 경로를 템플릿처럼 편리하게 사용할 수 있다.
  • 경로 변수 ({itemId}) 뿐만 아니라 쿼리 파라미터도 생성한다.

예)

th:href="@{/basic/items/{itemId}(itemId=${item.id}, query='test')}"


이를 위에서 봤던 리터럴 대체 문법을 통해 간단하게 나타낼 수 있다.
th:href="@{|/basic/items/${item.id}|}"



속성 변경 - th:action

  • th:action
  • HTML form에서 action에 값이 없으면 현재 URL에 데이터를 전송한다.
  • 상품 등록 폼의 URL과 실제 상품 등록을 처리하는 URL을 똑같이 맞추고 HTTP 메서드로 두 기능을 구분한다.
    • 상품 등록 폼: GET /basic/items/add
    • 상품 등록 처리: POST /basic/items/add
  • 이렇게 하면 하나의 URL로 등록 폼과, 등록 처리를 깔끔하게 처리할 수 있다.


상품 등록 처리 - @ModelAttribute

@PostMapping("/add")
public String addItemV2(@ModelAttribute("item") Item item, Model model) {
    itemRepository.save(item);
    //model.addAttribute("item", item); //자동 추가, 생략 가능
    return "basic/item";
}


@ModelAttribute - Model 추가
@ModelAttribute는 중요한 한가지 기능이 더 있는데, 바로 Model에 @ModelAttribute로 지정한 객체를 자동으로 넣어준다. 지금 코드를 보면 model.addAttribute("item", item)가 주석처리 되어 있어도 잘 동작하는 것을 확인할 수 있다.


ModelAttribute로 받은 객체는 view에서 다시 사용할 확률이 높기 때문에 자동으로 model에 넣어주는 것이다. Model에는 key-value로 저장하는데, key로는 @ModelAttribute(“item”)에서 지정한 “item”이, 그리고 value 객체로는 ModelAttribute의 대상이 되는 item 객체가 들어간다. 만약 @ModelAttribute(“item2”)라면 item 객체의 key는 “item2”가 된다.


어? 그런데 “item”은 생략할 수 있는데요?
V3에서 설명한다.



addItemV3 - 상품 등록 처리 - ModelAttribute 이름 생략

@PostMapping("/add")
public String addItemV3(@ModelAttribute Item item) {
    itemRepository.save(item);
    return "basic/item";
}

아까 말했던 것 처럼 @ModelAttribute의 이름을 생략할 수 있다. 이 때 item 객체의 key로는 어떤 규칙에 따라 사용될까?


객체 이름을 따라갈 것 같지만, ModelAttribute의 대상이 되는 타입이 Item 클래스이다. 클래스 이름의 첫 글자만 소문자로 바꿔서 key로 사용된다. 객체의 이름으로 key가 사용될 것이라고 헷갈리지 말자.


  • model.addAttribute("item", item); 자동 추가, 생략가능
  • modelAttirbute 는 view 지정한 이름(여기서 item)을 모델로 넣어준다.
  • 이름 지정을 안해주면 클래스명을 첫글자만 소문자로 바꿔준다 (Item item)
  • HelloData helloData 바뀐게 @ModelAttribute 에 담기게 된다.

물론, @ModelAttribute 자체도 생략 가능하다.



상품 수정 개발

@PostMapping("/{itemId}/edit")
public String edit(@PathVariable Long itemId, @ModelAttribute Item item) {
    itemRepository.update(itemId, item);
    return "redirect:/basic/items/{itemId}";
}

상품 수정은 상품 등록과 전체 프로세스가 유사하다.

  • GET /items/{itemId}/edit: 상품 수정 폼
  • POST /items/{itemId}/edit: 상품 수정 처리

리다이렉트


상품 수정을 마지막에 뷰 템플릿을 호출하는 대신에 상품 상세 화면으로 이동하도록 리다이렉트를 호출한다.

  • 스프링은 redirect:/...으로 편리하게 리다이렉트를 지원한다.
  • redirect:/basic/items/{itemId}
    • 컨트롤러에 매핑된 @PathVariable의 값은 리다이렉트에도 사용할 수 있다.
    • redirect:/basic/items/{itemId} {itemId}는 @PathVariable Long itemId의 값을 그대로 사용한다.

PRG Post/Redirect/Get


지금까지 진행한 상품 등록 처리 컨트롤러는 심각한 문제가 있다. (addItemV1 ~ addItemV4)
상품 등록을 완료하고 웹 브라우저의 새로고침 버튼을 클릭하면 상품이 계속해서 중복 등록된다. 이미 Post의 결과물로 아이템 상세 페이지가 나왔는데 왜 그럴까?



웹 브라우저의 새로 고침은 마지막에 서버에 전송한 데이터를 다시 전송한다.
상품 등록 폼에서 데이터를 입력하고 저장을 선택하면 POST /add + 상품 데이터를 서버로 전송한다.
이 상태에서 새로 고침을 또 선택하면 마지막에 전송한 POST /add + 상품 데이터를 서버로 다시 전송하게 된다. 그래서 내용은 같고, ID만 다른 상품 데이터가 계속 쌓이게 된다.


어떻게 해결할 수 있을까? POST하고 새로고침 하기 전에 클라이언트에서 다른 동작을 해서 새로고침시에 POST가 나가지 않도록 해보자.


POST, Redirect GET


리다이렉트 : 웹브라우저 입장에서 새로운 요청을 하는 것


웹 브라우저의 새로 고침은 마지막에 서버에 전송한 데이터를 다시 전송한다.
새로 고침 문제를 해결하려면 상품 저장 후에 뷰 템플릿으로 이동하는 것이 아니라, 상품 상세 화면으로 리다이렉트를 호출해주면 된다.
웹 브라우저는 리다이렉트의 영향으로 상품 저장 후에 실제 상품 상세 화면으로 다시 이동한다.
따라서 마지막에 호출한 내용이 상품 상세 화면인 GET /items/{id}가 되는 것이다.


@PostMapping("/add")
public String addItemV5(Item item) {
    itemRepository.save(item);
    return "redirect:/basic/items/" + item.getId();
}

이러한 방식으로 POST후 리다이렉트 시키는 방식을 PRG(Post-Redirect-Get) 패턴이라고 부릅니다.


주의

"redirect:/basic/items/" + item.getId() redirect에서 +item.getId()처럼 URL에 변수를 더해서 사용하는 것은 URL 인코딩이 안되기 때문에 위험하다. 다음에 설명하는RedirectAttributes를 사용하자.


RedirectAttributes

저장이 잘 되었으면 상품 상세 화면에 "저장되었습니다"라는 메시지를 보여지게 만들어보자.
이렇게 하기 위해서는 Post가 완료되고 리다이렉트 시킬 때 저장이 되었다는 정보를 클라이언트에게 내려줘 해당 정보를 가지고 저장이 성공했음을 보여줘야 한다.


@PostMapping("/add")
public String addItemV6(Item item, RedirectAttributes redirectAttributes) {
    Item savedItem = itemRepository.save(item);
    redirectAttributes.addAttribute("itemId", savedItem.getId());
    redirectAttributes.addAttribute("status", true);
    return "redirect:/basic/items/{itemId}";
}

이 예제에서는 리다이렉트 할 때 간단히 status=true를 추가했다.


실행해보면 다음과 같은 리다이렉트 결과가 나온다.
http://localhost:8080/basic/items/3?status=true


RedirectAttributes

RedirectAttributes를 사용하면 URL 인코딩도 해주고, pathVariable, 쿼리 파라미터까지 처리해준다.

  • redirect:/basic/items/{itemId}
    • pathVariable 바인딩: {itemId}
    • 나머지는 쿼리 파라미터로 처리: ?status=true

클라이언트에서는 어떻게 처리할까?

<div class="container">
    <div class="py-5 text-center">
        <h2>상품 상세</h2>
    </div>
    <!-- 추가 -->
    <h2 th:if="${param.status}" th:text="'저장 완료!'"></h2>
</div> <!-- /container -->

  • th:if: 해당 조건이 참이면 실행
  • ${param.status}: 타임리프에서 쿼리 파라미터를 편리하게 조회하는 기능
    • 원래는 컨트롤러에서 모델에 직접 담고 값을 꺼내야 한다. 그런데 쿼리 파라미터는 자주 사용해서 타임리프에서 직접 지원한다.

Ref) 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 강의 | 김영한 - 인프런

'Spring > MVC' 카테고리의 다른 글

[Spring MVC] 08. 타임리프 기본기능  (0) 2024.12.27
[Spring/MVC] WebMvcConfigurer  (0) 2024.12.24
[Spring MVC] 06. 스프링 MVC - 기본 기능  (0) 2024.11.24
[Spring MVC] 05. 스프링 MVC - 구조 이해  (0) 2024.11.21
[Spring MVC] 04. MVC 프레임워크 만들기  (0) 2024.11.20

'Spring/MVC'의 다른글

  • 현재글[Spring MVC] 07. 스프링 MVC - 웹 페이지 만들기(타임리프, PRG, RedirectAttribute)

관련글

티스토리툴바