Merge pull request #842 from prgrms-be-devcourse/changhyeon/w3-1

[4기 - 황창현] Week 3-1 Thymeleaf를 이용하여 바우처 관리페이지 구현, ControllerAdvice를 통한 예외 처리

Author: Hchanghyeon

README.md

@@ -63,3 +63,23 @@ Type list to list all vouchers.
 - [x] 고객이 어떤 바우처를 보유하고 있는지 조회할 수 있어야 합니다.
 - [x] 고객이 보유한 바우처를 제거할 수 있어야 합니다.
 - [x] 특정 바우처를 보유한 고객을 조회할 수 있어야 합니다.
+
+### 3주차 미션
+
+**3-1**
+
+- [x] Spring MVC를 적용해서 thymeleaf 템플릿을 설정해보세요.
+- [x] 커맨드로 지원했던 기능을 thymeleaf를 이용해서 관리페이지를 만들고 다음 기능을 지원가능하게 해보세요
+    - [x]  조회페이지
+    - [x]  상세페이지
+    - [x]  입력페이지
+    - [x]  삭제기능
+
+**3-2**
+
+- [ ] Spring MVC를 적용해서 JSON과 XML을 지원하는 REST API를 개발해보세요
+    - [ ]  전체 조회기능
+    - [ ]  조건별 조회기능 (바우처 생성기간 및 특정 할인타입별)
+    - [ ]  바우처 추가기능
+    - [ ]  바우처 삭제기능
+    - [ ]  바우처 아이디로 조회 기능

build.gradle

@@ -19,6 +19,9 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     implementation 'org.springframework.boot:spring-boot-starter-jdbc'
+    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    implementation 'org.springframework.boot:spring-boot-starter-validation'
 
     runtimeOnly 'com.h2database:h2'
 

src/main/java/com/programmers/springweekly/controller/CustomErrorController.java

@@ -0,0 +1,31 @@
+package com.programmers.springweekly.controller;
+
+import jakarta.servlet.RequestDispatcher;
+import jakarta.servlet.http.HttpServletRequest;
+import org.springframework.boot.web.servlet.error.ErrorController;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.GetMapping;
+
+@Controller
+public class CustomErrorController implements ErrorController {
+
+    // ControllerAdvice로 처리되지 않는 서블릿 수준의 예외와 404 에러 처리
+    @GetMapping("/error")
+    public String errorThrow(HttpServletRequest httpServletRequest, Model model) {
+        Integer errorStatusCode = (Integer) httpServletRequest.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
+        String errorMessage = (String) httpServletRequest.getAttribute(RequestDispatcher.ERROR_MESSAGE);
+
+        model.addAttribute("errorCode", errorStatusCode);
+
+        if (errorStatusCode == 404) {
+            model.addAttribute("errorMsg", "요청하신 페이지를 찾을 수 없습니다.");
+            return "errorPage";
+        }
+
+        model.addAttribute("errorMsg", errorMessage);
+
+        return "errorPage";
+    }
+
+}

src/main/java/com/programmers/springweekly/controller/CustomerViewController.java

@@ -0,0 +1,65 @@
+package com.programmers.springweekly.controller;
+
+import com.programmers.springweekly.dto.customer.request.CustomerCreateRequest;
+import com.programmers.springweekly.dto.customer.response.CustomerListResponse;
+import com.programmers.springweekly.dto.customer.response.CustomerResponse;
+import com.programmers.springweekly.service.CustomerService;
+import jakarta.validation.Valid;
+import java.util.UUID;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+
+@Controller
+@RequiredArgsConstructor
+@RequestMapping("/view/customer")
+public class CustomerViewController {
+
+    private final CustomerService customerService;
+
+    @GetMapping
+    public String getMenuPage() {
+        return "customer/menu";
+    }
+
+    @GetMapping("/save")
+    public String getCreatePage() {
+        return "customer/create";
+    }
+
+    @PostMapping("/save")
+    public String save(@Valid CustomerCreateRequest customerCreateRequest) {
+        customerService.save(customerCreateRequest);
+
+        return "customer/menu";
+    }
+
+    @GetMapping("/findAll")
+    public String getFindAllPage(Model model) {
+        CustomerListResponse customerListResponse = customerService.findAll();
+        model.addAttribute("customerList", customerListResponse.getCustomerList());
+
+        return "customer/findAll";
+    }
+
+    @GetMapping("/find/{id}")
+    public String findById(@PathVariable("id") UUID customerId, Model model) {
+        CustomerResponse customerResponse = customerService.findById(customerId);
+        model.addAttribute("customer", customerResponse);
+
+        return "customer/find";
+    }
+
+    @DeleteMapping("/delete/{id}")
+    public String deleteById(@PathVariable("id") UUID customerId) {
+        customerService.deleteById(customerId);
+
+        return "redirect:/view/customer/find";
+    }
+
+}

src/main/java/com/programmers/springweekly/controller/HomeController.java

@@ -0,0 +1,13 @@
+package com.programmers.springweekly.controller;
+
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+
+@Controller
+public class HomeController {
+    
+    @GetMapping("/")
+    public String home() {
+        return "home";
+    }
+}

src/main/java/com/programmers/springweekly/controller/VoucherController.java

