경북대 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,37 @@
+package gift.Controller;
+
+import gift.Service.ProductService;
+import gift.Model.Product;
+import java.util.List;
+import java.util.Map;
+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(value = "/api")
+public class BasicController {
+
+    private final ProductService productService;
+
+    @Autowired
+    public BasicController(ProductService productService) {
+        this.productService = productService;
+    }
+
+    /**
+     * 홈 화면으로 이동, 상품 목록 넘겨줌
+     *
+     * @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,106 @@
+package gift.Controller;
+
+import gift.Global.Response.ErrorCode;
+import gift.Global.Response.ErrorResponseDto;
+import gift.Global.Response.ResponseMaker;
+import gift.Global.Response.ResultCode;
+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 java.util.Map;
+import javax.swing.text.StyledEditorKit.BoldAction;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+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.ResponseBody;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping(value = "/api/products")
+public class ProductController {
+
+    private final ProductService productService;
+
+    @Autowired
+    public ProductController(ProductService productService) {
+        this.productService = productService;
+    }
+
+    /**
+     * 상품 추가
+     *
+     * @param productDTO
+     * @return 결과 메시지
+     */
+    @PostMapping
+    public ResponseEntity<SimpleResultResponseDto> postProduct(@Valid @ModelAttribute ProductDTO productDTO) {
+        productService.postProduct(productDTO);
+        return ResponseMaker.createSimpleResponse(ResultCode.CREATE_PRODUCT_SUCCESS);
+    }
+
+    /**
+     * 전체 상품 목록 조회
+     *
+     * @return products (상품 목록)
+     */
+    @GetMapping
+    public ResponseEntity<ResultResponseDto<List<Product>>> getProducts() {
+        List<Product> products = productService.getProducts();
+        // 성공 시
+        return ResponseMaker.createResponse(ResultCode.GET_ALL_PRODUCTS_SUCCESS, products);
+    }
+
+
+    /**
+     * 상품 수정
+     *
+     * @param id
+     * @param productDTO
+     * @return 결과 메시지
+     */
+    @PutMapping("/{id}")
+    public ResponseEntity<SimpleResultResponseDto> updateProduct(@PathVariable("id") Long id,
+        @RequestBody ProductDTO productDTO) {
+        productService.updateProduct(id, productDTO);
+        return ResponseMaker.createSimpleResponse(ResultCode.UPDATE_PRODUCT_SUCCESS);
+    }
+
+
+    /**
+     * 해당 ID 리스트에 속한 상품 삭제
+     *
+     * @param productIds
+     * @return 결과 메시지
+     */
+    @DeleteMapping
+    public ResponseEntity<?> deleteSelectedProducts(@RequestBody List<Long> productIds) {
+        productService.deleteProductsByIds(productIds);
+        return ResponseMaker.createSimpleResponse(ResultCode.DELETE_PRODUCTS_SUCCESS);
+    }
+
+    /**
+     * 해당 ID 를 가진 상품 삭제
+     *
+     * @param id
+     * @return 결과 메시지
+     */
+    @DeleteMapping("/{id}")
+    public ResponseEntity<?> deleteProduct(@PathVariable("id") Long id) {
+        productService.deleteProduct(id);
+        return ResponseMaker.createSimpleResponse(ResultCode.DELETE_PRODUCT_SUCCESS);
+    }
+
+
+}

src/main/java/gift/DTO/ProductDTO.java

