redis clients springboot spring_session_redis_masterreplica

Spring Session Redis Master-Replica

레디스 개발자 교육 신청	레디스 정기점검/기술지원 Redis Technical Support	레디스 엔터프라이즈 서버 Redis Enterprise Server

Java Program Project Configuration

구성 소프트웨어 버전

Project 생성: start.spring.io

Project: Gradle-Groovy Language: Java Spring Boot 3.1.6 Group: com.redisgate Artifact: springSessionRedisMasterReplica Name: Spring Session Redis MasterReplica Description: Redis MasterReplica project for Spring Session Package name: com.redisgate.springSessionRedisMasterReplica Packaging: Jar Java: 17 Dependencies Spring Web Spring Session Lombok Spring Data Redis(Access+Driver)

build.gradle

dependencies에 spring-session-data-redis 가 있는지 확인한다.

application.properties

Standalone 설정에서 추가된 항목에서 중요한 것은 replicas.host, port와 readFrom이 추가되었다.
readFrom은 조회 명령을 복제(replica) 서버에서 실행하게 해서 부하분산을 하는 기능입니다.
Lettuce 설정에 있습니다. 여기서는 replicaPreferred으로 설정했습니다.
자세한 내용은 여기(readFrom)를 보세요. # Redis Master-Replica Config redis.master.host: 114.203.87.18 redis.master.port: 18510 redis.password: redisgate redis.database: 0 redis.clientName: redisgate #redis.replicas: 114.203.87.18:18511, 114.203.87.18:18512 redis.replicas[0].host: 114.203.87.18 redis.replicas[0].port: 18511 redis.replicas[1].host: 114.203.87.18 redis.replicas[1].port: 18512 redis.readFrom: replicaPreferred

참고

설정에서 spring.session.store-type:redis 이나 @EnableRedisHttpSession이 필요하다는 글도 있으나 현재 테스트 버전에서는 필요하지 않았다.

Java Program

Main Class: SpringSessionRedisMasterReplicaApplication

package com.redisgate.springSessionRedisMasterReplica; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication @Slf4j public class SpringSessionRedisMasterReplicaApplication { public static void main(String[] args) { SpringApplication.run(SpringSessionRedisMasterReplicaApplication.class, args); log.info("SpringSessionRedisStandaloneApplication 시작"); } }

Class RedisMasterReplicaInfo

application.properties 설정 값을 읽어오는 클래스 package com.redisgate.springSessionRedisMasterReplica; import lombok.Getter; import lombok.Setter; import lombok.NoArgsConstructor; import lombok.AllArgsConstructor; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Configuration; import java.util.List; @Getter @Setter @NoArgsConstructor @AllArgsConstructor @ConfigurationProperties(prefix="redis") @Configuration public class RedisMasterReplicaInfo { private String host; private int port; private String password; private int database; private String readFrom; private String clientName; private RedisMasterReplicaInfo master; private List<RedisMasterReplicaInfo> replicas; }

Class RedisMasterReplicaConfig