@@ -19,7 +19,7 @@ public class VoucherController {
     public void save(VoucherCreateRequest voucherCreateRequest) {
         VoucherValidator.validateVoucher(
                 voucherCreateRequest.getVoucherType(),
-                String.valueOf(voucherCreateRequest.getDiscountAmount())
+                voucherCreateRequest.getDiscountAmount()
         );
 
         voucherService.save(voucherCreateRequest);
@@ -28,7 +28,7 @@ public void save(VoucherCreateRequest voucherCreateRequest) {
     public void update(VoucherUpdateRequest voucherUpdateRequest) {
         VoucherValidator.validateVoucher(
                 voucherUpdateRequest.getVoucherType(),
-                String.valueOf(voucherUpdateRequest.getDiscountAmount())
+                voucherUpdateRequest.getDiscountAmount()
         );
 
         voucherService.update(voucherUpdateRequest);

src/main/java/com/programmers/springweekly/controller/VoucherViewController.java

@@ -0,0 +1,71 @@
+package com.programmers.springweekly.controller;
+
+import com.programmers.springweekly.dto.voucher.request.VoucherCreateRequest;
+import com.programmers.springweekly.dto.voucher.response.VoucherListResponse;
+import com.programmers.springweekly.dto.voucher.response.VoucherResponse;
+import com.programmers.springweekly.service.VoucherService;
+import com.programmers.springweekly.util.validator.VoucherValidator;
+import jakarta.validation.Valid;
+import java.util.UUID;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+
+@Controller
+@RequiredArgsConstructor
+@RequestMapping("/view/voucher")
+public class VoucherViewController {
+
+    private final VoucherService voucherService;
+
+    @GetMapping
+    public String getMenuPage() {
+        return "voucher/menu";
+    }
+
+    @GetMapping("/save")
+    public String getCreatePage() {
+        return "voucher/create";
+    }
+
+    @PostMapping("/save")
+    public String save(@Valid VoucherCreateRequest voucherCreateRequest) {
+        VoucherValidator.validateVoucher(
+                voucherCreateRequest.getVoucherType(),
+                voucherCreateRequest.getDiscountAmount()
+        );
+
+        voucherService.save(voucherCreateRequest);
+
+        return "voucher/menu";
+    }
+
+    @GetMapping("/findAll")
+    public String getFindAllPage(Model model) {
+        VoucherListResponse voucherListResponse = voucherService.findAll();
+        model.addAttribute("voucherList", voucherListResponse.getVoucherList());
+
+        return "voucher/findAll";
+    }
+
+    @GetMapping("/find/{id}")
+    public String findById(@PathVariable("id") UUID voucherId, Model model) {
+        VoucherResponse voucherResponse = voucherService.findById(voucherId);
+        model.addAttribute("voucher", voucherResponse);
+
+        return "voucher/find";
+    }
+
+    @DeleteMapping("/delete/{id}")
+    public String deleteById(@PathVariable("id") UUID voucherId) {
+        voucherService.deleteById(voucherId);
+
+        return "redirect:/view/voucher/find";
+    }
+
+}

src/main/java/com/programmers/springweekly/docs/specification.md

@@ -206,4 +206,46 @@ blacklist
 - 바우처 지갑에 있는 모든 리스트 조회(findAll)
 - 테스트 코드 구현
 
+<hr>
+
+### 3-1 Thymeleaf를 이용하여 바우처 관리페이지 구현
+
+### 요약
+
+- 고객, 바우처 CREATE, UPDATE, DELETE Web Controller 구현
+- CreateRequestDto에 Validation 적용.
+- Thymeleaf를 이용한 페이지 생성
+- ControllerAdvice를 통한 Global 예외 처리
+
+### Voucher(web)
+
+- 바우처 입력 기능
+- 바우처 삭제 기능
+- 바우처 전체 조회, 상세 조회 기능
+
+### Customer(web)
+
+- 고객 입력 기능
+- 고객 삭제 기능
+- 고객 전체 조회, 상세 조회 기능
+
+### Validation
+
+- Spring에서 제공하는 Validation을 사용하여 DTO단에서 RequestBody 값을 검증
+
+### ControllerAdvice
+
+- Controller, Serivce, Repository 등 Controller 하위 단에서 발생한 예외를 전역으로 잡는 ExceptionHandler 클래스 생성
+- 프로그램 내에서 발생할 것 같은 예외들을 모두 구분하여 로깅하고, 메세지를 페이지로 발송하여 Error페이지에 출력
+- 예외 별 상태 코드 적용
+- 발생할 것 같은 예외들을 모두 잡고 예상치 못한 예외가 발생했을 때 프로그램이 꺼지지 않도록 제일 하위에 최상위 Exception으로 예외 처리
+
+### 웹 동작 화면(정상)
+![ezgif com-video-to-gif](https://github.com/prgrms-be-devcourse/springboot-basic/assets/92444744/c85de587-903e-493d-8fde-5e2d0ba3116b)
+
+### 웹 동작 화면(에러)
+![ezgif com-video-to-gif (1)](https://github.com/prgrms-be-devcourse/springboot-basic/assets/92444744/36e41e81-6d1f-4298-8527-43ee10d43e11)
+
+
+
 

src/main/java/com/programmers/springweekly/domain/voucher/FixedAmountVoucher.java

@@ -11,7 +11,7 @@ public class FixedAmountVoucher implements Voucher {
     public FixedAmountVoucher(UUID voucherId, long discountAmount) {
         VoucherValidator.validateVoucher(
                 VoucherType.FIXED,
-                String.valueOf(discountAmount)
+                discountAmount
         );
 
         this.voucherId = voucherId;

src/main/java/com/programmers/springweekly/domain/voucher/PercentDiscountVoucher.java

@@ -11,7 +11,7 @@ public class PercentDiscountVoucher implements Voucher {
     public PercentDiscountVoucher(UUID voucherId, long discountAmount) {
         VoucherValidator.validateVoucher(
                 VoucherType.PERCENT,
-                String.valueOf(discountAmount)
+                discountAmount
         );
 
         this.voucherId = voucherId;