검색어 자동 완성 API 개발 및 성능 개선 (#95)

build.gradle

@@ -59,6 +59,9 @@ dependencies {
 		implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
 	}
 
+	//Redis를 사용하기 위해 추가
+	implementation 'org.springframework.boot:spring-boot-starter-data-redis'
+
 }
 
 test {

src/main/java/com/nainga/nainga/domain/store/api/StoreApi.java

@@ -3,9 +3,11 @@
 import com.nainga.nainga.domain.store.application.GoodPriceGoogleMapStoreService;
 import com.nainga.nainga.domain.store.application.MobeomGoogleMapStoreService;
 import com.nainga.nainga.domain.store.application.SafeGoogleMapStoreService;
+import com.nainga.nainga.domain.store.application.StoreService;
 import com.nainga.nainga.domain.store.dto.CreateDividedGoodPriceStoresResponse;
 import com.nainga.nainga.domain.store.dto.CreateDividedMobeomStoresResponse;
 import com.nainga.nainga.domain.store.dto.CreateDividedSafeStoresResponse;
+import com.nainga.nainga.domain.storecertification.dto.StoreCertificationsByLocationResponse;
 import com.nainga.nainga.global.util.Result;
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
@@ -15,12 +17,15 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
+import java.util.List;
+
 @RestController
 @RequiredArgsConstructor
 public class StoreApi {
     private final MobeomGoogleMapStoreService mobeomGoogleMapStoreService;
     private final SafeGoogleMapStoreService safeGoogleMapStoreService;
     private final GoodPriceGoogleMapStoreService goodPriceGoogleMapStoreService;
+    private final StoreService storeService;
 
     @Hidden
     @Tag(name = "초기 Data 생성")
@@ -78,5 +83,18 @@ public Result<CreateDividedGoodPriceStoresResponse> createDividedGoodPriceStores
         System.out.println("response = " + response);   //편하게 콘솔 로그에서 확인하기 위한 용도
         return new Result<>(Result.CODE_SUCCESS, Result.MESSAGE_OK, response);
     }
+
+    //검색어를 이용해 가게 이름에 대해 검색하여 나온 검색 결과를 바탕으로 검색어를 자동 완성해서 최대 10개의 자동 완성된 검색어를 리턴
+    @Tag(name = "[New] 검색어 자동 완성")
+    @Operation(summary = "사용자의 검색 키워드를 바탕으로 검색어 자동 완성", description = "사용자의 검색 키워드를 바탕으로 DB에서 매칭되는 가게 이름을 조회하여 최대 10개까지 검색어를 자동으로 완성하여 반환해줍니다.<br><br>" +
+            "[Request Body]<br>" +
+            "searchKeyword: 사용자의 검색 키워드<br>" +
+            "[Response Body]<br>" +
+            "자동으로 완성된 최대 10개의 검색어<br>")
+    @GetMapping("api/store/autocorrect/v1")
+    public Result<List<String>> autocorrect(@RequestParam(value = "searchKeyword") String searchKeyword) {
+        List<String> autocorrectResult = storeService.autocorrect(searchKeyword);
+        return new Result<>(Result.CODE_SUCCESS, Result.MESSAGE_OK, autocorrectResult);
+    }
 }
 

src/main/java/com/nainga/nainga/domain/store/application/StoreService.java

