How to use Lettuce in Redis
1. Summary
Lettuce is an advanced Java client for Redis. It has become one of the most popular clients alongside Jedis. It has now become the default redis client in SpringBoot 2.0 version.
Compared with the veteran Jedis, Lettuce is a rising star. It is not only rich in functions, but also provides many new features, such as asynchronous operations, reactive programming, etc., and also solves the thread insecurity problem in Jedis.
2. Lettuce
2.1. Basic use
First, create a maven project, introduce the lettuce-core package, and you can use it.
<dependency> <groupId>io.lettuce</groupId> <artifactId>lettuce-core</artifactId> <version>5.3.1.RELEASE</version> </dependency>
Use lettuce to connect to redis and test whether the connection can be normal!
public class LettuceMain {
public static void main(String[] args) {
RedisURI redisUri = RedisURI.builder()
.withHost("127.0.0.1")
.withPort(6379)
.withPassword("111111")
.withTimeout(Duration.of(10, ChronoUnit.SECONDS))
.build();
RedisClient redisClient = RedisClient.create(redisUri);
StatefulRedisConnection<String, String> connection = redisClient.connect();
RedisCommands<String, String> commands = connection.sync();
System.out.println(commands.ping());
connection.close();
redisClient.shutdown();
}
}2.2. Synchronous operations
Basically, Lettuce supports all synchronous command operations supported by Jedis.
Below, we take the synchronous operation of strings as an example. Lettuce's api operation is as follows!
public class LettuceSyncMain {
public static void main(String[] args) {
RedisURI redisUri = RedisURI.builder()
.withHost("127.0.0.1").withPort(6379).withPassword("111111")
.withTimeout(Duration.of(10, ChronoUnit.SECONDS))
.build();
RedisClient redisClient = RedisClient.create(redisUri);
StatefulRedisConnection<String, String> connection = redisClient.connect();
//获取同步操作命令工具
RedisCommands<String, String> commands = connection.sync();
System.out.println("清空数据："+commands.flushdb());
System.out.println("判断某个键是否存在："+commands.exists("username"));
System.out.println("新增<'username','xmr'>的键值对："+commands.set("username", "xmr"));
System.out.println("新增<'password','password'>的键值对："+commands.set("password", "123"));
System.out.println("获取<'password'>键的值："+commands.get("password"));
System.out.println("系统中所有的键如下：" + commands.keys("*"));
System.out.println("删除键password:"+commands.del("password"));
System.out.println("判断键password是否存在："+commands.exists("password"));
System.out.println("设置键username的过期时间为5s:"+commands.expire("username", 5L));
System.out.println("查看键username的剩余生存时间："+commands.ttl("username"));
System.out.println("移除键username的生存时间："+commands.persist("username"));
System.out.println("查看键username的剩余生存时间："+commands.ttl("username"));
System.out.println("查看键username所存储的值的类型："+commands.type("username"));
connection.close();
redisClient.shutdown();
}
}2.3. Asynchronous operations
In addition, Lettuce also supports asynchronous operations. Change the above operations to asynchronous processing. The results are as follows!
public class LettuceASyncMain {
public static void main(String[] args) throws Exception {
RedisURI redisUri = RedisURI.builder()
.withHost("127.0.0.1").withPort(6379).withPassword("111111")
.withTimeout(Duration.of(10, ChronoUnit.SECONDS))
.build();
RedisClient redisClient = RedisClient.create(redisUri);
StatefulRedisConnection<String, String> connection = redisClient.connect();
//获取异步操作命令工具
RedisAsyncCommands<String, String> commands = connection.async();
System.out.println("清空数据："+commands.flushdb().get());
System.out.println("判断某个键是否存在："+commands.exists("username").get());
System.out.println("新增<'username','xmr'>的键值对："+commands.set("username", "xmr").get());
System.out.println("新增<'password','password'>的键值对："+commands.set("password", "123").get());
System.out.println("获取<'password'>键的值："+commands.get("password").get());
System.out.println("系统中所有的键如下：" + commands.keys("*").get());
System.out.println("删除键password:"+commands.del("password").get());
System.out.println("判断键password是否存在："+commands.exists("password").get());
System.out.println("设置键username的过期时间为5s:"+commands.expire("username", 5L).get());
System.out.println("查看键username的剩余生存时间："+commands.ttl("username").get());
System.out.println("移除键username的生存时间："+commands.persist("username").get());
System.out.println("查看键username的剩余生存时间："+commands.ttl("username").get());
System.out.println("查看键username所存储的值的类型："+commands.type("username").get());
connection.close();
redisClient.shutdown();
}
}2.4. Reactive programming
In addition to supporting asynchronous programming, Lettuce also supports reactive programming. The reactive programming framework introduced by Lettuce is Project Reactor. If not You can learn about reactive programming experience by yourself first.
Reactive programming use cases are as follows:
public class LettuceMain {
public static void main(String[] args) throws Exception {
RedisURI redisUri = RedisURI.builder()
.withHost("127.0.0.1").withPort(6379).withPassword("111111")
.withTimeout(Duration.of(10, ChronoUnit.SECONDS))
.build();
RedisClient redisClient = RedisClient.create(redisUri);
StatefulRedisConnection<String, String> connection = redisClient.connect();
//获取响应式API操作命令工具
RedisReactiveCommands<String, String> commands = connection.reactive();
Mono<String> setc = commands.set("name", "mayun");
System.out.println(setc.block());
Mono<String> getc = commands.get("name");
getc.subscribe(System.out::println);
Flux<String> keys = commands.keys("*");
keys.subscribe(System.out::println);
//开启一个事务，先把count设置为1，再将count自增1
commands.multi().doOnSuccess(r -> {
commands.set("count", "1").doOnNext(value -> System.out.println("count1：" + value)).subscribe();
commands.incr("count").doOnNext(value -> System.out.println("count2：" + value)).subscribe();
}).flatMap(s -> commands.exec())
.doOnNext(transactionResult -> System.out.println("transactionResult：" + transactionResult.wasDiscarded())).subscribe();
Thread.sleep(1000 * 5);
connection.close();
redisClient.shutdown();
}
}2.5. Publishing and subscribing
Lettuce also supports redis message publishing and subscription. The specific implementation cases are as follows:
public class LettuceReactiveMain1 {
public static void main(String[] args) throws Exception {
RedisURI redisUri = RedisURI.builder()
.withHost("127.0.0.1").withPort(6379).withPassword("111111")
.withTimeout(Duration.of(10, ChronoUnit.SECONDS))
.build();
RedisClient redisClient = RedisClient.create(redisUri);
//获取发布订阅操作命令工具
StatefulRedisPubSubConnection<String, String> pubsubConn = redisClient.connectPubSub();
pubsubConn.addListener(new RedisPubSubListener<String, String>() {
@Override
public void unsubscribed(String channel, long count) {
System.out.println("[unsubscribed]" + channel);
}
@Override
public void subscribed(String channel, long count) {
System.out.println("[subscribed]" + channel);
}
@Override
public void punsubscribed(String pattern, long count) {
System.out.println("[punsubscribed]" + pattern);
}
@Override
public void psubscribed(String pattern, long count) {
System.out.println("[psubscribed]" + pattern);
}
@Override
public void message(String pattern, String channel, String message) {
System.out.println("[message]" + pattern + " -> " + channel + " -> " + message);
}
@Override
public void message(String channel, String message) {
System.out.println("[message]" + channel + " -> " + message);
}
});
RedisPubSubAsyncCommands<String, String> pubsubCmd = pubsubConn.async();
pubsubCmd.psubscribe("CH");
pubsubCmd.psubscribe("CH2");
pubsubCmd.unsubscribe("CH");
Thread.sleep(100 * 5);
pubsubConn.close();
redisClient.shutdown();
}
}2.6. Client resources and parameter configuration
The communication framework of Lettuce client integrates Netty’s non-blocking IO operations. The setting of client resources is closely related to Lettuce’s performance, concurrency and event processing. If not I am particularly familiar with client parameter configuration. It is not recommended to modify the default values intuitively without experience. Just keep the default configuration.
In a non-cluster environment, the specific configuration examples are as follows:
public class LettuceMain {
public static void main(String[] args) throws Exception {
ClientResources resources = DefaultClientResources.builder()
.ioThreadPoolSize(4) //I/O线程数
.computationThreadPoolSize(4) //任务线程数
.build();
RedisURI redisUri = RedisURI.builder()
.withHost("127.0.0.1").withPort(6379).withPassword("111111")
.withTimeout(Duration.of(10, ChronoUnit.SECONDS))
.build();
ClientOptions options = ClientOptions.builder()
.autoReconnect(true)//是否自动重连
.pingBeforeActivateConnection(true)//连接激活之前是否执行PING命令
.build();
RedisClient client = RedisClient.create(resources, redisUri);
client.setOptions(options);
StatefulRedisConnection<String, String> connection = client.connect();
RedisCommands<String, String> commands = connection.sync();
commands.set("name", "关羽");
System.out.println(commands.get("name"));
connection.close();
client.shutdown();
resources.shutdown();
}
}In a cluster environment, the specific configuration examples are as follows:
public class LettuceMain {
public static void main(String[] args) throws Exception {
ClientResources resources = DefaultClientResources.builder()
.ioThreadPoolSize(4) //I/O线程数
.computationThreadPoolSize(4) //任务线程数
.build();
RedisURI redisUri = RedisURI.builder()
.withHost("127.0.0.1").withPort(6379).withPassword("111111")
.withTimeout(Duration.of(10, ChronoUnit.SECONDS))
.build();
ClusterClientOptions options = ClusterClientOptions.builder()
.autoReconnect(true)//是否自动重连
.pingBeforeActivateConnection(true)//连接激活之前是否执行PING命令
.validateClusterNodeMembership(true)//是否校验集群节点的成员关系
.build();
RedisClusterClient client = RedisClusterClient.create(resources, redisUri);
client.setOptions(options);
StatefulRedisClusterConnection<String, String> connection = client.connect();
RedisAdvancedClusterCommands<String, String> commands = connection.sync();
commands.set("name", "张飞");
System.out.println(commands.get("name"));
connection.close();
client.shutdown();
resources.shutdown();
}
}2.7, Thread pool configuration
Lettuce connections are designed to be thread-safe, so a connection can be shared by multiple threads. At the same time, lettuce connections are automatically reconnected by default. Using a single connection can basically meet business needs. In most cases, there is no need to configure the connection. Pooling and multiple connections will not bring performance improvement to the operation.
But in some special scenarios, such as transaction operations, using a connection pool would be a better solution. So how to configure the thread pool?
public class LettuceMain {
public static void main(String[] args) throws Exception {
RedisURI redisUri = RedisURI.builder()
.withHost("127.0.0.1")
.withPort(6379)
.withPassword("111111")
.withTimeout(Duration.of(10, ChronoUnit.SECONDS))
.build();
RedisClient client = RedisClient.create(redisUri);
//连接池配置
GenericObjectPoolConfig poolConfig = new GenericObjectPoolConfig();
poolConfig.setMaxIdle(2);
GenericObjectPool<StatefulRedisConnection<String, String>> pool = ConnectionPoolSupport.createGenericObjectPool(client::connect, poolConfig);
StatefulRedisConnection<String, String> connection = pool.borrowObject();
RedisCommands<String, String> commands = connection.sync();
commands.set("name", "张飞");
System.out.println(commands.get("name"));
connection.close();
pool.close();
client.shutdown();
}
}2.8. Master-slave mode configuration
redis generally uses the master-slave replication mode to build a high-availability architecture. Simply put, there is one master node, multiple slave nodes, and automatic slave nodes. Sync the latest data.
Lettuce supports automatically discovering node information in master-slave mode and then saving it locally. The specific configuration is as follows:
public class LettuceMain {
public static void main(String[] args) throws Exception {
//这里只需要配置一个节点的连接信息，不一定需要是主节点的信息，从节点也可以;可以自动发现主从节点
RedisURI uri = RedisURI.builder().withHost("192.168.31.111").withPort(6379).withPassword("123456").build();
RedisClient client = RedisClient.create(uri);
StatefulRedisMasterReplicaConnection<String, String> connection = MasterReplica.connect(client, StringCodec.UTF8, uri);
//从节点读取数据
connection.setReadFrom(ReadFrom.REPLICA);
RedisCommands<String, String> commands = connection.sync();
commands.set("name", "张飞");
System.out.println(commands.get("name"));
connection.close();
client.shutdown();
}
}Of course, we can also manually specify the cluster node to load. The specific configuration is as follows:
public class LettuceMain {
public static void main(String[] args) throws Exception {
//集群节点
List<RedisURI> uris = new ArrayList();
uris.add(RedisURI.builder().withHost("192.168.31.111").withPort(6379).withPassword("111111").build());
uris.add(RedisURI.builder().withHost("192.168.31.112").withPort(6379).withPassword("111111").build());
uris.add(RedisURI.builder().withHost("192.168.31.113").withPort(6379).withPassword("111111").build());
RedisClient client = RedisClient.create();
StatefulRedisMasterReplicaConnection<String, String> connection = MasterReplica.connect(client, StringCodec.UTF8, uris);
//从节点读取数据
connection.setReadFrom(ReadFrom.REPLICA);
RedisCommands<String, String> commands = connection.sync();
commands.set("name", "张飞");
System.out.println(commands.get("name"));
connection.close();
client.shutdown();
}
}2.9. Sentinel mode configuration
Sentinel mode is also a highlight of redis in achieving high service availability. The specific configuration is as follows:
public class LettuceMain {
public static void main(String[] args) throws Exception {
//集群节点
List<RedisURI> uris = new ArrayList();
uris.add(RedisURI.builder().withSentinel("192.168.31.111", 26379).withSentinelMasterId("mymaster").withPassword("123456").build());
uris.add(RedisURI.builder().withSentinel("192.168.31.112", 26379).withSentinelMasterId("mymaster").withPassword("123456").build());
uris.add(RedisURI.builder().withSentinel("192.168.31.113", 26379).withSentinelMasterId("mymaster").withPassword("123456").build());
RedisClient client = RedisClient.create();
StatefulRedisMasterReplicaConnection<String, String> connection = MasterReplica.connect(client, StringCodec.UTF8, uris);
//从节点读取数据
connection.setReadFrom(ReadFrom.REPLICA);
RedisCommands<String, String> commands = connection.sync();
commands.set("name", "赵云");
System.out.println(commands.get("name"));
connection.close();
client.shutdown();
}
}2.10. Cluster cluster mode configuration
Cluster cluster mode is a high-availability architecture model introduced later. It mainly uses sharding to store data. The specific configuration is as follows:
public class LettuceReactiveMain4 {
public static void main(String[] args) throws Exception {
Set<RedisURI> uris = new HashSet<>();
uris.add(RedisURI.builder().withHost("192.168.31.111").withPort(7000).withPassword("123456").build());
uris.add(RedisURI.builder().withHost("192.168.31.112").withPort(7000).withPassword("123456").build());
uris.add(RedisURI.builder().withHost("192.168.31.113").withPort(7000).withPassword("123456").build());
uris.add(RedisURI.builder().withHost("192.168.31.114").withPort(7000).withPassword("123456").build());
uris.add(RedisURI.builder().withHost("192.168.31.115").withPort(7000).withPassword("123456").build());
uris.add(RedisURI.builder().withHost("192.168.31.116").withPort(7001).withPassword("123456").build());
RedisClusterClient client = RedisClusterClient.create(uris);
StatefulRedisClusterConnection<String, String> connection = client.connect();
RedisAdvancedClusterCommands<String, String> commands = connection.sync();
commands.set("name", "关羽");
System.out.println(commands.get("name"));
//选择从节点,只读
NodeSelection<String, String> replicas = commands.replicas();
NodeSelectionCommands<String, String> nodeSelectionCommands = replicas.commands();
Executions<List<String>> keys = nodeSelectionCommands.keys("*");
keys.forEach(key -> System.out.println(key));
connection.close();
client.shutdown();
}
}The above is the detailed content of How to use Lettuce in Redis. For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Undress AI Tool
Undress images for free
Clothoff.io
AI clothes remover
Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
Hot Topics
1662
14
1419
52
1312
25
1262
29
1235
24
How to build the redis cluster mode
Apr 10, 2025 pm 10:15 PM
Redis cluster mode deploys Redis instances to multiple servers through sharding, improving scalability and availability. The construction steps are as follows: Create odd Redis instances with different ports; Create 3 sentinel instances, monitor Redis instances and failover; configure sentinel configuration files, add monitoring Redis instance information and failover settings; configure Redis instance configuration files, enable cluster mode and specify the cluster information file path; create nodes.conf file, containing information of each Redis instance; start the cluster, execute the create command to create a cluster and specify the number of replicas; log in to the cluster to execute the CLUSTER INFO command to verify the cluster status; make
How to clear redis data
Apr 10, 2025 pm 10:06 PM
How to clear Redis data: Use the FLUSHALL command to clear all key values. Use the FLUSHDB command to clear the key value of the currently selected database. Use SELECT to switch databases, and then use FLUSHDB to clear multiple databases. Use the DEL command to delete a specific key. Use the redis-cli tool to clear the data.
How to read redis queue
Apr 10, 2025 pm 10:12 PM
To read a queue from Redis, you need to get the queue name, read the elements using the LPOP command, and process the empty queue. The specific steps are as follows: Get the queue name: name it with the prefix of "queue:" such as "queue:my-queue". Use the LPOP command: Eject the element from the head of the queue and return its value, such as LPOP queue:my-queue. Processing empty queues: If the queue is empty, LPOP returns nil, and you can check whether the queue exists before reading the element.
How to configure Lua script execution time in centos redis
Apr 14, 2025 pm 02:12 PM
On CentOS systems, you can limit the execution time of Lua scripts by modifying Redis configuration files or using Redis commands to prevent malicious scripts from consuming too much resources. Method 1: Modify the Redis configuration file and locate the Redis configuration file: The Redis configuration file is usually located in /etc/redis/redis.conf. Edit configuration file: Open the configuration file using a text editor (such as vi or nano): sudovi/etc/redis/redis.conf Set the Lua script execution time limit: Add or modify the following lines in the configuration file to set the maximum execution time of the Lua script (unit: milliseconds)
How to use the redis command line
Apr 10, 2025 pm 10:18 PM
Use the Redis command line tool (redis-cli) to manage and operate Redis through the following steps: Connect to the server, specify the address and port. Send commands to the server using the command name and parameters. Use the HELP command to view help information for a specific command. Use the QUIT command to exit the command line tool.
How to implement redis counter
Apr 10, 2025 pm 10:21 PM
Redis counter is a mechanism that uses Redis key-value pair storage to implement counting operations, including the following steps: creating counter keys, increasing counts, decreasing counts, resetting counts, and obtaining counts. The advantages of Redis counters include fast speed, high concurrency, durability and simplicity and ease of use. It can be used in scenarios such as user access counting, real-time metric tracking, game scores and rankings, and order processing counting.
How to set the redis expiration policy
Apr 10, 2025 pm 10:03 PM
There are two types of Redis data expiration strategies: periodic deletion: periodic scan to delete the expired key, which can be set through expired-time-cap-remove-count and expired-time-cap-remove-delay parameters. Lazy Deletion: Check for deletion expired keys only when keys are read or written. They can be set through lazyfree-lazy-eviction, lazyfree-lazy-expire, lazyfree-lazy-user-del parameters.
How to optimize the performance of debian readdir
Apr 13, 2025 am 08:48 AM
In Debian systems, readdir system calls are used to read directory contents. If its performance is not good, try the following optimization strategy: Simplify the number of directory files: Split large directories into multiple small directories as much as possible, reducing the number of items processed per readdir call. Enable directory content caching: build a cache mechanism, update the cache regularly or when directory content changes, and reduce frequent calls to readdir. Memory caches (such as Memcached or Redis) or local caches (such as files or databases) can be considered. Adopt efficient data structure: If you implement directory traversal by yourself, select more efficient data structures (such as hash tables instead of linear search) to store and access directory information
