FEAT: 사용자 잔고 변경 기능 추가 #34

jhkim31 · jhkim31 · commit b4d6804f93b0 · 2024-07-09T16:29:28.000+09:00
* 외부 SDK를 사용해보려 했으나, 프론트엔드 에서 제공해줘야 하는 값이 있어서 백엔드로는 불가능
diff --git a/src/main/java/jshop/domain/user/controller/UserController.java b/src/main/java/jshop/domain/user/controller/UserController.java
@@ -2,17 +2,22 @@
 
 import jakarta.validation.Valid;
 import jshop.domain.user.dto.UpdateUserRequest;
+import jshop.domain.user.dto.UpdateWalletBalanceRequest;
 import jshop.domain.user.dto.UserInfoResponse;
 import jshop.domain.user.service.UserService;
 import jshop.global.annotation.CurrentUserId;
+import jshop.global.common.ErrorCode;
 import jshop.global.dto.Response;
+import jshop.global.exception.JshopException;
 import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Slf4j
 @RestController
 @RequestMapping("/api/users")
 @RequiredArgsConstructor
@@ -32,4 +37,10 @@ public Response<UserInfoResponse> getUserInfo(@CurrentUserId Long userId) {
         return Response
             .<UserInfoResponse>builder().data(userInfoResponse).build();
     }
+
+    @PatchMapping("/balance")
+    public void updateWalletBalance(@CurrentUserId Long userId,
+        @RequestBody @Valid UpdateWalletBalanceRequest updateWalletBalanceRequest) {
+        userService.updateWalletBalance(userId, updateWalletBalanceRequest);
+    }
 }
diff --git a/src/main/java/jshop/domain/user/dto/UpdateWalletBalanceRequest.java b/src/main/java/jshop/domain/user/dto/UpdateWalletBalanceRequest.java
@@ -0,0 +1,29 @@
+package jshop.domain.user.dto;
+
+import jakarta.validation.constraints.Min;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Pattern;
+import jakarta.validation.constraints.Positive;
+import jshop.domain.wallet.entity.WalletChangeType;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+@Getter
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@EqualsAndHashCode
+@ToString
+public class UpdateWalletBalanceRequest {
+
+    @NotNull(message = "변경 잔고는 공백일 수 없습니다.")
+    @Positive
+    private Long amount;
+
+    @NotNull(message = "변경 타입은 공백일 수 없습니다.")
+    private WalletChangeType type;
+}
diff --git a/src/main/java/jshop/domain/user/service/UserService.java b/src/main/java/jshop/domain/user/service/UserService.java
@@ -6,9 +6,11 @@
 import jshop.domain.address.repository.AddressRepository;
 import jshop.domain.user.dto.JoinUserRequest;
 import jshop.domain.user.dto.UpdateUserRequest;
+import jshop.domain.user.dto.UpdateWalletBalanceRequest;
 import jshop.domain.user.dto.UserInfoResponse;
 import jshop.domain.user.entity.User;
 import jshop.domain.user.repository.UserRepository;
+import jshop.domain.wallet.entity.Wallet;
 import jshop.global.common.ErrorCode;
 import jshop.global.exception.JshopException;
 import jshop.global.utils.UserUtils;
@@ -55,6 +57,21 @@ public void updateUser(Long userId, UpdateUserRequest updateUserRequest) {
         user.updateUserInfo(updateUserRequest);
     }
 
