From 735e96bae68b913f6d49c8d475709691053a79c2 Mon Sep 17 00:00:00 2001 From: hydrationn Date: Thu, 16 May 2024 01:42:55 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20#89=20JavaDoc=20=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../pointdetail/adaptor/UserPointDetailAdaptor.java | 13 ++++++++++++- .../client/UserPointDetailApiClient.java | 1 + .../controller/UserPointDetailController.java | 5 +++-- .../pointdetail/service/UserPointDetailService.java | 13 ++++++++++++- 4 files changed, 28 insertions(+), 4 deletions(-) diff --git a/src/main/java/com/t3t/frontserver/pointdetail/adaptor/UserPointDetailAdaptor.java b/src/main/java/com/t3t/frontserver/pointdetail/adaptor/UserPointDetailAdaptor.java index a344cc7..4c582dc 100644 --- a/src/main/java/com/t3t/frontserver/pointdetail/adaptor/UserPointDetailAdaptor.java +++ b/src/main/java/com/t3t/frontserver/pointdetail/adaptor/UserPointDetailAdaptor.java @@ -1,6 +1,5 @@ package com.t3t.frontserver.pointdetail.adaptor; -import com.t3t.frontserver.auth.util.SecurityContextUtils; import com.t3t.frontserver.common.exception.ApiDataFetchException; import com.t3t.frontserver.model.response.BaseResponse; import com.t3t.frontserver.pointdetail.client.UserPointDetailApiClient; @@ -15,12 +14,24 @@ import java.util.List; import java.util.Objects; +/** + * 포인트 상세 정보를 가져오는 adaptor class + * 외부 시스템으로부터 사용자의 포인트 상세 내역을 가져오는 역할 + */ @Slf4j @Component @RequiredArgsConstructor public class UserPointDetailAdaptor { private final UserPointDetailApiClient userPointDetailApiClient; + /** + * 사용자 ID와 포인트 상세 유형을 기반으로 포인트 상세 정보 조회 + * @param memberId 회원 ID + * @param pointDetailType 조회할 포인트 타입(사용/적립), null이면 전체 내역 조회 + * @return 조건에 맞는 포인트 상세 내역 리스트를 반환. 조회된 정보가 없거나, 요청 처리 중 오류가 발생한 경우 null 반환. + * @throws ApiDataFetchException 외부 시스템으로부터 데이터를 가져오는 과정에서 오류가 발생한 경우 예외 발생 + * @author hydrationn(박수화) + */ public List getPointDetailByPointDetailType(Long memberId, String pointDetailType) { try { ResponseEntity>> response = userPointDetailApiClient.getPointDetailByPointDetailType(memberId, pointDetailType); diff --git a/src/main/java/com/t3t/frontserver/pointdetail/client/UserPointDetailApiClient.java b/src/main/java/com/t3t/frontserver/pointdetail/client/UserPointDetailApiClient.java index 8ce50f9..c0920ec 100644 --- a/src/main/java/com/t3t/frontserver/pointdetail/client/UserPointDetailApiClient.java +++ b/src/main/java/com/t3t/frontserver/pointdetail/client/UserPointDetailApiClient.java @@ -17,6 +17,7 @@ public interface UserPointDetailApiClient { /** * 회원의 포인트 타입에 따른 포인트 사용/적립 내역 조회 API 호출 + * @param memberId 회원 ID * @param pointDetailType 조회할 포인트 타입(사용/적립) * @author hydrationn(박수화) */ diff --git a/src/main/java/com/t3t/frontserver/pointdetail/controller/UserPointDetailController.java b/src/main/java/com/t3t/frontserver/pointdetail/controller/UserPointDetailController.java index bf2d71a..4011efe 100644 --- a/src/main/java/com/t3t/frontserver/pointdetail/controller/UserPointDetailController.java +++ b/src/main/java/com/t3t/frontserver/pointdetail/controller/UserPointDetailController.java @@ -22,8 +22,9 @@ public class UserPointDetailController { private final UserPointDetailService userPointDetailService; /** - * 회원 포인트 사용/적립 내역 페이지 뷰 반환 - * @return 포인트 사용/적립 내역 뷰 + * 회원 포인트 전체/사용/적립 내역 페이지 뷰 반환 + * @param pointDetailType 조회할 포인트 타입(사용/적립) + * @return 포인트 전체/사용/적립 내역 뷰 * @author hydrationn(박수화) */ @GetMapping("/mypage/point-details") diff --git a/src/main/java/com/t3t/frontserver/pointdetail/service/UserPointDetailService.java b/src/main/java/com/t3t/frontserver/pointdetail/service/UserPointDetailService.java index af180cd..5dcaf63 100644 --- a/src/main/java/com/t3t/frontserver/pointdetail/service/UserPointDetailService.java +++ b/src/main/java/com/t3t/frontserver/pointdetail/service/UserPointDetailService.java @@ -1,6 +1,5 @@ package com.t3t.frontserver.pointdetail.service; -import com.t3t.frontserver.auth.util.SecurityContextUtils; import com.t3t.frontserver.pointdetail.adaptor.UserPointDetailAdaptor; import com.t3t.frontserver.pointdetail.model.response.PointDetailResponse; import lombok.RequiredArgsConstructor; @@ -8,11 +7,23 @@ import java.util.List; +/** + * 사용자의 포인트 상세 정보를 관리하는 서비스 + * 외부 시스템으로부터 사용자의 포인트 상세 정보를 조회하는 기능 제공 + */ @Service @RequiredArgsConstructor public class UserPointDetailService { private final UserPointDetailAdaptor userPointDetailAdaptor; + /** + * 회원 ID와 포인트 상세 유형을 기반으로 포인트 상세 내역 조회 + * @param memberId 회원 ID + * @param pointDetailType 조회할 포인트 타입(사용/적립) + * @return 해당 조건에 맞는 포인트 상세 정보 리스트를 반환. + * 외부 시스템으로부터 정보를 성공적으로 조회하면 그에 대한 결과를, 그렇지 않으면 null을 반환. + * @author hydrationn(박수화) + */ public List getPointDetailByPointDetailType(Long memberId, String pointDetailType) { return userPointDetailAdaptor.getPointDetailByPointDetailType(memberId, pointDetailType); }