Feature/75 관심기관 등록, 취소 기능 구현 (#85)

7zrv · web-flow · commit ff886b7eb1d1 · 2024-11-29T23:26:21.000+09:00
* feat: 관심기관 등록 기능 구현 - InterestCenter 엔티티에 누락된 기관, 봉사자 id 필드 추가 - 관심 기관 등록 유스케이스 추가및 서비스 레이어 구현 - 등록, 검증을 위한 영속성 레이어 구현 - 중복 예외 클래스 추가 - 예외 메세지 추가 - 테스트 코드 작성및 검증 완 * feat: 관심기관 취소 기능 구현 - 관심 기관 취소 유스케이스 추가및 서비스 레이어 구현 - 관심기관 취소, 검증을 위한 영속성 레이어 구현 - 예외 메세지 추가 - 테스트 코드 작성및 검증 완료 * feat: 관심기관 API 컨트롤러 구현 - 관심 기관 등록과 취소 엔드포인트 컨트롤러 구현 - ApiResponse 공통 응답 객체 메서드 추가(논의 예정) - 테스트 코드 작성및 검증완료 * feat: 요청 유효성 검증추가 - 관심기관 등록 요청 Dto에 유효성 검증 어노테이션 추가 - 활성화를 위해 컨트롤러에 @Valid 어노테이션 추가 * refactor: 공통 응답 객체 수정및 적용 - 기존 와일드카드를 사용하던 ApiResponse의 ok 메서드를 String 타입으로 리팩토링 - 변경에 따른 컨트롤러 return문 수정 * chore: 요청 Dto swagger scheme 수정 - 봉사자 -> 기관으로 수정 * chore: 컨트롤러 엔드 포인트 수정 - 기존 RequestMapping을 이용한 전역적인 엔드포인트 적용에서 엔드포인트마다 url을 붙여주는 방식으로 수정
diff --git a/src/main/java/com/somemore/domains/InterestCenter.java b/src/main/java/com/somemore/domains/InterestCenter.java
diff --git a/src/main/java/com/somemore/global/common/response/ApiResponse.java b/src/main/java/com/somemore/global/common/response/ApiResponse.java
@@ -15,14 +15,10 @@ public static <T> ApiResponse<T> ok(int status, T data, String message) {
         return new ApiResponse<>(status, message, data);
     }
 
-    public static ApiResponse<?> ok(String message) {
+    public static ApiResponse<String> ok(String message) {
         return new ApiResponse<>(200, message, "");
     }
 
-    public static ApiResponse<?> error(int code, String message) {
-        return new ApiResponse<>(code, message, "");
-    }
-
     public ApiResponse(int code, String message, T data) {
         this.code = code;
         this.message = message;
diff --git a/src/main/java/com/somemore/global/exception/DuplicateException.java b/src/main/java/com/somemore/global/exception/DuplicateException.java
@@ -0,0 +1,8 @@
+package com.somemore.global.exception;
+
+public class DuplicateException extends RuntimeException{
+
+    public DuplicateException(final String message) {
+        super(message);
+    }
+}
diff --git a/src/main/java/com/somemore/global/exception/ExceptionMessage.java b/src/main/java/com/somemore/global/exception/ExceptionMessage.java
@@ -21,6 +21,8 @@ public enum ExceptionMessage {
     FILE_SIZE_EXCEEDED("파일 크기가 허용된 한도를 초과했습니다."),
     EMPTY_FILE("파일이 존재하지 않습니다."),
     INSTANTIATION_NOT_ALLOWED("인스턴스화 할 수 없는 클래스 입니다."),
+    CANNOT_CANCEL_DELETED_INTEREST_CENTER("이미 삭제된 관심 기관은 취소할 수 없습니다."),
+    DUPLICATE_INTEREST_CENTER("이미 관심 표시한 기관입니다.")
     ;
 
     private final String message;
diff --git a/src/main/java/com/somemore/global/handler/GlobalExceptionHandler.java b/src/main/java/com/somemore/global/handler/GlobalExceptionHandler.java
@@ -1,17 +1,14 @@
 package com.somemore.global.handler;
 
-
 import com.somemore.global.exception.BadRequestException;
+import com.somemore.global.exception.DuplicateException;
 import com.somemore.global.exception.ImageUploadException;
-import org.springframework.data.crossstore.ChangeSetPersister;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ProblemDetail;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
-import org.springframework.web.context.request.WebRequest;
 import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
 
-
 @RestControllerAdvice
 public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {
 
@@ -39,4 +36,13 @@ ProblemDetail handleImageUploadException(final ImageUploadException e) {
         return problemDetail;
     }
 
+    @ExceptionHandler(DuplicateException.class)
+    ProblemDetail handleDuplicateException(final DuplicateException e) {
+
+        ProblemDetail problemDetail = ProblemDetail.forStatusAndDetail(HttpStatus.BAD_REQUEST, e.getMessage());
+        problemDetail.setTitle("중복 예외");
+
+        return problemDetail;
+    }
+
 }
diff --git a/src/main/java/com/somemore/interestcenter/controller/InterestCenterCommandApiController.java b/src/main/java/com/somemore/interestcenter/controller/InterestCenterCommandApiController.java
@@ -0,0 +1,40 @@
+package com.somemore.interestcenter.controller;
+
+import com.somemore.global.common.response.ApiResponse;
+import com.somemore.interestcenter.dto.request.RegisterInterestCenterRequestDto;
+import com.somemore.interestcenter.dto.response.RegisterInterestCenterResponseDto;
+import com.somemore.interestcenter.usecase.CancelInterestCenterUseCase;
+import com.somemore.interestcenter.usecase.RegisterInterestCenterUseCase;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.*;
+
+@RequiredArgsConstructor
+@RestController
+@Tag(name = "Interest Center Command API", description = "관심 기관의 등록과 취소 API를 제공합니다")
+public class InterestCenterCommandApiController {
+
+    private final RegisterInterestCenterUseCase registerInterestCenterUseCase;
+    private final CancelInterestCenterUseCase cancelInterestCenterUseCase;
+
+    @Operation(summary = "관심기관 등록 API")
+    @PostMapping("/api/interest-center")
+    public ApiResponse<RegisterInterestCenterResponseDto> registerInterestCenter(@Valid @RequestBody RegisterInterestCenterRequestDto requestDto) {
+
+        RegisterInterestCenterResponseDto responseDto = registerInterestCenterUseCase.registerInterestCenter(requestDto);
+
+        return ApiResponse.ok(200, responseDto, "관심 기관 등록 성공");
+    }
+
+    @Operation(summary = "관심기관 취소 API")
+    @DeleteMapping("/api/interest-center/{interest-center-id}")
+    public ApiResponse<String> deleteInterestCenter(@PathVariable("interest-center-id") Long interestCenterId) {
+
+        cancelInterestCenterUseCase.cancelInterestCenter(interestCenterId);
+
+        return ApiResponse.ok("관심 기관 취소 성공");
+    }
+
+}
diff --git a/src/main/java/com/somemore/interestcenter/domain/InterestCenter.java b/src/main/java/com/somemore/interestcenter/domain/InterestCenter.java
@@ -0,0 +1,39 @@
+package com.somemore.interestcenter.domain;
+
+import com.somemore.global.common.BaseEntity;
+import jakarta.persistence.*;
+import lombok.*;
+
+import java.util.UUID;
+
+import static jakarta.persistence.GenerationType.IDENTITY;
+
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@Getter
+@Entity
+@Table(name = "interest_center")
+public class InterestCenter extends BaseEntity {
+
+    @Id
+    @GeneratedValue(strategy = IDENTITY)
+    private Long id;
+
+    @Column(name = "volunteer_id", nullable = false)
+    private UUID volunteerId;
+
+    @Column(name = "center_id", nullable = false)
+    private UUID centerId;
+
+    @Builder
+    private InterestCenter(UUID volunteerId, UUID centerId) {
+        this.volunteerId = volunteerId;
+        this.centerId = centerId;
+    }
+
+    public static InterestCenter create(UUID volunteerId, UUID centerId) {
+        return InterestCenter.builder()
+                .volunteerId(volunteerId)
+                .centerId(centerId)
+                .build();
+    }
+}
diff --git a/src/main/java/com/somemore/interestcenter/dto/request/RegisterInterestCenterRequestDto.java b/src/main/java/com/somemore/interestcenter/dto/request/RegisterInterestCenterRequestDto.java
@@ -0,0 +1,25 @@
+package com.somemore.interestcenter.dto.request;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.somemore.interestcenter.domain.InterestCenter;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotNull;
+
+import java.util.UUID;
+
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+public record RegisterInterestCenterRequestDto(
+
+        @Schema(description = "봉사자 ID", example = "123e4567-e89b-12d3-a456-426614174000")
+        @NotNull(message = "봉사자 ID는 필수값입니다.")
+        UUID volunteerId,
+
+        @Schema(description = "기관 ID", example = "123e4567-e89b-12d3-a456-426614174000")
+        @NotNull(message = "기관 ID는 필수값입니다.")
+        UUID centerId
+) {
+    public InterestCenter toEntity(){
+        return InterestCenter.create(volunteerId, centerId);
+    }
+}
diff --git a/src/main/java/com/somemore/interestcenter/dto/response/RegisterInterestCenterResponseDto.java b/src/main/java/com/somemore/interestcenter/dto/response/RegisterInterestCenterResponseDto.java
@@ -0,0 +1,30 @@
+package com.somemore.interestcenter.dto.response;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.somemore.interestcenter.domain.InterestCenter;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Builder;
+
+import java.util.UUID;
+
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+@Builder
+public record RegisterInterestCenterResponseDto(
+        @Schema(description = "관심 ID", example = "1111")
+        Long id,
+
+        @Schema(description = "봉사자 ID", example = "123e4567-e89b-12d3-a456-426614174000")
+        UUID volunteerId,
+
+        @Schema(description = "센터 ID", example = "123e4567-e89b-12d3-a456-426614174000")
+        UUID centerId
+) {
+        public static RegisterInterestCenterResponseDto from(InterestCenter interestCenter) {
+                return RegisterInterestCenterResponseDto.builder()
+                        .id(interestCenter.getId())
+                        .volunteerId(interestCenter.getVolunteerId())
+                        .centerId(interestCenter.getCenterId())
+                        .build();
+        }
+}
diff --git a/src/main/java/com/somemore/interestcenter/repository/InterestCenterJpaRepository.java b/src/main/java/com/somemore/interestcenter/repository/InterestCenterJpaRepository.java
@@ -0,0 +1,7 @@
+package com.somemore.interestcenter.repository;
+
+import com.somemore.interestcenter.domain.InterestCenter;
+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface InterestCenterJpaRepository extends JpaRepository<InterestCenter, Long> {
+}
diff --git a/src/main/java/com/somemore/interestcenter/repository/InterestCenterRepository.java b/src/main/java/com/somemore/interestcenter/repository/InterestCenterRepository.java
@@ -0,0 +1,14 @@
+package com.somemore.interestcenter.repository;
+
+import com.somemore.interestcenter.domain.InterestCenter;
+import com.somemore.interestcenter.dto.response.RegisterInterestCenterResponseDto;
+
+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);
+    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
@@ -0,0 +1,81 @@
+package com.somemore.interestcenter.repository;
+
+import com.querydsl.core.types.Projections;
+import com.querydsl.jpa.impl.JPAQueryFactory;
+import com.somemore.interestcenter.domain.InterestCenter;
+import com.somemore.interestcenter.domain.QInterestCenter;
+import com.somemore.interestcenter.dto.response.RegisterInterestCenterResponseDto;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Repository;
+
+import java.util.Optional;
+import java.util.UUID;
+
+@RequiredArgsConstructor
+@Repository
+public class InterestCenterRepositoryImpl implements InterestCenterRepository {
+
+    private final JPAQueryFactory queryFactory;
+    private final InterestCenterJpaRepository interestCenterJpaRepository;
+
+    @Override
+    public InterestCenter save(InterestCenter interestCenter) {
+        return interestCenterJpaRepository.save(interestCenter);
+    }
+
+    @Override
+    public Optional<InterestCenter> findById(Long id) {
+        QInterestCenter interestCenter = QInterestCenter.interestCenter;
+
+        InterestCenter result = queryFactory
+                .selectFrom(interestCenter)
+                .where(
+                        interestCenter.id.eq(id)
+                                .and(interestCenter.deleted.eq(false))
+                )
+                .fetchOne();
+
+        return Optional.ofNullable(result);
+    }
+
+    @Override
+    public Optional<RegisterInterestCenterResponseDto> findInterestCenterResponseById(Long id) {
+        QInterestCenter interestCenter = QInterestCenter.interestCenter;
+
+        RegisterInterestCenterResponseDto result = queryFactory
+                .select(
+                        Projections.constructor(
+                                RegisterInterestCenterResponseDto.class,
+                                interestCenter.id,
+                                interestCenter.volunteerId,
+                                interestCenter.centerId
+                        )
+                )
+                .from(interestCenter)
+                .where(
+                        interestCenter.id.eq(id)
+                                .and(interestCenter.deleted.eq(false))
+                )
+                .fetchOne();
+
+        return Optional.ofNullable(result);
+    }
+
+    @Override
+    public boolean existsByVolunteerIdAndCenterId(UUID volunteerId, UUID centerId) {
+        QInterestCenter interestCenter = QInterestCenter.interestCenter;
+
+        Integer result = queryFactory
+                .selectOne()
+                .from(interestCenter)
+                .where(
+                        interestCenter.volunteerId.eq(volunteerId)
+                                .and(interestCenter.centerId.eq(centerId))
+                                .and(interestCenter.deleted.eq(false))
+                )
+                .fetchFirst();
+
+        return result != null;
+    }
+
+}
diff --git a/src/main/java/com/somemore/interestcenter/service/CancelInterestCenterService.java b/src/main/java/com/somemore/interestcenter/service/CancelInterestCenterService.java
@@ -0,0 +1,28 @@
+package com.somemore.interestcenter.service;
+
+import com.somemore.global.exception.BadRequestException;
+import com.somemore.interestcenter.domain.InterestCenter;
+import com.somemore.interestcenter.repository.InterestCenterRepository;
+import com.somemore.interestcenter.usecase.CancelInterestCenterUseCase;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+import static com.somemore.global.exception.ExceptionMessage.CANNOT_CANCEL_DELETED_INTEREST_CENTER;
+
+@RequiredArgsConstructor
+@Service
+public class CancelInterestCenterService implements CancelInterestCenterUseCase {
+
+    private final InterestCenterRepository interestCenterRepository;
+
+    @Override
+    public void cancelInterestCenter(Long interestCenterId) {
+        InterestCenter interestCenter = interestCenterRepository.findById(interestCenterId)
+                .orElseThrow(() -> new BadRequestException(CANNOT_CANCEL_DELETED_INTEREST_CENTER.getMessage()));
+
+        interestCenter.markAsDeleted();
+
+        interestCenterRepository.save(interestCenter);
+    }
+
+}
diff --git a/src/main/java/com/somemore/interestcenter/service/RegisterInterestCenterService.java b/src/main/java/com/somemore/interestcenter/service/RegisterInterestCenterService.java
@@ -0,0 +1,37 @@
+package com.somemore.interestcenter.service;
+
+import com.somemore.center.usecase.query.CenterQueryUseCase;
+import com.somemore.global.exception.DuplicateException;
+import com.somemore.interestcenter.domain.InterestCenter;
+import com.somemore.interestcenter.dto.request.RegisterInterestCenterRequestDto;
+import com.somemore.interestcenter.dto.response.RegisterInterestCenterResponseDto;
+import com.somemore.interestcenter.repository.InterestCenterRepository;
+import com.somemore.interestcenter.usecase.RegisterInterestCenterUseCase;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+
+import static com.somemore.global.exception.ExceptionMessage.DUPLICATE_INTEREST_CENTER;
+
+@RequiredArgsConstructor
+@Service
+public class RegisterInterestCenterService implements RegisterInterestCenterUseCase {
+
+    private final InterestCenterRepository repository;
+    private final CenterQueryUseCase centerQueryUseCase;
+
+    @Override
+    public RegisterInterestCenterResponseDto registerInterestCenter(RegisterInterestCenterRequestDto requestDto) {
+
+        centerQueryUseCase.validateCenterExists(requestDto.centerId());
+
+        boolean isDuplicate = repository.existsByVolunteerIdAndCenterId(requestDto.volunteerId(), requestDto.centerId());
+        if(isDuplicate){
+            throw new DuplicateException(DUPLICATE_INTEREST_CENTER.getMessage());
+        }
+
+        InterestCenter interestCenter = repository.save(requestDto.toEntity());
+
+        return RegisterInterestCenterResponseDto.from(interestCenter);
+    }
+
+}
diff --git a/src/main/java/com/somemore/interestcenter/usecase/CancelInterestCenterUseCase.java b/src/main/java/com/somemore/interestcenter/usecase/CancelInterestCenterUseCase.java
diff --git a/src/main/java/com/somemore/interestcenter/usecase/RegisterInterestCenterUseCase.java b/src/main/java/com/somemore/interestcenter/usecase/RegisterInterestCenterUseCase.java
diff --git a/src/test/java/com/somemore/interestcenter/controller/InterestCenterCommandApiControllerTest.java b/src/test/java/com/somemore/interestcenter/controller/InterestCenterCommandApiControllerTest.java
diff --git a/src/test/java/com/somemore/interestcenter/service/CancelInterestCenterServiceTest.java b/src/test/java/com/somemore/interestcenter/service/CancelInterestCenterServiceTest.java
diff --git a/src/test/java/com/somemore/interestcenter/service/RegisterInterestCenterServiceTest.java b/src/test/java/com/somemore/interestcenter/service/RegisterInterestCenterServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -15,14 +15,10 @@ public static <T> ApiResponse<T> ok(int status, T data, String message) {`
`15`	`15`	`return new ApiResponse<>(status, message, data);`
`16`	`16`	`}`
`17`	`17`
`18`		`- public static ApiResponse<?> ok(String message) {`
	`18`	`+ public static ApiResponse<String> ok(String message) {`
`19`	`19`	`return new ApiResponse<>(200, message, "");`
`20`	`20`	`}`
`21`	`21`
`22`		`- public static ApiResponse<?> error(int code, String message) {`
`23`		`- return new ApiResponse<>(code, message, "");`
`24`		`- }`
`25`		`-`
`26`	`22`	`public ApiResponse(int code, String message, T data) {`
`27`	`23`	`this.code = code;`
`28`	`24`	`this.message = message;`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ public enum ExceptionMessage {`
`21`	`21`	`FILE_SIZE_EXCEEDED("파일 크기가 허용된 한도를 초과했습니다."),`
`22`	`22`	`EMPTY_FILE("파일이 존재하지 않습니다."),`
`23`	`23`	`INSTANTIATION_NOT_ALLOWED("인스턴스화 할 수 없는 클래스 입니다."),`
	`24`	`+ CANNOT_CANCEL_DELETED_INTEREST_CENTER("이미 삭제된 관심 기관은 취소할 수 없습니다."),`
	`25`	`+ DUPLICATE_INTEREST_CENTER("이미 관심 표시한 기관입니다.")`
`24`	`26`	`;`
`25`	`27`
`26`	`28`	`private final String message;`