AS AgentScopeAPI 手册 / API Reference

LettuceClientAdapter

public class LettuceClientAdapter implements RedisClientAdapter
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:93–336

Lettuce 客户端适配器,在多次调用之间保存和恢复会话与记忆数据。位于 io.agentscope.core.session.redis.lettuce 包,实现 RedisClientAdapter。核心成员包括 of、set、get、rightPushList、rangeList、getListLength。

Adapter for Lettuce Redis client.

This adapter supports multiple Redis deployment modes through different client types:

  • RedisClient - Standalone and Sentinel modes

  • RedisClusterClient - Cluster mode

The adapter internally manages a shared connection and commands instance for efficient connection usage.

This implementation uses direct conditional checks to handle Lettuce's separate command APIs for standalone/sentinel and cluster modes. This is the simplest approach given Lettuce's lack of a unified API across deployment modes.

Usage Examples:

Standalone Mode:

`// Create standalone RedisClient
RedisClient redisClient = RedisClient.create("redis://localhost:6379");

// Use with RedisSession
Session session = RedisSession.builder()
.lettuceClient(redisClient)
.build();
`

Cluster Mode:

`// Create cluster client
RedisClusterClient clusterClient = RedisClusterClient.create("redis://localhost:7000");

// Use with RedisSession
Session session = RedisSession.builder()
.lettuceClusterClient(clusterClient)
.build();
`

Sentinel Mode:

`// Create Lettuce RedisClient for sentinel
RedisURI sentinelUri = RedisURI.builder()
.withSentinelMasterId("mymaster")
.withSentinel("localhost", 26379)
.withSentinel("localhost", 26380)
.withSentinel("localhost", 26381)
.withDatabase(0)
.build();
RedisClient redisClient = RedisClient.create(sentinelUri);

// Use with RedisSession
Session session = RedisSession.builder()
.lettuceClient(redisClient)
.build();
`

方法摘要Method Summary

方法Method说明Description
public static LettuceClientAdapter of(RedisClient redisClient)
static
创建并返回实例。
Create adapter from RedisClient (standalone/sentinel mode).
public static LettuceClientAdapter of(RedisClusterClient redisClusterClient)
static
创建适配器来自 RedisClusterClient(集群模式)。
Create adapter from RedisClusterClient (cluster mode).
public void set(String key, String value)
执行设置相关操作。
Performs the set operation.
public String get(String key)
按条件读取数据。
Performs the get operation.
public void rightPushList(String key, String value)
执行 `rightPushList` 方法。
Performs the right push list operation.
public List<String> rangeList(String key, long start, long end)
执行 `rangeList` 方法。
Performs the range list operation.
public long getListLength(String key)
获取列表长度。
Returns the list length.
public void deleteKeys(String... keys)
删除密钥。
Deletes the keys.
public void addToSet(String key, String member)
添加到设置。
Adds the to set.
public Set<String> getSetMembers(String key)
获取设置成员。
Returns the set members.
public long getSetSize(String key)
获取设置大小。
Returns the set size.
public boolean keyExists(String key)
设置该参数。
Performs the key exists operation.
public Set<String> findKeysByPattern(String pattern)
查找 `findKeysByPattern`。
Finds the keys by pattern.
public void close()
关闭连接并释放相关资源。
Releases resources and connections.

方法详情Method Detail

of

public static LettuceClientAdapter of(RedisClient redisClient)
static

创建并返回实例。

Create adapter from RedisClient (standalone/sentinel mode).

参数Parameters
名称Name类型Type说明Description
redisClientRedisClientRedis 客户端(类型 `RedisClient`)。the RedisClient for standalone or sentinel mode
返回Returns LettuceClientAdapter
一种新的LettuceClientAdapter。a new LettuceClientAdapter
抛出Throws
  • NullPointerException 可能抛出 `NullPointerException`。if redisClient is null
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:132–139

of

public static LettuceClientAdapter of(RedisClusterClient redisClusterClient)
static

创建适配器来自 RedisClusterClient(集群模式)。

Create adapter from RedisClusterClient (cluster mode).

参数Parameters
名称Name类型Type说明Description
redisClusterClientRedisClusterClientRedisClusterClient 用于集群模式。the RedisClusterClient for cluster mode
返回Returns LettuceClientAdapter
一种新的LettuceClientAdapter。a new LettuceClientAdapter
抛出Throws
  • NullPointerException 可能抛出 `NullPointerException`。if redisClusterClient is null
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:148–155

set

public void set(String key, String value)

执行设置相关操作。

Performs the set operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
valueString值(类型 `String`)。The value.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:157–164

get

public String get(String key)

按条件读取数据。

Performs the get operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:166–173

rightPushList

public void rightPushList(String key, String value)

执行 rightPushList 方法。

Performs the right push list operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
valueString值(类型 `String`)。The value.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:175–182

rangeList

public List<String> rangeList(String key, long start, long end)

执行 rangeList 方法。

Performs the range list operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
startlong启动(类型 `long`)。The start.
endlong结束(类型 `long`)。The end.
返回Returns List<String>
返回列出。Returns list.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:184–191

getListLength

public long getListLength(String key)

获取列表长度。

Returns the list length.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns long
返回数值结果。Returns a numeric result.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:193–200

deleteKeys

public void deleteKeys(String... keys)

删除密钥。

Deletes the keys.

参数Parameters
名称Name类型Type说明Description
keys varargsString...密钥(类型 `String...`)。The keys.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:202–209

addToSet

public void addToSet(String key, String member)

添加到设置。

Adds the to set.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
memberString成员(类型 `String`)。The member.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:211–218

getSetMembers

public Set<String> getSetMembers(String key)

获取设置成员。

Returns the set members.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns Set<String>
返回设置。Returns set.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:220–227

getSetSize

public long getSetSize(String key)

获取设置大小。

Returns the set size.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns long
返回数值结果。Returns a numeric result.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:229–236

keyExists

public boolean keyExists(String key)

设置该参数。

Performs the key exists operation.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:238–245

findKeysByPattern

public Set<String> findKeysByPattern(String pattern)

查找 findKeysByPattern。

Finds the keys by pattern.

参数Parameters
名称Name类型Type说明Description
patternStringpattern(类型 `String`)。The pattern.
返回Returns Set<String>
返回设置。Returns set.
源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:247–254

close

public void close()

关闭连接并释放相关资源。

Releases resources and connections.

源码Source io/agentscope/core/session/redis/lettuce/LettuceClientAdapter.java:283–293
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.