Lettuce Introduction

Redis Developer Course	Redis Technical Support	Redis Enterprise Server

Lettuce 개요

Lettuce(레터스)는 많은 사이트에서 사용되고 있는 Java용 Redis Client 입니다.
Spring Boot 2.0부터 Lettuce가 Redis 기본 클라이언트로 사용되고 있습니다.
Spring Boot 1.x에서는 Jedis가 기본 클라이언트로 사용되었습니다.

Lettuce Version History

기본 사용법

① RedisURI redisUri = RedisURI.Builder.redis("localhost",6379).build();: Redis 서버의 주소(ip와 port)를 지정해서 RedisURI를 생성합니다.
② RedisClient client = RedisClient.create(redisUri);: RedisURI로 RedisClient 인스턴스를 생성합니다.
③ StatefulRedisConnection<String, String> connection = client.connect();: Redis 서버에 연결합니다.
④ RedisCommands<String, String> commands = connection.sync();: Sync 명령 실행용 API를 얻습니다.
⑤ String result = commands.set("key","value");: SET 명령을 실행해서 "key"와 "value"를 저장합니다.
⑥ String value = commands.get("key");: GET 명령을 실행해서 "value"를 가져옵니다.
⑦ result = commands.del("key");: DEL 명령을 실행해서 입력된 "key"를 삭제합니다.
⑧ connection.close();: 연결을 종료합니다. 일반적으로 애플리케이션을 끝날 때 실행합니다.
⑨ client.shutdown();: 레디스 클라이언트를 종료합니다. 스레드와 리소스를 해제합니다.

Source code ① RedisURI redisUri = RedisURI.Builder.redis("localhost",6379).build(); ② RedisClient client = RedisClient.create(redisUri); ③ StatefulRedisConnection<String, String> connection = client.connect(); ④ RedisCommands<String, String> commands = connection.sync(); ⑤ String result = commands.set("key","value"); ⑥ String value = commands.get("key"); ⑦ result = commands.del("key"); ⑧ connection.close(); ⑨ client.shutdown();

RedisURI를 이용한 연결(접속) 방법

Case 1: IP, Port: RedisURI redisUri = RedisURI.Builder.redis("localhost",6379).build();
Case 2: IP, Port, Password: RedisURI redisUri = RedisURI.Builder.redis("localhost",6379) .withPassword("password".toCharArray()) // char[] .build();
Case 3: IP, Port, Password, Database, CommandTimeout, ClientName: RedisURI redisUri = RedisURI.Builder.redis("localhost",6379) .withPassword("password".toCharArray()) // char[] .withDatabase(0) // int .withTimeout(Duration.ofSeconds(5)) // Duration .withClientName("redisClient") // String .build();

Connect String(URI)을 이용한 연결(접속) 방법

URI syntax
redis :// [[username :] password@] host [:port][/database] [?[timeout=timeout[d|h|m|s|ms|us|ns]] [&clientName=clientName] [&libraryName=libraryName] [&libraryVersion=libraryVersion] ]
위에서 설명한 RedisURI와 같은 방법으로 Connect String(URI)으로 RedisClient를 생성한다.
redisClient = RedisClient.create(uri);

Case 1: IP, Port: String uri = "redis://localhost:6379";
Case 2: IP, Port, Password: String uri = "redis://password@localhost:6379";
Case 3: IP, Port, Password, Database, CommandTimeout, ClientName: String uri = "redis://password@localhost:6379/0?timeout=5s&clientName=redisClient";

RedisClient 내부에서 받은 string을 RedisURI로 만들어서 사용한다.

    public static RedisClient create(String uri) {
        LettuceAssert.notEmpty(uri, "URI must not be empty");
        return new RedisClient(clientResoruces: null, RedisURI.create(uri));
    }

그러므로 위에서 설명한 RedisURI를 이용한 연결(접속) 방법을 권장합니다.

SSL/TLS를 이용한 연결 방법: redis -> rediss로 변경한다.

rediss :// [[username :] password@] host [: port][/database]
           [?[timeout=timeout[d|h|m|s|ms|us|ns]] [&clientName=clientName]
           [&libraryName=libraryName] [&libraryVersion=libraryVersion] ]

