[Springboot] '최근 읽은 글' Dto로 Redis에 저장하고 조회하기 AtoZ

❓ redis 를 선택한 이유

블로그 홈페이지를 만드는 프로젝트에서, "최근 읽은 글" 을 개발해야하는 상황이 있었습니다. velog 같은 서비스에서는 꽤 오랜 기간동안 내가 읽은 글을 저장하는 듯 했는데, 현재 프로젝트의 기획에서는 일주일이라는 기간이 지정되어있었습니다. 처음에는 테이블을 하나 더 생성해야하나 고민이 되었는데, 읽은 글 특성 상 단기간에 많은 데이터가 수집된다는 점과 만료 기간을 설정하는 것이 성능 상으로 좋지 않을 것이라고 생각했습니다. 그러다 이전 프로젝트에서 refreshToken을 저장할 때 redis를 사용했던 것이 생각나서, redis로 조회한 글 데이터를 캐싱하고, 일정 기간이 지나면 삭제되는 기능을 적용해보고자 합니다.

📌 구현해야하는 기능

1. redis list 자료형을 사용하여 postDto로저장
2. key 값을 통해 postDto를 저장한목록 조회

1️⃣ springboot 에 redis 설정

build.gradle에 의존성 추가

implementation group: 'org.springframework.boot', name: 'spring-boot-starter-data-redis', version: '2.3.12.RELEASE'

application.yaml 에 spring redis 설정 추가 - local

spring:
    redis:
        host: localhost 
        port: 6379

 

👉 배포 서버에 redis 설정

실제 서버에 있는 docker 이미지인 Redis와 연결하려면 다음과 같이 설정해줍니다. redis는 docker-compose 로 실행할 때 컨테이너명입니다. redis 도커 이미지와 연결하려는 것이 아니라 서버 로컬 redis와 연결하려면 ip 주소를 적어주시면 됩니다.

spring:
    redis:
        host: redis(컨테이너 명)
        port: 6379

EC2 서버에서 docker pull redis 로 최신 redis 이미지를 다운받고 docker-compose.yml 파일에 redis 설정 추가도 해줍니다.

redis:
    container_name: redis
    hostname: redis
    image: redis
    command: ["redis-server", "--bind", "redis", "--port", "6379"]
    ports:
      - "6379:6379"
    restart: always
    networks: # 서버와 같은 네트워크, 잊지 마세요!
       - backend

 server:
   ....
   depends_on:
             - redis

2️⃣ RedisConfiguration 설정하기

📂 config/redisRepositoryConfig

@Configuration
@EnableRedisRepositories(basePackages = "com.yapp18.retrospect.config")
public class RedisRepositoryConfig extends CachingConfigurerSupport {

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

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


    // jackson LocalDateTime mapper
    @Bean public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); // timestamp 형식 안따르도록 설정
        mapper.registerModules(new JavaTimeModule(), new Jdk8Module()); // LocalDateTime 매핑을 위해 모듈 활성화
        return mapper;
    }


    // redisConnectionFactory 를 통해 외부 redis 를 연결합니다.
    @Bean
    public RedisConnectionFactory redisConnectionFactory(){
        return new LettuceConnectionFactory(redisHost, redisPort);
    }

    //RedisTemplate을 통해 RedisConnection에서 넘겨준 byte 값을 객체 직렬화합니다.
    @Bean
    public RedisTemplate<?,?> redisTemplate(){
        RedisTemplate<String, RecentLog> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer(objectMapper()));
        return redisTemplate;
    }

}

• ObjectMapper : redis에서 값을 저장하고 가져오는 과정에서, LocalDateTime이나 LocalDateTime 형식은 역직렬화하는 과정에서 에러가 날 수 있습니다.
• 날짜 타입 처리하기springboot에서는 ObjectMapper 가 빈으로 주입되기 때문에 application.yml 파일에서도 설정이 가능합니다.
• spring: jackson: serialization: WRITE\_DATES\_AS\_TIMESTAMPS: false
• Object → Json(직렬화) / Json → Object(역직렬화) / ObejctMapper 이 이런 역할을 담당하고 있고, Jackson은 기본적으로 ObjectMapper을 제공하고 있습니다. Jackson에서 LocalDateTime을 매핑하려면 JavaTimeModule을 활성화해야하고, WRITE_DATES_AS_TIMESTAMPS 를 적용하지 않기로 설정해주어야합니다.
• RedisConnectionFactory : application.yml 파일에서 설정한 redis와 port 번호를 가져와 외부 redis와 연결합니다.
• RedisTemplate : RedisTemplate를 사용하여 RedisConnection에서 넘겨준 바이트 값을 직렬화합니다. 이 때, GenericJackson2JsonRedisSerializer에서 아까 설정해두었던 objectMapper() 설정을 사용합니다.

3️⃣ redis 엔티티 설정

📂 domain/RecentLog

@RedisHash("userIdx")
@Getter @ToString @NoArgsConstructor @AllArgsConstructor @Builder
public class RecentLog {

    @Id
    private  Long userIdx;
    private  PostDto.ListResponse postDto;

}

• RedisHash("value") : jpa에서 RecentLog가 Redis 엔티티임을 명시, 애노테이션에 들어갈 값은 @Id 와 결합하여 key를 생성하는데 사용됩니다. Long , String 값이 들어갈 수 있습니다.
• 저는 글을 작성한 사용자의 인덱스 값과 해당 post를 dto로 변환한 값을 저장하도록 해두었습니다.

