redis clients springboot springboot_lettuce_multidatasource

Lettuce Multi Data Source

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

Lettuce Multi Data Source

Lettuce RedisClient를 이용해서 Redis Standalone, Master-Replica, Sentinel, Cluster 각 데이터 소스(서버)에 연결하고 메소드(명령)을 실행하는 방법을 설명합니다.

Project 생성: start.spring.io

Project: Gradle Language: Java Spring Boot 3.1.4 Group: com.redisgate Artifact: LettuceMultiDataSource Packaging: Jar Java: 17 Dependencies Spring Web Lombok Spring Data Redis(Access+Driver)

application.properties

• redis.masterReplicas: 마스터와 복제노드를 구분하지 않고 일렬로 나열했다. MasterReplica.connect()에서는 마스터와 복제노드를 구분하지 않고 설정한다.
• redis.sentinel.redisPassword: 센티널이 모니터(관리)하는 레디스 서버의 password를 구분해서 지정했다.
• 센티널 서버의 password는 설정하지 않는다. 설정하면 센티널에 연결할 수 없습니다. 접속 문자열(redis-sentinel://password)는 레디스 서버의 password를 지정하는 것입니다.

redis.host: 192.168.56.102 redis.port: 18500 redis.password: redisgate redis.clientName: redisgate redis.readFrom: replicaPreferred redis.masterReplicas: 192.168.56.102:18510, 192.168.56.102:18511, 192.168.56.102:18512 redis.sentinel.nodes: 192.168.56.102:18525, 192.168.56.102:18526, 192.168.56.102:18527 redis.sentinel.master: mymaster redis.sentinel.redisPassword: redispass redis.cluster.nodes: 192.168.56.102:18530, 192.168.56.102:18531, 192.168.56.102:18532, 192.168.56.102:18533, 192.168.56.102:18534, 192.168.56.102:18535

Main Class: LettuceMultiDataSourceApplication

package com.redisgate.LettuceMultiDataSource; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication @Slf4j public class LettuceMultiDataSourceApplication { public static void main(String[] args) { SpringApplication.run(LettuceMultiDataSourceApplication.class, args); log.info("Lettuce Multi Data Source Application 시작"); } }

Class RedisConfig

• application.properties에서 콤마(,)로 구분된 서버 정보(IP:Port)를 읽어 올 때는 Set<String> masterReplicas, sentinelNodes, clusterNodes를 사용합니다.
  주의: 서버 정보(IP:Port)를 String으로 읽어서 StringUtils.split(replicas, ",")를 사용해서 구분할 경우 IP 앞에 space가 붙어서 서버 연결이 되지 않습니다.
• RedisClient 생성과 연결(connect)는 각 Repository에서 합니다. 각 Repository에서 연결하는 것이 더 적절합니다.
• ReadFrom getReadFrom(): application.properties에서 readFrom을 읽어서 Lettuce의 ReadFrom으로 변환합니다.

package com.redisgate.LettuceMultiDataSource; import io.lettuce.core.ReadFrom; import lombok.Getter; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Configuration; import java.util.Set; @Configuration @Slf4j @Getter public class RedisConfig { @Value("${redis.host}") private String host; @Value("${redis.port}") private int port; @Value("${redis.password}") private String password; @Value("${redis.clientName}") private String clientName; @Value("${redis.readFrom}") // redis.readFrom: any private String readFrom; @Value("${redis.masterReplicas}") private Set<String> masterReplicas; @Value("${redis.sentinel.nodes}") private Set<String> sentinelNodes; @Value("${redis.sentinel.master}") private String sentinelMaster; @Value("${redis.sentinel.redisPassword}") private String sentinelRedisPassword; @Value("${redis.cluster.nodes}") private Set<String> clusterNodes; // readFrom string을 ReadFrom 값으로 변환한다. public ReadFrom getReadFrom() { ReadFrom readFrom = null; try { readFrom = ReadFrom.valueOf(this.readFrom); } catch (IllegalArgumentException e) { // "Name must not be empty" // "ReadFrom 'name' not supported" log.error("readFrom Exception ERROR: {} ", e.getMessage()); } if (readFrom == null) { readFrom = ReadFrom.ANY; log.info("readFrom is ANY"); } else { log.info("readFrom is {}",this.readFrom); } return readFrom; } }

Class RedisStandaloneRepository - 단독 서버 레파지토리

RedisClient를 생성하고 레디스 서버에 연결합니다.

package com.redisgate.LettuceMultiDataSource; import io.lettuce.core.RedisClient; import io.lettuce.core.RedisFuture; import io.lettuce.core.api.StatefulRedisConnection; import io.lettuce.core.api.async.RedisAsyncCommands; import io.lettuce.core.api.sync.RedisCommands; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Repository; @Repository @Slf4j public class RedisStandaloneRepository { private final RedisClient redisClient; private final StatefulRedisConnection<String, String> connection; private final RedisCommands<String, String> redisCommands; private final RedisAsyncCommands<String, String> redisAsyncCommands; public RedisStandaloneRepository(RedisConfig redisConfig) { String uri = "redis://"+redisConfig.getPassword()+"@"+ redisConfig.getHost()+":"+redisConfig.getPort()+ "?&clientName="+redisConfig.getClientName(); this.redisClient = RedisClient.create(uri); this.connection = redisClient.connect(); this.redisCommands = this.connection.sync(); this.redisAsyncCommands = this.connection.async(); } public String save(String key, String value) { return redisCommands.set(key, value); } public String get(String key) { return redisCommands.get(key); } public RedisFuture<String> saveAsync(String key, String value) { return redisAsyncCommands.set(key, value); } public RedisFuture<String> getAsync(String key) { return redisAsyncCommands.get(key); } }

Class RedisMasterReplicaRepository - 마스터-복제 서버 레파지토리

RedisClient를 생성하고 마스터, 복제 서버에 연결합니다.
노드 수만큼 아래과 같은 연결문자열을 만들어서 RedisURI.create(uri) 생성합니다.

package com.redisgate.LettuceMultiDataSource; import io.lettuce.core.RedisClient; import io.lettuce.core.RedisFuture; import io.lettuce.core.RedisURI; import io.lettuce.core.api.async.RedisAsyncCommands; import io.lettuce.core.api.sync.RedisCommands; import io.lettuce.core.codec.StringCodec; import io.lettuce.core.masterreplica.MasterReplica; import io.lettuce.core.masterreplica.StatefulRedisMasterReplicaConnection; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Repository; import java.util.HashSet; import java.util.Set; @Repository @Slf4j public class RedisMasterReplicaRepository { private final RedisClient redisClient; private final StatefulRedisMasterReplicaConnection<String, String> connection; private final RedisCommands<String, String> redisCommands; private final RedisAsyncCommands<String, String> redisAsyncCommands; public RedisMasterReplicaRepository(RedisConfig redisConfig) { this.redisClient = RedisClient.create(); Set<RedisURI> redisURIs = new HashSet<>(); String uri; for(String node: redisConfig.getMasterReplicas()) { uri = "redis://"+redisConfig.getPassword()+"@"+node+"?&clientName="+redisConfig.getClientName(); log.info("{}",uri); redisURIs.add(RedisURI.create(uri)); } this.connection = MasterReplica.connect(redisClient, StringCodec.UTF8, redisURIs); this.connection.setReadFrom(redisConfig.getReadFrom()); this.redisCommands = this.connection.sync(); this.redisAsyncCommands = this.connection.async(); } public String save(String key, String value) { return redisCommands.set(key, value); } public String get(String key) { return redisCommands.get(key); } public RedisFuture<String> saveAsync(String key, String value) { return redisAsyncCommands.set(key, value); } public RedisFuture<String> getAsync(String key) { return redisAsyncCommands.get(key); } }

Class RedisSentinelRepository - 센티널 레파지토리

• RedisClient를 생성하고 센티널에 연결합니다. 센티널에 연결해서 레디스 정보를 얻어와서 레디스 서버에 연결합니다. 그러므로 레디스 서버의 정보(ip:port)를 제공할 필요가 없습니다.
• 센티널 서버의 password는 설정하지 않는다. 설정하면 센티널에 연결할 수 없습니다. 접속 문자열(redis-sentinel://password)는 레디스 서버의 password를 지정하는 것입니다.
• redisClient.connectSentinel(): 센티널에 접속합니다. 센티널 명령을 실행합니다.
• MasterReplica.connect(): 센티널이 모니터(관리)하는 레디스 서버에 연결합니다. 레디스 명령을 실행합니다.

package com.redisgate.LettuceMultiDataSource; import io.lettuce.core.RedisClient; import io.lettuce.core.RedisFuture; import io.lettuce.core.RedisURI; import io.lettuce.core.api.async.RedisAsyncCommands; import io.lettuce.core.api.sync.RedisCommands; import io.lettuce.core.codec.StringCodec; import io.lettuce.core.masterreplica.MasterReplica; import io.lettuce.core.masterreplica.StatefulRedisMasterReplicaConnection; import io.lettuce.core.sentinel.api.StatefulRedisSentinelConnection; import io.lettuce.core.sentinel.api.async.RedisSentinelAsyncCommands; import io.lettuce.core.sentinel.api.sync.RedisSentinelCommands; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Repository; @Repository @Slf4j public class RedisSentinelRepository { private final RedisClient redisClient; private final StatefulRedisSentinelConnection<String, String> sentinelConnection; private final RedisSentinelCommands<String, String> sentinelCommands; private final RedisSentinelAsyncCommands<String, String> sentinelAsyncCommands; private final StatefulRedisMasterReplicaConnection<String, String> masterReplicaConnection; private final RedisCommands<String, String> redisCommands; private final RedisAsyncCommands<String, String> redisAsyncCommands; public RedisSentinelRepository(RedisConfig redisConfig) { // Connect String 작성 // redis-sentinel://[[username:]password@]host1 [: port1][, host2 [:port2]][, hostN [:portN]][/ database][? [timeout=timeout[d|h|m|s|ms|us|ns]] [ &sentinelMasterId=sentinelMasterId] [&database=database] [&clientName=clientName] [&verifyPeer=NONE|CA|FULL]] // 여기 password는 redis server password를 의미하는 것임. // sentinel password는 사용할 수 없음. 즉, sentinel server에 password를 설정하면 안됨. // 참조1: https://github.com/lettuce-io/lettuce-core/issues/1232 2020.02.19 // RedisURI 클래스는 redis-sentinel을 사용할 때 비밀번호를 구문 분석하지 않습니다. -> 해당 기능 제공되지 않음. // 참조2: https://github.com/lettuce-io/lettuce-core/issues/1002 2019.03.14 Redis Sentinel 인증 지원 추가 StringBuilder redisUri = new StringBuilder("redis-sentinel://" + redisConfig.getSentinelRedisPassword() + "@"); int i=0; for(String node: redisConfig.getSentinelNodes()) { log.info("Sentinel node: {}", node); redisUri.append(node); if (++i < redisConfig.getSentinelNodes().size()) redisUri.append(","); } redisUri.append("?&sentinelMasterId=").append(redisConfig.getSentinelMaster()); redisUri.append("&clientName=").append(redisConfig.getClientName()); log.info("Sentinel URI: {}", redisUri); RedisURI redisURI = RedisURI.create(redisUri.toString()); this.redisClient = RedisClient.create(redisURI); // Connect Sentinel this.sentinelConnection = this.redisClient.connectSentinel(); this.sentinelCommands = this.sentinelConnection.sync(); this.sentinelAsyncCommands = this.sentinelConnection.async(); log.info("Sentinel Connect OK"); // Connect Redis masterReplicaConnection = MasterReplica.connect(this.redisClient, StringCodec.UTF8, redisURI); masterReplicaConnection.setReadFrom(redisConfig.getReadFrom()); this.redisCommands = this.masterReplicaConnection.sync(); this.redisAsyncCommands = this.masterReplicaConnection.async(); log.info("Redis MasterReplica Connect OK"); } public String save(String key, String value) { return redisCommands.set(key, value); } public String get(String key) { return redisCommands.get(key); } public RedisFuture<String> saveAsync(String key, String value) { return redisAsyncCommands.set(key, value); } public RedisFuture<String> getAsync(String key) { return redisAsyncCommands.get(key); } public String infoSentinel() { return sentinelCommands.info(); } }

Class RedisClusterRepository - 클러스터 레파지토리

RedisClusterClient.create(): 레디스 서버에 연결합니다.

package com.redisgate.LettuceMultiDataSource; import io.lettuce.core.RedisFuture; import io.lettuce.core.RedisURI; import io.lettuce.core.cluster.ClusterClientOptions; import io.lettuce.core.cluster.ClusterTopologyRefreshOptions; import io.lettuce.core.cluster.RedisClusterClient; import io.lettuce.core.cluster.api.StatefulRedisClusterConnection; import io.lettuce.core.cluster.api.async.RedisAdvancedClusterAsyncCommands; import io.lettuce.core.cluster.api.sync.RedisAdvancedClusterCommands; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Repository; import java.time.Duration; import java.util.HashSet; import java.util.Set; @Repository @Slf4j public class RedisClusterRepository { private final RedisClusterClient redisClusterClient; private final StatefulRedisClusterConnection<String, String> clusterConnection; private final RedisAdvancedClusterCommands<String, String> clusterCommands; private final RedisAdvancedClusterAsyncCommands<String, String> clusterAsyncCommands; public RedisClusterRepository(RedisConfig redisConfig) { log.info("clusterNodes: {}", redisConfig.getClusterNodes()); Set<RedisURI> nodes = new HashSet<>(); for(String node: redisConfig.getClusterNodes()) { String uri = "redis://"+redisConfig.getPassword()+"@"+node+"?&clientName="+redisConfig.getClientName(); log.info("{}",uri); nodes.add(RedisURI.create(uri)); } this.redisClusterClient = RedisClusterClient.create(nodes); ClusterTopologyRefreshOptions topologyRefreshOptions = ClusterTopologyRefreshOptions.builder() .enablePeriodicRefresh(Duration.ofSeconds(60)) // default 60 sec // .enableAllAdaptiveRefreshTriggers() .build(); redisClusterClient.setOptions(ClusterClientOptions.builder() .topologyRefreshOptions(topologyRefreshOptions) .autoReconnect(true) // default true .build()); this.clusterConnection = this.redisClusterClient.connect(); // redisConfig에서 readFrom 값을 가져와서 ReadFrom을 설정한다. // readFrom은 application.properties에서 설정한다. this.clusterConnection.setReadFrom(redisConfig.getReadFrom()); this.clusterCommands = this.clusterConnection.sync(); this.clusterAsyncCommands = this.clusterConnection.async(); } public String save(String key, String value) { return clusterCommands.set(key, value); } public String get(String key) { return clusterCommands.get(key); } public RedisFuture<String> saveAsync(String key, String value) { return clusterAsyncCommands.set(key, value); } public RedisFuture<String> getAsync(String key) { return clusterAsyncCommands.get(key); } }

Class RedisController

• @GetMapping("/standalone/save/{key}"), @GetMapping("/standalone/get/{key}"): 단독 서버 저장, 조회
• @GetMapping("/standalone/saveAsync/{key}"), @GetMapping("/standalone/getAsync/{key}"): 단독 서버 비동기 저장, 조회
• @GetMapping("/masterReplica/save/{key}"), @GetMapping("/masterReplica/get/{key}"): 마스터-복제 저장, 조회
• @GetMapping("/sentinel/save/{key}"), @GetMapping("/sentinel/get/{key}"): 센티널-레디스 서버 저장, 조회
• @GetMapping("/sentinel/info"): 센티널 서버 info 명령 실행(레디스 서버 아님)
• @GetMapping("/cluster/save/{key}"), @GetMapping("/cluster/get/{key}"): 레디스 클러스터 서버 저장, 조회

package com.redisgate.LettuceMultiDataSource; import io.lettuce.core.RedisFuture; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; 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 { @Autowired private RedisStandaloneRepository redisStandaloneRepository; @Autowired private RedisMasterReplicaRepository redisMasterReplicaRepository; @Autowired private RedisSentinelRepository redisSentinelRepository; @Autowired private RedisClusterRepository redisClusterRepository; @GetMapping("/standalone/save/{key}") public String saveStandalone(@PathVariable("key") String key) { String result = redisStandaloneRepository.save(key,"value-"+key); log.info("{}", result); return result; } @GetMapping("/standalone/get/{key}") public String getStandalone(@PathVariable("key") String key) { String result = redisStandaloneRepository.get(key); log.info("{}", result); return result; } @GetMapping("/standalone/saveAsync/{key}") public void saveAsyncStandalone(@PathVariable("key") String key) { RedisFuture<String> result = redisStandaloneRepository.saveAsync(key,"value-"+key); result.thenAccept(r -> { log.info("{}", r); }); } @GetMapping("/standalone/getAsync/{key}") public void getAsyncStandalone(@PathVariable("key") String key) { RedisFuture<String> result = redisStandaloneRepository.getAsync(key); result.thenAccept(r -> { log.info("{}", r); }); } @GetMapping("/masterReplica/save/{key}") public String saveMasterReplica(@PathVariable("key") String key) { String result = redisMasterReplicaRepository.save(key,"value-"+key); log.info("{}", result); return result; } @GetMapping("/masterReplica/get/{key}") public String getMasterReplica(@PathVariable("key") String key) { String result = redisMasterReplicaRepository.get(key); log.info("{}", result); return result; } @GetMapping("/sentinel/save/{key}") public String saveSentinel(@PathVariable("key") String key) { String result = redisSentinelRepository.save(key,"value-"+key); log.info("{}", result); return result; } @GetMapping("/sentinel/get/{key}") public String getSentinel(@PathVariable("key") String key) { String result = redisSentinelRepository.get(key); log.info("{}", result); return result; } @GetMapping("/sentinel/info") public String infoSentinel() { String result = redisSentinelRepository.infoSentinel(); log.info("{}", result); return result; } @GetMapping("/cluster/save/{key}") public String save(@PathVariable("key") String key) { String result = redisClusterRepository.save(key,"value-"+key); log.info("{}", result); return result; } @GetMapping("/cluster/get/{key}") public String get(@PathVariable("key") String key) { String result = redisClusterRepository.get(key); log.info("{}", result); return result; } }