redis clients springboot spring_masterreplica

Spring Redis Master/Replica

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

Spring Redis Master/Replica

이 문서는 Spring Data Redis를 이용해서 레디스 마스터/복제(Master/Replica) 용 Java Spring 애플리케이션을 개발하는 방법을 설명합니다.
Spring Data Redis로 레디스 마스터/복제 서버로 연결할 경우 수동 구성(Manual Config)을 해야 합니다. 자동 구성(Auto Config)는 지원하지 않습니다.

기본 사용법

① new RedisStaticMasterReplicaConfiguration(master[0],Integer.parseInt(master[1]))

RedisStaticMasterReplicaConfiguration을 마스터 IP, Port로 생성합니다.

② redisConfig.addNode(node[0].trim(), Integer.parseInt(node[1]))

복제 서버들의 IP, Port를 추가해서 구성합니다.

③ LettuceClientConfiguration.builder()

LettuceClientConfiguration을 생성/구성합니다.
readFrom, clientName, commandTimeout 등을 설정합니다.

④ new LettuceConnectionFactory(redisConfig, clientConfig)

LettuceConnectionFactory를 생성합니다.

⑤ valueOperations.set(key, value)

레디스 명령을 실행합니다.

Source code
① // Master 설정: 192.168.56.102:6000 RedisStaticMasterReplicaConfiguration redisConfig = new RedisStaticMasterReplicaConfiguration(master[0],Integer.parseInt(master[1])); ② // Replica(복제) 설정: [192.168.56.102:6001, 192.168.56.102:6002] for (String replica : redisProps.getReplicas()) { String[] node = replica.split(":"); redisConfig.addNode(node[0].trim(), Integer.parseInt(node[1])); } ③ LettuceClientConfiguration clientConfig = LettuceClientConfiguration.builder() .readFrom(redisProps.getReadFrom()) // 부하분산 설정: replicaPreferred 조회는 복제서버에서 실행 .clientName(redisProps.getClientName()) // client name: redisgate .commandTimeout(redisProps.getTimeout()) // command timeout: 5s .clientOptions(clientOptions.build()) // clientOptions 설정 .build(); ④ // LettuceConnectionFactory 생성 LettuceConnectionFactory connFactory = new LettuceConnectionFactory(redisConfig, clientConfig); ⑤ valueOperations.set(key, value); // 명령 실행

Master/Replica 구성과 Pub/Sub과의 관계

Master/Replica 구성에서는 Pub/Sub을 사용할 수 없습니다.
자세한 내용은 여기를 보세요
사용하려면 Master에 Standalone으로 연결해서 사용하면 됩니다.

Spring Project

Spring Project 생성

Java Spring Project 생성 URL: start.spring.io

• Project: Gradle-Groovy
• Language: Java
• Spring Boot: 3.1.8
• Project Metadata
  • Group: com.redisgate
  • Artifact: MasterReplciaSpring -> Project 명칭, 이 이름으로 압축파일이 생긴다.
  • Name: Main -> Main Class Name
  • Description: Redis MasterReplcia Spring Application -> 설명
  • Package name: com.redisgate.redis -> Package Name
  • Packaging: Jar
  • Java: 17 -> Java 버전 선택
• Dependencies에서 [ADD … CTRL + B] 버튼을 클릭해서 아래 3개를 추가합니다.
  • Spring Web
  • Lombok
  • Spring Data Redis(Access+Driver)
• 마지막으로 [GENERATE CTRL + ⏎ ] 버튼 클릭해서 압축 파일(zip)을 다운받는다.
• 스프링부트3.x 는 자바17 이상, 스프링부트 2.x는 자바11을 사용합니다.

이 프로젝트에 사용된 Spring, Lettuce, Redis 버전

• Spring-Boot: 3.1.8, Spring: 6.0.16
• Lettuce-6.2.7
• Redis-7.2.3

Main Class

package com.redisgate.redis; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication @Slf4j public class MainApplication { public static void main(String[] args) { SpringApplication.run(MainApplication.class, args); log.info("----- Redis MasterReplcia Spring Application 시작 -----"); } }

application.properties

