[Redis] Redis로 최근 검색 기록 관리하기

 

프로젝트 중 최근 검색 기록을 구현해야 할 일이 생겼다. 처음엔 SearchLog 엔티티를 만들어 mysql에 저장할까 했다. 

하지만 검색 시 항상 검색 기록을 조회해와야 했고다. 특히 나같은 경우 검색 기록 개수를 10개로 제한해두었는데, 만약 검색 기록이 꽉 찼을 때 새로 insert 하기 위해선 가장 오래된 기록을 제거해야 했기 때문에 정렬 후 delete 하는 과정이 필요했다. 

 

위 문제를 해결하기 위해 인메모리 DB인 Redis를 사용하기로 했다. 

 

레디스 리스트를 만들어서 관리하는 방식으로 사용할 것이고 SearchLog + memberId 를 key로 두어 식별할 수 있도록  구현했다. 

레디스 리스트를 다루기 위한 메소드는 leftpush,leftpop,rightpush,rightpop 등이 있어 큐처럼 이용할 수 있다.

 

인메모리??

컴퓨터의 메인 메모리 RAM에 데이터를 올려서 사용하는 방법을 말한다. 사용하는 이유는 명확하게 속도 때문이다. SSD, HDD 같은 저장공간에 데이터를 가져오는 것보다 RAM에 올려진 데이터를 가져오는 것이 수백배(HDD 기준) 이상 빠르다. 즉, Redis는 빠른 검색 속도를 가진다.

하지만 빠른 속도를 가지는만큼 단점도 존재한다. 기본적으로 노트북 사양을 고를 때 RAM 용량이 8기가, 16기가 32기가로 많이 상용되고 있는데 램이 커질수록 비용이 증가하는 것을 경험해본 적이 있을 것이다. 또한 Key-Value 형태의 NoSQL이라는 점에서 다양한 형태의 데이터 구조를 지원하기는 하지만 복잡한 데이터를 저장하는 데이터베이스로 사용하기에는 어려움이 있다.

 

 

 

코드로 살펴보자.

 

RedisConfig에 SearchLog를 저장할 수 있는 RedisTemplate를 등록해줘야 한다.

@Configuration
@EnableCaching
public class RedisConfig {

    @Value("${spring.data.redis.port}")
    private int port;

    @Value("${spring.data.redis.host}")
    private String host;

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        return new LettuceConnectionFactory(host, port);
    }


    // 검색 로그 템플릿
    @Bean
    public RedisTemplate<String, SearchLog> SearchLogRedis() {
        RedisTemplate<String, SearchLog> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(SearchLog.class));
        redisTemplate.setValueSerializer(new Jackson2JsonRedisSerializer<>(SearchLog.class));

        return redisTemplate;
    }
}

 

 

 

key 는 위에서 말했듯이 SearchLog + [memberId] 로 식별하고 value는 [검색어, 생성시간] 으로 저장할 것이다.

 

먼저 value에 해당하는 SearchLog 클래스를 생성해주자.

엔티티였다면 @AllArgsConstructor 이나 클래스단의 @Builder 어노테이션은 붙이지 않는 것이 좋지만 단순히 value 저장을 위해 만든 클래스이므로 그냥 붙여주었다. 

기본 생성자와 getter 같은 경우는 Jackson 라이브러리가 JSON을 Java 객체로 변환에 필요하기 때문에 붙여줘야한다.

@AllArgsConstructor
@NoArgsConstructor
@Getter
@Builder
public class SearchLog {
    private String name;
    private String createdAt;
}

 

 

 

SearchLogService 클래스에 검색 기록 저장, 조회, 삭제 로직을 구현해주었다. 

 

먼저 저장 로직부터 살펴보자.

public void saveRecentSearchLog(Long memberId, SearchLogSaveRequest request) {
    Member member = memberRepository.findById(memberId)
            .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));

    String now = LocalDateTime.now().toString();
    String key = "SearchLog" + member.getId();
    SearchLog value = SearchLog.builder()
            .name(request.getName())
            .createdAt(now)
            .build();

    Long size = redisTemplate.opsForList().size(key);
    if (size == 10) {
        // rightPop을 통해 가장 오래된 데이터 삭제
        redisTemplate.opsForList().rightPop(key);
    }

    redisTemplate.opsForList().leftPush(key, value);
}

 

key로 현재 로그인한 SearchLog + [현재 로그인한 member의 id 값] 으로 두었고

value 로 SearchLog class 로 두었다. 

 

만약 redis의 현재 크기가 10인 경우 rightTop을 통해 가장 오래된 데이터를 삭제해준다.