@@ -0,0 +1,41 @@
+package gift.DTO;
+
+public class ProductDTO {
+
+    private String name;
+    private int price;
+    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,22 @@
+package gift.Global.Exception;
+
+import gift.Global.Response.ErrorCode;
+
+/**
+ * RuntimeException 을 상속받는 커스텀 에러
+ * 개발자가 직접 날리는 에러
+ */
+public class BusinessException extends RuntimeException{
+
+    private final ErrorCode errorCode;
+
+    public BusinessException(ErrorCode errorCode) {
+        super(errorCode.getMessage());
+        this.errorCode = errorCode;
+    }
+
+    public ErrorCode getErrorCode() {
+        return errorCode;
+    }
+
+}

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.ErrorCode;
+import gift.Global.Response.ErrorResponseDto;
+import gift.Global.Response.ResponseMaker;
+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.getErrorCode());
+    }
+
+
+    /**
+     * MethodArgumentNotValidException 에러 핸들러
+     * 매개변수 인자가 유효하지 않은 경우 발생
+     * @param e
+     * @return
+     */
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    public ResponseEntity<ErrorResponseDto> MethodArgumentNotValidException(
+        MethodArgumentNotValidException e) {
+        return ResponseMaker.createErrorResponse(ErrorCode.INVALID_PRODUCT_ARGUMENT);
+    }
+}

src/main/java/gift/Global/Response/ErrorCode.java

@@ -0,0 +1,38 @@
+package gift.Global.Response;
+
+public enum ErrorCode {
+
+    // Product CRUD 동작
+    GET_ALL_PRODUCTS_FAILED(400, "PE001", "전체 상품 목록 조회에 실패했습니다."),
+    CREATE_PRODUCT_FAILED(400, "PE002", "상품 추가에 실패했습니다."),
+    UPDATE_PRODUCT_FAILED(400, "PE003", "상품 수정에 실패했습니다."),
+    DELETE_PRODUCT_FAILED(400, "PE004", "상품 삭제에 실패했습니다."),
+    DELETE_PRODUCTS_FAILED(400, "PE005", "상품들을 삭제에 실패했습니다."),
+
+    // 값 유효성 검사
+    INVALID_PRODUCT_ARGUMENT(400, "VE001", "상품 입력 정보가 유효하지 않습니다."),
+
+    ;
+    ;
+    private final int status;
+    private final String code;
+    private final String message;
+
+    ErrorCode(int status, String code, String message) {
+        this.status = status;
+        this.code = code;
+        this.message = message;
+    }
+
+    public int getStatus() {
+        return status;
+    }
+
+    public String getCode() {
+        return code;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+}

src/main/java/gift/Global/Response/ErrorResponseDto.java

@@ -0,0 +1,7 @@
+package gift.Global.Response;
+
+public record ErrorResponseDto(String code, String message) {
+    public ErrorResponseDto(ErrorCode errorCode) {
+        this(errorCode.getCode(), errorCode.getMessage());
+    }
+}

src/main/java/gift/Global/Response/ResponseMaker.java

@@ -0,0 +1,44 @@
+package gift.Global.Response;
+
+import org.springframework.http.ResponseEntity;
+
+/**
+ * 응답 객체를 생성하는 클래스
+ */
+public class ResponseMaker {
+
+    /**
+     * BODY 에 성공 메시지와 데이터를 보냄
+     * @param resultCode
+     * @param data
+     * @return
+     * @param <T>
+     */
+    public static <T> ResponseEntity<ResultResponseDto<T>> createResponse(ResultCode resultCode, T data) {
+        ResultResponseDto<T> resultResponseDto = new ResultResponseDto<>(resultCode, data);
+        return ResponseEntity.status(resultCode.getStatus())
+            .body(resultResponseDto);
+    }
+
+    /**
+     * BODY 에 성공 메시지만 보냄 (데이터 X)
+     * @param resultCode
+     * @return
+     */
+    public static ResponseEntity<SimpleResultResponseDto> createSimpleResponse(ResultCode resultCode) {
+        SimpleResultResponseDto simpleResultResponseDto = new SimpleResultResponseDto(resultCode);
+        return ResponseEntity.status(resultCode.getStatus())
+            .body(simpleResultResponseDto);
+    }
+
+    /**
+     * BODY 에 에러 메시지만 보냄 (데이터 X)
+     * @param errorCode
+     * @return
+     */
+    public static ResponseEntity<ErrorResponseDto> createErrorResponse(ErrorCode errorCode) {
+        ErrorResponseDto errorResponseDto = new ErrorResponseDto(errorCode);
+        return ResponseEntity.status(errorCode.getStatus())
+            .body(errorResponseDto);
+    }
+}