# Spring Data Redis (Lettuce) Properties spring.data.redis.master: 192.168.56.102:6000 spring.data.redis.replicas: 192.168.56.102:6001, 192.168.56.102:6002 spring.data.redis.password: redisgate spring.data.redis.database: 0 spring.data.redis.timeout: 5s spring.data.redis.connectTimeout: 5s spring.data.redis.clientName: redisgate spring.data.redis.readFrom: replicaPreferred #spring.data.redis.readFrom: upstream/any #server.port: 9090 #logging.level.root: debug

RedisProps class

application.properties 파일을 읽어오는 클래스.

• master는 String으로, replicas는 List<String>으로 읽어옵니다.
• readFrom 문자열을 ReadFrom 값으로 변경하는 getReadFrom()이 추가되었습니다.

package com.redisgate.redis; import io.lettuce.core.ReadFrom; import lombok.Getter; import lombok.Setter; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.autoconfigure.data.redis.RedisProperties; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Primary; import java.util.List; @Configuration @Getter @Setter @Slf4j @Primary // RedisProperties와 중복되므로 RedisInfo를 primary로 사용하는 것으로 명시 public class RedisProps extends RedisProperties { private String master; private List<String> replicas; private String readFrom; /* 나머지 값은 Spring RedisProperties에서 정의한 대로 읽어온다. RedisProperties의 각 필드에 대한 자세한 설명은 아래 URL을 참고하세요. http://redisgate.kr/redis/clients/springboot_intro.php#RedisProperties */ /** * 조회 명령을 복제서버에 실행하도록하는 ReadFrom * application.properties에 입력한 문자열(String)을 ReadFrom 값으로 만든다. * 자세한 설명은 아래 URL을 참고하세요. * http://redisgate.kr/redis/clients/springboot_readfrom.php * @return ReadFrom */ public ReadFrom getReadFrom() { return ReadFrom.valueOf(readFrom); } /** * application.properties에 입력한 문자열(String)을 리턴한다. * @return String */ public String getReadFromString() { return readFrom; } }

RedisConn class

Redis 서버에 연결합니다.
ConnectTimeout은 ClientOptions을 사용해서 설정합니다.

