redis clients lettuce2 lettuce2_masterreplica

Lettuce Redis Master/Replica

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

Lettuce Redis Master/Replica

이 문서는 레터스(Lettuce)를 이용해서 레디스 마스터/복제(Master/Replica) 용 Java Spring 애플리케이션을 개발하는 방법을 설명합니다.

기본 사용법

① RedisURI redisURI = RedisURI.Builder.redis(host[0], Integer.parseInt(host[1])) ...

Redis 서버의 주소(ip와 port)와 추가 정보로 RedisURI list를 생성합니다.

② redisClient = RedisClient.create();

RedisClient 인스턴스를 생성합니다.

③ masterReplicaConnection = MasterReplica.connect(redisClient, StringCodec.UTF8, redisURIs);

Redis 서버(Master/Replica)에 연결합니다.

④ masterReplicaConnection.setReadFrom(redisProps.getReadFrom());

조회 명령은 복제서버에서 실행하기 위해 ReadFrom을 설정합니다.
ReadFrom 각 값에 대한 자세한 설명은 여기를 보세요.

⑤ redisSyncCommands = masterReplicaConnection.sync();

Sync 명령 실행용 API를 얻습니다.

Source code
① List<RedisURI> redisURIs = new ArrayList<>(); for(String node: redisProps.getMasterReplicas()) { String[] host = node.split(":"); RedisURI redisURI = RedisURI.Builder.redis(host[0], Integer.parseInt(host[1])) .withPassword(redisProps.getPassword()) .withDatabase(redisProps.getDatabase()) .withTimeout(redisProps.getTimeout()) .withClientName(redisProps.getClientName()) .build(); redisURIs.add(redisURI); } ② redisClient = RedisClient.create(); ③ masterReplicaConnection = MasterReplica.connect(redisClient, StringCodec.UTF8, redisURIs); ④ masterReplicaConnection.setReadFrom(redisProps.getReadFrom()); ⑤ redisSyncCommands = masterReplicaConnection.sync();

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

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

Lettuce 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: MasterReplciaLettuce -> Project 명칭, 이 이름으로 압축파일이 생긴다.
  • Name: Main -> Main Class Name
  • Description: Redis MasterReplcia Lettuce 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을 사용합니다.

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

• Lettuce-6.2.7
• Spring-Boot: 3.1.8, Spring: 6.0.16
• 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 Lettuce Application 시작 -----"); } }

application.properties

# Redis Lettuce Properties redis.masterReplicas: 192.168.56.102:6000, 192.168.56.102:6001, 192.168.56.102:6002 redis.password: redisgate redis.database: 0 redis.timeout: 5s redis.connectTimeout: 5s redis.clientName: redisgate redis.readFrom: replicaPreferred #server.port: 9090 #logging.level.root: debug

RedisProps class

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

• masterReplicas의 IP:Port 목록은 순서를 유지하는 List를 사용했습니다.
• password는 char[]를 사용한다. String을 사용하면 적용 시 getPassword().toCharArray()를 사용해야 합니다.
• readFrom 문자열을 ReadFrom 값으로 변경하는 getReadFrom()이 추가되었습니다.

