📚 TIL 41일차

원본 풀리퀘스트: [Feature][Refactor] 작성된 게시글(post) Redis로 캐싱하기

이전엔 엄청난 삽질을 했었는데... 가까운 곳을 못보고 cache-session 서버를 분리할 생각부터 했었다. (결론적으론 분리하는게 장기적으로 맞긴 하지만, 지금은 프로젝트 규모가 작기 때문에 큰 필요는 없다.) 여기서도 시간을 많이 잡아 먹고...

레디스가 뭔지 전혀!! 감이 오지 않아서, 자료와 예제만 3일정도 찾아다닌 것 같다... 힘들어... (ㅠㅠ)
하지만 하고 나니까 껍질을 하나 깬 느낌... 뿌듯했다.

작성된 게시글(post) Redis로 캐싱하기

• 이전 목표: 작성한 글을 캐싱해야겠다! (글이 작성될 때마다)
• 현재 목표: 조회한 글을 캐싱해야겠다!

1. Serialize를 위한 의존성 추가

아래 트러블 슈팅 1번 참고

build.gradle

dependency {
    // serialize
    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.13.3'
}

2. RedisCacheConfig로 조회한 글 캐싱하기

1. RedisCacheConfig를 통해 @Cacheable 어노테이션을 사용했을 때, Spring이 아닌 Redis가 캐싱할 수 있도록 설정한다.

@Configuration
@EnableCaching
public class RedisCacheConfig {
    @Bean
    public RedisCacheManager redisCacheManager(RedisConnectionFactory cacheConnectionFactory) {
        GenericJackson2JsonRedisSerializer redisSerializer = getGenericJackson2JsonRedisSerializer(); // 바로 아래 문단에
        
        RedisCacheConfiguration configuration = RedisCacheConfiguration.defaultCacheConfig()
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()))
                    .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()))
                .entryTtl(Duration.ofMinutes(10)); // 캐시 지속 시간

        return RedisCacheManager
                .RedisCacheManagerBuilder
                .fromConnectionFactory(cacheConnectionFactory)
                .cacheDefaults(configuration)
                .build();
    }
}

private GenericJackson2JsonRedisSerializer getGenericJackson2JsonRedisSerializer() {
    PolymorphicTypeValidator typeValidator = BasicPolymorphicTypeValidator
            .builder()
            .allowIfSubType(Object.class)
            .build();

    // ObjectMapper 를 사용해서 LocalTimeDate를 직렬화를 하기 위해 매핑
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.registerModule(new JavaTimeModule());
    objectMapper.activateDefaultTyping(typeValidator, ObjectMapper.DefaultTyping.NON_FINAL);
    GenericJackson2JsonRedisSerializer redisSerializer = new GenericJackson2JsonRedisSerializer(objectMapper);

    return redisSerializer;
}

2. SpringApplication에도 @EnableCaching 어노테이션을 추가해주어야 한다.

@EnableCaching // ← ★
public class KP3COutsourcingProjectApplication { ... }

3. Service 클래스 중, 캐싱할 메서드에 @Cacheable 어노테이션을 추가하고, 값을 설정해준다.

• value = 저장할 value 이름
• key = 저장할 key 이름, #+{변수명}을 조합해서 key 값을 변수명으로 설정해줄 수 있다.
• cacheManager = RedisCacheConfig에서 생성한 캐시 매니저 메서드

/* PostService.java */
    
// 게시글 1개만
@Cacheable(value = "post", key = "#postId", cacheManager = "redisCacheManager")
public PostResponseDto getPost(Long postId) {
    Post post = postRepository.findById(postId).orElseThrow(() ->
                new NullPointerException("존재하지 않는 게시글 입니다.")
    );
    return new PostResponseDto(post);
}

• 이렇게하면 반환형인 PostResponseDto 타입으로 데이터가 담겨져 Redis 캐시 메모리에 저장된다.