package com.redisgate.redis; import io.lettuce.core.ClientOptions; import io.lettuce.core.SocketOptions; 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 @Slf4j public class RedisConn { private final RedisProps redisProps; public RedisConn(RedisProps redisProps) { this.redisProps = redisProps; } @Bean public LettuceConnectionFactory redisConnectionFactory() { // Master 설정: 192.168.56.102:6000 String[] master = redisProps.getMaster().split(":"); RedisStaticMasterReplicaConfiguration redisConfig = new RedisStaticMasterReplicaConfiguration(master[0],Integer.parseInt(master[1])); // Replica(복제) 설정: [192.168.56.102:6001, 192.168.56.102:6002] for (String replica : redisProps.getReplicas()) { String[] node = replica.split(":"); redisConfig.addNode(node[0].trim(), Integer.parseInt(node[1])); } redisConfig.setPassword(redisProps.getPassword()); // redis password: redisgate redisConfig.setDatabase(redisProps.getDatabase()); // datebase: 0 // ClientOptions: autoReconnect, connectTimeout(5s) 설정 ClientOptions.Builder clientOptions = ClientOptions.builder() .autoReconnect(true) // default true. 레디스 서버 다운 시 1,2,4,8,16,30,이후 30초마다 재연결 시도 .socketOptions(SocketOptions.builder().connectTimeout(redisProps.getConnectTimeout()).build()); LettuceClientConfiguration clientConfig = LettuceClientConfiguration.builder() .readFrom(redisProps.getReadFrom()) // 부하분산 설정: replicaPreferred 조회는 복제서버에서 실행 .clientName(redisProps.getClientName()) // client name: redisgate .commandTimeout(redisProps.getTimeout()) // command timeout: 5s .clientOptions(clientOptions.build()) // clientOptions 설정 .build(); // LettuceConnectionFactory 생성 LettuceConnectionFactory connFactory = new LettuceConnectionFactory(redisConfig, clientConfig); connFactory.setShareNativeConnection(true); // default: true return connFactory; } }

• 주의: Spring Redis Connection을 이용하면 Application 시작할 때 레디스 서버에 연결하지 않습니다. 그러므로 레디스 서버가 시작되지 않았어도 Application은 시작됩니다.
  첫 명령(SET)이 실행되면 Application은 각 레디스 서버(마스터,복제1,복제2)에 다음 명령을 실행합니다.
  마지막에 SET 명령 실행용 연결은 종료하지 않고 유지합니다.
  다음에 입력 명령이 실행되면 해당 연결(connection)으로 명령을 실행합니다.
  connFactory.setShareNativeConnection(true);
• 1차 연결
  HELLO 3 AUTH default redisgate SETNAME redisgate
  ROLE
  1차 연결 종료
• 2차 연결
  HELLO 3 AUTH default redisgate SETNAME redisgate
  CLIENT SETNAME lettuce#MasterReplicaTopologyRefresh
  PING NODES
  2차 연결 종료
• 3차 연결(마스터에만)
  HELLO 3 AUTH default redisgate SETNAME redisgate
  SET key01 value-key01
  3차 연결 유지
• connFactory.setShareNativeConnection(false);
  1,2,3차 연결을 하고 3차 연결도 종료합니다. 따라서 매 명령 실행마다 1,2,3차 연결을 합니다.
  Connection Pool을 사용해서 연결별로 별도 스레드를 사용할 경우 설정합니다. 하지만 이 경우에도 성능상 이점은 없습니다.

RedisController class

• SET 테스트: http://localhost:8080/set/key01
• GET 테스트: http://localhost:8080/get/key01
  GET 명령이 복제서버에 실행되는 것을 확인하기 위해서 아래와 같이 redis-cli를 실행 후 위 get 명령을 실행합니다.
  $ bin/redis-cli -p 6001 -a redisgate --stat
• PING 테스트: http://localhost:8080/ping -> 마스터에서 실행됩니다.

package com.redisgate.redis; import org.springframework.data.redis.connection.RedisConnectionFactory; import org.springframework.data.redis.core.StringRedisTemplate; import org.springframework.data.redis.core.ValueOperations; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RestController; @RestController public class RedisController { private final StringRedisTemplate stringRedisTemplate; private final ValueOperations<String,String> valueOperations; public RedisController(StringRedisTemplate stringRedisTemplate) { this.stringRedisTemplate = stringRedisTemplate; this.valueOperations = stringRedisTemplate.opsForValue(); } // 예제 1) SET: 키-값 저장 // SET key value [NX|XX] [EX 초] [PX 밀리초] [EXAT timestamp] [PXAT milliseconds-timestamp] [KEEPTTL] [GET] // http://localhost:8080/set/key01 @GetMapping("/set/{key}") public String set(@PathVariable("key") String key) { String msg = "예제 1) SET -> "; valueOperations.set(key,"value-"+key); msg += "OK"; System.out.println(msg); return msg; } // 예제 2) GET: 조회, 복제에서 읽는지 readFrom 설정 확인 // $ bin/redis-cli -p 6000 -a redisgate --stat // $ bin/redis-cli -p 6001 -a redisgate --stat // $ bin/redis-cli -p 6002 -a redisgate --stat // GET key // http://localhost:8080/get/key01 @GetMapping("/get/{key}") public String get(@PathVariable("key") String key) { String msg = "예제 2) GET -> "; int count = 1; // 반복 실행 가능(readFrom 테스트 시) for (int i=0; i<count; i++ ) { valueOperations.get(key); } msg += count; System.out.println(msg); return msg; } // 예제 3) PING -> 마스터에서 실행된다. // StringRedisTemplate 에는 ping() 메소드가 없다. // connectionFactory.getConnection().ping(); -> connectionFactory 에서 가능. // PING // http://localhost:8080/ping @GetMapping("/ping") public String ping() { String msg = "예제 3) PING -> "; // String result = stringRedisTemplate.getConnectionFactory().getConnection().ping(); RedisConnectionFactory connectionFactory = stringRedisTemplate.getConnectionFactory(); if (connectionFactory == null) return "connectionFaction is NULL"; String result = connectionFactory.getConnection().ping(); msg += result; System.out.println(msg); return msg; } }