10 미만이라면 leftPush를 통해 새로운 검색어를 추가해준다.

 

 

다음은 최근 검색 기록 조회 로직이다.

public List<SearchLog> findRecentSearchLogs(Long memberId) {
    Member member = memberRepository.findById(memberId)
            .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));

    String key = "SearchLog" + member.getId();
    List<SearchLog> logs = redisTemplate.opsForList().
            range(key, 0, 10);

    return logs;
}

 

 

 opsForList().range() 함수로 Redis 리스트에서 key에 해당하는 값들 중 인덱스 0부터 10까지의 값을 가져온 후 반환해준다. 

 

 

다음은 검색 기록 삭제 로직이다.

public void deleteRecentSearchLog(Long memberId, SearchLogDeleteRequest request) {
    Member member = memberRepository.findById(memberId)
            .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));

    String key = "SearchLog" + member.getId();
    SearchLog value = SearchLog.builder()
            .name(request.getName())
            .createdAt(request.getCreatedAt())
            .build();

    long count = redisTemplate.opsForList().remove(key, 1, value);

    if (count == 0) {
        throw new CustomException(ErrorCode.SEARCH_LOG_NOT_EXIST);
    }
}

 

opsForList().remove() 함수로 데이터를 삭제해주고, 반환값으로 삭제된 행의 개수를 반환해준다.

 

 

 간단하게 TestController를 만들어 테스트 해보았다. 

@RestController
@RequiredArgsConstructor
@Slf4j
public class SearchLogController {
    private final SearchLogService searchLogService;

    @Operation(summary = "최근 검색 기록: 저장")
    @PostMapping("/api/searchLog")
    public ResponseEntity<Response> saveRecentSearchLog(@AuthenticationPrincipal PrincipalDetails principalDetails,
                                                        @RequestBody SearchLogSaveRequest request) {
        searchLogService.saveRecentSearchLog(principalDetails.getMember().getId(), request);
        return ResponseEntity.ok(new Response("최근 검색 기록 저장 완료"));
    }

    @Operation(summary = "최근 검색 기록: 조회")
    @GetMapping("/api/searchLogs")
    public ResponseEntity<Response> findRecentSearchLog(@AuthenticationPrincipal PrincipalDetails principalDetails) {
        List<SearchLog> recentSearchLogList = searchLogService.findRecentSearchLogs(principalDetails.getMember().getId());
        return ResponseEntity.ok(new Response(recentSearchLogList, "최근 검색 기록 조회 완료"));
    }
}

 

 

 

redis-cli 에서 확인해보면 잘 조회되고 10개일 경우 가장 오래된 검색 기록을 지우고 새 검색 기록이 insert 되는걸 확인할 수 있었다.  

 

 

swagger에서 테스트 시 아래 사진과 같이 잘 응답이 되었고, Redis 를 사용했기에 별도의 로그 관련 검색 쿼리는 나가지 않았다. 

 

 

 

 

SearchLogService 전체 코드

@Service
@RequiredArgsConstructor
public class SearchLogService {
    private final RedisTemplate<String, SearchLog> redisTemplate;
    private final MemberRepository memberRepository;

    public void saveRecentSearchLog(Long memberId, SearchLogSaveRequest request) {
        Member member = memberRepository.findById(memberId)
                .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));

        String now = LocalDateTime.now().toString();
        String key = "SearchLog" + member.getId();
        SearchLog value = SearchLog.builder()
                .name(request.getName())
                .createdAt(now)
                .build();

        Long size = redisTemplate.opsForList().size(key);
        if (size == 10) {
            // rightPop을 통해 가장 오래된 데이터 삭제
            redisTemplate.opsForList().rightPop(key);
        }

        redisTemplate.opsForList().leftPush(key, value);
    }

    public List<SearchLog> findRecentSearchLogs(Long memberId) {
        Member member = memberRepository.findById(memberId)
                .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));

        String key = "SearchLog" + member.getId();
        List<SearchLog> logs = redisTemplate.opsForList().
                range(key, 0, 10);

        return logs;
    }

    public void deleteRecentSearchLog(Long memberId, SearchLogDeleteRequest request) {
        Member member = memberRepository.findById(memberId)
                .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));

        String key = "SearchLog" + member.getId();
        SearchLog value = SearchLog.builder()
                .name(request.getName())
                .createdAt(request.getCreatedAt())
                .build();

        long count = redisTemplate.opsForList().remove(key, 1, value);

        if (count == 0) {
            throw new CustomException(ErrorCode.SEARCH_LOG_NOT_EXIST);
        }
    }
}