Unix Domain Sockets을 이용한 연결 방법: host:port 자리에 path를 지정한다. database 위치가 다르다.

redis-socket :// [[username :] password@]path
                 [?[timeout=timeout[d|h|m|s|ms|us|ns]] [&database=database]
                 [&clientName=clientName] [&libraryName=libraryName]
                 [&libraryVersion=libraryVersion] ]

Timeout 단위: 단위를 지정하지 않으면 ms(Milliseconds)가 기본으로 적용된다.
d Days
h Hours
m Minutes
s Seconds
ms Milliseconds
us Microseconds
ns Nanoseconds
application.properties에 redis.timeout: 5s 이렇게 지정할 수 있다.

Lettuce Spring Project

Spring Project 생성

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

개발 툴(IDE) 설정, 사용법

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

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

Class/File 구성

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 Standalone Lettuce Application 시작 -----"); } }

application.properties

# Redis Lettuce Properties redis.host: 127.0.0.1 redis.port: 6379 redis.password: redisgate redis.database: 0 redis.timeout: 5s redis.connectTimeout: 5s redis.clientName: redisgate #server.port: 9090 #logging.level.root: debug

RedisProps class

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

password는 char[]를 사용한다. String을 사용하면 .toCharArray()를 추가해야 한다.

package com.redisgate.redis; import lombok.Getter; import lombok.Setter; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Configuration; import java.time.Duration; @Configuration @ConfigurationProperties(prefix = "redis") @Getter @Setter public class RedisProps { private String host; private int port; private char[] password; // RedisURI에서 password는 char[]로 받는다. private int database; private Duration timeout; private Duration connectTimeout; private String clientName; }

RedisConn class

Redis 서버에 연결한다.

연결 방법

연결 방법은 RedisURI.Builder, Connection URL 2가지로 설명한다. 각 방법은 soruce code를 참고하세요.
Connection URL: redis://[[username:]password@]host [: port][/database]
[? [timeout=timeout[d|h|m|s|ms|us|ns]] [ &database=database] [&clientName=clientName]
RedisURI.Builder 사용을 권장합니다.

연결 구분

용도에 따라 구분해서 연결(connection)을 사용한다. Sync, Async, Pipeline, Publish, Subscribe 용.
Async connection: Sync connection 과 구분해서 사용한다.
Pipeline connection: 대량 입력용 연결이므로 구분해서 사용한다.
Publish connection과 Subscribe connection을 구분해서 사용한다. 한 connection으로 subscribe 중이면 publish 명령을 사용할 수 없다.
일반 연결(Sync)로 publish 명령을 사용할 수 있으나, Publish connection으로 사용할 것을 권장합니다.

package com.redisgate.redis; import io.lettuce.core.ClientOptions; import io.lettuce.core.RedisClient; import io.lettuce.core.RedisURI; import io.lettuce.core.SocketOptions; import io.lettuce.core.api.StatefulRedisConnection; import io.lettuce.core.api.async.RedisAsyncCommands; import io.lettuce.core.api.sync.RedisCommands; import io.lettuce.core.pubsub.StatefulRedisPubSubConnection; import io.lettuce.core.pubsub.api.async.RedisPubSubAsyncCommands; import io.lettuce.core.pubsub.api.sync.RedisPubSubCommands; import lombok.Getter; import lombok.extern.slf4j.Slf4j; import org.springframework.context.annotation.Configuration; /** * Application.properties에서 읽어온 데이터(접속 정보)로 레디스 서버에 연결(접속)한다. * 연결 방법은 RedisURI.Builder, Connection URL 2가지로 설명한다. */ @Configuration @Slf4j @Getter public class RedisConn { private final RedisProps redisProps; private final RedisClient redisClient; // Sync Connection and Commands private final StatefulRedisConnection<String, String> redisSyncConn; private final RedisCommands<String, String> redisSyncCommands; // Async Connection and Commands private final StatefulRedisConnection<String, String> redisAsyncConn; private final RedisAsyncCommands<String, String> redisAsyncCommands; // Pipeline Connection and Commands private final StatefulRedisConnection<String, String> redisPipelineConn; private final RedisAsyncCommands<String, String> redisPipelineCommands; /* Publish/Subscribe Connection and Commands publish 용 connection과 subscribe 용 connection을 구분한다. 같은 connection에서 subscribe를 사용하는 중에 publish를 실행하면 아래과 같은 RunTime Error가 발생한다. "Command PUBLISH not allowed while subscribed." "Allowed commands are: [PSUBSCRIBE, QUIT, PUNSUBSCRIBE, SUBSCRIBE, UNSUBSCRIBE, PING]] with root cause" */ // Publish Connection and Commands private final StatefulRedisPubSubConnection<String, String> redisPubConn; private final RedisPubSubCommands<String, String> redisPubCommands; private final RedisPubSubAsyncCommands<String, String> redisPubAsyncCommands; // Subscribe Connection and Commands private final StatefulRedisPubSubConnection<String, String> redisSubConn; private final RedisPubSubCommands<String, String> redisSubCommands; private final RedisPubSubAsyncCommands<String, String> redisSubAsyncCommands; public RedisConn(RedisProps redisProps) { this.redisProps = redisProps; /* Connection URL 를 이용한 연결 redis://[[username:]password@]host [: port][/database][? [timeout=timeout[d|h|m|s|ms|us|ns]] [ &database=database] [&clientName=clientName] 방법 1: host, port String url = "redis://localhost:6379"; String url = "redis://"+redisProps.getHost()+":"+redisProps.getPort(); 방법 2: host, port, password String url = "redis://password@localhost:6379"; String url = "redis://"+redisProps.getPassword()+"@"+redisProps.getHost()+":"+redisProps.getPort(); 방법 3: host, port, password, database, timeout, clientName String url = "redis://password@localhost:6379/0?timeout=5s&clientName=redisClient"; String url = "redis://"+redisProps.getPassword()+"@"+redisProps.getHost()+":"+ redisProps.getPort()+"/"+redisProps.getDatabase()+"?timeout="+ redisProps.getTimeout().toMillis()+"&clientName="+redisProps.getClientName(); redisClient = RedisClient.create(url); */ /* RedisURI.Builder를 이용한 연결: 값 직접 입력 RedisURI redisUri = RedisURI.Builder.redis("localhost",6379).build(); RedisURI redisUri = RedisURI.Builder.redis("localhost",6379) .withPassword("password".toCharArray()) .build(); RedisURI redisUri = RedisURI.Builder.redis("localhost",6379) .withPassword("password".toCharArray()) .withDatabase(0) .withTimeout(Duration.ofSeconds(5)) .withClientName("redisClient") .build(); */ // RedisURI.Builder를 이용한 연결: redisProps 이용 RedisURI redisURI = RedisURI.Builder.redis(redisProps.getHost(), redisProps.getPort()) .withPassword(redisProps.getPassword()) .withDatabase(redisProps.getDatabase()) .withTimeout(redisProps.getTimeout()) .withClientName(redisProps.getClientName()) .build(); redisClient = RedisClient.create(redisURI); // connectTimeout 설정 -> ClientOptions ClientOptions.Builder builder = ClientOptions.builder(); builder.autoReconnect(true); // default true // connectTimeout Setting builder.socketOptions(SocketOptions.builder().connectTimeout(redisProps.getConnectTimeout()).build()); redisClient.setOptions(builder.build()); // Redis Sync Connection redisSyncConn = redisClient.connect(); redisSyncCommands = redisSyncConn.sync(); // Redis Async Connection redisAsyncConn = redisClient.connect(); redisAsyncCommands = redisAsyncConn.async(); // Redis Pipeline Connection redisPipelineConn = redisClient.connect(); redisPipelineCommands = redisAsyncConn.async(); // Redis Publish Connection redisPubConn = redisClient.connectPubSub(); redisPubCommands = redisPubConn.sync(); redisPubAsyncCommands = redisPubConn.async(); // Redis Subscribe Connection redisSubConn = redisClient.connectPubSub(); redisSubCommands = redisSubConn.sync(); redisSubAsyncCommands = redisSubConn.async(); } }

	Lettuce Introduction	Strings >>

Email 답글이 올라오면 이메일로 알려드리겠습니다.