부산대 BE_정재빈_step3

README.md

@@ -1 +1,46 @@
-# spring-gift-product
+# spring-gift-product
+
+---
+
+## Step1
+
+**요구 사항**<br>
+아래와 같이 http 메세지를 받도록 구현한다
+
+```http request
+GET /api/products HTTP/1.1
+```
+
+```http request
+HTTP/1.1 200 
+Content-Type: application/json
+
+[
+  {
+    "id": 8146027,
+    "name": "아이스 카페 아메리카노 T",
+    "price": 4500,
+    "imageUrl": "https://st.kakaocdn.net/product/gift/product/20231010111814_9a667f9eccc943648797925498bdd8a3.jpg"
+  }
+]
+```
+
+
+**필요 조건**<br>
+상품 데이터 관리
+현재는 별도의 데이터베이스가 없으므로 적절한 컬렉션을 이용하여 메모리에 저장한다.
+```java
+public class ProductController {
+    private final Map<Long, Product> productMap = new HashMap<>();
+}
+```
+----
+## 구현 기능
+- product 조회
+- product 추가
+- product 수정
+- product 삭제
+
+
+
+

build.gradle

@@ -19,6 +19,7 @@ repositories {
 
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-jdbc'
+    implementation 'org.springframework.boot:spring-boot-starter-data-jdbc'
     implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
     implementation 'org.springframework.boot:spring-boot-starter-web'
     runtimeOnly 'com.h2database:h2'

src/main/http/product/Product.http

@@ -0,0 +1,31 @@
+### get product list
+GET http://localhost:8080/api/products
+Content-Type: application/json
+
+### get product
+GET http://localhost:8080/api/products/1
+Content-Type: application/json
+
+### create product
+POST http://localhost:8080/api/products
+Content-Type: application/json
+
+{
+  "name": "아메리카노",
+  "price": "4500",
+  "imageUrl": "http://hello"
+}
+
+### update product
+PUT http://localhost:8080/api/products/1
+Content-Type: application/json
+
+{
+  "name": "아메리카노2",
+  "price": "5000",
+  "imageUrl": "http://hello"
+}
+
+### delete product
+DELETE http://localhost:8080/api/products/1
+Content-Type: application/json

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

@@ -0,0 +1,21 @@
+package gift.global.exception;
+
+import gift.global.response.ErrorCode;
+
+public class BusinessException extends RuntimeException {
+    private final ErrorCode errorCode;
+
+    public BusinessException(ErrorCode errorCode) {
+        super(errorCode.getMessage());
+        this.errorCode = errorCode;
+    }
+
+    public ErrorCode getErrorCode() {
+        return errorCode;
+    }
+
+    @Override
+    public String toString() {
+        return errorCode.toString() + " : " + super.toString();
+    }
+}

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

@@ -0,0 +1,16 @@
+package gift.global.handler;
+
+import gift.global.exception.BusinessException;
+import gift.global.response.ErrorResponseDto;
+import gift.global.utils.ResponseHelper;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+@RestControllerAdvice
+public class GlobalExceptionHandler {
+    @ExceptionHandler(BusinessException.class)
+    public ResponseEntity<ErrorResponseDto> handleBusinessException(BusinessException e) {
+        return ResponseHelper.createErrorResponse(e.getErrorCode());
+    }
+}

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

@@ -0,0 +1,28 @@
+package gift.global.response;
+
+public enum ErrorCode {
+    // Product
+    PRODUCT_NOT_FOUND_ERROR(400, "EP001", "Product Not Found Error"),
+    ;
+    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/ResultCode.java

@@ -0,0 +1,35 @@
+package gift.global.response;
+
+public enum ResultCode {
+    // Product
+    GET_ALL_PRODUCTS_SUCCESS(200, "P001", "모든 제품 조회 성공"),
+    GET_PRODUCT_BY_ID_SUCCESS(200, "P002", "단일 제품 조회 성공"),
+    CREATE_PRODUCT_SUCCESS(200, "P003", "제품 추가 성공"),
+    UPDATE_PRODUCT_SUCCESS(200, "P002", "제품 수정 성공"),
+    DELETE_PRODUCT_SUCCESS(200, "P002", "제품 삭제 성공"),
+
+    ;
+
+    // status 를 HttpStatus 로 관리하는 것이 좋을까, 아니면 int로 관리하는 것이 좋을까?
+    private final int status;
+    private final String code;
+    private final String message;
+
+    ResultCode(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/ResultResponseDto.java

@@ -0,0 +1,8 @@
+package gift.global.response;
+
+public record ResultResponseDto<T>(String code, String message, T data) {
+    // 자바 record 에서 생성자를 만들 경우, 반드시 canonical(표준) 생성자를 사용해야 한다!!
+    public ResultResponseDto(ResultCode resultCode, T data) {
+        this(resultCode.getCode(), resultCode.getMessage(), data);
+    }
+}

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

@@ -0,0 +1,7 @@
+package gift.global.response;
+
+public record SimpleResultResponseDto(String code, String message) {
+    public SimpleResultResponseDto(ResultCode resultCode) {
+        this(resultCode.getCode(), resultCode.getMessage());
+    }
+}

src/main/java/gift/global/utils/ResponseHelper.java

@@ -0,0 +1,26 @@
+package gift.global.utils;
+
+import gift.global.response.*;
+import org.springframework.http.ResponseEntity;
+
+public class ResponseHelper {
+    private ResponseHelper() {}
+
+    public static <T> ResponseEntity<ResultResponseDto<T>> createResponse(ResultCode resultCode, T data) {
+        ResultResponseDto<T> resultResponseDto = new ResultResponseDto<>(resultCode, data);
+        return org.springframework.http.ResponseEntity.status(resultCode.getStatus())
+                .body(resultResponseDto);
+    }
+
+    public static ResponseEntity<SimpleResultResponseDto> createSimpleResponse(ResultCode resultCode) {
+        var resultResponseDto = new SimpleResultResponseDto(resultCode);
+        return ResponseEntity.status(resultCode.getStatus())
+                .body(resultResponseDto);
+    }
+
+    public static ResponseEntity<ErrorResponseDto> createErrorResponse(ErrorCode errorCode) {
+        ErrorResponseDto errorResponseDto = new ErrorResponseDto(errorCode);
+        return ResponseEntity.status(errorCode.getStatus())
+                .body(errorResponseDto);
+    }
+}

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

@@ -0,0 +1,53 @@
+package gift.product.controller;
+
+import gift.global.response.ResultCode;
+import gift.global.response.ResultResponseDto;
+import gift.global.response.SimpleResultResponseDto;
+import gift.global.utils.ResponseHelper;
+import gift.product.dto.ProductRequestDto;
+import gift.product.domain.Product;
+import gift.product.service.ProductService;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.List;
+
+@RestController
+@RequestMapping("/api/products")
+public class ProductController {
+    private final ProductService productService;
+
+    public ProductController(ProductService productService) {
+        this.productService = productService;
+    }
+
+    @GetMapping("")
+    public ResponseEntity<ResultResponseDto<List<Product>>> getAllProducts() {
+        List<Product> products = productService.getAllProducts();
+        return ResponseHelper.createResponse(ResultCode.GET_ALL_PRODUCTS_SUCCESS, products);
+    }
+
+    @GetMapping("/{id}")
+    public ResponseEntity<ResultResponseDto<Product>> getProductById(@PathVariable(name = "id") Long id) {
+        Product product = productService.getProductById(id);
+        return ResponseHelper.createResponse(ResultCode.GET_PRODUCT_BY_ID_SUCCESS, product);
+    }
+
+    @PostMapping("")
+    public ResponseEntity<SimpleResultResponseDto> createProduct(@RequestBody ProductRequestDto productRequestDto) {
+        productService.createProduct(productRequestDto.toServiceDto());
+        return ResponseHelper.createSimpleResponse(ResultCode.CREATE_PRODUCT_SUCCESS);
+    }
+
+    @PutMapping("/{id}")
+    public ResponseEntity<SimpleResultResponseDto> updateProduct(@PathVariable(name = "id") Long id, @RequestBody ProductRequestDto productRequestDto) {
+        productService.updateProduct(productRequestDto.toServiceDto(id));
+        return ResponseHelper.createSimpleResponse(ResultCode.UPDATE_PRODUCT_SUCCESS);
+    }
+
+    @DeleteMapping("/{id}")
+    public ResponseEntity<SimpleResultResponseDto> deleteProduct(@PathVariable(name = "id") Long id) {
+        productService.deleteProduct(id);
+        return ResponseHelper.createSimpleResponse(ResultCode.DELETE_PRODUCT_SUCCESS);
+    }
+}

src/main/java/gift/product/domain/Product.java

@@ -0,0 +1,52 @@
+package gift.product.domain;
+
+import gift.product.dto.ProductRequestDto;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.relational.core.mapping.Table;
+
+@Table("products")
+public class Product {
+    @Id
+    private Long id;
+    private String name;
+    private int price;
+    private String imageUrl;
+
+    // JDBC 에서 엔티티 클래스를 인스턴스화할 때 반드시 기본 생성자와 파라미터 생성자가 필요하다
+    public Product() {}
+
+    public Product(Long id, String name, int price, String imageUrl) {
+        this.id = id;
+        this.name = name;
+        this.price = price;
+        this.imageUrl = imageUrl;
+    }
+
+    public Product(Long id, ProductRequestDto productRequestDto) {
+        this.id = id;
+        this.name = productRequestDto.name();
+        this.price = productRequestDto.price();
+        this.imageUrl = productRequestDto.imageUrl();
+    }
+
+
+    public Long getId() {
+        return id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public int getPrice() {
+        return price;
+    }
+
+    public String getImageUrl() {
+        return imageUrl;
+    }
+
+    public boolean checkNew() {
+        return id == null;
+    }
+}

src/main/java/gift/product/dto/ProductRequestDto.java

@@ -0,0 +1,18 @@
+package gift.product.dto;
+
+import java.util.Objects;
+
+public record ProductRequestDto(String name, int price, String imageUrl) {
+    public ProductRequestDto {
+        Objects.requireNonNull(name);
+        Objects.requireNonNull(imageUrl);
+    }
+
+    public ServiceDto toServiceDto() {
+        return new ServiceDto(null, this.name, this.price, this.imageUrl);
+    }
+
+    public ServiceDto toServiceDto(Long id) {
+        return new ServiceDto(id, this.name, this.price, this.imageUrl);
+    }
+}

src/main/java/gift/product/dto/ServiceDto.java

@@ -0,0 +1,9 @@
+package gift.product.dto;
+
+import gift.product.domain.Product;
+
+public record ServiceDto(Long id, String name, int price, String imageUrl) {
+    public Product toProduct() {
+        return new Product(id, name, price, imageUrl);
+    }
+}

src/main/java/gift/product/exception/ProductNotFoundException.java

@@ -0,0 +1,10 @@
+package gift.product.exception;
+
+import gift.global.exception.BusinessException;
+import gift.global.response.ErrorCode;
+
+public class ProductNotFoundException extends BusinessException {
+    public ProductNotFoundException() {
+        super(ErrorCode.PRODUCT_NOT_FOUND_ERROR);
+    }
+}