[Spring-MVC] 웹 페이지 만들기

나영·2023년 8월 9일
MVCSpring

Spring-MVC

목록 보기
7/7
post-thumbnail

상품 관리 웹 페이지를 만들어보자. 😎

요구사항 분석

상품 도메인 모델

  • 상품 ID
  • 상품명
  • 가격
  • 수량

상품 관리 기능

  • 상품 목록

  • 상품 상세

  • 상품 등록

  • 상품 수정

서비스 제공 흐름

상품 도메인 개발

Item - 상품 객체

import lombok.Data;

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

    }

}

ItemRepository - 상품 저장소

@Repository
public class ItemRepository {

    private static final Map<Long, Item> store = new HashMap<>();
    private static long sequence = 0L;

    public Item save(Item item) {
        item.setId(++sequence);
        store.put(item.getId(), item);
        return item;
    }

    public Item findById(Long id) {
        return store.get(id);
    }

    public List<Item> findAll() {
        return new ArrayList<>(store.values());
    }

    public void update(Long itemId, Item updateItem) {
        Item findItem = findById(itemId);
        findItem.setItemName(updateItem.getItemName());
        findItem.setPrice(updateItem.getPrice());
        findItem.setQuantity(updateItem.getQuantity());
    }

    public void clearStore() {
        store.clear();
    }

}

ItemRepositoryTest - 상품 저장소 테스트

class ItemRepositoryTest {

    ItemRepository itemRepository = new ItemRepository();

    @AfterEach
    void afterEach() {
        itemRepository.clearStore();
    }

    @Test
    void save() {
        // given
        Item item = new Item("itemA", 10000, 10);

        // when
        Item savedItem = itemRepository.save(item);

        // then
        Item findItem = itemRepository.findById(item.getId());
        assertThat(findItem).isEqualTo(savedItem);
    }

    @Test
    void findAll() {
        // given
        Item item1 = new Item("item1", 10000, 10);
        Item item2 = new Item("item2", 10000, 20);

        itemRepository.save(item1);
        itemRepository.save(item2);

        // when
        List<Item> result = itemRepository.findAll();

        // then
        assertThat(result.size()).isEqualTo(2);
        assertThat(result).contains(item1, item2);
    }

    @Test
    void updateItem() {
        // given
        Item item = new Item("item1", 10000, 10);

        Item savedItem = itemRepository.save(item);
        Long itemId = savedItem.getId();

        // when
        Item updateParam = new Item("item2", 20000, 30);
        itemRepository.update(itemId, updateParam);

        Item findItem = itemRepository.findById(itemId);

        // then
        assertThat(findItem.getItemName()).isEqualTo(updateParam.getItemName());
        assertThat(findItem.getPrice()).isEqualTo(updateParam.getPrice());
        assertThat(findItem.getQuantity()).isEqualTo(updateParam.getQuantity());
    }
}

상품 서비스 HTML

  1. 상품 목록 폼
  2. 상품 상세 폼
  3. 상품 등록 폼
  4. 상품 수정 폼

4가지의 정적 리소스 를 작성해본다. /resources/static 경로에 !

상품 목록 - 타임리프

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("itemA", 10000, 10));
        itemRepository.save(new Item("itemB", 20000, 20));
    }
}

사용 선언

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

속성 변경

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

  • href="value1" -> th:href="value2"
  • 타임리프 뷰 템플릿을 거치면 th:href 의 값이 href 로 대체되면서 동적으로 변경할 수 있다.
  • 대부분의 html 속성은 th:xxx 로 변경할 수 있다.

