xredis 是基于 Lettuce 实现的 Redis 客户端，用于简化 Redis 数据操作。
xredis 是对 Lettuce 的一个非常非常薄的封装。
- 统一
standalone、sentinel和cluster的 API，统一通过RedisOperator操作数据。 - 提供
RedisSyncOperator、RedisAsyncOperator和RedisReactiveOperator接口，可以灵活使用不同编程范式。 - 提供
Pipeline接口，支持批提交命令。 - 提供
StreamContainer和StreamPublisher，简化Redis-Stream的订阅发布。 - 提供
RedisOperatorProxy，简化批数据操作，提高批数据操作性能。 - 提供
SpringBoot自动配置，可以通过配置文件直接配置Lettuce的绝大部分配置项（有些特殊配置项需编程实现）。
总之，项目初衷是希望保留性能强大且功能灵活的 Lettuce 原生 API，在此基础上再去扩展一些实用的常用的功能。同时，能够支持 SpringBoot 的自动配置，做到开箱即用。
| 名称 | 版本 | 关键理由 |
|---|---|---|
| JDK | 21+ | 虚拟线程 |
| Lettuce | 6.5.4.RELEASE+ | 支持 Redis-JSON 操作，支持 Redis-Hash 设置字段的过期时间 |
| SpringBoot | 3.3.0+ | 虚拟线程 |
示例项目：xredis-samples
<dependencies>
<!-- ... xredis 依赖 ... -->
<dependency>
<groupId>com.igeeksky.xredis</groupId>
<artifactId>xredis-lettuce-spring-boot-autoconfigure</artifactId>
<version>${xredis.version}</version>
</dependency>
<!-- ... 其它：假定使用 SpringWeb ... -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>${spring.boot.version}</version>
</dependency>
</dependencies>xredis:
lettuce: # Lettuce 客户端配置
standalone: # 单机模式 或 副本集模式
node: 127.0.0.1:6379 # Redis 节点这是 xredis 的最简配置，其余配置项均采用默认参数。
如果你希望更精细地控制客户端行为，想了解完整的配置项，请查看 参考手册（或 示例项目的 application-all.yml 文件）。
这里是将 Redis Server 作为用户信息存储，并使用 async 异步操作数据。
@Service
public class UserService {
private final RedisOperator<String, String> redisOperator;
private final JacksonCodec<User> codec = new JacksonCodec<>(User.class);
/**
* 使用 Spring 注入的 RedisOperator，创建 UserService
*
* @param redisOperator RedisOperator
*/
public UserService(RedisOperator<String, String> redisOperator) {
this.redisOperator = redisOperator;
}
/**
* 添加用户信息
*
* @param user 用户信息
* @return 添加结果
*/
public CompletableFuture<Response<Void>> addUser(User user) {
return redisOperator.async().set(user.getId() + "", codec.encode(user))
.toCompletableFuture()
.thenApply(result -> {
if (Objects.equals("OK", result)) {
return Response.ok();
}
return Response.error("Failed to add user.");
});
}
/**
* 获取用户信息
*
* @param id 用户 ID
* @return 用户信息
*/
public CompletableFuture<Response<User>> getUser(Long id) {
return redisOperator.async().get(id + "")
.toCompletableFuture()
.thenApply(s -> {
if (s == null) {
return Response.error("User not found.");
}
return Response.ok(codec.decode(s));
});
}
/**
* 删除用户信息
*
* @param id 用户 ID
* @return 删除结果
*/
public CompletableFuture<Response<Void>> deleteUser(Long id) {
return redisOperator.async().del(id + "")
.toCompletableFuture()
.thenApply(result -> {
if (Objects.equals(1L, result)) {
return Response.ok();
}
return Response.error("User doesn't exist.");
});
}
}如希望尝试新特性，或者修改源码，可将项目克隆到本地进行编译。
# 1. git clone项目到本地
git clone https://github.com/patricklaux/xredis.git
# 2. 进入项目目录
cd xredis
# 3. 执行 maven 命令编译
mvn clean install| 分支 | 说明 |
|---|---|
| main | 主分支，用于版本发布 |
| dev | 开发分支，用于接受 PR |
如您希望参与开发，请 fork 项目到您的仓库，修改 dev 分支并提交 pr。
https://github.com/patricklaux/xredis/discussions
如您希望了解如何使用 xredis，或在使用中遇到问题无法解决，欢迎在此提问。
https://github.com/patricklaux/xredis/issues
如您发现功能缺陷，或有任何开发建议，欢迎在此提交。
如您发现安全漏洞，请私信与我联系。
xredis 采用 Apache License Version 2.0 进行许可。有关详细信息，请参阅 LICENSE 文件。