포스트맨 테스트

1. 최초 실행: 135ms
   

2. 2번째 실행: 22ms
   

3. 3번째 실행: 11ms
   

Redis 메모리에 저장된 모습

트러블 슈팅

1. LocalDateTime 타입 직렬화 문제

Java 8 date/time type java.time.LocalDateTime not supported by default: add Module "com.fasterxml.jackson.datatype:jackson-datatype-jsr310" to enable handling...

• 위와 같이 LocalDateTime 타입을 지원하지 않는 듯한 오류가 발생했다. Jackson은 해당 타입의 직렬화를 지원하지 않으며, 처리하기 위해 com.fasterxml.jackson.datatype:jackson-datatype-jsr310 의존성을 추가하라는 뜻이다.

1-2. 해결

• 에러 메세지의 권유대로 의존성을 추가.

build.gradle

dependency {
    // serialize
    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.13.3'
}

• 직렬화 및 역직렬화, 포맷 설정 어노테이션 추가

/* TimeStamped.java */

@CreatedDate
@Column(updatable = false)
@Temporal(TemporalType.TIMESTAMP)
@JsonSerialize(using = LocalDateTimeSerializer.class) // ＊ 직렬화
@JsonDeserialize(using = LocalDateTimeDeserializer.class) // ＊ 역직렬화
@JsonFormat(shape= JsonFormat.Shape.STRING, pattern="yyyy-MM-dd HH:mm") // ＊ 저장 포맷 설정
private LocalDateTime createdAt;

우려되는 점...: 어노테이션이 너무 많이 달려서 가독성에 좋지 않거나 성능상의 문제가 생기진 않을지 걱정이 되긴 한다.

2. imageUrlList 호출 문제

could not write json: failed to lazily initialize a collection: could not initialize proxy - no session

• 위와 같은 오류가 발생하면서 imageUrlList 필드부터는 제대로 데이터가 캐싱되지 않은 것 같은 모습을 보였다.
  

2-2. 해결

• 이는 Redis에 저장되는 PostResponseDto 내부, imageUrlList 필드가 엔티티의 정보를 List 형태로 담고 있었기 때문이었다. Redis에는 엔티티를 그대로 저장하는 것이 불가능하고, 가능하더라도 권장사항이 아니기 때문에, 저장하는 것을 지양해야한다.

수정 전 PostResponseDto

@NoArgsConstructor
@AllArgsConstructor
public class PostResponseDto extends ApiResponseDto {
    private Long id;
    private String username;
    private String nickname;
    private String content;
    private LocalDateTime createdAt;
    private List<Post_Image> imageUrlList; // Post_Image 엔티티 클래스를 List 형태로 담고 있다
    private List<PostResponseDto> children;

    /* 생성자 잠시 생략 */
}

수정 후 PostResponseDto

@NoArgsConstructor
@AllArgsConstructor
public class PostResponseDto extends ApiResponseDto {
    private Long id;
    private String username;
    private String nickname;
    private String content;
    private LocalDateTime createdAt;
    private List<PostImageDto> imageUrlList; // Post_Image 엔티티 클래스의 정보를 담은 Dto 클래스를 만들었다
    private List<PostResponseDto> children;

    /* 생성자 잠시 생략 */
}

• PostImageDto를 생성하여 Post_Image 엔티티 클래스의 정보를 담았다.

@NoArgsConstructor
@AllArgsConstructor
public class PostImageDto {
    Long id;
    String imgUrl;

    public PostImageDto (Post_Image postImage) {
        this.id = postImage.getId();
        this.imgUrl = postImage.getImgUrl();
    }
}

Post_Image 값을 PostImageDto로 저장할 때는 이렇게...

/* PostResponseDto.java */

public PostResponseDto(Post post) {
    // 다른 필드 생략
    this.imageUrlList = post.getImagetList().stream().map(PostImageDto::new).toList();
}