타임리프 핵심

  • th:xxx 가 붙은 부분은 서버사이드에서 렌더링되고, 기존 것을 대체한다. 이것이 없으면 기존 html 속성이 그대로 사용된다.
  • HTML 파일을 직접 열었을 때, th:xxx 가 있어도 웹 브라우저는 th: 속성을 알지 못하므로 무시한다.
  • 따라서 HTML을 파일 보기를 유지하면서 템플릿 기능도 할 수 있다.

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

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

  • URL 링크 표현식 : 타임리프는 URL 링크를 사용하는 경우 @{...} 를 사용한다.
  • URL 링크 표현식 -> 서블릿 컨텍스트를 자동으로 포함한다.

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

  • 상품 ID 를 선택하는 링크이다.
  • 경로변수 뿐 아니라 쿼리 파라미터도 생성할 수 있다.
    ex ) th:href="@{/basic/items/{itemId}(itemId=${item.id}, query='test')}"

-> 리터럴 문법 써서 간단히 하면 th:href="@{|/basic/items/${item.id}|}"

속성 변경 - th:onclick

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

리터럴 대체 - |...|

리터럴 대체 문법을 사용하면 문자와 표현식을 같이 사용할 수 있다.
<span th:text="|Welcome to our application, ${user.name}!|">

반복 출력 - th:each

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

  • items 컬렉션 데이터가 item 변수에 하나씩 포함되고, 반복문 안에서 item 변수를 사용할 수 있다.
  • 컬렉션의 수만큼 <tr>...</tr> 이 하위 테그를 포함해 생성된다.

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

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

  • 모델에 포함된 값이나 타임리프 변수로 선언한 값을 조회할 수 있다.
  • 프로퍼티 접근법을 사용한다. (item.getPrice())

내용 변경 - th:text

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

  • 내용의 값을 th:text 로 변경한다.

⭐ 참고

타임리프는 순수 HTML 파일을 웹 브라우저에서 열어도 내용을 확인할 수 있고, 서버를 통해 뷰 템플릿을 거치면 동적으로 변경된 결과를 확인할 수 있다.
JSP 의 경우, 웹 브라우저에서 열면 HTML 과 JSP 소스코드가 뒤죽박죽이어서 오직 서버를 통해서 JSP 를 열어야 한다.


-> 순수 HTML 그대로 유지하면서 뷰 템플릿도 사용할 수 있는 타임리프의 특징을 내츄럴 템플릿 (natural templates) 이라 한다.

상품 상세

BasicItemController에 추가

@GetMapping("/{itemId}")
    public String item(@PathVariable Long itemId, Model model) {
        Item item = itemRepository.findById(itemId);
        model.addAttribute("item", item);
        return "basic/item";
    }

PathVariable 로 넘어온 상품 ID 로 상품을 조회하고, 모델에 담아둔다. 그리고 뷰 템플릿을 호출한다.

HTML에 타임리프 적용

  • 속성 변경 - th:value
    th:value="${item.id}"

  • 상품 수정 링크
    th:onclick="|location.href='@{/basic/items/{itemId}/edit(itemId=${item.id})}'|"

  • 목록으로 링크
    th:onclick="|location.href='@{/basic/items/{itemId}/edit(itemId=${item.id})}'|"

상품 등록 폼

BasicItemController에 추가

@GetMapping("/add")
  public String addForm() {
   	return "basic/addForm";
  }

HTML에 타임리프 적용

상품 등록 폼의 URL과 실제 상품 등록을 처리하는 URL 을 똑같이 맞추고 HTTP 메서드로 두 기능을 구분한다.

  1. 상품 등록 폼 : GET /basic/items/add
  2. 상품 등록 처리 : POST /basic/items/add

상품 등록 처리

상품 등록 폼은 메시지 바디에 쿼리 파라미터 형식으로 전달해 서버로 데이터를 전달하게 된다.
ex ) itemName=itemA&price=10000&quantity=10

요청 파라미터 형식을 처리해야 하므로 @RequestParam 을 사용해보자.

@RequestParam

@PostMapping("/add")
public String addItemV1(
	@RequestParam String itemName, 
    @RequestParam int price,
 	@RequestParam Integer quantity,
 	Model model) {
    
 Item item = new Item();
 item.setItemName(itemName);
 item.setPrice(price);
 item.setQuantity(quantity);
 
 itemRepository.save(item);
 model.addAttribute("item", item);
 
 return "basic/item";
}