@@ -0,0 +1,61 @@
+package com.nainga.nainga.domain.store.application;
+
+import com.nainga.nainga.domain.store.dao.StoreRepository;
+import com.nainga.nainga.global.application.RedisSortedSetService;
+import jakarta.annotation.PostConstruct;
+import lombok.RequiredArgsConstructor;
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+
+@Service
+@Transactional(readOnly = true)
+@RequiredArgsConstructor
+public class StoreService {
+    private final StoreRepository storeRepository;
+    private final RedisSortedSetService redisSortedSetService;
+    private String suffix = "*";    //검색어 자동 완성 기능에서 실제 노출될 수 있는 완벽한 형태의 단어를 구분하기 위한 접미사
+    private int maxSize = 10;    //검색어 자동 완성 기능 최대 개수
+
+    @PostConstruct
+    public void init() {    //이 Service Bean이 생성된 이후에 검색어 자동 완성 기능을 위한 데이터들을 Redis에 저장 (Redis는 인메모리 DB라 휘발성을 띄기 때문)
+        saveAllSubstring(storeRepository.findAllDisplayName()); //MySQL DB에 저장된 모든 가게명을 음절 단위로 잘라 모든 Substring을 Redis에 저장해주는 로직
+    }
+
+    private void saveAllSubstring(List<String> allDisplayName) {
+        ExecutorService executorService = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors()); //병렬 처리를 위한 스레드풀을 생성하는 과정
+
+        for (String displayName : allDisplayName) {
+            executorService.submit(() -> {  //submit 메서드를 사용해서 병렬 처리할 작업 추가
+                redisSortedSetService.addToSortedSet(displayName + suffix);
+
+                for (int i = displayName.length(); i > 0; --i) {
+                    redisSortedSetService.addToSortedSet(displayName.substring(0, i));
+                }
+            });
+        }
+        executorService.shutdown(); //작업이 모두 완료되면 스레드풀을 종료
+    }
+
+    public List<String> autocorrect(String keyword) { //검색어 자동 완성 기능 관련 로직
+        Long index = redisSortedSetService.findFromSortedSet(keyword);  //사용자가 입력한 검색어를 바탕으로 Redis에서 조회한 결과 매칭되는 index
+
+        if (index == null) {
+            return new ArrayList<>();   //만약 사용자 검색어 바탕으로 자동 완성 검색어를 만들 수 없으면 Empty Array 리턴
+        }
+
+        Set<String> allValuesAfterIndexFromSortedSet = redisSortedSetService.findAllValuesAfterIndexFromSortedSet(index);   //사용자 검색어 이후로 정렬된 Redis 데이터들 가져오기
+
+        return allValuesAfterIndexFromSortedSet.stream()
+                .filter(value -> value.endsWith(suffix) && value.startsWith(keyword))
+                .map(value -> StringUtils.removeEnd(value, suffix))
+                .limit(maxSize)
+                .toList();  //자동 완성을 통해 만들어진 최대 maxSize개의 키워드들
+    }
+}

src/main/java/com/nainga/nainga/domain/store/dao/StoreRepository.java

@@ -43,4 +43,9 @@ public List<Store> findAll() {
         return em.createQuery("select s from Store s", Store.class)
                 .getResultList();
     }
+
+    public List<String> findAllDisplayName() {
+        return em.createQuery("select s.displayName from Store s", String.class)
+                .getResultList();
+    }
 }

src/main/java/com/nainga/nainga/global/application/RedisSortedSetService.java

@@ -0,0 +1,30 @@
+package com.nainga.nainga.global.application;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.redis.core.RedisCallback;
+import org.springframework.data.redis.core.RedisTemplate;
+import org.springframework.data.redis.core.ZSetOperations;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+import java.util.Set;
+
+@Service
+@RequiredArgsConstructor
+public class RedisSortedSetService {    //검색어 자동 완성을 구현할 때 사용하는 Redis의 SortedSet 관련 서비스 레이어
+    private final RedisTemplate<String, String> redisTemplate;
+    private String key = "autocorrect"; //검색어 자동 완성을 위한 Redis 데이터
+    private int score = 0;  //Score는 딱히 필요 없으므로 하나로 통일
+
+    public void addToSortedSet(String value) {    //Redis SortedSet에 추가
+        redisTemplate.opsForZSet().add(key, value, score);
+    }
+
+    public Long findFromSortedSet(String value) {   //Redis SortedSet에서 Value를 찾아 인덱스를 반환
+        return redisTemplate.opsForZSet().rank(key, value);
+    }
+
+    public Set<String> findAllValuesAfterIndexFromSortedSet(Long index) {
+        return redisTemplate.opsForZSet().range(key, index, index + 200);   //전체를 다 불러오기 보다는 200개 정도만 가져와도 자동 완성을 구현하는 데 무리가 없으므로 200개로 rough하게 설정
+    }
+}

src/main/java/com/nainga/nainga/global/config/RedisConfig.java

@@ -0,0 +1,25 @@
+package com.nainga.nainga.global.config;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.redis.connection.RedisConnectionFactory;
+import org.springframework.data.redis.connection.RedisStandaloneConfiguration;
+import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
+
+@Configuration
+public class RedisConfig {  //Redis 연결을 위한 기본 설정
+
+    @Value("${spring.data.redis.host}")
+    private String host;
+
+    @Value("${spring.data.redis.port}")
+    private int port;
+
+    @Bean
+    public RedisConnectionFactory redisConnectionFactory() {
+        return new LettuceConnectionFactory(
+                new RedisStandaloneConfiguration(host, port)
+        );
+    }
+}