Spring RedisSerializer 종류와 특징

🤔 배경

프로젝트 진행 중에 Redis Queue와 WebSocket을 활용해서 서비스를 개발하는 과정이 있었다. Spring Data Redis를 사용하기 위해 Config 파일에 RedistTemplate을 Bean으로 등록하게 되었고, 관련해서 Key와 Value에 Serializer도 설정하게 되었다. 해당 과정에서 알게 된 RedisSerializer 종류와 특징에 대해 소개해보려고 한다.

 

Redis는 인 메모리 데이터베이스 이므로 Redis에 데이터를 저장/조회하는 동안에 직렬화/역직렬화가 필요하다.

직렬화는 데이터를 메모리에 저장하기 위해 바이트 스트림으로 변환하는 것을 의미한다.

RedisTemplate 설정

Spring Data Redis 의존성을 추가하면 RedisTemplate 객체를 Bean으로 등록하고 이를 활용해서 Redis를 사용할 수 있다. 이때 데이터 Key와 Value를 직렬화 / 역직렬화하는 방식을 필요에 따라 적절한 방식으로 설정해야 한다.

 

@Configuration
@EnableRedisRepositories
public class RedisConfig {

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

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

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        return new LettuceConnectionFactory(redisHost, redisPort);
    }

    @Bean
    public RedisTemplate<?, ?> redisTemplate() {
        RedisTemplate<byte[], byte[]> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());

        redisTemplate.setKeySerializer(new JdkSerializationRedisSerializer());
        redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());

        return redisTemplate;
    }
}

 

redisTemplate에는 setKeySerializer, setValueSerializer 메서드를 제공하는데 해당 파라미터로 RedisSerializer 구현체를 추가할 수 있다. 기본적으로 RedisTemplate에서 제공하는 직렬화/역직렬화 담당 구현 클래스가 존재한다.

1. JdkSerializationRedisSerializer (Default)

- 기본으로 설정된 자바 직렬화 방식이다.

2. StringRedisSerializer

- 문자열(String) 타입의 값을 그대로 저장하는 방식이다.

 

- Class Type을 별도로 지정할 필요가 없다.

 

- 일반적인 객체 타입(Dto, Entity 등)은 캐스팅이 불가능하다.

 

- 기본적으로 UTF-8로 설정된다.

3. GenericJackson2JsonRedisSerializer

- 별도 Class Type을 지정하지 않고 모든 Class Type을 JSON 형식으로 저장할 수 있다는 범용적인 특징이 있다.

 

- Object의 class, package를 같이 저장하기 때문에 별도 애플리케이션이 접근해서 데이터를 사용하기 어렵다.

(데이터를 사용하기 위해서는 반드시 @class로 지정된 동일한 패키지에 있는 Dto로 가져와야 한다.)

 

- 내부적으로 ObjectMapper를 사용해서 직렬화, 역직렬화 과정을 수행한다.

4. GenericToStringSerializer<T>

- Class Type을 지정해야 하고(Generic), 특정 Class Type의 파라미터를 Converter.convert()를 활용해서 String으로 변환 후, 직렬화하는 특징이 있다.

 

- 기본적으로 일반적으로 사용되는 타입들의 변환이 가능하도록 스프링에서 기본적으로 제공하는 Converter, ConverterFactory를 등록한 DefaultConversionService을 사용한다.

5. Jackson2JsonRedisSerializer<T>

- Class Type을 지정해야 하고(Generic), Redis에 객체를 저장할 때 JSON 형태로 저장하는 특징이 있다.

 

- Class Type 지정 때문에 특정 클래스에 종속적이며, 만약 추상 클래스, 인터페이스를 사용해서 추상화하는 경우에는 추가적인 별도 설정이 필요하다.

 

- 내부적으로 ObjectMapper를 사용해서 직렬화, 역직렬화 과정을 수행한다.

6. OxmSerializer

- Marshaller, Unmarshaller를 기반으로 직렬화, 역직렬화를 수행하는 특징이 있다.

(Marshaller는 자바 객체를 XML 문서로 변환, Unmarshaller는 XML 문서를 자바 객체로 변환)