경북대 BE_김동현_1주차 과제(3단계)

README.md

@@ -1 +1,9 @@
-# spring-gift-product
+# spring-gift-product
+
+## 기능 목록
+- 상품 추가 기능
+- 상품 조회 기능
+- 상품 수정 기능 
+- 상품 삭제 기능
+- 상품 테스트 코드 작성
+- 리팩토링

build.gradle

@@ -24,6 +24,9 @@ dependencies {
     runtimeOnly 'com.h2database:h2'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+
+    implementation 'org.springframework.boot:spring-boot-starter-validation'
+
 }
 
 tasks.named('test') {

src/main/java/gift/Application.java

@@ -8,4 +8,6 @@ public class Application {
     public static void main(String[] args) {
         SpringApplication.run(Application.class, args);
     }
+
+
 }

src/main/java/gift/controller/BasicController.java

@@ -0,0 +1,36 @@
+package gift.controller;
+
+import gift.service.ProductService;
+import gift.model.Product;
+import java.util.List;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+
+@Controller
+@RequestMapping( "/api")
+public class BasicController {
+
+    private final ProductService productService;
+
+    @Autowired
+    public BasicController(ProductService productService) {
+        this.productService = productService;
+    }
+
+    /**
+     * 홈 화면 렌더링 (thymeleaf)
+     *
+     * @param model
+     * @return 홈 화면 html 명
+     */
+    @GetMapping
+    String homePage(Model model) {
+        // 현재 상품 목록 조회
+        List<Product> products = productService.getProducts();
+        model.addAttribute("products", products);
+        return "index";
+    }
+}

src/main/java/gift/controller/ProductController.java

@@ -0,0 +1,101 @@
+package gift.controller;
+
+import gift.global.response.ResponseMaker;
+import gift.global.response.ResultResponseDto;
+import gift.global.response.SimpleResultResponseDto;
+import gift.service.ProductService;
+import gift.dto.ProductDTO;
+import gift.model.Product;
+import jakarta.validation.Valid;
+import java.util.List;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/products")
+public class ProductController {
+
+    private final ProductService productService;
+
+    @Autowired
+    public ProductController(ProductService productService) {
+        this.productService = productService;
+    }
+
+    /**
+     * 상품 추가
+     *
+     * @param productDTO
+     * @return 결과 메시지
+     */
+    @PostMapping
+    public ResponseEntity<SimpleResultResponseDto> createProduct(
+        @Valid @ModelAttribute ProductDTO productDTO) {
+        productService.createProduct(productDTO);
+        return ResponseMaker.createSimpleResponse(HttpStatus.CREATED, "상품이 추가되었습니다.");
+    }
+
+    /**
+     * 전체 상품 목록 조회
+     *
+     * @return 결과 메시지, products (상품 목록)
+     */
+    @GetMapping
+    public ResponseEntity<ResultResponseDto<List<Product>>> getProducts() {
+        List<Product> products = productService.getProducts();
+        // 성공 시
+        return ResponseMaker.createResponse(HttpStatus.OK, "전체 목록 상품을 조회했습니다.", products);
+    }
+
+
+    /**
+     * 상품 수정
+     *
+     * @param id
+     * @param productDTO
+     * @return 결과 메시지
+     */
+    @PutMapping("/{id}")
+    public ResponseEntity<SimpleResultResponseDto> updateProduct(@PathVariable("id") Long id,
+        @Valid @RequestBody ProductDTO productDTO) {
+        productService.updateProduct(id, productDTO);
+        return ResponseMaker.createSimpleResponse(HttpStatus.OK, "상품을 수정했습니다.");
+    }
+
+
+    /**
+     * 해당 ID 리스트에 속한 상품 삭제
+     *
+     * @param productIds
+     * @return 결과 메시지
+     */
+    @DeleteMapping
+    public ResponseEntity<?> deleteSelectedProducts(@RequestBody List<Long> productIds) {
+        productService.deleteProductsByIds(productIds);
+        return ResponseMaker.createSimpleResponse(HttpStatus.OK, "선택된 상품들을 삭제했습니다.");
+    }
+
+    /**
+     * 해당 ID 를 가진 상품 삭제
+     *
+     * @param id
+     * @return 결과 메시지
+     */
+    @DeleteMapping("/{id}")
+    public ResponseEntity<?> deleteProduct(@PathVariable("id") Long id) {
+        productService.deleteProduct(id);
+        return ResponseMaker.createSimpleResponse(HttpStatus.OK, "상품이 삭제되었습니다.");
+    }
+
+
+}

src/main/java/gift/dto/ProductDTO.java

@@ -0,0 +1,50 @@
+package gift.dto;
+
+import jakarta.validation.constraints.Min;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+
+public class ProductDTO {
+
+    @NotBlank
+    private String name;
+
+    @Min(0)
+    private int price;
+
+    @NotBlank
+    private String imageUrl;
+
+    public ProductDTO() {
+    }
+
+    public ProductDTO(String name, int price, String imageUrl) {
+        this.name = name;
+        this.price = price;
+        this.imageUrl = imageUrl;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public int getPrice() {
+        return price;
+    }
+
+    public void setPrice(int price) {
+        this.price = price;
+    }
+
+    public String getImageUrl() {
+        return imageUrl;
+    }
+
+    public void setImageUrl(String imageUrl) {
+        this.imageUrl = imageUrl;
+    }
+}

src/main/java/gift/global/exception/BusinessException.java

@@ -0,0 +1,24 @@
+package gift.global.exception;
+
+import org.springframework.http.HttpStatus;
+
+/**
+ * RuntimeException 을 상속받는 커스텀 에러
+ * 개발자가 직접 날리는 에러
+ */
+public class BusinessException extends RuntimeException{
+    HttpStatus status;
+
+    public BusinessException(HttpStatus status, String message) {
+        super(message);
+        this.status = status;
+    }
+
+    public HttpStatus getStatus() {
+        return status;
+    }
+
+    public void setStatus(HttpStatus status) {
+        this.status = status;
+    }
+}

src/main/java/gift/global/handler/GlobalExceptionHandler.java

@@ -0,0 +1,38 @@
+package gift.global.handler;
+
+import gift.global.exception.BusinessException;
+import gift.global.response.ErrorResponseDto;
+import gift.global.response.ResponseMaker;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+@RestControllerAdvice
+public class GlobalExceptionHandler {
+
+    /**
+     * RuntimeException 을 상속받는 커스텀 에러 핸들러
+     * 개발자가 직접 날리는 에러
+     * @param e
+     * @return
+     */
+    @ExceptionHandler(BusinessException.class)
+    public ResponseEntity<ErrorResponseDto> handleBusinessException(BusinessException e) {
+        return ResponseMaker.createErrorResponse(e.getStatus(), e.getMessage());
+    }
+
+
+    /**
+     * MethodArgumentNotValidException 에러 핸들러
+     * 매개변수 인자가 유효하지 않은 경우 발생
+     * @param e
+     * @return
+     */
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    public ResponseEntity<ErrorResponseDto> MethodArgumentNotValidException(
+        MethodArgumentNotValidException e) {
+        return ResponseMaker.createErrorResponse(HttpStatus.BAD_REQUEST, "입력값이 유효하지 않습니다.");
+    }
+}

src/main/java/gift/global/response/ErrorResponseDto.java

@@ -0,0 +1,5 @@
+package gift.global.response;
+
+public record ErrorResponseDto(String message) {
+
+}

src/main/java/gift/global/response/ResponseMaker.java

@@ -0,0 +1,47 @@
+package gift.global.response;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+/**
+ * 응답 객체를 생성하는 클래스
+ */
+public class ResponseMaker {
+
+    /**
+     * BODY 에 성공 메시지와 데이터를 보냄
+     * @param message
+     * @param data
+     * @return
+     * @param <T>
+     */
+    public static <T> ResponseEntity<ResultResponseDto<T>> createResponse(HttpStatus status, String message, T data) {
+        ResultResponseDto<T> resultResponseDto = new ResultResponseDto<>(message, data);
+
+        return ResponseEntity.status(status).body(resultResponseDto);
+    }
+
+    /**
+     * BODY 에 성공 메시지만 보냄 (데이터 X)
+     * @param message
+     * @return
+     */
+    public static ResponseEntity<SimpleResultResponseDto> createSimpleResponse(HttpStatus status, String message) {
+        System.out.println("message = " + message);
+        SimpleResultResponseDto simpleResultResponseDto = new SimpleResultResponseDto(message);
+        System.out.println("simpleResultResponseDto = " + simpleResultResponseDto);
+        return ResponseEntity.status(status).body(simpleResultResponseDto);
+    }
+
+    /**
+     * BODY 에 에러 메시지만 보냄 (데이터 X)
+     * @param message
+     * @return
+     */
+    public static ResponseEntity<ErrorResponseDto> createErrorResponse(HttpStatus status, String message) {
+        ErrorResponseDto errorResponseDto = new ErrorResponseDto(message);
+        return ResponseEntity.status(status)
+            .body(errorResponseDto);
+    }
+
+}

src/main/java/gift/global/response/ResultResponseDto.java

@@ -0,0 +1,12 @@
+package gift.global.response;
+
+/**
+ * 메시지, "데이터" 전달
+ *
+ * @param message
+ * @param data
+ * @param <T>
+ */
+public record ResultResponseDto<T>(String message, T data) {
+
+}

src/main/java/gift/global/response/SimpleResultResponseDto.java

@@ -0,0 +1,10 @@
+package gift.global.response;
+
+/**
+ * 메시지 전달 (데이터 X)
+ *
+ * @param message
+ */
+public record SimpleResultResponseDto(String message) {
+
+}

src/main/java/gift/global/validation/validator.java

@@ -0,0 +1,21 @@
+package gift.global.validation;
+
+import gift.dto.ProductDTO;
+import gift.global.exception.BusinessException;
+import org.springframework.http.HttpStatus;
+import org.springframework.stereotype.Component;
+
+/**
+ * 유효성 검증 클래스
+ */
+@Component
+public class validator {
+
+    public void validateProduct(ProductDTO productDTO) {
+        if (productDTO.getName() == ""
+            || productDTO.getPrice() == 0
+            || productDTO.getImageUrl() == "") {
+            throw new BusinessException(HttpStatus.BAD_REQUEST, "입력값이 유효하지 않습니다.");
+        }
+    }
+}