Lua脚本 快速掌握

1.Lua脚本概述

Lua是一种轻量级的编程语言,由巴西里约热内卢天主教大学开发。设计初衷是为了嵌入应用程序中,提供灵活的配置和脚本能力。Lua具有简洁的语法和强大的扩展性,使得它在多个领域得到了广泛应用。

Lua的特点包括动态类型、自动内存管理、协程、模块和包支持。它使用表(Table)这一数据结构来实现关联数组、集合等多种功能。Lua的执行速度快,且库体积小。

教程链接:Lua 教程 | 菜鸟教程 (runoob.com)

2.快速入门实操:

(1)创建lua脚本

例如在resource下创建名为unlock.lua的脚本:

if(redis.call('get',KEYS[1]) == ARGV[1]) then
    return redis.call('del',KEYS[1])
end
return 0

说明:

  • **if**是Lua的条件判断关键字。
  • redis.call 是Lua脚本中调用Redis命令的方法。在这里,它调用了Redis的 **GET**命令。
  • **KEYS[1]**是一个特殊变量,代表传递给Lua脚本的键名列表中的第一个键。
  • ARGV[1] 是另一个特殊变量,代表传递给Lua脚本的参数列表中的第一个参数。
  • **end**标志着if语句块的结束。
  • 如果if条件不成立(即键值不匹配),则执行这个 **return**语句。
  • 返回值 0 表示没有进行任何操作。

(2)编写代码

    private static final String KEY_PREFIX = "lock:";
    private static final String ID_PREFIX = UUID.randomUUID().toString();
 
    // 定义一个静态常量 UNLOCK_SCRIPT,类型为 DefaultRedisScript,预期返回值类型为 Long
    private static final DefaultRedisScript<Long> UNLOCK_SCRIPT;
 
    // 静态初始化块,用于初始化静态常量 UNLOCK_SCRIPT
    static{
        UNLOCK_SCRIPT = new DefaultRedisScript<>();
 
        // 设置 Lua 脚本的路径,这里脚本是从类路径下的资源文件 "unlock.lua" 中加载
        UNLOCK_SCRIPT.setLocation(new ClassPathResource("unlock.lua"));
 
        // 指定脚本执行后的返回值类型为 Long.class
        UNLOCK_SCRIPT.setResultType(Long.class);
    }
 
    @Override
    public boolean tryLock(long timeoutSec) {
 
        String threadId = ID_PREFIX + Thread.currentThread().getId();
 
        Boolean flag  = stringRedisTemplate.opsForValue().setIfAbsent(KEY_PREFIX+name,threadId,timeoutSec, TimeUnit.SECONDS);
 
        return Boolean.TRUE.equals(flag);
    }
 
    @Override
    public void unlock(){
        // 使用 StringRedisTemplate 执行 Lua 脚本 UNLOCK_SCRIPT
        stringRedisTemplate.execute(
                // 传递预定义的 Lua 脚本对象 UNLOCK_SCRIPT
                UNLOCK_SCRIPT,
                // 传递一个包含锁键的列表,这里锁键由前缀和锁的名称组成
                Collections.singletonList(KEY_PREFIX + name),
                // 传递一个参数,该参数是线程 ID 前缀加上当前线程的 ID
                ID_PREFIX + Thread.currentThread().getId());
    }

3.了解Spring Data Redis提供的execute方法

查看源码可以知道execute方法可知

第一个参数:确定返回的类型值和脚本文件的位置

第二个参数:传递给脚本文件key的值,如果没有想传递的key值可以传递为空的Collections.emptyList()。在脚本文件中通过KEYS[序号]获取,例如KEY[1]表示第一个Key的值

之后的参数:传递给脚本文件arg的值,在脚本文件中通过ARGV[序号]获取,例如AVG[1]表示第一个arg的值

4.更复杂的lua脚本示例代码

这里只写了lua脚本,还需要在使用Spring Data Redis提供的 execute方法才能运行,

-- 优惠卷ID,通过ARGV参数传递,ARGV[1]是第一个参数
local voucherId  = ARGV[1]

-- 用户ID,通过ARGV参数传递,ARGV[2]是第二个参数
local userId = ARGV[2]

-- 订单ID,通过ARGV参数传递,ARGV[3]是第三个参数
local orderId = ARGV[3]

-- 库存Key,拼接字符串构建库存的Redis键名
local stockKey = 'seckill:stock:' .. voucherId

-- 订单Key,拼接字符串构建订单的Redis键名
local orderKey = 'seckill:order:' .. voucherId

-- 脚本业务逻辑开始

-- 检查库存是否充足,使用get命令获取库存数量,如果库存小于等于0则返回1
if(tonumber(redis.call('get',stockKey)) <=0 ) then
    -- 库存不足,返回1,这里1通常表示库存不足的错误码
    return 1
end

-- 判断用户是否已经下过单,使用sismember命令检查订单集合中是否包含该用户ID
-- 如果用户已存在订单集合中,返回2
if(tonumber(redis.call('sismember',orderKey,userId)) == 1 ) then
    -- 用户已下单,返回2,这里2通常表示用户重复下单的错误码
    return 2
end

-- 如果库存充足且用户未下单,则减少库存数量,使用incrby命令对库存进行减一操作
redis.call('incrby',stockKey,-1)

-- 将用户ID添加到订单集合中,记录用户已下单,使用sadd命令添加集合元素
redis.call('sadd',orderKey,userId)

-- 将订单信息发送到消息队列中,使用xadd命令向stream.orders消息队列添加一条消息
-- '*': 表示自动生成消息ID
-- 'userId',userId: 消息字段名为userId,值为脚本传入的userId
-- 'voucherId',voucherId: 消息字段名为voucherId,值为脚本传入的voucherId
-- 'id',orderId: 消息字段名为id,值为脚本传入的orderId
-- 发送消息到队列中 XADD stream.orders * k1 v1 k2 v2
--(下面的key值请参考实体类所定义的,因为这个lua脚本是创建订单信息,所以oderId对应实体的id)
redis.call('xadd','stream.orders','*','userId',userId,'voucherId',voucherId,'id',orderId)

-- 如果脚本执行至此,表示操作成功,返回0
return 0
相关推荐
励志成为嵌入式工程师26 分钟前
c语言简单编程练习9
c语言·开发语言·算法·vim
捕鲸叉1 小时前
创建线程时传递参数给线程
开发语言·c++·算法
A charmer1 小时前
【C++】vector 类深度解析:探索动态数组的奥秘
开发语言·c++·算法
Peter_chq1 小时前
【操作系统】基于环形队列的生产消费模型
linux·c语言·开发语言·c++·后端
记录成长java2 小时前
ServletContext,Cookie,HttpSession的使用
java·开发语言·servlet
前端青山2 小时前
Node.js-增强 API 安全性和性能优化
开发语言·前端·javascript·性能优化·前端框架·node.js
睡觉谁叫~~~3 小时前
一文解秘Rust如何与Java互操作
java·开发语言·后端·rust
音徽编程3 小时前
Rust异步运行时框架tokio保姆级教程
开发语言·网络·rust
观音山保我别报错3 小时前
C语言扫雷小游戏
c语言·开发语言·算法
小屁孩大帅-杨一凡3 小时前
java后端请求想接收多个对象入参的数据
java·开发语言