Jedis SetParams教程：参数化设置 Redis 键值对

SetParams是 Jedis 中用于控制 SET命令行为的核心参数类，支持原子化设置键值对的条件、过期时间等。以下从基础参数、使用场景到代码示例全面解析其用法。

---

一、核心参数详解

SetParams提供以下关键参数，通过链式调用设置：

参数	作用	说明
NX	仅在键不存在时设置	等效于 Redis 命令 SETNX，用于分布式锁或避免覆盖
XX	仅在键存在时设置	用于更新已有键的值
EX	设置秒级过期时间	如 ex(10)表示键 10 秒后自动过期
PX	设置毫秒级过期时间	如 px(10000)表示 10 秒后过期
KEEPTTL	保留原有过期时间	设置新值时不修改原有 TTL
GET	返回键原值	设置成功后返回旧值（需结合 Jedis的返回值处理）

---

二、基础使用场景

1. 条件设置键值

场景：避免覆盖已有数据

Jedis jedis = new Jedis("localhost", 6379);
SetParams params = SetParams.setParams().nx(); // 仅键不存在时设置
String result = jedis.set("user:1:name", "Alice", params);

if ("OK".equals(result)) {
    System.out.println("设置成功（键不存在时）");
} else {
    System.out.println("键已存在，未覆盖");
}

场景：更新已有键值

SetParams params = SetParams.setParams().xx(); // 仅键存在时设置
String result = jedis.set("user:1:email", "alice@example.com", params);

---

2. 原子化设置过期时间

场景：缓存数据时自动过期

// 设置键值并同时指定过期时间（秒）
SetParams params = SetParams.setParams().ex(60); // 60 秒后过期
jedis.set("cache:product:1001", "商品信息", params);

// 毫秒级过期（适用于高精度场景）
SetParams pxParams = SetParams.setParams().px(5000); // 5 秒后过期
jedis.set("session:token", "abc123", pxParams);

---

3. 返回旧值（GET 参数）

场景：需要获取更新前的值

SetParams getParams = SetParams.setParams().get();
String oldValue = jedis.set("config:timeout", "300", getParams);
System.out.println("旧值：" + oldValue); // 输出原值（若键不存在则为 null）

---

三、进阶应用：分布式锁

1. 加锁（原子化 NX + PX）

public boolean tryLock(String lockKey, String requestId, long expireTime) {
    SetParams params = SetParams.setParams().nx().px(expireTime);
    String result = jedis.set(lockKey, requestId, params);
    return "OK".equals(result);
}

2. 解锁（Lua 脚本保证原子性）

public boolean unlock(String lockKey, String requestId) {
    String script = "if redis.call('get', KEYS[1]) == ARGV[1] then " +
                    "   return redis.call('del', KEYS[1]) " +
                    "else " +
                    "   return 0 " +
                    "end";
    Object result = jedis.eval(script, 1, lockKey, requestId);
    return "1".equals(result.toString());
}

---

四、完整代码示例

1. 工具类封装

public class RedisUtils {
    private static final JedisPool jedisPool = new JedisPool("localhost", 6379);

    // 带过期时间的 SET 操作（秒）
    public static boolean setWithEx(String key, String value, int seconds) {
        try (Jedis jedis = jedisPool.getResource()) {
            SetParams params = SetParams.setParams().ex(seconds);
            return "OK".equals(jedis.set(key, value, params));
        }
    }

    // 带过期时间的 SET 操作（毫秒）
    public static boolean setWithPx(String key, String value, long millis) {
        try (Jedis jedis = jedisPool.getResource()) {
            SetParams params = SetParams.setParams().px(millis);
            return "OK".equals(jedis.set(key, value, params));
        }
    }
}

2. 测试用例

public class RedisUtilsTest {
    @Test
    public void testSetWithEx() throws InterruptedException {
        String key = "test:key";
        RedisUtils.setWithEx(key, "value", 2); // 2 秒后过期

        // 立即获取
        assertEquals("value", new Jedis("localhost", 6379).get(key));

        // 等待 3 秒后验证过期
        Thread.sleep(3000);
        assertNull(new Jedis("localhost", 6379).get(key));
    }
}

---

五、最佳实践

1. 优先使用 NX+ PX组合​

   在分布式锁、缓存更新等场景中，原子化设置键值和过期时间可避免竞态条件。

2. 避免硬编码参数​

   将过期时间配置为常量或从配置中心读取，便于统一管理。

3. 合理选择时间单位​

   • 短时间任务（如锁）：使用 PX（毫秒级）

   • 长时间缓存：使用 EX（秒级）

4. 异常处理​

   通过 try-with-resources确保 Jedis连接正确关闭，避免连接泄漏。

---

六、常见问题

**Q1：SetParams的参数顺序是否影响结果？**​

A：不影响。参数顺序无关，如 nx().px(1000)与 px(1000).nx()等效。

**Q2：如何同时设置多个键值？**​

A：SET命令本身不支持批量设置参数，需通过管道（pipeline）或 MSET命令实现。

**Q3：GET参数返回的旧值类型是什么？**​

A：返回 String类型，若键不存在则返回 null。

---

通过灵活组合 SetParams的参数，可以实现高效、安全的 Redis 操作，尤其适用于分布式锁、缓存控制等高并发场景。实际开发中建议结合业务需求选择参数，并通过单元测试验证逻辑正确性。