[SpringMVC] 스프링 MVC - 웹 페이지 만들기

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술

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

강의를 들으며 생각 정리

 

 

프로젝트 생성

---

+) 참고 : 프로젝트 이름을 item-service로 했지만 Package name에는 가급적 특수기호가 들어가지 않는 것이 좋기 때문에 itemservice로 설정했다.

 

 

요구사항 분석

---

상품을 관리할 수 있는 서비스를 만들어보자.

 

<상품 도메인>

모델 상품 ID

상품명

가격

수량

 

<상품 관리 기능>

상품 목록

상품 상세

상품 등록

상품 수정

 

<서비스 흐름>

 

요구사항이 정리되었으니 이제 백엔드 개발을 진행한다.

<업무 방식 참고>

gksdudrb922.tistory.com/98

웹 서비스 - 업무 진행 방식

 

 

상품 도메인 개발

---

</domain/item/Item.java - 상품 객체>

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

+) 참고

롬복 사용시 @Data는 이런 핵심 도메인에서는 위험할 수 있다. (ex. @ToString - 양방향 연관관계 무한 루프)

@Getter, @Setter 혹은 @Getter 정도만 열어두는 것이 좋다. (Dto에서는 @Data를 조심히 사용해도 좋다)

 

</domain/item/itemRepository.java - 상품 저장소>

@Repository
public class ItemRepository {

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

    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 updateParam) {
        Item findItem = findById(itemId);
        findItem.setItemName(updateParam.getItemName());
        findItem.setPrice(updateParam.getPrice());
        findItem.setQuantity(updateParam.getQuantity());
    }

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

저장소는 정적 메모리 저장소를 사용하고, id 값을 위해 정적 변수 sequence를 사용한다.

+) 싱글톤을 사용하기 때문에 사용자 동시 접근을 고려하여 ConcurrentHashMap이나 AtomicLong을 사용하는 것이 좋다. (여기서는 간단히)

 

<상품 저장소 기능>

상품 저장

상품 조회

상품 목록

상품 수정

메모리 초기화 

+) 상품 목록의 경우 ArrayList로 한 번 감쌌는데 이는 중간에 store가 수정되는 등의 상황에 대해 안전하게 상품 목록을 반환해주기 위해서이다.

+) 상품 수정에서 setter를 세 번 사용했는데 사실 정석은 세 필드를 포함하는 Dto를 통해 수정 정보를 명확히 하는 것이 좋다.

 

-> 간단한 테스트를 통해 상품 저장소 기능이 정상 작동하는지 확인하자.

 

 

상품 서비스 HTML

---

핵심 비즈니스 로직을 개발하는 동안, 웹 퍼블리셔가 HTML 마크업을 완료했다고 하자. 이제 제공 받은 HTML 파일들을 경로에 넣고 잘 동작하는지 확인하면 된다.

 

<부트스트랩>

부트스트랩은 웹사이트를 쉽게 만들 수 있게 도와주는 HTML, CSS, JS 프레임워크다.

-> 부트스트랩을 다운로드 받는다.

이동: https://getbootstrap.com/docs/5.0/getting-started/download/

압축을 풀고 bootstrap.min.css를 복사해서 resources/static/ 폴더에 추가하자.

 

<HTML, CSS 파일>

/resources/static/css/bootstrap.min.css

/resources/static/html/items.html

/resources/static/html/item.html

/resources/static/html/addForm.html

/resources/static/html/editForm.html

-> 위 파일들을 제공받았다고 가정하자. 지금은 백엔드 개발에 집중하기 때문에 코드 상세 내용은 넘어간다.

(모든 코드는 깃허브에 올려두었다)

 

+) 참고

이렇게 정적 리소스가 공개되는 /resources/static 폴더에 HTML을 넣어두면, 실제 서비스에서도 공개된다. 어차피 해당 리소스들을 타임리프 템플릿으로 수정할 것이기 때문에 지금처럼 바로 공개할 필요 없는 HTML을 해당 폴더에 두는 것은 주의하자.

 

 

상품 목록 - 타임리프

---

본격적으로 컨트롤러와 뷰 템플릿을 개발해보자.

 

컨트롤러

</web/basic/BasicItemController.java>

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

<상품 저장소 사용>

컨트롤러는 상품 저장소를 사용하기 위해 itemRepository를 의존해야 한다. 이 때 롬복의 @RequiredArgsConstructor를 사용해서 의존관계 주입을 했다.

+) @RequiredArgsConstructor