master.host, port, replicas.host, port, readFrom 등의 정보로 redisConnectionFactory를 만든다.
application.properties에 readFrom이 없을 경우 ANY로 설정하게 했다. package com.redisgate.springSessionRedisMasterReplica; import io.lettuce.core.ReadFrom; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.connection.RedisStaticMasterReplicaConfiguration; import org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration; import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory; @Configuration @RequiredArgsConstructor @Slf4j public class RedisMasterReplicaConfig { private final RedisMasterReplicaInfo redisInfo; @Bean public LettuceConnectionFactory redisConnectionFactory() { // RedisConfig 설정 log.info("Step 1 - Master Config"); log.info("Master: {}:{}", redisInfo.getMaster().getHost(), redisInfo.getMaster().getPort()); log.info("Database: {}", redisInfo.getDatabase()); RedisStaticMasterReplicaConfiguration redisConfig = new RedisStaticMasterReplicaConfiguration( redisInfo.getMaster().getHost(), redisInfo.getMaster().getPort()); redisConfig.setPassword(redisInfo.getPassword()); redisConfig.setDatabase(redisInfo.getDatabase()); // Replicas 추가 log.info("Step 2 - Replicas Config"); redisInfo.getReplicas().forEach(replica -> log.info("{}:{}", replica.getHost(), replica.getPort())); redisInfo.getReplicas().forEach(replica -> redisConfig.addNode(replica.getHost(), replica.getPort())); ReadFrom readFrom = ReadFrom.valueOf(redisInfo.getReadFrom()); if (readFrom == null) readFrom = ReadFrom.ANY; log.info("Step 3 - Client Config"); LettuceClientConfiguration clientConfig = LettuceClientConfiguration.builder() .readFrom(readFrom) .clientName(redisInfo.getClientName()) .build(); return new LettuceConnectionFactory(redisConfig, clientConfig); } }

Class SessionController

• hello1(): session.setAttribute("hello1","Charlie");
• hello2(): session.setAttribute(); 2회 실행
• hello3(): ① 속성명 지정해서 값 가져오기. ② 모든 속성명, 값 가져오기. ③ Session ID, 생성일시, 마지막 액세스(접근) 일시 가져오기
• hello4(): Redis HGETALL 명령으로 세션 데이터 가져오기. 메서드 명은 redisHash.entries()

package com.redisgate.springSessionRedisMasterReplica; import jakarta.servlet.http.HttpSession; import lombok.extern.slf4j.Slf4j; import org.springframework.data.redis.core.HashOperations; import org.springframework.data.redis.core.StringRedisTemplate; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; import java.util.Date; import java.util.Enumeration; import java.util.Map; @RestController @Slf4j public class SessionController { private final HashOperations redisHash; public SessionController(StringRedisTemplate stringRedisTemplate) { this.redisHash = stringRedisTemplate.opsForHash(); } @GetMapping("/hello1") public String hello1(HttpSession session) { // 속성명: hello1, 값: Charlie session.setAttribute("hello1","Charlie"); log.info("hello1 Charlie"); return "hello1 Charlie"; } @GetMapping("/hello2") public String hello2(HttpSession session) { // 속성명: hello2-1, 값: Kwon-1 // 속성명: hello2-2, 값: Kwon-2 session.setAttribute("hello2-1","Kwon-1"); session.setAttribute("hello2-2","Kwon-2"); log.info("hello2 Kwon"); return "hello2 Kwon"; } @GetMapping("/hello3") public String hello3(HttpSession session) { // 속성명 지정해서 값 가져오기 String hello1Value = (String) session.getAttribute("hello1"); log.info("hello1 Value: {}",hello1Value); // 모든 속성명, 값 가져오기 Enumeration<?> attrName = session.getAttributeNames(); while (attrName.hasMoreElements()) { String attr = (String) attrName.nextElement(); log.info("{}:{}",attr,session.getAttribute(attr)); } // Session ID, 생성일시, 마지막 액세스(접근) 일시 가져오기 String sessionId = session.getId(); Date ctime = new Date(session.getCreationTime()); Date atime = new Date(session.getLastAccessedTime()); log.info("sessionId: {}",sessionId); log.info("CreationTime: {}",ctime); log.info("LastAccessedTime: {}",atime); return "hello3"; } @GetMapping("/hello4") @SuppressWarnings("unchecked") public String hello4(HttpSession session) { // Redis HGETALL 명령으로 데이터 가져오기. 메서드 명은 redisHash.entries() String prefix = "spring:session:sessions:"; String sessionId = session.getId(); String springSessionId = prefix + sessionId; log.info("springSessionId: {}",springSessionId); Map<String, String> entries = redisHash.entries(springSessionId); log.info("방법1: Lambda 사용"); entries.forEach((key, value) -> { log.info("key:{}, value:{}", key, value); }); log.info("방법2: entrySet()"); for(Map.Entry<String, String> entry : entries.entrySet()) { log.info("key:{}, value:{}", entry.getKey(), entry.getValue()); } log.info("방법3: keySet()"); for(String key : entries.keySet()) { String value = entries.get(key); log.info("key:{}, value:{}", key, value); } return "hello4"; } }

Redis Master-Replica 구성도

Redis Server에서 실행되는 명령과 클라이언트 로그

Redis Server에서 실행되는 명령 확인은 redis-cli의 monitor 기능을 사용했습니다.
방법: redis-cli -h ip -p port -a password monitor

http://localhost:8080/hello1

hello1() source

@GetMapping("/hello1") public String hello1(HttpSession session) { // 속성명: hello1, 값: Charlie session.setAttribute("hello1","Charlie"); log.info("hello1 Charlie"); return "hello1 Charlie"; }

레디스 서버에서 실행되는 명령

처음 실행: 새 브라우저에서 처음 실행할 때

Master (마스터)

• 총 10 개 명령 실행: 레디스 서버 접속 관련 명령 6개 실행, Spring Session 명령 4개 실행.
• HMSET 명령은 4개 필드 lastAccessedTime, maxInactiveInterval, creationTime, sessionAttr를 저장한다.
• 가능한 한 줄에 보이게 하려고 'spring:session:sessions:a1ad6ded-b803-423f-a14e-52b4af3e64fe' 에서 'spring:session:sessions:' 부분을 삭제했다.

Replica1 (복제1)

• 총 11 개 명령 실행: 레디스 서버 접속 관련 명령 6개 실행, 마스터에서 전파된 Spring Session 명령 5개 실행.
• "SELECT" 명령은 마스터에서 명령이 처음 전파될때 DB를 선택하는 명령이 추가된다.

Replica2 (복제2)

• 총 20 개 명령 실행: 레디스 서버 접속 관련 명령 6개 실행, 마스터에서 전파된 Spring Session 명령 5개 실행, Client에서 실행된 명령 9개.
• Client에서 실행된 명령 9개는 조회 명령은 복제서버에서 실행되도록 readFrom을 설정했기 때문이다.
• "SELECT" 명령은 마스터에서 명령이 처음 전파될때 DB를 선택하는 명령이 추가된다.

두 번째 실행

Master (마스터)

• 두 번째 실행할 때는 마스터에서는 2개 명령이 실행된다. 마스터 서버의 부담이 줄었다.
• HGETALL 명령이 실행되면 HMSET 명령으로 lastAccessedTime을 수정한다. 그리고 PEXPIREAT 명령으로 만료(삭제)일시를 수정한다.   ->   HGETALL 명령은 복제2 에서 실행되었다.
• "HMSET"과 "PEXPIREAT" 명령은 복제서버로 전파된다.

Replica1 (복제1)

• 마스터에서 전파된 2개 명령이 실행되었다.

Replica2 (복제2)

• 조회 명령 4개와 마스터에서 전파된 명령 2개가 순서대로 실행되었다.
• 부하분산을 위한 readFrom 설정 효과로 조회 명령이 복제2에서 실행되었다.

명령이 마스터와 복제에서 분산 실행되므로 문제가 발생할까?

마스터와 복제2에서 분산되어서 실행되는 명령을 시간 순으로 살펴보자.

1. 927ms: 복제2 HGETALL 명령 실행
2. 937ms: 복제2 EXISTS 명령 실행, 10ms 차이
3. 985ms: 마스터 HMSET 명령 실행, 48ms 차이
4. 985ms: 복제2 HMSET 명령 실행, 0ms 차이
5. 994ms: 마스터 PEXPIREAT 명령 실행, 9ms 차이
6. 994ms: 복제2 PEXPIREAT 명령 실행, 0ms 차이
7. 002ms: 복제2 HGETALL 명령 실행, 8ms 차이
8. 008ms: 복제2 EXISTS 명령 실행, 6ms 차이

명령 사이의 시간 간격은 약 10ms이고, 마스터에서 복제서버로 전파되는 시간은 1ms 이내이다.
그러므로 일련의 명령이 복제서버와 마스터에서 나누어서(분산) 실행되어도 순서가 바뀌어서 문제가 될 확률은 거의 없다.
(이 측정치는 부하(load) 정도, 서버나 네트워크 상황에 따라서 다를 수 있습니다)

http://localhost:8080/hello2

hello2() source

@GetMapping("/hello2") public String hello2(HttpSession session) { // 속성명: hello2-1, 값: Kwon-1 // 속성명: hello2-2, 값: Kwon-2 session.setAttribute("hello2-1","Kwon-1"); session.setAttribute("hello2-2","Kwon-2"); log.info("hello2 Kwon"); return "hello2 Kwon"; }

레디스 서버에서 실행되는 명령

Master (마스터)

• 마스터에서는 2개 명령이 실행된다. 마스터 서버의 부담이 줄었다.
• setAttribute()로 인해서 HMSET 명령에 sessionAttr:hello2-2, sessionAttr:hello2-1 필드와 값이 추가되었다.

Replica1 (복제1)

• 마스터에서 전파된 2개 명령이 실행되었다.

Replica2 (복제2)

• 부하분산을 위한 readFrom 설정 효과로 조회 명령이 복제2에서 실행되었다.
• 조회 명령 4개와 마스터에서 전파된 명령 2개가 순서대로 실행되었다.

http://localhost:8080/hello3

hello3() source

@GetMapping("/hello3") public String hello3(HttpSession session) { // 속성명 지정해서 값 가져오기 String hello1Value = (String) session.getAttribute("hello1"); log.info("hello1 Value: {}",hello1Value); // 모든 속성명, 값 가져오기 Enumeration<?> attrName = session.getAttributeNames(); while (attrName.hasMoreElements()) { String attr = (String) attrName.nextElement(); log.info("{}:{}",attr,session.getAttribute(attr)); } // Session ID, 생성일시, 마지막 액세스(접근) 일시 가져오기 String sessionId = session.getId(); Date ctime = new Date(session.getCreationTime()); Date atime = new Date(session.getLastAccessedTime()); log.info("sessionId: {}",sessionId); log.info("CreationTime: {}",ctime); log.info("LastAccessedTime: {}",atime); return "hello3"; }

레디스 서버에서 실행되는 명령

Master (마스터)

• 마스터에서는 2개 명령이 실행된다. 마스터 서버의 부담이 줄었다.

Replica1 (복제1)

• 마스터에서 전파된 2개 명령이 실행되었다.

Replica2 (복제2)

• 부하분산을 위한 readFrom 설정 효과로 조회 명령이 복제2에서 실행되었다.
• 조회 명령 4개와 마스터에서 전파된 명령 2개가 순서대로 실행되었다.

클라이언트 로그 - 해당 java source를 같이 표시했다.

http://localhost:8080/hello4

hello4() source

@GetMapping("/hello4") @SuppressWarnings("unchecked") public String hello4(HttpSession session) { // Redis HGETALL 명령으로 데이터 가져오기. 메서드 명은 redisHash.entries() String prefix = "spring:session:sessions:"; String sessionId = session.getId(); String springSessionId = prefix + sessionId; log.info("springSessionId: {}",springSessionId); Map<String, String> entries = redisHash.entries(springSessionId); log.info("방법1: Lambda 사용"); entries.forEach((key, value) -> { log.info("key:{}, value:{}", key, value); }); log.info("방법2: entrySet()"); for(Map.Entry<String, String> entry : entries.entrySet()) { log.info("key:{}, value:{}", entry.getKey(), entry.getValue()); } log.info("방법3: keySet()"); for(String key : entries.keySet()) { String value = entries.get(key); log.info("key:{}, value:{}", key, value); } return "hello4"; }

레디스 서버에서 실행되는 명령

Master (마스터)

• 마스터에서는 2개 명령이 실행된다. 마스터 서버의 부담이 줄었다.

Replica1 (복제1)

• 마스터에서 전파된 2개 명령이 실행되었다.

Replica2 (복제2)

• 부하분산을 위한 readFrom 설정 효과로 조회 명령이 복제2에서 실행되었다.
• 조회 명령 5개와 마스터에서 전파된 명령 2개가 순서대로 실행되었다.
• 소스 "Map entries = redisHash.entries(springSessionId);" 의 결과로 두 번째 HGETALL이 실행되었다.

클라이언트 로그

소스에서는 세 가지 방법으로 출력(로그)했으나 결과는 모두 같으므로 여기서는 "방법1: Lambda 사용"만 표시했다.