🧪 [Unit Test] Item 유닛테스트 추가 및 자바독 추가 및 자잘한 코드 다듬기 (#507)

src/main/java/com/gg/server/admin/item/service/ItemAdminService.java

@@ -27,14 +27,29 @@ public class ItemAdminService {
 	private final ItemAdminRepository itemAdminRepository;
 	private final AsyncNewItemImageUploader asyncNewItemImageUploader;
 
+	/**
+	 * <p>Item 히스토리를 반환한다.</p>
+	 * @param pageable
+	 * @return
+	 */
 	@Transactional(readOnly = true)
 	public ItemListResponseDto getAllItemHistory(Pageable pageable) {
 		Page<ItemHistoryResponseDto> responseDtos = itemAdminRepository.findAll(pageable)
 			.map(ItemHistoryResponseDto::new);
 		return new ItemListResponseDto(responseDtos.getContent(), responseDtos.getTotalPages());
 	}
 
-	// 아이템 수정 시 신규 이미지가 존재하는 경우
+	/**
+	 * <p>아이템 수정 시 신규 이미지가 존재하는 경우</p>
+	 * <p>기존 아이템의 item.isVisible 를 false 로 변경한다</p>
+	 * @param itemId 타겟 아이템
+	 * @param itemUpdateRequestDto 타겟 아이템 변경 dto
+	 * @param itemImageFile 신규 이미지
+	 * @param user 바꾸는 유저 id
+	 * @throws IOException IOException
+	 * @throws ItemNotFoundException 아이템 없음
+	 * @throws ItemNotAvailableException 접근 불가한 아이템
+	 */
 	@Transactional
 	public void updateItem(Long itemId, ItemUpdateRequestDto itemUpdateRequestDto,
 		MultipartFile itemImageFile, UserDto user) throws IOException {
@@ -50,10 +65,17 @@ public void updateItem(Long itemId, ItemUpdateRequestDto itemUpdateRequestDto,
 		itemAdminRepository.save(newItem);
 	}
 
-	// 아이템 수정 시 신규 이미지가 존재하지 않는 경우
+	/**
+	 * <p>아이템 수정 시 신규 이미지가 존재하지 않는 경우</p>
+	 * <p>기존 아이템의 item.isVisible 를 false 로 변경한다</p>
+	 * @param itemId 타겟 아이템
+	 * @param itemUpdateRequestDto 타겟 아이템 변경 dto
+	 * @param user 바꾸는 유저 id
+	 * @throws ItemNotFoundException 아이템 없음
+	 * @throws ItemNotAvailableException 접근 불가한 아이템
+	 */
 	@Transactional
-	public void updateItem(Long itemId, ItemUpdateRequestDto itemUpdateRequestDto,
-		UserDto user) {
+	public void updateItem(Long itemId, ItemUpdateRequestDto itemUpdateRequestDto, UserDto user) {
 		Item item = itemAdminRepository.findById(itemId).orElseThrow(ItemNotFoundException::new);
 		if (!item.getIsVisible()) {
 			throw new ItemNotAvailableException();
@@ -63,6 +85,13 @@ public void updateItem(Long itemId, ItemUpdateRequestDto itemUpdateRequestDto,
 		itemAdminRepository.save(newItem);
 	}
 
+	/**
+	 * <p>아이템 삭제</p>
+	 * <p>item.isVisible 를 false 로 변경한다</p>
+	 * @param itemId 타겟 id
+	 * @param user 삭제하는 유저
+	 * @throws ItemNotFoundException 아이템 없음
+	 */
 	@Transactional
 	public void deleteItem(Long itemId, UserDto user) {
 		Item item = itemAdminRepository.findById(itemId).orElseThrow(ItemNotFoundException::new);

src/main/java/com/gg/server/domain/item/service/ItemService.java

@@ -48,34 +48,43 @@ public class ItemService {
 	private final NotiService notiService;
 	private final UserCoinChangeService userCoinChangeService;
 
+	/**
+	 * <p>모든 아이템을 가져온다.</p>
+	 * @return
+	 */
 	@Transactional(readOnly = true)
 	public ItemStoreListResponseDto getAllItems() {
-
 		List<ItemStoreResponseDto> itemStoreListResponseDto = itemRepository.findAllByCreatedAtDesc()
 			.stream().map(ItemStoreResponseDto::new).collect(Collectors.toList());
 		return new ItemStoreListResponseDto(itemStoreListResponseDto);
 	}
 
+	/**
+	 * <p>게스트 유저가 아닌 유저가 아이템을 구매하는 메서드 이다</p>
+	 * <p>할인 중 이라면 할인가를 적용하고, 구매 후 영수증을 db에 저장한다.</p>
+	 * @param itemId 타겟 아이템 Id
+	 * @param userDto 구매 유저 정보
+	 * @throws ItemNotFoundException 존재하지 않는 아이템
+	 * @throws ItemNotPurchasableException 구매할 수 없는 아이템
+	 * @throws UserNotFoundException 타겟 유저 없음
+	 * @throws KakaoPurchaseException 게스트(카카오) 유저가 아이템을 구매하려 할때
+	 * @throws
+	 */
 	@Transactional
 	public void purchaseItem(Long itemId, UserDto userDto) {
-		Item item = itemRepository.findById(itemId)
-			.orElseThrow(() -> {
-				throw new ItemNotFoundException();
-			});
+		Item item = itemRepository.findById(itemId).orElseThrow(ItemNotFoundException::new);
 		if (!item.getIsVisible()) {
 			throw new ItemNotPurchasableException();
 		}
 
 		//세일가격 존재할때 세일가로 결정
-		Integer finalPrice;
+		Integer finalPrice = item.getPrice();
 		if (item.getDiscount() != null && item.getDiscount() > 0) {
-			finalPrice = item.getPrice() - (item.getPrice() * item.getDiscount() / 100);
-		} else {
-			finalPrice = item.getPrice();
+			finalPrice -= (item.getPrice() * item.getDiscount() / 100);
 		}
 
 		User payUser = userRepository.findById(userDto.getId())
-			.orElseThrow(() -> new UserNotFoundException());
+			.orElseThrow(UserNotFoundException::new);
 
 		if (payUser.getRoleType() == RoleType.GUEST) {
 			throw new KakaoPurchaseException();
@@ -88,22 +97,29 @@ public void purchaseItem(Long itemId, UserDto userDto) {
 		receiptRepository.save(receipt);
 	}
 
+	/**
+	 * <p>게스트 유저가 아닌 유저들 끼리 선물을 주는 메서드 이다</p>
+	 * <p>할인 중 이라면 할인가를 적용하고, 구매 후 영수증을 db에 저장한다.</p>
+	 * @param itemId 타겟 아이템 id
+	 * @param ownerId 선물 받는 owner intraId
+	 * @param userDto 구매자 id
+	 * @throws ItemNotFoundException 존재하지 않는 아이템
+	 * @throws ItemNotPurchasableException 구매할 수 없는 아이템
+	 * @throws UserNotFoundException 타겟 유저 없음
+	 * @throws KakaoPurchaseException 게스트(카카오) 유저가 아이템을 구매하려 할때
+	 * @throws KakaoGiftException 게스트(카카오) 유저에게 선물하려 할때
+	 */
 	@Transactional
 	public void giftItem(Long itemId, String ownerId, UserDto userDto) {
-		Item item = itemRepository.findById(itemId)
-			.orElseThrow(() -> {
-				throw new ItemNotFoundException();
-			});
+		Item item = itemRepository.findById(itemId).orElseThrow(ItemNotFoundException::new);
 		if (!item.getIsVisible()) {
 			throw new ItemNotPurchasableException();
 		}
 
 		//세일가격 존재할때 세일가로 결정
-		Integer finalPrice;
+		Integer finalPrice = item.getPrice();
 		if (item.getDiscount() != null && item.getDiscount() > 0) {
-			finalPrice = item.getPrice() - (item.getPrice() * item.getDiscount() / 100);
-		} else {
-			finalPrice = item.getPrice();
+			finalPrice -= (item.getPrice() * item.getDiscount() / 100);
 		}
 
 		User payUser = userRepository.findById(userDto.getId())
@@ -128,34 +144,55 @@ public void giftItem(Long itemId, String ownerId, UserDto userDto) {
 		notiService.createGiftNoti(owner, payUser, item.getName());
 	}
 
+	/**
+	 * <p>유저가 구매한 아이템 중 상태가 BEFORE, USING, WAITING 인 것들을 찾는 메서드이다.</p>
+	 * @param userDto 유저 정보
+	 * @param pageable 페이지
+	 * @return
+	 */
 	@Transactional(readOnly = true)
 	public UserItemListResponseDto getItemByUser(UserDto userDto, Pageable pageable) {
 		Page<Receipt> receipts = userItemRepository.findByOwnerIntraId(userDto.getIntraId(), pageable);
-		Page<UserItemResponseDto> responseDtos = receipts.map(UserItemResponseDto::new);
-		return new UserItemListResponseDto(responseDtos.getContent(), responseDtos.getTotalPages());
+		Page<UserItemResponseDto> responseDto = receipts.map(UserItemResponseDto::new);
+		return new UserItemListResponseDto(responseDto.getContent(), responseDto.getTotalPages());
 	}
 
+	/**
+	 * <p>해당 아이템의 주인이 맞는지 체크한다.</p>
+	 * @param loginUser 로그인 유저
+	 * @param receipt 영수증
+	 */
 	public void checkItemOwner(User loginUser, Receipt receipt) {
 		if (!receipt.getOwnerIntraId().equals(loginUser.getIntraId())) {
 			throw new ReceiptNotOwnerException();
 		}
 	}
 
+	/**
+	 * <p>해당 아이템의 타입이 영수증과 맞는지 체크한다.</p>
+	 * @param receipt 영수증
+	 * @param itemType 아이템 타입
+	 */
 	public void checkItemType(Receipt receipt, ItemType itemType) {
 		if (!receipt.getItem().getType().equals(itemType)) {
 			throw new ItemTypeException();
 		}
 	}
 
+	/**
+	 * <p>아이템의 상태를 체크한다.</p>
+	 * <p>메가폰인데 ItemStatus.WAITING 가 아니거나 사용중이라면 예외 발생</p>
+	 * <p>메가폰이 아닌 아이템인데 ItemStatus.BEFORE 인경우 예외 발생</p>
+	 * @param receipt
+	 */
 	public void checkItemStatus(Receipt receipt) {
 		if (receipt.getItem().getType().equals(ItemType.MEGAPHONE)) {
-			if (!(receipt.getStatus().equals(ItemStatus.WAITING) || receipt.getStatus().equals(ItemStatus.USING))) {
-				throw new ItemStatusException();
-			}
-		} else {
-			if (!receipt.getStatus().equals(ItemStatus.BEFORE)) {
+			if (!(receipt.getStatus().equals(ItemStatus.WAITING)
+				|| receipt.getStatus().equals(ItemStatus.USING))) {
 				throw new ItemStatusException();
 			}
+		} else if (!receipt.getStatus().equals(ItemStatus.BEFORE)) {
+			throw new ItemStatusException();
 		}
 	}
 }