Merge pull request #19 from 9oormthon-univ/feat/questions-trash-type

TaetaetaE01 · web-flow · commit f8c0165f14db · 2025-09-04T04:09:32.000+09:00
[Feat] 챗봇 단어로 쓰레기 배출 방법 검색 구현
diff --git a/src/main/java/com/trashheroesbe/feature/question/api/QuestionController.java b/src/main/java/com/trashheroesbe/feature/question/api/QuestionController.java
@@ -7,11 +7,13 @@
 import com.trashheroesbe.feature.trash.dto.response.TrashItemResponse;
 import com.trashheroesbe.feature.trash.dto.response.TrashTypeResponse;
 import com.trashheroesbe.global.response.ApiResponse;
+import jakarta.validation.constraints.NotBlank;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
@@ -38,11 +40,23 @@ public ApiResponse<List<TrashItemResponse>> getTrashItems(
     }
 
     @Override
-    @GetMapping("/trash-items/{trashItemId}")
-    public ApiResponse<List<TrashDescriptionResponse>> getTrashDescriptions(
-        @PathVariable Long trashItemId
+    @GetMapping("/trash-types/{trashTypeId}/descriptions")
+    public ApiResponse<TrashDescriptionResponse> getTrashDescriptions(
+        @PathVariable Long trashTypeId
     ) {
         // TODO : 여기서 question객체 생성해서 검색기록 추적할 수 있도록 하면 좋을 거 같음
-        return ApiResponse.success(OK, null);
+        TrashDescriptionResponse response = questionService.getTrashDescriptions(trashTypeId);
+        return ApiResponse.success(OK, response);
     }
+
+    @Override
+    @GetMapping("/search")
+    public ApiResponse<TrashDescriptionResponse> searchTrashDescription(
+        @RequestParam("keyword") String keyword
+    ) {
+        TrashDescriptionResponse response = questionService.searchTrashDescription(keyword);
+        return ApiResponse.success(OK, response);
+    }
+
+
 }
diff --git a/src/main/java/com/trashheroesbe/feature/question/api/QuestionControllerApi.java b/src/main/java/com/trashheroesbe/feature/question/api/QuestionControllerApi.java
@@ -6,6 +6,7 @@
 import com.trashheroesbe.global.response.ApiResponse;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.constraints.NotBlank;
 import java.util.List;
 
 @Tag(name = "Question", description = "질문 관련 API(챗봇)")
@@ -17,6 +18,9 @@ public interface QuestionControllerApi {
     @Operation(summary = "쓰레기 카테고리별 품목 조회(쓰레기 품목 조회)", description = "trashTypeId를 통해 쓰레기 품목을 조회 합니다.")
     ApiResponse<List<TrashItemResponse>> getTrashItems(Long trashTypeId);
 
-    @Operation(summary = "쓰레기 배출 방법 조회하기", description = "trashItemId를 통해 쓰레기 배출 방법을 조회 합니다.")
-    ApiResponse<List<TrashDescriptionResponse>> getTrashDescriptions(Long trashItemId);
+    @Operation(summary = "쓰레기 배출 방법 조회하기", description = "trashTypeId를 통해 쓰레기 배출 방법을 조회 합니다.")
+    ApiResponse<TrashDescriptionResponse> getTrashDescriptions(Long trashTypeId);
+
+    @Operation(summary = "단어로 쓰레기 배출 방법 조회하기", description = "keyword로 쓰레기 배출방법을 조회한다.")
+    ApiResponse<TrashDescriptionResponse> searchTrashDescription(@NotBlank String keyword);
 }
diff --git a/src/main/java/com/trashheroesbe/feature/question/application/QuestionService.java b/src/main/java/com/trashheroesbe/feature/question/application/QuestionService.java
@@ -1,15 +1,21 @@
 package com.trashheroesbe.feature.question.application;
 