itemName 요청 파라미터 데이터를 해당 변수에 받고, Item 객체를 생성한 후 itemRepository 를 통해 저장한다.
저장된 item 을 모델에 담에 뷰에 전달한다.

@ModelAttribute

@PostMapping("/add")
public String addItemV2(@ModelAttribute("item") Item item, Model model) {

    itemRepository.save(item);

    // model.addAttribute("item", item);

    return "basic/item";
}

/**
 * @ModelAttribute name 생략 가능
 * model.addAttribute(item); 자동 추가, 생략 가능
 * 생략시 model에 저장되는 name은 클래스명 첫글자만 소문자로 등록 Item -> item
 */
@PostMapping("/add")
public String addItemV3(@ModelAttribute Item item, Model model) {

    itemRepository.save(item);

    // model.addAttribute("item", item);

    return "basic/item";
}

/**
 * @ModelAttribute 자체 생략 가능
 * model.addAttribute(item) 자동 추가
 */
@PostMapping("/add")
public String addItemV4(Item item) {

    itemRepository.save(item);

    // model.addAttribute("item", item);

    return "basic/item";
}

상품 수정

BasicItemController 에 추가

	@GetMapping("/{itemId}/edit")
    public String editForm(@PathVariable Long itemId, Model model) {
        Item item = itemRepository.findById(itemId);
        model.addAttribute("item", item);
        return "basic/editForm";
    }

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

        return "redirect:/basic/items/{itemId}";
    }

리다이렉트 - redirect:/..

상품 수정 후 상품 상세 화면으로 이동하도록 redirect를 호출한다.

redirect:/basic/items/{itemId}

컨트롤러에 매핑된 @PathVariable 의 값은 redirect 에도 사용 할 수 있다. 여기서 {itemId} 는 @PathVariable Long itemId 의 값을 그래도 사용한다.

PRG - Post, Redirect, Get

기존 문제

지금까지 개발한 방식의 문제점은 ?
-> 상품 등록 완료 후 새로 고침 버튼을 누르면 상품이 계속해서 중복 등록된다는 점 !!

웹 브라우저의 새로 고침은 마지막에 서버에 전송한 데이터를 다시 전송하는 것이기 때문에, 상품 등록 폼에서 데이터를 입력 후 저장하면 POST /add 상품 데이터를 서버로 전송한다.
이 상태에서 새로 고침을 또 하면, 마지막에 전송한 POST /add 상품 데이터가 또 서버로 전송돼 내용은 같고, ID 만 다른 상품 데이터가 쌓이게 되는것이다.

문제 해결 - redirect

새로 고침 문제 해결을 위해서는 상품 저장 후에 바로 뷰 템플릿으로 이동하는 게 아니라, 상품 상세 화면으로 리다이렉트를 호출해주면 된다.
웹 브라우저는 마지막에 호출한 내용이 상품 상세 화면인 GET /items/{id} 가 되므로 새로 고침을 계속 해도 상세 화면으로 이동하게 돼 기존 문제를 해결할 수 있다.

BasicItemController 에 추가

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

RedirectAttributes

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

따라서 RedirectAttributes 를 사용해보고, 사용자에게 저장 완료 메시지를 띄워보자.

BasicItemController에 추가

@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 를 사용하면 URL 인코딩도 해주고, pathVariable, 쿼리 파라미터까지 처리해준다.

redirect:/basic/items/{itemId}

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

뷰 템플릿 메시지 추가

item.html 상세화면에 메시지를 출력해보자. 

<!--저장 완료 메시지 보이기 -->
    <h2 th:if="${param.status}" th:text="저장 완료!"></h2>
  • th:if를 통해 해당 조건이 참이면 실행한다
  • ${param.status} : 타임리프에서 쿼리 파라미터를 쉽게 조회하는 기능

이제 상품 등록 후 실행하면 저장 완료! 메시지를 볼 수 있다. 😁

profile
나영
이전 포스트

[Spring-MVC] 스프링 MVC 기본 기능

0개의 댓글