Junhyunny's Devlogs

글 검색

기술 글 제목, 본문, 카테고리에서 검색합니다.

    이전 화면으로

    스프링 부트 RedisTemplate 사용하기

    • spring-boot
    • redis
    이 글의 목차

    0. 들어가면서

    현재 진행 중인 프로젝트의 특정 비즈니스에서 데이터를 저장할 수 있는 큐(queue)가 필요했다. 다음과 같은 옵션이 있었다.

    • Transactional Outbox Pattern처럼 데이터베이스를 메시지 큐로 사용
    • 사용자 세션(session)을 관리하는 레디스(redis)를 메시지 큐로 사용

    데이터 크기가 작고, 엄격한 트랜잭션 관리가 필요 없기 때문에 레디스를 메시지 큐로 사용했다. 이번 포스트는 간단한 시나리오를 토대로 레디스의 자료 구조 중 하나인 리스트(list)를 큐로 사용하는 예제를 다뤘다.

    1. Setup environment

    다음과 같은 실습 환경을 구축했다.

    • 사용자는 서비스를 통해 다른 사용자를 초대(invitation)할 수 있다.
      • /invitation 경로
      • 초대 이벤트가 발생하면 초대받은 사람에게 메시지가 전송된다.
    • 사용자는 자신이 다른 사용자를 초대했던 내용을 취소할 수 있다.
      • /invitation/cancel 경로
      • 초대 이벤트가 발생하면 초대받은 사람에게 메시지가 전송된다.
    • 사용자는 자신 앞으로 전송된 메시지를 볼 수 있다.
      • /user/messages/{userId} 경로
      • 읽은 메시지들은 삭제된다.
    • 사용자 역할은 터미널의 cURL 명령어로 대체했다.

    다음과 같은 패키지 구조를 가진다.

    ./
    ├── Dockerfile
    ├── docker-compose.yml
    ├── mvnw
    ├── mvnw.cmd
    ├── pom.xml
    ├── run.sh
    └── src
        ├── main
        │   ├── java
        │   │   └── action
        │   │       └── in
        │   │           └── blog
        │   │               ├── ActionInBlogApplication.java
        │   │               ├── client
        │   │               │   ├── InvitationEventClient.java
        │   │               │   └── RedisInvitationEventClient.java
        │   │               ├── config
        │   │               │   ├── EmbeddedRedisServerConfig.java
        │   │               │   └── RedisTemplateConfig.java
        │   │               ├── controller
        │   │               │   ├── InvitationController.java
        │   │               │   └── UserController.java
        │   │               ├── domain
        │   │               │   ├── Invitation.java
        │   │               │   ├── InvitationMessage.java
        │   │               │   ├── InvitationStatus.java
        │   │               │   └── QueueChannel.java
        │   │               └── proxy
        │   │                   ├── EmbbededRedisUserMessageProxy.java
        │   │                   ├── RedisUserMessageProxy.java
        │   │                   └── UserMessageProxy.java
        │   └── resources
        │       ├── application-dev.yml
        │       ├── application-local.yml
        │       └── application.yml
        └── test
            └── java
                └── action
                    └── in
                        └── blog
                            └── app
                                └── ActionInBlogApplicationTests.java

    레디스를 사용하기 위해 다음과 같은 의존성들을 추가한다.

    • spring-boot-starter-data-redis 의존성
      • 레디스의 클라이언트(client) 기능을 제공한다.
    • embedded-redis 의존성
      • 레디스 컨테이너 없이 개발자 로컬 컴퓨터에서 애플리케이션과 함께 실행되는 임베디드(embedded) 메모리 레디스 서비스를 제공한다.
        <dependencies>
            <dependency>
                <groupId>it.ozimov</groupId>
                <artifactId>embedded-redis</artifactId>
                <version>0.7.3</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.slf4j</groupId>
                        <artifactId>slf4j-simple</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
            </dependency>
        </dependencies>

    애플리케이션이 레디스 서버에 접속하기 위한 정보를 application YAML 파일에 작성한다.

    spring:
      redis:
        host: redis-server
        password:
        port: 6379

    2. Implementation

    실제 구현 코드를 살펴보자. 인터페이스를 통해 추상화한 코드도 있지만, 설명은 제외한다. 서비스 구현체와 도메인 객체들에 대해 주로 설명하였다.

    2.1. RedisTemplateConfig Class

    RedisTemplate 빈(bean) 객체를 생성한다.

    • 레디스 커넥션(connection)을 생성하는 팩토리 빈을 생성한다.
      • LettuceConnectionFactory 클래스를 사용한다.
    • 레디스에 객체를 JSON 형태로 저장할 수 있도록 ValueSerializer 빈을 생성한다.
      • GenericJackson2JsonRedisSerializer 클래스를 사용한다.
    package action.in.blog.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.lettuce.LettuceConnectionFactory;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.data.redis.repository.configuration.EnableRedisRepositories;
    import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
    import org.springframework.data.redis.serializer.RedisSerializer;
    import org.springframework.data.redis.serializer.StringRedisSerializer;
    
    @Configuration
    @EnableRedisRepositories
    public class RedisTemplateConfig {
    
        @Value("${spring.redis.host}")
        private String host;
        @Value("${spring.redis.port}")
        private int port;
    
        @Bean
        public RedisSerializer<Object> springSessionDefaultRedisSerializer() {
            return new GenericJackson2JsonRedisSerializer();
        }
    
        @Bean
        public RedisConnectionFactory redisConnectionFactory() {
            return new LettuceConnectionFactory(host, port);
        }
    
        @Bean
        public RedisTemplate<String, Object> redisTemplate(
                RedisConnectionFactory connectionFactory,
                RedisSerializer<Object> springSessionDefaultRedisSerializer
        ) {
            RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
            redisTemplate.setConnectionFactory(connectionFactory);
            redisTemplate.setKeySerializer(new StringRedisSerializer());
            redisTemplate.setValueSerializer(springSessionDefaultRedisSerializer);
            return redisTemplate;
        }
    }

    2.2. InvitationController Class

    컨트롤러 객체에 엔드포인트를 구현한다.

    • /invitation 경로
      • 초대 요청을 받으면 해당 이벤트 메시지를 InvitationEventClient 객체를 통해 전달한다.
    • /invitation/cancel 경로
      • 초대 취소 요청을 받으면 해당 이벤트 메시지를 InvitationEventClient 객체를 통해 전달한다.
    package action.in.blog.controller;
    
    import action.in.blog.client.InvitationEventClient;
    import action.in.blog.domain.Invitation;
    import lombok.RequiredArgsConstructor;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.PutMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RestController;
    
    @RequiredArgsConstructor
    @RestController
    public class InvitationController {
    
        private final InvitationEventClient invitationEventClient;
    
        @PostMapping("/invitation")
        public void createPost(@RequestBody Invitation invitation) {
            invitationEventClient.pushInvitationMessage(invitation);
        }
    
        @PostMapping("/invitation/cancel")
        public void updatePost(@RequestBody Invitation invitation) {
            invitationEventClient.pushInvitationCancelMessage(invitation);
        }
    }

    초대(invitation) 도메인 객체를 만든다. 초대 객체에는 초대자, 초대받는 사람 정보가 존재한다.

    package action.in.blog.domain;
    
    import lombok.AllArgsConstructor;
    import lombok.Builder;
    import lombok.Getter;
    import lombok.NoArgsConstructor;
    
    @Builder
    @AllArgsConstructor
    @NoArgsConstructor
    @Getter
    public class Invitation {
    
        private String inviter;
        private String invitee;
    }

    2.3. RedisInvitationEventClient Class

    초대 이벤트를 전달하는 클라이언트 객체를 살펴보자.

    • pushInvitationMessage 메서드
      • RedisTemplate 객체를 통해 초대 메시지를 전달한다.
      • 초대자, 초대 상태 정보를 메시지에 담는다. 키 값은 채널명과 초대받는 사람 정보를 조합한다.
    • pushInvitationCancelMessage 메서드
      • RedisTemplate 객체를 통해 초대 메시지를 전달한다.
      • 초대자, 초대 취소 상태 정보를 메시지에 담는다. 키 값은 채널명과 초대받는 사람 정보를 조합한다.
    package action.in.blog.client;
    
    import action.in.blog.domain.Invitation;
    import action.in.blog.domain.InvitationMessage;
    import action.in.blog.domain.InvitationStatus;
    import action.in.blog.domain.QueueChannel;
    import lombok.RequiredArgsConstructor;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.stereotype.Component;
    
    @Component
    @RequiredArgsConstructor
    public class RedisInvitationEventClient implements InvitationEventClient {
    
        private final RedisTemplate<String, Object> redisTemplate;
    
        @Override
        public void pushInvitationMessage(Invitation invitation) {
            String key = invitation.getInvitee();
            InvitationMessage message = InvitationMessage.builder()
                    .inviter(invitation.getInviter())
                    .status(InvitationStatus.INVITATION)
                    .build();
            redisTemplate.opsForList().rightPush(QueueChannel.INVITATION.of(key), message);
        }
    
        @Override
        public void pushInvitationCancelMessage(Invitation invitation) {
            String key = invitation.getInvitee();
            InvitationMessage message = InvitationMessage.builder()
                    .inviter(invitation.getInviter())
                    .status(InvitationStatus.INVITATION_CANCEL)
                    .build();
            redisTemplate.opsForList().rightPush(QueueChannel.INVITATION.of(key), message);
        }
    }

    초대 메시지(invitation message) 객체를 생성한다. 초대 메시지에는 초대자, 상태 정보가 존재한다.

    package action.in.blog.domain;
    
    import lombok.AllArgsConstructor;
    import lombok.Builder;
    import lombok.Getter;
    import lombok.NoArgsConstructor;
    
    @Builder
    @AllArgsConstructor
    @NoArgsConstructor
    @Getter
    public class InvitationMessage {
        private String inviter;
        private InvitationStatus status;
    }

    레디스 리스트의 키 값을 위해 enum 객체를 사용한다. 비즈니스에 맞는 채널 명칭과 특정 키 값을 조합하여 채널 이름을 생성한다.

    package action.in.blog.domain;
    
    public enum QueueChannel {
    
        INVITATION;
    
        public String of(String key) {
            return String.format("%s-%s", INVITATION.name(), key);
        }
    }

    2.4. UserController Class

    사용자는 ID를 사용해 자신에게 전달된 메시지를 볼 수 있다. 사용자가 전달받은 메시지를 볼 수 있는 엔드포인트를 구현한다.

    • /user/messages/{userId} 경로
      • 사용자에게 전달된 메시지를 수신한다.
    package action.in.blog.controller;
    
    import action.in.blog.domain.InvitationMessage;
    import action.in.blog.proxy.UserMessageProxy;
    import lombok.RequiredArgsConstructor;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    
    @RequiredArgsConstructor
    @RestController
    public class UserController {
    
        private final UserMessageProxy userMessageProxy;
    
        @GetMapping("/user/messages/{userId}")
        public List<InvitationMessage> getInvitationMessage(@PathVariable("userId") String userId) {
            return userMessageProxy.getInvitationMessage(userId);
        }
    }

    2.5. RedisUserMessageProxy Class

    이벤트를 수신할 수 있는 프록시 객체를 생성한다. RedisTemplate 객체를 통해 메시지를 수신한다.

    • ID에 해당하는 메시지를 수신한다.
    • 메시지를 꺼냄과 동시에 레디스 리스트에서 제거하기 위해 leftPop 메서드를 사용한다.
    package action.in.blog.proxy;
    
    import action.in.blog.domain.InvitationMessage;
    import action.in.blog.domain.QueueChannel;
    import lombok.RequiredArgsConstructor;
    import org.springframework.context.annotation.Profile;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.stereotype.Component;
    
    import java.util.List;
    
    @Profile("!local")
    @Component
    @RequiredArgsConstructor
    public class RedisUserMessageProxy implements UserMessageProxy {
    
        private final RedisTemplate<String, Object> redisTemplate;
    
        @Override
        public List<InvitationMessage> getInvitationMessage(String userId) {
            String channel = QueueChannel.INVITATION.of(userId);
            long size = redisTemplate.opsForList().size(channel);
            return (List) redisTemplate.opsForList().leftPop(channel, size);
        }
    }

    3. Test with container

    실제로 잘 동작하는지 컨테이너를 사용한다. 도커 컴포즈(docker compose)로 테스트 환경을 구축한다. 도커 컴포즈 YAML 파일은 다음과 같다.

    version: "3.9"
    services:
      redis:
        image: redis
        command: redis-server --port 6379
        container_name: redis-server
        ports:
          - '6379:6379'
      backend:
        build: .
        ports:
          - '8080:8080'
        depends_on:
          - redis
        restart: on-failure

    컨테이너를 실행한다.

    $ docker-compose up -d          
    
    ...
    
    [+] Running 2/2
     ⠿ Container redis-server              Started                                   0.5s
     ⠿ Container action-in-blog-backend-1  Started                                   0.6s

    다음과 같은 쉘 명령어를 실행한다. 초대, 초대 취소를 각각 1회씩 요청한다.

    $ curl -X POST\
      -H "Content-Type: application/json"\
      -d '{"inviter": "Junhyunny", "invitee": "Jua"}'\
      http://localhost:8080/invitation
    
    $ curl -X POST\
      -H "Content-Type: application/json"\
      -d '{"inviter": "Junhyunny", "invitee": "Jua"}'\
      http://localhost:8080/invitation/cancel

    테스트 결과를 확인해보자. 메시지 조회 명령어를 수행한다. 2회 수행하면 빈 리스트가 조회된다.

    $ curl http://localhost:8080/user/messages/Jua | jq .
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100   100    0   100    0     0   2025      0 --:--:-- --:--:-- --:--:--  2380
    [
      {
        "inviter": "Junhyunny",
        "status": "INVITATION"
      },
      {
        "inviter": "Junhyunny",
        "status": "INVITATION_CANCEL"
      }
    ]
    
    $ curl http://localhost:8080/user/messages/Jua | jq .
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100     2    0     2    0     0    135      0 --:--:-- --:--:-- --:--:--   250
    []

    CLOSING

    개발자 로컬 컴퓨터에서 서비스를 실행할 때마다 매번 레디스 컨테이너를 띄우는 일은 매우 번거롭다. 내장 레디스를 사용하면 별도 컨테이너 없이도 레디스 서버를 이용할 수 있다. 내장 레디스 서버는 해당 애플리케이션이 실행될 때 함께 실행된다. 한 가지 문제점은 실제 레디스 서버가 아니기 때문에 RedisTemplate 객체의 특정 메서드를 실행할 때 에러가 발생한다.

    이번 글에선 leftPop 메서드를 호출할 때 임베디드 레디스 서버에서 에러가 발생했다. 아래와 같은 방식을 사용해서 에러를 우회했다.

    package action.in.blog.proxy;
    
    import action.in.blog.domain.InvitationMessage;
    import action.in.blog.domain.QueueChannel;
    import lombok.RequiredArgsConstructor;
    import org.springframework.context.annotation.Profile;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.stereotype.Component;
    
    import java.util.List;
    
    @Profile("local")
    @Component
    @RequiredArgsConstructor
    public class EmbbededRedisUserMessageProxy implements UserMessageProxy {
    
        private final RedisTemplate<String, Object> redisTemplate;
    
        @Override
        public List<InvitationMessage> getInvitationMessage(String userId) {
            String channel = QueueChannel.INVITATION.of(userId);
            long size = redisTemplate.opsForList().size(channel);
            List<InvitationMessage> result = (List) redisTemplate.opsForList().range(channel, 0, size);
            redisTemplate.delete(channel);
            return result;
        }
    }

    KEEP READING

    DISCUSSION

    댓글