final 키워드가 붙은 멤버변수만 사용해서 생성자를 자동으로 만들어준다.

public BasicItemController(ItemRepository itemRepository) {
 	this.itemRepository = itemRepository;
}

그리고 이렇게 생성자가 딱 1개만 있으면 스프링은 해당 생성자에 @Autowired로 의존관계를 주입해준다.

 

-> 의존관계 자동 주입 포스팅에서 '롬복' 부분 참고

gksdudrb922.tistory.com/22

의존관계 자동 주입

<상품 목록 조회>

먼저 상품 목록을 조회하는 기능을 개발한다.(/basic/items)

itemRepository에서 findAll()(모든 상품 조회)한 items 객체를 모델에 담은 뒤 뷰 템플릿을 호출한다.

 

<테스트용 데이터 추가>

테스트용 데이터를 추가하기 위해 빈 초기화 기능을 사용했다.

@PostConstruct : 해당 빈의 의존관계가 모두 주입되고 나면 초기화 용도로 호출된다.

 

-> 빈 생명주기 콜백 포스팅 참고

gksdudrb922.tistory.com/23?category=956531

빈 생명주기 콜백

 

뷰 템플릿

이제 items.html 정적 HTML 파일을 뷰 템플릿 영역으로 복사하고 다음과 같이 수정하자.

</resources/templates/basic/items.html>

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
    <link th:href="@{/css/bootstrap.min.css}"
            href="../css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
<div class="container" style="max-width: 600px">
    <div class="py-5 text-center">
        <h2>상품 목록</h2>
    </div>
    <div class="row">
        <div class="col">
            <button class="btn btn-primary float-end"
                    onclick="location.href='addForm.html'"
                    th:onclick="|location.href='@{/basic/items/add}'|"
                    type="button">상품 등록</button>
        </div>
    </div>
    <hr class="my-4">
    <div>
        <table class="table">
            <thead>
            <tr>
                <th>ID</th>
                <th>상품명</th>
                <th>가격</th>
                <th>수량</th>
            </tr>
            </thead>
            <tbody>
            <tr th:each="item : ${items}">
                <td><a href="item.html" th:href="@{/basic/items/{itemId}(itemId=${item.id})}" th:text="${item.id}">회원id</a></td>
                <td><a href="item.html" th:href="@{|/basic/items/${item.id}|}" th:text="${item.itemName}">상품명</a></td>
                <td th:text="${item.price}">10000</td>
                <td th:text="${item.quantity}">10</td>
            </tr>
            </tbody>
        </table>
    </div>
</div> <!-- /container -->
</body>
</html>

타임리프를 간단히 알아보자.

 

<타임리프 사용 선언>

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

 

<속성 변경 - th:href>

<link th:href="@{/css/bootstrap.min.css}"
            href="../css/bootstrap.min.css" rel="stylesheet">

타임리프 사용시 이렇게 html태그에 th를 추가하면 렌더링시 href="value1"을 th:href="value2" 값으로 변경한다.(value2가 있을 시)

즉, HTML을 그대로 볼 때는 href 속성이 사용되고, 뷰 템플릿을 거치면 th:href의 값이 href로 대체되면서 동적으로 변경할 수 있다.

-> 대부분의 HTML 속성을 th:xxx로 변경할 수 있다.

 

<타임리프 핵심>

핵심은 th:xxx가 붙은 부분은 서버사이드에서 렌더링 되고, 기존 것을 대체한다. th.xxx가 없으면 기존 html의 xxx 속성이 그대로 사용된다.

HTML을 파일로 직접 열었을 때는, th:xxx가 있어도 웹 브라우저는 th: 속성을 알지 못하므로 무시한다.

-> 따라서 HTML 파일 보기를 유지하면서 템플릿 기능도 사용할 수 있다.

 

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

<link th:href="@{/css/bootstrap.min.css}"
            href="../css/bootstrap.min.css" rel="stylesheet">

@{...} : 타임리프는 URL 링크를 사용하는 경우 @{...}를 사용한다.

 

+) 참고 : 자바에서 링크를 나타낼 때

1. 앞에 '/'가 붙는다 : host 뒤에 바로 주소를 붙인다.

ex.)

현재 resources/static/css/bootstrap.min.css에 파일을 불러와야 하는 상황

 

현재 파일 경로 : http://localhost:8080/basic/items.html

Link to /css/bootstrap.min.css -> localhost:8080/css/bootstrap.min.css

그리고 스프링 MVC는 이 경로를 받아서 resources/static/css/bootstrap.min.css를 반환한다.

 