+    @Transactional
+    public void updateWalletBalance(Long userId, UpdateWalletBalanceRequest updateWalletBalanceRequest) {
+        User user = getUser(userId);
+        Wallet wallet = user.getWallet();
+        switch (updateWalletBalanceRequest.getType()) {
+            case DEPOSIT:
+                wallet.deposit(updateWalletBalanceRequest.getAmount());
+                break;
+
+            case WITHDRAW:
+                wallet.withdraw(updateWalletBalanceRequest.getAmount());
+                break;
+        }
+    }
+
     public User getUser(Long userId) {
         Optional<User> optionalUser = userRepository.findById(userId);
         return UserUtils.getUserOrThrow(optionalUser, userId);
diff --git a/src/main/java/jshop/domain/wallet/entity/Wallet.java b/src/main/java/jshop/domain/wallet/entity/Wallet.java
@@ -42,22 +42,29 @@ public class Wallet extends BaseEntity {
     private WalletChangeType walletChangeType;
 
     public static Wallet create() {
+        return create(0L);
+    }
+
+    public static Wallet create(Long balance) {
         return Wallet
-            .builder().balance(0L).walletChangeType(WalletChangeType.CREATE).build();
+            .builder().balance(balance).walletChangeType(WalletChangeType.CREATE).build();
     }
 
 
     public Long deposit(Long amount) {
+        checkAmount(amount);
         walletChangeType = WalletChangeType.DEPOSIT;
         return balance += amount;
     }
 
     public Long refund(Long amount) {
+        checkAmount(amount);
         walletChangeType = WalletChangeType.REFUND;
         return balance += amount;
     }
 
     public Long purchase(Long amount) {
+        checkAmount(amount);
         if (balance - amount < 0) {
             log.error(ErrorCode.WALLET_BALANCE_EXCEPTION.getLogMessage(), balance - amount);
             throw JshopException.of(ErrorCode.WALLET_BALANCE_EXCEPTION);
@@ -68,6 +75,7 @@ public Long purchase(Long amount) {
     }
 
     public Long withdraw(Long amount) {
+        checkAmount(amount);
         if (balance - amount < 0) {
             log.error(ErrorCode.WALLET_BALANCE_EXCEPTION.getLogMessage(), balance - amount);
             throw JshopException.of(ErrorCode.WALLET_BALANCE_EXCEPTION);
@@ -76,4 +84,12 @@ public Long withdraw(Long amount) {
         walletChangeType = WalletChangeType.WITHDRAW;
         return balance -= amount;
     }
+
+    private boolean checkAmount(Long amount) {
+        if (amount <= 0) {
+            log.error(ErrorCode.ILLEGAL_BALANCE_REQUEST.getLogMessage(), amount);
+            throw JshopException.of(ErrorCode.ILLEGAL_BALANCE_REQUEST);
+        }
+        return true;
+    }
 }
diff --git a/src/main/java/jshop/global/common/ErrorCode.java b/src/main/java/jshop/global/common/ErrorCode.java
@@ -46,35 +46,36 @@ public enum ErrorCode {
     INVALID_ORDER_ITEM(10060, "주문 정보가 잘못되었습니다", "주문 수량이나 가격이 잘못되었습니다. 수량 : [{}], 가격 : [{}]", HttpStatus.BAD_REQUEST),
 
     // 비즈니스 로직 오류
-    ILLEGAL_QUANTITY_REQUEST_EXCEPTION(50_001, "재고 변화량이 잘못되었습니다.", "재고 변화량이 잘못되었습니다. [{}]", HttpStatus.BAD_REQUEST),
-    NEGATIVE_QUANTITY_EXCEPTION(50_002, "재고는 음수일 수 없습니다.", "재고는 음수일 수 없습니다. [{}]", HttpStatus.BAD_REQUEST),
-    ILLEGAL_PRICE_EXCEPTION(50_101, "가격이 잘못되었습니다.", "가격은 0보다 커야합니다. [{}].", HttpStatus.BAD_REQUEST),
-    ILLEGAL_PAGE_REQUEST(60_001, "요청할 수 없는 페이지 입니다.", "요청할 수 없는 페이지 입니다. pageNumber : [{}], pageSize : [{}]",
+    ILLEGAL_QUANTITY_REQUEST_EXCEPTION(50001, "재고 변화량이 잘못되었습니다.", "재고 변화량이 잘못되었습니다. [{}]", HttpStatus.BAD_REQUEST),
+    NEGATIVE_QUANTITY_EXCEPTION(50002, "재고는 음수일 수 없습니다.", "재고는 음수일 수 없습니다. [{}]", HttpStatus.BAD_REQUEST),
+    ILLEGAL_PRICE_EXCEPTION(50101, "가격이 잘못되었습니다.", "가격은 0보다 커야합니다. [{}].", HttpStatus.BAD_REQUEST),
+    ILLEGAL_PAGE_REQUEST(60001, "요청할 수 없는 페이지 입니다.", "요청할 수 없는 페이지 입니다. pageNumber : [{}], pageSize : [{}]",
         HttpStatus.BAD_REQUEST),
-    ILLEGAL_CART_QUANTITY_REQUEST_EXCEPTION(70_001, "장바구니 수량이 잘못되었습니다.", "장바구니 수량은 1 이상이여야 합니다. [{}]",
+    ILLEGAL_CART_QUANTITY_REQUEST_EXCEPTION(70001, "장바구니 수량이 잘못되었습니다.", "장바구니 수량은 1 이상이여야 합니다. [{}]",
         HttpStatus.BAD_REQUEST),
-    WALLET_BALANCE_EXCEPTION(80_001, "잔고는 음수일 수 없습니다.", "잔고는 음수일 수 없습니다. [{}]", HttpStatus.BAD_REQUEST),
-    ALREADY_SHIPPING_ORDER(90_001, "이미 배송이 시작된 주문입니다.", "이미 배송이 시작된 주문입니다. [{}]", HttpStatus.BAD_REQUEST),
-    ALREADY_CANCLED_DELIVERY(90_100, "이미 취소된 배송입니다.", "이미 취소된 배송입니다. DELIVERY_ID : [{}]", HttpStatus.BAD_REQUEST),
-    ILLEGAL_DELIVERY_STATE(90_200, "배송 상태가 잘못되었습니다.", "배송 상태가 잘못되었습니다. 현재 상태 : [{}], 원하는 상태 : [{}]",
+    ILLEGAL_BALANCE_REQUEST(70101, "잔고 변화는 0보다 커야합니다.", "잔고 변화는 0보다 커야합니다. 요청 값 : [{}]", HttpStatus.BAD_REQUEST),
+    WALLET_BALANCE_EXCEPTION(80001, "잔고는 음수일 수 없습니다.", "잔고는 음수일 수 없습니다. [{}]", HttpStatus.BAD_REQUEST),
+    ALREADY_SHIPPING_ORDER(90001, "이미 배송이 시작된 주문입니다.", "이미 배송이 시작된 주문입니다. [{}]", HttpStatus.BAD_REQUEST),
+    ALREADY_CANCLED_DELIVERY(90100, "이미 취소된 배송입니다.", "이미 취소된 배송입니다. DELIVERY_ID : [{}]", HttpStatus.BAD_REQUEST),
+    ILLEGAL_DELIVERY_STATE(90200, "배송 상태가 잘못되었습니다.", "배송 상태가 잘못되었습니다. 현재 상태 : [{}], 원하는 상태 : [{}]",
         HttpStatus.BAD_REQUEST),
-    ORDER_PRICE_MISMATCH(90_500, "주문 가격과 상품 가격이 맞지 않습니다.", "주문 가격과 상품 가격이 맞지 않습니다. 주문가격 : [{}] , 상품 가격 총합 : [{}]",
+    ORDER_PRICE_MISMATCH(90500, "주문 가격과 상품 가격이 맞지 않습니다.", "주문 가격과 상품 가격이 맞지 않습니다. 주문가격 : [{}] , 상품 가격 총합 : [{}]",
         HttpStatus.BAD_REQUEST),
-    PRODUCT_PRICE_MISMATCH(90_501, "상품 가격이 변경되었습니다.",
+    PRODUCT_PRICE_MISMATCH(90501, "상품 가격이 변경되었습니다.",
         "주문요청 상품 가격과 실제 상품 가격이 맞지 않습니다. 상품 상세 ID : [{}] 주문 상품 가격 : " + "[{}], 실제 상품 가격 : [{}]", HttpStatus.BAD_REQUEST),
-    ORDER_QUANTITY_MISMATCH(90_550, "주문 수량과 상품 수량의 합이 맞지 않습니다.",
+    ORDER_QUANTITY_MISMATCH(90550, "주문 수량과 상품 수량의 합이 맞지 않습니다.",
         "주문 수량과 상품 수량의 합이 맞지 않습니다. 주문수량 : [{}] , 상품 수량 총합 : " + "[{}]", HttpStatus.BAD_REQUEST),
 
     // 잘못된 상품
-    INVALID_PRODUCT_ATTRIBUTE(100_001, "상세 상품 속성이 잘못되었습니다.",
+    INVALID_PRODUCT_ATTRIBUTE(100001, "상세 상품 속성이 잘못되었습니다.",
         "상세상품 속성이 상품 속성에 없습니다. [attributes : {}]   [attribute : {}]", HttpStatus.BAD_REQUEST),
-    INVALID_PRODUCTDETAIL_INVENTORY(100_100, "상세 상품이 잘못되었습니다. 관리자에게 문의하세요",
+    INVALID_PRODUCTDETAIL_INVENTORY(100100, "상세 상품이 잘못되었습니다. 관리자에게 문의하세요",
         "상세 상품의 Inventory가 잘못되었습니다. product " + "detail : [{}]", HttpStatus.INTERNAL_SERVER_ERROR),
-    INVALID_PRODUCTDETAIL_PRODUCT(100_200, "상세 상품이 잘못되었습니다. 관리자에게 문의하세요", "상세 상품의 Product가 잘못되었습니다. [{}]",
+    INVALID_PRODUCTDETAIL_PRODUCT(100200, "상세 상품이 잘못되었습니다. 관리자에게 문의하세요", "상세 상품의 Product가 잘못되었습니다. [{}]",
         HttpStatus.INTERNAL_SERVER_ERROR),
 
     // 서버 문제
-    USER_WALLET_NOT_FOUND(200_100, "사용자의 지갑을 찾을 수 없습니다. 관리자에게 문의하세요", "사용자의 지갑을 찾을 수 없습니다. user : [{}]",
+    USER_WALLET_NOT_FOUND(200100, "사용자의 지갑을 찾을 수 없습니다. 관리자에게 문의하세요", "사용자의 지갑을 찾을 수 없습니다. user : [{}]",
         HttpStatus.INTERNAL_SERVER_ERROR);
 
     private final int code;
diff --git a/src/test/java/jshop/domain/user/controller/UserControllerTest.java b/src/test/java/jshop/domain/user/controller/UserControllerTest.java
@@ -4,16 +4,26 @@
 import static jshop.utils.MockSecurityContextUtil.mockUserSecurityContext;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
+import java.util.stream.Stream;
 import jshop.domain.user.dto.UpdateUserRequest;
+import jshop.domain.user.dto.UpdateWalletBalanceRequest;
 import jshop.domain.user.service.UserService;
+import jshop.domain.wallet.entity.WalletChangeType;
+import jshop.global.common.ErrorCode;
 import jshop.global.controller.GlobalExceptionHandler;
 import jshop.utils.config.TestSecurityConfig;
 import org.json.JSONObject;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
@@ -23,6 +33,9 @@
 import org.springframework.test.web.servlet.ResultActions;
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
 
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
 @WebMvcTest(UserController.class)
 @Import({TestSecurityConfig.class, GlobalExceptionHandler.class})
 @DisplayName("[단위 테스트] UserController")
@@ -107,4 +120,75 @@ public void updateUser_noAuth() throws Exception {
             perform.andExpect(status().isUnauthorized());
         }
     }
+
+    @Nested
+    @DisplayName("현재 유저의 잔고 변경 검증")
+    class UpdateWallet {
+
+        @Captor
+        ArgumentCaptor<Long> userIdCaptor;
+
+        @Captor
+        ArgumentCaptor<UpdateWalletBalanceRequest> updateWalletBalanceRequestArgumentCaptor;
+
+        private static Stream<Arguments> provideValidArgs() {
+            String depositRequestStr = """
+                { "amount" : 100, "type" : "DEPOSIT"}
+                """;
+
+            String withdrawRequestStr = """
+                { "amount" : 100, "type" : "WITHDRAW"}
+                """;
+            return Stream.of(Arguments.of(depositRequestStr, WalletChangeType.DEPOSIT),
+                Arguments.of(withdrawRequestStr, WalletChangeType.WITHDRAW));
+        }
+
+        private static Stream<Arguments> provideInValidArgs() {
+            String depositRequestStr = """
+                { "amount" : -100, "type" : "DEPOSIT"}
+                """;
+
+            String withdrawRequestStr = """
+                { "amount" : 0, "type" : "WITHDRAW"}
+                """;
+            return Stream.of(Arguments.of(depositRequestStr, WalletChangeType.DEPOSIT),
+                Arguments.of(withdrawRequestStr, WalletChangeType.WITHDRAW));
+        }
+
+        @ParameterizedTest
+        @DisplayName("잔고 변화량이 0 이상이고, 변경 타입이 DEPOSIT, WITHDRAW라면 잔고를 갱신할 수 있다.")
+        @MethodSource("provideValidArgs")
+        public void updateWalletBalance_success(String request, WalletChangeType type) throws Exception {
+            // when
+            mockMvc.perform(MockMvcRequestBuilders
+                .patch("/api/users/balance")
+                .with(mockUserSecurityContext())
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(request));
+
+            // then
+            verify(userService, times(1)).updateWalletBalance(userIdCaptor.capture(),
+                updateWalletBalanceRequestArgumentCaptor.capture());
+
+            assertThat(updateWalletBalanceRequestArgumentCaptor.getValue().getAmount()).isEqualTo(100);
+            assertThat(updateWalletBalanceRequestArgumentCaptor.getValue().getType()).isEqualTo(type);
+        }
+
+        @ParameterizedTest
+        @DisplayName("잔고 변화량이 0 이하면 BAD_REQUEST 발생")
+        @MethodSource("provideInValidArgs")
+        public void updateWalletBalance_illegal_amount(String request, WalletChangeType type) throws Exception {
+            // when
+            ResultActions perform = mockMvc.perform(MockMvcRequestBuilders
+                .patch("/api/users/balance")
+                .with(mockUserSecurityContext())
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(request));
+
+            // then
+            perform
+                .andExpect(status().isBadRequest())
+                .andExpect(jsonPath("$.errorCode").value(ErrorCode.BAD_REQUEST.getCode()));
+        }
+    }
 }
diff --git a/src/test/java/jshop/domain/user/service/UserServiceTest.java b/src/test/java/jshop/domain/user/service/UserServiceTest.java
diff --git a/src/test/java/jshop/integration/domain/user/UserControllerIntegrationTest.java b/src/test/java/jshop/integration/domain/user/UserControllerIntegrationTest.java
diff --git a/src/test/java/jshop/utils/dto/UserDtoUtils.java b/src/test/java/jshop/utils/dto/UserDtoUtils.java