+import static com.trashheroesbe.global.response.type.ErrorCode.NOT_EXISTS_TRASH_DESCRIPTION;
 import static com.trashheroesbe.global.response.type.ErrorCode.NOT_EXISTS_TRASH_ITEM;
 import static com.trashheroesbe.global.response.type.ErrorCode.NOT_EXISTS_TRASH_TYPE;
 
+import com.trashheroesbe.feature.trash.domain.Type;
+import com.trashheroesbe.feature.trash.domain.entity.TrashDescription;
 import com.trashheroesbe.feature.trash.domain.entity.TrashItem;
 import com.trashheroesbe.feature.trash.domain.entity.TrashType;
+import com.trashheroesbe.feature.trash.domain.service.TrashDescriptionFinder;
 import com.trashheroesbe.feature.trash.domain.service.TrashItemFinder;
 import com.trashheroesbe.feature.trash.domain.service.TrashTypeFinder;
+import com.trashheroesbe.feature.trash.dto.response.TrashDescriptionResponse;
 import com.trashheroesbe.feature.trash.dto.response.TrashItemResponse;
 import com.trashheroesbe.feature.trash.dto.response.TrashTypeResponse;
 import com.trashheroesbe.global.exception.BusinessException;
+import com.trashheroesbe.infrastructure.port.gpt.ChatAIClientPort;
 import java.util.List;
 import java.util.stream.Collectors;
 import lombok.RequiredArgsConstructor;
@@ -23,24 +29,40 @@ public class QuestionService {
 
     private final TrashTypeFinder trashTypeFinder;
     private final TrashItemFinder trashItemFinder;
+    private final TrashDescriptionFinder trashDescriptionFinder;
+    private final ChatAIClientPort chatAIClientPort;
 
     public List<TrashTypeResponse> getTrashTypes() {
         List<TrashType> trashTypes = trashTypeFinder.getAllTrashTypes();
-        if (trashTypes.isEmpty()) {
-            throw new BusinessException(NOT_EXISTS_TRASH_TYPE);
-        }
+
         return trashTypes.stream()
+            .filter(trashType -> trashType.getType() != Type.UNKNOWN)
             .map(TrashTypeResponse::from)
             .collect(Collectors.toList());
     }
 
     public List<TrashItemResponse> getTrashItems(Long trashTypeId) {
         List<TrashItem> trashItems = trashItemFinder.findTrashItemsByTrashTypeId(trashTypeId);
-        if (trashItems.isEmpty()) {
-            throw new BusinessException(NOT_EXISTS_TRASH_ITEM);
-        }
         return trashItems.stream()
             .map(TrashItemResponse::from)
             .collect(Collectors.toList());
     }
+
+    public TrashDescriptionResponse getTrashDescriptions(Long trashTypeId) {
+        TrashDescription trashDescription = trashDescriptionFinder.findTrashDescriptionsByTrashTypeId(
+            trashTypeId);
+        return TrashDescriptionResponse.from(trashDescription);
+    }
+
+    public TrashDescriptionResponse searchTrashDescription(String keyword) {
+        Type type = chatAIClientPort.findSimilarTrashItem(keyword);
+        if (type == null) {
+            return TrashDescriptionResponse.ofNotFound();
+        }
+
+        TrashType trashType = trashTypeFinder.getTrashType(type);
+        TrashDescription trashDescription = trashDescriptionFinder.findTrashDescriptionsByTrashTypeId(
+            trashType.getId());
+        return TrashDescriptionResponse.from(trashDescription);
+    }
 }
diff --git a/src/main/java/com/trashheroesbe/feature/trash/domain/entity/TrashDescription.java b/src/main/java/com/trashheroesbe/feature/trash/domain/entity/TrashDescription.java
@@ -1,6 +1,8 @@
 package com.trashheroesbe.feature.trash.domain.entity;
 
 import jakarta.persistence.*;
+import java.util.Arrays;
+import java.util.List;
 import lombok.*;
 
 @Getter