2. 앞에 '/'가 붙지 않는다 : 현재 디렉토리에서 주소를 붙인다.

ex)

현재 URL : http://localhost:8080/basic/items.html

Link to css/bootstrap.min.css -> http://localhost:8080/basic/css/bootstrap.min.css

이런 파일은 존재하지 않기 때문에 불러올 수 없다.

 

대안 : ../css/bootstrap.min.css

이러면 http://localhost:8080/css/bootstrap.min.css 경로를 호출하게 되는데 이 역시 스프링 MVC가 경로를 받아

resources/static/css/bootstrap.min.css을 반한할 수 있게 된다.

 

<속성 변경 - th:onclick>

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

여기에는 다음에 설명하는 리터럴 대체 문법이 사용되었다.

 

<리터럴 대체 - |...|>

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

th:onclick="'location.href=' + '\'' + @{/basic/items/add} + '\''"

리터럴 대체 문법을 사용하면 다음과 같이 편리하게 사용할 수 있다.

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

 

<반복 출력 - th:each>

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

이렇게 하면 모델에 포함된 items 컬렉션 데이터가 item 변수에 하나씩 포함되고, 반복문 안에서 item 변수를 사용할 수 있다.

 

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

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

모델에 포함된 값이나, 타임리프 변수로 선언한 값을 조회할 수 있다.

프로퍼티 접근법을 사용한다 (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})}"

타임리프 문법을 사용하여 URL 링크 표현식에서 경로 변수 {itemId}를 사용했다.

경로 변수 뿐만 아니라 쿼리 파라미터도 생성 가능하다.

ex)

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

생성 링크: http://localhost:8080/basic/items/1?query=test

 

<URL 링크 간단히>

th:href="@{|/basic/items/${item.id}|}"

 

+) 참고

타임리프는 순수 HTML 파일을 웹 브라우저에서 열어도 내용을 확인할 수 있고, 서버를 통해 뷰 템플릿을 거치면 동적으로 변경된 결과를 확인할 수 있다.

JSP를 생각해보면, JSP 파일은 웹 브라우저에서 그냥 열면 JSP와 HTML이 섞여 있어 정상적인 확인이 불가능하다. 오직 서버를 통해서 JSP를 열어야 한다.

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

 

타임리프 기능들은 따로 정리해두었다.

 

 

상품 상세

---

상품 상세 컨트롤러와 뷰를 개발하자.

<BasicItemController.java에 추가>

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

@PathVariable을 사용한다.

 

상품 상세 뷰 템플릿을 제작한다.

-> 앞서 타임리프에 대해 다뤘기 때문에 참고해서 제작한다. 포스팅에서는 생략하겠다. (모든 코드는 깃허브에 있다.)

 

 

상품 등록 폼

---

<BasicItemController에 추가>

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

상품 등록 폼은 단순히 뷰 템플릿만 호출한다.

 

+) 타임리프 추가 기능 : 속성 변경 - th:action

HTML form에서 aciton에 값이 없으면 현재 URL에 데이터를 전송한다.

<form action="item.html" th:action method="post">

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

- 상품 등록 폼 : GET /basic/items/add

- 상품 등록 처리 : POST /basic/items/add

 

 

상품 등록 처리 - @ModelAttribute

---

이제 상품 등록 폼에서 전달된 데이터로 실제 상품 등록을 처리해보자.

상품 등록 폼은 다음 방식으로 서버에 데이터를 전달한다.

POST - HTML Form

content-type: application/x-www-form-urlencoded

 

itemName=itemA&price=10000&quantity=10

-> 요청 파라미터 형식을 처리해야 하므로 @RequestParam이나 @ModelAttribute를 사용한다.

 

<v1>

@PostMapping("/add")
public String addItemV1(@RequestParam String itemName,
                        @RequestParam Integer 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";
}

먼저 @RequestParam을 사용하는 방식이다.

요청 파라미터의 데이터들을 각각 받아 setter로 객체에 넣고 모델에 담아 뷰에 전달한다.

 

<v2>

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

    itemRepository.save(item);
 //        model.addAttribute("item", item); //자동 추가, 생략 가능

    return "/basic/item";
}

@ModelAttribute를 사용하는 방식이다.

- 요청 파라미터 처리

@ModelAttribute는 Item 객체를 생성하고 요청 파라미터의 값을 프로퍼티 접근법(setXxx)으로 입력해준다.

 

- Model 추가

