一、为什么需要lua脚本

Spring data redis 提供了全量redis命令对应的api。但复杂的业务可能需要多次操作redis，而且这些redis操作需要分布式环境下保证原子性。

redis的 eval 命令，可以执行lua脚本，redis保证脚本的执行是原子性的。命令格式：

EVAL script numkeys key [key ...] arg [arg ...]

Spring data redis 也提供了相应的api来支持redis的eval命令，一个典型的方法是：

/**
* Executes the given {@link RedisScript}
*
* @param script The script to execute
* @param keys Any keys that need to be passed to the script
* @param args Any args that need to be passed to the script
* @return The return value of the script or null if {@link RedisScript#getResultType()} is null, likely indicating a
*         throw-away status reply (i.e. "OK")
*/
@Nullable
<T> T execute(RedisScript<T> script, List<K> keys, Object... args);

redisTemplate 还有重载的其他方法执行脚本，参考API即可。

二、如何执行

Spring redis template执行lua脚本，首先需要创建一个lua脚本对象，再使用相应api调用即可。

示例代码：

// 略，获取redis template; template的类型不重要
StringRedisTemplate stringRedisTemplate = getTemplate();

// 构建脚本，泛型类型是期待的返回值类型
DefaultRedisScript<List> script = new DefaultRedisScript<>();
script.setResultType(List.class);
// 加载lua脚本
script.setScriptSource(new ResourceScriptSource(new ClassPathResource("redis.script/zset-get-del.lua")));
// 可选以下方法传入lua脚本
// script.setScriptText("lua脚本内容");

// 使用；第一个参数是脚本，第二个参数是redis key列表，第三个可变长度参数是脚本的参数，具体依据脚本而定
List result = stringRedisTemplate.execute(script, Collections.singletonList("redis key"), 'argv1', 'argv2',...);

一个完整的例子是：

@Component
public class RedisUtils {

    private DefaultRedisScript<List> zSetGetAndDel;

    private final StringRedisTemplate stringRedisTemplate;

    public RedisUtils(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    @PostConstruct
    public void initScript() {
        zSetGetAndDel = new DefaultRedisScript<>();
        zSetGetAndDel.setResultType(List.class);
        zSetGetAndDel.setScriptSource(new ResourceScriptSource(
                new ClassPathResource("redis.script/zset-get-del.lua", RedisUtils.class.getClassLoader())));
    }

    /**
     * 获取 StringRedisTemplate
     *
     * @return StringRedisTemplate
     */
    public StringRedisTemplate getStringRedisTemplate() {
        return this.stringRedisTemplate;
    }

    /**
     * zset ZRANGEBYSCORE and then ZREM immediately.
     *
     * @param zSetKey  zset key
     * @param minScore 最小score 包含
     * @param maxScore 最大score 包含
     * @param offset   偏移量
     * @param limit    查询数目限制
     * @return 符合条件的集合；若没有返回空列表； never null
     */
    @SuppressWarnings("unchecked")
    public List<String> zSetGetAndDel(String zSetKey, long minScore, long maxScore, int offset, int limit) {
        return stringRedisTemplate.execute(zSetGetAndDel, Collections.singletonList(zSetKey),
                String.valueOf(minScore), String.valueOf(maxScore), String.valueOf(offset), String.valueOf(limit));
    }
}

三、有用的lua脚本

1） 读取zset，并删除

命令原型：

ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT offset count] # 获取zset最大最小socre(包含)之间的元素，可选limit以及要求返回score值
ZREM key member [member ...] # 移除一个或多个成员

lua脚本：

local data = redis.call('ZRANGEBYSCORE', KEYS[1], ARGV[1], ARGV[2], 'LIMIT', ARGV[3], ARGV[4]);
if table.getn(data) > 0
then
    redis.call('ZREM', KEYS[1], unpack(data));
end
return data;

脚本持续更新...

四、参考

1. redis eval 命令： https://redis.io/commands/eval