package com.redisgate.redis; import io.lettuce.core.ReadFrom; import lombok.Getter; import lombok.Setter; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Configuration; import java.time.Duration; import java.util.List; @Configuration @ConfigurationProperties(prefix = "redis") @Getter @Setter public class RedisProps { private List<String> masterReplicas; private int database; private char[] password; // RedisURI에서 password는 char[]로 받는다. private Duration timeout; private Duration connectTimeout; private String clientName; private String readFrom; /** * 조회 명령을 복제서버에 실행하도록하는 ReadFrom * application.properties에 입력한 문자열(String)을 ReadFrom 값으로 만든다. * 자세한 설명은 아래 URL을 참고하세요. * http://redisgate.kr/redis/clients/lettuce2_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.*; import io.lettuce.core.api.async.RedisAsyncCommands; import io.lettuce.core.api.sync.RedisCommands; import io.lettuce.core.codec.StringCodec; import lombok.Getter; import lombok.extern.slf4j.Slf4j; import org.springframework.context.annotation.Configuration; import io.lettuce.core.masterreplica.MasterReplica; import io.lettuce.core.masterreplica.StatefulRedisMasterReplicaConnection; import java.util.ArrayList; import java.util.List; @Configuration @Slf4j @Getter public class RedisConn { private final RedisProps redisProps; private final RedisClient redisClient; private final StatefulRedisMasterReplicaConnection<String, String> masterReplicaConnection; private final RedisCommands<String, String> redisSyncCommands; private final RedisAsyncCommands<String, String> redisAsyncCommands; // private final CompletableFuture<StatefulRedisMasterReplicaConnection<String, String>> masterReplicaAsyncConnection; public RedisConn(RedisProps redisProps) { this.redisProps = redisProps; List<RedisURI> redisURIs = new ArrayList<>(); for(String node: redisProps.getMasterReplicas()) { String[] host = node.split(":"); RedisURI redisURI = RedisURI.Builder.redis(host[0], Integer.parseInt(host[1])) .withPassword(redisProps.getPassword()) .withDatabase(redisProps.getDatabase()) .withTimeout(redisProps.getTimeout()) .withClientName(redisProps.getClientName()) .build(); redisURIs.add(redisURI); } // Redis Connection URL // redis://[[username:]password@]host [: port][/database][? [timeout=timeout[d|h|m|s|ms|us|ns]] [ &database=database] [&clientName=clientName] ] // List<RedisURI> redisURIs = new ArrayList<>(); // for(String node: redisProps.getMasterReplicas()) { // String url = "redis://"+ redisProps.getPassword()+"@"+node+"/"+ redisProps.getDatabase()+ // "?timeout="+ redisProps.getTimeout().toMillis()+"&clientName="+ redisProps.getClientName(); // System.out.println("url: "+url); // redisURIs.add(RedisURI.create(url)); // } redisClient = RedisClient.create(); // connectTimeout 설정 -> ClientOptions ClientOptions.Builder clientOptions = ClientOptions.builder(); clientOptions.autoReconnect(true); // default true clientOptions.socketOptions(SocketOptions.builder().connectTimeout(redisProps.getConnectTimeout()).build()); redisClient.setOptions(clientOptions.build()); // Redis MasterReplica Connection masterReplicaConnection = MasterReplica.connect(redisClient, StringCodec.UTF8, redisURIs); // ReadFrom 설정 masterReplicaConnection.setReadFrom(redisProps.getReadFrom()); // Redis Sync Commands redisSyncCommands = masterReplicaConnection.sync(); // Redis Async Commands redisAsyncCommands = masterReplicaConnection.async(); // Connection 자체를 비동기로 실행한다. // masterReplicaAsyncConnection = MasterReplica.connectAsync(redisClient, StringCodec.UTF8, redisURIs); } }

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 io.lettuce.core.api.sync.RedisCommands; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RestController; @RestController @Slf4j public class RedisController { private final RedisCommands<String, String> redisSyncCommands; public RedisController(RedisConn redisConn) { redisSyncCommands = redisConn.getRedisSyncCommands(); } // 예제 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 -> "; String result = redisSyncCommands.set(key,"value-"+key); msg += result; 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 = 10000; // 1만번 실행 for (int i=0; i<count; i++ ) { redisSyncCommands.get(key); } msg += count; System.out.println(msg); return msg; } // 예제 3) PING -> 마스터에서 실행된다. // PING // http://localhost:8080/ping @GetMapping("/ping") public String ping() { String msg = "예제 3) PING -> "; String result = redisSyncCommands.ping(); msg += result; System.out.println(msg); return msg; } }