@ModelAttribute는 중요한 한 가지 기능이 더 있는데, 바로 모델에 지정한 객체를 자동으로 넣어준다. 코드에서 model.addAttribute("item", item)가 주석처리 되어 있어도 잘 동작하는 것을 볼 수 있다.

-> 모델에 담는 이름은 @ModelAttribute(name)에서 name을 사용한다.

 

<v3>

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

@ModelAttribute의 이름을 생략할 수 있다.

+) 주의

이름을 생략하면 모델에 저장될 때 클래스명을 사용한다. 이 때 클래스의 첫글자만 소문자로 변경해서 등록한다.

ex)

@ModelAttribute Item item 

-> 모델 이름 : Item -> item

->  model.addAttribute("item", item)

 

<v4>

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

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

 

 

상품 수정

---

<BasicItemController.java에 추가>

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

GET /items/{itemId}/edit : 상품 수정 폼

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

 

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

@PathVariable의 경우 redirect시에도 사용할 수 있다 -> redirect:/basic/items/{itemId}

 

이처럼 GET, POST 방식을 쓰는 기능은 상품 등록과 상품 수정이 있다. 상품 수정은 리다이렉트를 쓰는 반면 왜 상품 등록은 리다이렉트를 사용하지 않았을까?

사실 다음에 설명할 PRG 기법을 위해 일부러 상품 등록에서는 리다이렉트를 사용하지 않았다. 이제 알아보자.

 

 

PRG Post/Redirect/Get

---

사실 지금까지 진행한 상품 등록 처리 컨트롤러는 심각한 문제가 있다. 상품 등록을 완료하고 웹 브라우저의 새로고침을 하면 상품이 계속 중복 등록되는 것을 확인할 수 있다.

 

<상품 등록 컨트롤러(POST)>

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

웹 브라우저의 새로 고침은 마지막에 서버에 전송한 데이터를 다시 전송한다.

상품 등록 폼에서 데이터를 입력하고 저장을 선택하면 POST /add + 상품 데이터를 서버로 전송한다.

이 상태에서 새로 고침을 또 선택하면 마지막에 전송한 POST /add + 상품 데이터를 서버로 다시 전송하게 된다.

그래서 내용은 같고 ID만 다른 상품 데이터가 계속 쌓이게 된다.

 

이 문제는 PRG 방식을 통해 해결한다. 

<상품 등록 컨트롤러(POST) - 수정>

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

상품 저장 후에 뷰 템플릿으로 이동하는 것이 아니라, 상품 상세 화면으로 리다이렉트를 호출해주면 된다.

웹 브라우저는 리다이렉트의 영향으로 상품 저장 후에 실제 상품 상세 화면으로 다시 이동한다. 따라서 마지막에 호출한 내용이 GET /basic/items/{itemId}가 되는 것이다.

-> 이후 새로고침을 해도 상품 상세 화면으로 이동하므로 새로 고침 문제를 해결할 수 있다.

 

+) 참고 : PRG 패턴을 사용하면 중복 호출을 상다이 많이 줄일 수 있지만, POST의 중복을 궁극적으로 막을 수는 없다.

(ex. POST 요청에 대한 응답이 늦어져 기다릴 때 새로고침하는 상황)

실제로는 서버에서 중복을 체크하도록 로직을 추가로 개발해야 한다.

 

RedirectAttributes

---

상품을 저장하고 리다이렉트 한 것까지는 좋았으나, 고객 입장에서 저장이 잘 된것인지 확신이 들지 않는다. 저장이 잘 되었으면 상품 상세 화면에 저장 메시지를 보여달라는 요구사항이 있다고 하자.

 

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

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

redirect:/basic/items/{itemId}

- pathVariable 바인딩: {itemId}

- 나머지는 쿼리 파라미터로 처리: ?status=true

 

이제 상품 상세 화면에서 status 파라미터가 true라면 저장 표시를 해줘야 한다.

-> 뷰 템플릿 item.html에 다음 코드를 추가한다.

<!-- 추가 -->
<h2 th:if="${param.status}" th:text="'저장 완료'"></h2>

th:if : 해당 조건이 참이면 실행

${param.status} : 타임리프에서 쿼리 파라미터를 편리하게 조회하는 기능

 

뷰 템플릿에 메시지를 추가하고 실행해보면 '저장 완료'라는 메시지가 나오는 것을 확인할 수 있다. 물론 상품 목록에서 상품 상세로 이동한 경우에는 해당 메시지가 출력되지 않는다.

 

상품 등록시 상세 화면

 

일반 상품 상세 화면