@@ -29,11 +31,13 @@ public class TrashDescription {
     private String cautionNote;
 
     // 줄바꿈으로 STEP 리스트 변환
-    public java.util.List<String> steps() {
-        if (methodDetail == null || methodDetail.isBlank()) return java.util.List.of();
-        return java.util.Arrays.stream(methodDetail.split("\\r?\\n"))
-                .map(String::trim)
-                .filter(s -> !s.isBlank())
-                .toList();
+    public List<String> steps() {
+        if (methodDetail == null || methodDetail.isBlank()) {
+            return List.of();
+        }
+        return Arrays.stream(methodDetail.split("\\r?\\n"))
+            .map(String::trim)
+            .filter(s -> !s.isBlank())
+            .toList();
     }
 }
diff --git a/src/main/java/com/trashheroesbe/feature/trash/domain/service/TrashDescriptionFinder.java b/src/main/java/com/trashheroesbe/feature/trash/domain/service/TrashDescriptionFinder.java
@@ -0,0 +1,24 @@
+package com.trashheroesbe.feature.trash.domain.service;
+
+import static com.trashheroesbe.global.response.type.ErrorCode.NOT_EXISTS_TRASH_DESCRIPTION;
+
+import com.trashheroesbe.feature.trash.domain.entity.TrashDescription;
+import com.trashheroesbe.feature.trash.infrastructure.TrashDescriptionRepository;
+import com.trashheroesbe.global.exception.BusinessException;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Service
+@Transactional(readOnly = true)
+@RequiredArgsConstructor
+public class TrashDescriptionFinder {
+
+    private final TrashDescriptionRepository trashDescriptionRepository;
+
+    public TrashDescription findTrashDescriptionsByTrashTypeId(Long trashTypeId) {
+        return trashDescriptionRepository.findByTrashTypeId(trashTypeId)
+            .orElseThrow(() -> new BusinessException(NOT_EXISTS_TRASH_DESCRIPTION));
+    }
+}
diff --git a/src/main/java/com/trashheroesbe/feature/trash/domain/service/TrashItemFinder.java b/src/main/java/com/trashheroesbe/feature/trash/domain/service/TrashItemFinder.java
@@ -1,7 +1,10 @@
 package com.trashheroesbe.feature.trash.domain.service;
 
+import static com.trashheroesbe.global.response.type.ErrorCode.NOT_EXISTS_TRASH_ITEM;
+
 import com.trashheroesbe.feature.trash.domain.entity.TrashItem;
 import com.trashheroesbe.feature.trash.infrastructure.TrashItemRepository;
+import com.trashheroesbe.global.exception.BusinessException;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -15,6 +18,10 @@ public class TrashItemFinder {
     private final TrashItemRepository trashItemRepository;
 
     public List<TrashItem> findTrashItemsByTrashTypeId(Long trashTypeId) {
-        return trashItemRepository.findByTrashTypeId(trashTypeId);
+        List<TrashItem> trashItems = trashItemRepository.findByTrashTypeId(trashTypeId);
+        if (trashItems.isEmpty()) {
+            throw new BusinessException(NOT_EXISTS_TRASH_ITEM);
+        }
+        return trashItems;
     }
 }
diff --git a/src/main/java/com/trashheroesbe/feature/trash/domain/service/TrashTypeFinder.java b/src/main/java/com/trashheroesbe/feature/trash/domain/service/TrashTypeFinder.java
@@ -1,7 +1,12 @@
 package com.trashheroesbe.feature.trash.domain.service;
 
+import static com.trashheroesbe.global.response.type.ErrorCode.ENTITY_NOT_FOUND;
+import static com.trashheroesbe.global.response.type.ErrorCode.NOT_EXISTS_TRASH_TYPE;
+
+import com.trashheroesbe.feature.trash.domain.Type;
 import com.trashheroesbe.feature.trash.domain.entity.TrashType;
 import com.trashheroesbe.feature.trash.infrastructure.TrashTypeRepository;
+import com.trashheroesbe.global.exception.BusinessException;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -15,6 +20,15 @@ public class TrashTypeFinder {
     private final TrashTypeRepository trashTypeRepository;
 
     public List<TrashType> getAllTrashTypes() {
-        return trashTypeRepository.findAll();
+        List<TrashType> trashTypes = trashTypeRepository.findAllByOrderByIdAsc();
+        if (trashTypes.isEmpty()) {
+            throw new BusinessException(NOT_EXISTS_TRASH_TYPE);
+        }
+        return trashTypes;
+    }
+
+    public TrashType getTrashType(Type type) {
+        return trashTypeRepository.findByType(type)
+            .orElseThrow(() -> new BusinessException(ENTITY_NOT_FOUND));
     }
 }
diff --git a/src/main/java/com/trashheroesbe/feature/trash/dto/response/TrashDescriptionResponse.java b/src/main/java/com/trashheroesbe/feature/trash/dto/response/TrashDescriptionResponse.java
@@ -1,7 +1,35 @@
 package com.trashheroesbe.feature.trash.dto.response;
 
-public record TrashDescriptionResponse(
+import com.trashheroesbe.feature.trash.domain.Type;
+import com.trashheroesbe.feature.trash.domain.entity.TrashDescription;
+import com.trashheroesbe.feature.trash.domain.entity.TrashItem;
+import java.util.List;
+import lombok.Builder;
 
+@Builder
+public record TrashDescriptionResponse(
+    Long trashDescriptionId,
+    List<String> guideSteps,
+    String cautionNote,
+    String typeName
 ) {
 
+    public static TrashDescriptionResponse from(TrashDescription trashDescription) {
+        List<String> steps = trashDescription.steps();
+        return TrashDescriptionResponse.builder()
+            .trashDescriptionId(trashDescription.getId())
+            .guideSteps(steps)
+            .cautionNote(trashDescription.getCautionNote())
+            .typeName(trashDescription.getTrashType().getType().getNameKo())
+            .build();
+    }
+
+    public static TrashDescriptionResponse ofNotFound() {
+        return TrashDescriptionResponse.builder()
+            .trashDescriptionId(-1L)
+            .guideSteps(List.of())
+            .cautionNote("해당하는 키워드에 분리배출 방법을 찾지 못했습니다.")
+            .typeName(Type.UNKNOWN.getNameKo())
+            .build();
+    }
 }
diff --git a/src/main/java/com/trashheroesbe/feature/trash/infrastructure/TrashDescriptionRepository.java b/src/main/java/com/trashheroesbe/feature/trash/infrastructure/TrashDescriptionRepository.java
@@ -2,10 +2,16 @@
 
 import com.trashheroesbe.feature.trash.domain.entity.TrashDescription;
 import com.trashheroesbe.feature.trash.domain.entity.TrashType;
+import java.util.List;
+import org.springframework.data.jpa.repository.EntityGraph;
 import org.springframework.data.jpa.repository.JpaRepository;
 
 import java.util.Optional;
 
 public interface TrashDescriptionRepository extends JpaRepository<TrashDescription, Long> {
+
     Optional<TrashDescription> findByTrashType(TrashType trashType);
+
+    @EntityGraph(attributePaths = "trashType")
+    Optional<TrashDescription> findByTrashTypeId(Long trashTypeId);
 }
diff --git a/src/main/java/com/trashheroesbe/feature/trash/infrastructure/TrashItemRepository.java b/src/main/java/com/trashheroesbe/feature/trash/infrastructure/TrashItemRepository.java
@@ -4,11 +4,15 @@
 import com.trashheroesbe.feature.trash.domain.entity.TrashType;
 import java.util.List;
 import java.util.Optional;
+import org.springframework.data.jpa.repository.EntityGraph;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
 @Repository
 public interface TrashItemRepository extends JpaRepository<TrashItem, Long> {
+
+    @EntityGraph(attributePaths = "trashType")
     List<TrashItem> findByTrashTypeId(Long trashTypeId);
+
     Optional<TrashItem> findByTrashTypeAndName(TrashType trashType, String name);
 }
diff --git a/src/main/java/com/trashheroesbe/feature/trash/infrastructure/TrashTypeRepository.java b/src/main/java/com/trashheroesbe/feature/trash/infrastructure/TrashTypeRepository.java
@@ -2,6 +2,7 @@
 
 import com.trashheroesbe.feature.trash.domain.Type;
 import com.trashheroesbe.feature.trash.domain.entity.TrashType;
+import java.util.List;
 import java.util.Optional;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.Query;
@@ -14,4 +15,6 @@ public interface TrashTypeRepository extends JpaRepository<TrashType, Long> {
     boolean isEmpty();
 
     Optional<TrashType> findByType(Type type);
+
+    List<TrashType> findAllByOrderByIdAsc();
 }
diff --git a/src/main/java/com/trashheroesbe/global/config/WebConfig.java b/src/main/java/com/trashheroesbe/global/config/WebConfig.java
@@ -18,8 +18,13 @@ public class WebConfig implements WebMvcConfigurer {
     @Override
     public void addCorsMappings(CorsRegistry registry) {
         registry.addMapping("/api/**")
-            .allowedOrigins("http://localhost:8080", "http://127.0.0.1:8080")
-            .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
+            .allowedOriginPatterns(
+                "http://localhost:*",
+                "http://127.0.0.1:*",
+                "https://trash-heroes.store",
+                "https://*.trash-heroes.store"
+            )
+            .allowedMethods("GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS")
             .allowedHeaders("*")
             .allowCredentials(true);
 
diff --git a/src/main/java/com/trashheroesbe/global/response/type/ErrorCode.java b/src/main/java/com/trashheroesbe/global/response/type/ErrorCode.java
@@ -29,9 +29,16 @@ public enum ErrorCode {
 
     // trash
     NOT_EXISTS_TRASH_TYPE(HttpStatus.INTERNAL_SERVER_ERROR, "쓰레기 타입이 존재하지 않습니다. 개발자에게 문의 주세요."),
-    NOT_EXISTS_TRASH_ITEM(HttpStatus.INTERNAL_SERVER_ERROR, "쓰레기 품목이 존재하지 않습니다. 개발자에게 문의 주세요.");
+    NOT_EXISTS_TRASH_ITEM(HttpStatus.INTERNAL_SERVER_ERROR, "쓰레기 품목이 존재하지 않습니다. 개발자에게 문의 주세요."),
+    NOT_EXISTS_TRASH_DESCRIPTION(HttpStatus.INTERNAL_SERVER_ERROR, "쓰레기 설명이 존재하지 않습니다. 개발자에게 문의 주세요."),
+    INVALID_SEARCH_KEYWORD(HttpStatus.BAD_REQUEST, "검색 키워드가 비어있습니다."),
 
+    ERROR_GPT_CALL(HttpStatus.BAD_GATEWAY, "GPT 호출에 실패했습니다."),
+    EMPTY_GPT_RESPONSE(HttpStatus.BAD_GATEWAY, "GPT 응답이 비었습니다."),
+    FAIL_PARSING_RESPONSE(HttpStatus.UNPROCESSABLE_ENTITY, "응답 파싱에 실패했습니다"),
 
+
+    ;
     private final HttpStatus status;
     private final String message;
 }
diff --git a/src/main/java/com/trashheroesbe/infrastructure/adapter/out/gpt/OpenAIChatAdapter.java b/src/main/java/com/trashheroesbe/infrastructure/adapter/out/gpt/OpenAIChatAdapter.java
diff --git a/src/main/java/com/trashheroesbe/infrastructure/port/gpt/ChatAIClientPort.java b/src/main/java/com/trashheroesbe/infrastructure/port/gpt/ChatAIClientPort.java