주의할 점은 redis class에 Post와 같은 다른 엔티티 자체를 저장하면 stackoverflowError가 난다는 점입니다. 이 에러로 삽질을 많이 했는데, 값을 저장할 때는 엔티티를 dto로 변환해서 저장하도록 합시다.

🔎 Redis CRUD 방식

redis에 값을 저장하고 접근하는 방식은 2개가 있습니다. 제가 사용한 redisTemplate을 사용하는 방법과, CrudRepository를 상속받은 redisRepository를 사용하는 방법입니다. 최근 읽은 글 같은 경우는 저장과 조회만 간단하게 필요하므로, redisTemplate를 사용해보겠습니다.

4️⃣ Service 만들기

1) 최근 읽은 글 저장

먼저 postService에서 '상세보기' 조회를 할 때, 사용자가 로그인한 상태이면 해당 메소드를 호출하도록 설정해두었습니다.

private final PostMapper postMapper;
private final PostRepository postRepository;
private final RedisTemplate<String, PostDto.ListResponse> redisTemplate;


// 최근 읽은 글 저장
    @Transactional
    public void saveRecentReadPosts(Long userIdx, Long postIdx){
        ListOperations<String, PostDto.ListResponse> listOperations = redisTemplate.opsForList();
        Post post = postRepository.findById(postIdx)
                .orElseThrow(() -> new EntityNullException(ErrorInfo.POST_NULL));
        PostDto.ListResponse postDto = postMapper.postToListResponse(post, userIdx);
        String key = "userIdx::"+ userIdx;
        listOperations.leftPush(key, postDto);
        redisTemplate.expireAt(key, Date.from(ZonedDateTime.now().plusDays(7).toInstant())); // 유효기간 TTL 일주일 설정
    }

• RedisTemplate 를 Stirng(key 값), PostDto 로 받도록 합니다.
• post 인덱스에 해당하는 Post 엔티티를 mapstruct를 통해 dto로 변환해주었습니다. Entity → Dto 변환 방식은 편한 방식대로 사용해주시면 됩니다.
• redisTemplate.opsForList() 를 새로 만들어 key값과 postDto 를 leftPush 로 저장합니다.
• key는 @RedisHash 에 입력한 value값과 사용자 인덱스 값을 합쳐서 string 타입의 key값으로 만들었습니다.
• 최근 읽은 글은 최대 일주일까지만 저장할 것이므로, 해당 key의 redisTemplate의 만료 날짜를 오늘로부터 일주일로 설정합니다.

 

2) 최근 읽은 글 조회

여기서 가장 많은 삽질을 했습니다. 만약 redisConfig에서 objectMapper() 설정을 하지 않으면, Could not read JSON: Cannot construct instance of java.time.LocalDateTime (no Creators, like default construct, exist): cannot deserialize from Object value (no delegate- or property-based Creator) 에러가 납니다. Redis에 저장할 때는 Serialize 하고, 조회할 때는 다시 Deserialize 해서 갖고온다고 생각하면 됩니다.

간단하게 dto에 @JsonDeserialize(using = LocalDateTimeDeserializer.class), @JsonSerialize(using = LocalDateTimeSerializer.class) 를 붙여서 써도 되지만, dto마다 붙이면 번거롭기 때문에 아까처럼 custom 설정을 해주는 것이 편합니다.

// 최근 읽은 글 조회
    @Transactional
    public List<PostDto.ListResponse> findRecentPosts(Long userIdx) {
        ListOperations<String, PostDto.ListResponse> listOperations = redisTemplate.opsForList();
        String key = "userIdx::" + userIdx;
        long size = listOperations.size(key) == null ? 0 : listOperations.size(key); // NPE 체크해야함.

        return listOperations.range(key, 0, size);

    }

• key 값에 해당하는 목록 사이즈를 가져옵니다.
• listOperations.range로 0부터 목록 사이즈까지의 데이터를 가져옵니다.

5️⃣ Controller

최근 읽은 글 저장은 상세보기에서 service를 사용하면 되는 것이고, 조회할 때 controller만 만들어주면 됩니다.

@ApiOperation(value = "mypage", notes = "[마이페이지] 최근 읽은 글 조회 ")
    @GetMapping("/recent")
    public ResponseEntity<Object> findRecentPosts(HttpServletRequest request){
        Long userIdx = tokenService.getUserIdx(tokenService.getTokenFromRequest(request));
        return new ResponseEntity<>(ApiDefaultResponse.res(200, "",
                listService.findRecentPosts(userIdx)), HttpStatus.OK);
    }

• accessToken에서 userIdx 정보를 가져와서
• 아까 만들어 둔 service에 userIdx 값을 넘겨주면 됨.

 

 

 

📚 참고 블로그

[spring] redis로 caching해서 dbms의 부하 줄이기 - 1

[Java + Redis] Spring Data Redis로 Redis와 연동하기 - RedisRepository 편

[Spring Boot] Redis (Lettuce)를 이용한 간단한 API 제작

[ Redis ] Redis 환경 간단하게 구축하기

[spring] redis로 caching해서 dbms의 부하 줄이기 - 2

RedisTemplate 과 Json Serializer 설정