Feature/86 봉사자의 관심기관 조회 기능 (#96)

7zrv · web-flow · commit 8ed8bd0e075a · 2024-12-01T15:55:38.000+09:00
* feat: 기관 아이디 리스트를 통한 오버뷰 데이터 조회 구현

- 기관Id 리스트로 기관 Id, 이름, 프로필 이미지 url을 조회하는 query 메서드를 영속성 레이어에 구현
- 서비스 레이어 구현
- 테스트 코드 작성및 검증 완

* feat: 봉사자의 관심 기관 리스트 조회 기능 구현

- 봉사자 Id로 관심기관 데이터를 조회하는 쿼리 메서드 구현
- 서비스 레이어 구현
- 관심 기관의 Id, 이름, 프로필 이미지 링크를 담아줄 응답 객체 생성
- 테스트 코드 작성및 검증 완

* feat: 테스트용 인증 유저 어노테이션 구현

- 컨트롤러 테스트에서 이용할 인증유저 어노테이션을 구현했습니다.

* feat: 관심기관 조회 컨트롤러 구현

- 관심기관 조회 컨트롤러 구현
- swagger 어노테이션 작성
- 테스트 코드 작성및 검증 완료

* chore: 불필요한 import문 제거

- 응답 객체의 불필요한 import문 제거

* chore: 테스트 커버리지 제외 클래스 추가

- 테스트용 contextFactory의 테스트 커버리지 예외 설정

* chore: 코드 리뷰 사항 반영

- 일부 mapper 클래스의 네이밍을 수정
- mapper 클래스의 디렉토리 위치 수정
- 응답 클래스에 대한 스웨거 작
diff --git a/build.gradle b/build.gradle
@@ -115,7 +115,8 @@ def jacocoExcludePatterns = [
         '**/auth/**',
         '**/domain/*',
         '**/domains/*',
-        '**/fixture/*'
+        '**/fixture/*',
+        '**/*Factory*'
 ]
 
 def jacocoExcludePatternsForVerify = [
@@ -130,7 +131,8 @@ def jacocoExcludePatternsForVerify = [
         '*.auth.*',
         '*.domain.*',
         '*.domains.*',
-        '*.fixture.*'
+        '*.fixture.*',
+        '*.*Factory*'
 ]
 
 jacocoTestReport {
diff --git a/src/main/java/com/somemore/center/repository/CenterRepository.java b/src/main/java/com/somemore/center/repository/CenterRepository.java
@@ -1,8 +1,10 @@
 package com.somemore.center.repository;
 
 import com.somemore.center.domain.Center;
+import com.somemore.center.repository.mapper.CenterOverviewInfo;
 import org.springframework.stereotype.Repository;
 
+import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
 
@@ -14,5 +16,6 @@ default boolean doesNotExistById(UUID id) {
         return !existsById(id);
     }
     Optional<Center> findCenterById(UUID id);
+    List<CenterOverviewInfo> findCenterOverviewsByIds(List<UUID> ids);
     void deleteAllInBatch();
 }
diff --git a/src/main/java/com/somemore/center/repository/CenterRepositoryImpl.java b/src/main/java/com/somemore/center/repository/CenterRepositoryImpl.java
@@ -1,16 +1,22 @@
 package com.somemore.center.repository;
 
+import com.querydsl.core.types.Projections;
+import com.querydsl.jpa.impl.JPAQueryFactory;
 import com.somemore.center.domain.Center;
+import com.somemore.center.domain.QCenter;
+import com.somemore.center.repository.mapper.CenterOverviewInfo;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Repository;
 
+import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
 
 @RequiredArgsConstructor
 @Repository
 public class CenterRepositoryImpl implements CenterRepository {
 
+    private final JPAQueryFactory queryFactory;
     private final CenterJpaRepository centerJpaRepository;
 
     @Override
@@ -28,6 +34,23 @@ public Optional<Center> findCenterById(UUID id) {
         return centerJpaRepository.findCenterById(id);
     }
 
+    @Override
+    public List<CenterOverviewInfo> findCenterOverviewsByIds(List<UUID> ids) {
+        QCenter center = QCenter.center;
+
+        return queryFactory
+                .select(Projections.constructor(
+                        CenterOverviewInfo.class,
+                        center.id,
+                        center.name,
+                        center.imgUrl
+                ))
+                .from(center)
+                .where(center.id.in(ids)
+                        .and(center.deleted.eq(false)))
+                .fetch();
+    }
+
     @Override
     public void deleteAllInBatch() {
         centerJpaRepository.deleteAllInBatch();
diff --git a/src/main/java/com/somemore/center/repository/mapper/CenterOverviewInfo.java b/src/main/java/com/somemore/center/repository/mapper/CenterOverviewInfo.java
@@ -0,0 +1,12 @@
+package com.somemore.center.repository.mapper;
+
+
+import java.util.UUID;
+
+public record CenterOverviewInfo(
+        UUID centerId,
+        String centerName,
+        String imgUrl
+) {
+
+}
diff --git a/src/main/java/com/somemore/center/service/query/CenterQueryService.java b/src/main/java/com/somemore/center/service/query/CenterQueryService.java
@@ -1,6 +1,7 @@
 package com.somemore.center.service.query;
 
 import com.somemore.center.domain.Center;
+import com.somemore.center.repository.mapper.CenterOverviewInfo;
 import com.somemore.center.dto.response.CenterProfileResponseDto;
 import com.somemore.center.dto.response.PreferItemResponseDto;
 import com.somemore.center.repository.CenterRepository;
@@ -33,6 +34,11 @@ public CenterProfileResponseDto getCenterProfileByCenterId(UUID centerId) {
         return CenterProfileResponseDto.of(center, preferItemDtos);
     }
 
+    @Override
+    public List<CenterOverviewInfo> getCenterOverviewsByIds(List<UUID> centerIds) {
+        return centerRepository.findCenterOverviewsByIds(centerIds);
+    }
+
     @Override
     public void validateCenterExists(UUID id) {
         if (centerRepository.doesNotExistById(id)) {
diff --git a/src/main/java/com/somemore/center/usecase/query/CenterQueryUseCase.java b/src/main/java/com/somemore/center/usecase/query/CenterQueryUseCase.java
@@ -1,11 +1,13 @@
 package com.somemore.center.usecase.query;
 
+import com.somemore.center.repository.mapper.CenterOverviewInfo;
 import com.somemore.center.dto.response.CenterProfileResponseDto;
 
+import java.util.List;
 import java.util.UUID;
 
 public interface CenterQueryUseCase {
-
     CenterProfileResponseDto getCenterProfileByCenterId(UUID centerId);
+    List<CenterOverviewInfo> getCenterOverviewsByIds(List<UUID> centerIds);
     void validateCenterExists(UUID centerId);
 }
diff --git a/src/main/java/com/somemore/interestcenter/controller/InterestCenterQueryApiController.java b/src/main/java/com/somemore/interestcenter/controller/InterestCenterQueryApiController.java
@@ -0,0 +1,32 @@
+package com.somemore.interestcenter.controller;
+
+import com.somemore.global.common.response.ApiResponse;
+import com.somemore.interestcenter.dto.response.InterestCentersResponseDto;
+import com.somemore.interestcenter.usecase.InterestCenterQueryUseCase;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.List;
+import java.util.UUID;
+
+@RequiredArgsConstructor
+@RestController
+@Tag(name = "Interest Center Query API", description = "관심 기관의 조회 API를 제공합니다")
+public class InterestCenterQueryApiController {
+
+    private final InterestCenterQueryUseCase interestCenterQueryUseCase;
+
+    @Operation(summary = "관심기관 목록 조회 API")
+    @GetMapping("/api/interest-centers")
+    public ApiResponse<List<InterestCentersResponseDto>> getInterestCenters(@AuthenticationPrincipal String volunteerId) {
+
+        List<InterestCentersResponseDto> responseDtos = interestCenterQueryUseCase.getInterestCenters(UUID.fromString(volunteerId));
+
+        return ApiResponse.ok(200, responseDtos, "관심기관 조회 성공");
+    }
+
+}
diff --git a/src/main/java/com/somemore/interestcenter/dto/response/InterestCentersResponseDto.java b/src/main/java/com/somemore/interestcenter/dto/response/InterestCentersResponseDto.java
@@ -0,0 +1,28 @@
+package com.somemore.interestcenter.dto.response;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.somemore.center.repository.mapper.CenterOverviewInfo;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Builder;
+
+import java.util.UUID;
+
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+@Builder
+public record InterestCentersResponseDto(
+        @Schema(description = "관심기관의 ID", example = "123e4567-e89b-12d3-a456-426614174000")
+        UUID centerId,
+        @Schema(description = "관심기관의 이름", example = "서울 도서관")
+        String centerName,
+        @Schema(description = "관심기관의 프로필 이미지 링크", example = "~~/image.jpeg")
+        String imgUrl
+) {
+    public static InterestCentersResponseDto of(CenterOverviewInfo responseDto) {
+        return InterestCentersResponseDto.builder()
+                .centerId(responseDto.centerId())
+                .centerName(responseDto.centerName())
+                .imgUrl(responseDto.imgUrl())
+                .build();
+    }
+}
diff --git a/src/main/java/com/somemore/interestcenter/dto/response/RegisterInterestCenterResponseDto.java b/src/main/java/com/somemore/interestcenter/dto/response/RegisterInterestCenterResponseDto.java
@@ -17,7 +17,7 @@ public record RegisterInterestCenterResponseDto(
         @Schema(description = "봉사자 ID", example = "123e4567-e89b-12d3-a456-426614174000")
         UUID volunteerId,
 
-        @Schema(description = "센터 ID", example = "123e4567-e89b-12d3-a456-426614174000")
+        @Schema(description = "기관 ID", example = "123e4567-e89b-12d3-a456-426614174000")
         UUID centerId
 ) {
         public static RegisterInterestCenterResponseDto from(InterestCenter interestCenter) {
diff --git a/src/main/java/com/somemore/interestcenter/repository/InterestCenterRepository.java b/src/main/java/com/somemore/interestcenter/repository/InterestCenterRepository.java
@@ -3,12 +3,14 @@
 import com.somemore.interestcenter.domain.InterestCenter;
 import com.somemore.interestcenter.dto.response.RegisterInterestCenterResponseDto;
 
+import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
 
 public interface InterestCenterRepository {
     InterestCenter save(InterestCenter interestCenter);
     Optional<InterestCenter> findById(Long id);
     Optional<RegisterInterestCenterResponseDto> findInterestCenterResponseById(Long id);
+    List<UUID> findInterestCenterIdsByVolunteerId(UUID volunteerId);
     boolean existsByVolunteerIdAndCenterId(UUID volunteerId, UUID centerId);
 }
diff --git a/src/main/java/com/somemore/interestcenter/repository/InterestCenterRepositoryImpl.java b/src/main/java/com/somemore/interestcenter/repository/InterestCenterRepositoryImpl.java
@@ -8,6 +8,7 @@
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Repository;
 
+import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
 
@@ -61,6 +62,20 @@ public Optional<RegisterInterestCenterResponseDto> findInterestCenterResponseByI
         return Optional.ofNullable(result);
     }
 
+    @Override
+    public List<UUID> findInterestCenterIdsByVolunteerId(UUID volunteerId) {
+        QInterestCenter interestCenter = QInterestCenter.interestCenter;
+
+        return queryFactory
+                .select(interestCenter.centerId)
+                .from(interestCenter)
+                .where(
+                        interestCenter.volunteerId.eq(volunteerId)
+                                .and(interestCenter.deleted.eq(false))
+                )
+                .fetch();
+    }
+
     @Override
     public boolean existsByVolunteerIdAndCenterId(UUID volunteerId, UUID centerId) {
         QInterestCenter interestCenter = QInterestCenter.interestCenter;
diff --git a/src/main/java/com/somemore/interestcenter/service/InterestCenterQueryService.java b/src/main/java/com/somemore/interestcenter/service/InterestCenterQueryService.java
@@ -0,0 +1,34 @@
+package com.somemore.interestcenter.service;
+
+import com.somemore.center.repository.mapper.CenterOverviewInfo;
+import com.somemore.center.usecase.query.CenterQueryUseCase;
+import com.somemore.interestcenter.dto.response.InterestCentersResponseDto;
+import com.somemore.interestcenter.repository.InterestCenterRepository;
+import com.somemore.interestcenter.usecase.InterestCenterQueryUseCase;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+import java.util.UUID;
+
+@RequiredArgsConstructor
+@Service
+public class InterestCenterQueryService implements InterestCenterQueryUseCase {
+
+    private final CenterQueryUseCase centerQueryUseCase;
+    private final InterestCenterRepository interestCenterRepository;
+
+    @Override
+    public List<InterestCentersResponseDto> getInterestCenters(UUID volunteerId) {
+
+        List<UUID> interestCenterIds = interestCenterRepository.findInterestCenterIdsByVolunteerId(volunteerId);
+        if (interestCenterIds.isEmpty()) {
+            return List.of();
+        }
+
+        List<CenterOverviewInfo> centerOverviews = centerQueryUseCase.getCenterOverviewsByIds(interestCenterIds);
+        return centerOverviews.stream()
+                .map(InterestCentersResponseDto::of)
+                .toList();
+    }
+}
diff --git a/src/main/java/com/somemore/interestcenter/usecase/InterestCenterQueryUseCase.java b/src/main/java/com/somemore/interestcenter/usecase/InterestCenterQueryUseCase.java
@@ -0,0 +1,10 @@
+package com.somemore.interestcenter.usecase;
+
+import com.somemore.interestcenter.dto.response.InterestCentersResponseDto;
+
+import java.util.List;
+import java.util.UUID;
+
+public interface InterestCenterQueryUseCase {
+    List<InterestCentersResponseDto> getInterestCenters(UUID volunteerId);
+}
diff --git a/src/test/java/com/somemore/CustomSecurityContextFactory.java b/src/test/java/com/somemore/CustomSecurityContextFactory.java
@@ -0,0 +1,26 @@
+package com.somemore;
+
+import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.core.context.SecurityContext;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.test.context.support.WithSecurityContextFactory;
+
+import java.util.Collections;
+
+public class CustomSecurityContextFactory implements WithSecurityContextFactory<WithMockCustomUser> {
+    @Override
+    public SecurityContext createSecurityContext(WithMockCustomUser annotation) {
+        SecurityContext context = SecurityContextHolder.createEmptyContext();
+
+        Authentication auth = new UsernamePasswordAuthenticationToken(
+                annotation.username(),
+                "password",
+                Collections.singletonList(new SimpleGrantedAuthority("ROLE_USER"))
+        );
+
+        context.setAuthentication(auth);
+        return context;
+    }
+}
diff --git a/src/test/java/com/somemore/WithMockCustomUser.java b/src/test/java/com/somemore/WithMockCustomUser.java
@@ -0,0 +1,12 @@
+package com.somemore;
+
+import org.springframework.security.test.context.support.WithSecurityContext;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+@Retention(RetentionPolicy.RUNTIME)
+@WithSecurityContext(factory = CustomSecurityContextFactory.class)
+public @interface WithMockCustomUser {
+    String username() default "123e4567-e89b-12d3-a456-426614174000";
+}
diff --git a/src/test/java/com/somemore/center/service/query/CenterQueryServiceTest.java b/src/test/java/com/somemore/center/service/query/CenterQueryServiceTest.java
diff --git a/src/test/java/com/somemore/interestcenter/controller/InterestCenterQueryApiControllerTest.java b/src/test/java/com/somemore/interestcenter/controller/InterestCenterQueryApiControllerTest.java
diff --git a/src/test/java/com/somemore/interestcenter/service/InterestCenterQueryServiceTest.java b/src/test/java/com/somemore/interestcenter/service/InterestCenterQueryServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,10 @@`
`1`	`1`	`package com.somemore.center.repository;`
`2`	`2`
`3`	`3`	`import com.somemore.center.domain.Center;`
	`4`	`+import com.somemore.center.repository.mapper.CenterOverviewInfo;`
`4`	`5`	`import org.springframework.stereotype.Repository;`
`5`	`6`
	`7`	`+import java.util.List;`
`6`	`8`	`import java.util.Optional;`
`7`	`9`	`import java.util.UUID;`
`8`	`10`
`@@ -14,5 +16,6 @@ default boolean doesNotExistById(UUID id) {`
`14`	`16`	`return !existsById(id);`
`15`	`17`	`}`
`16`	`18`	`Optional<Center> findCenterById(UUID id);`
	`19`	`+ List<CenterOverviewInfo> findCenterOverviewsByIds(List<UUID> ids);`
`17`	`20`	`void deleteAllInBatch();`
`18`	`21`	`}`