Java生态/Redis中如何使用Lua脚本

灰太狼 2023-09-24 22:10 61阅读 0赞

#### 文章目录 ####

*  一、安装LUA
 *   *  1）简单使用
 *  二、lua语法简介
 *   *  1、注释
     *   *  1）单行注释
         *  2）多行注释
     *  2、关键字
     *  3、变量
     *   *  1）全局变量
         *  2）局部变量
     *  4、数据类型
     *   *  1）Lua数组
         *  2）字符串操作
     *  5、if-else
     *  6、循环
     *   *  1）for循环
         *   *  1> 数组for循环
             *  2> 泛型for循环
         *  2）while循环
         *  3）break提前退出循环
     *  7、函数
 *  三、Java中执行Lua脚本
 *   *  1、字符串方式
     *  2、文件方式
     *  3、Luaj概述
     *   *  1）线程安全问题
         *  2）性能问题
 *  四、Redis + Lua（EVAL命令）
 *   *  1、EVAL命令
     *   *  使用示例
 *  五、总结

## 一、安装LUA ##

Mac上安装LUA很简单，直接使用`brew`相关命令；

brew install lua

![在这里插入图片描述][4fc3a3fda05342feb207ce73e75e5dca.png]

使用`lua -v`命令可以看到lua已经安装完毕。

### 1）简单使用 ###

创建一个test.lua文件，内容为：  
![在这里插入图片描述][bffac633256441e0bcd28bd32a98042a.png]

**执行命令：**

lua test.lua

**输出为：**

![在这里插入图片描述][a3758cfd8d254f38a1a4af50f04f58ca.png]

## 二、lua语法简介 ##

Lua 提供了交互式编程和脚本式编程：

*  交互式编程：直接在命令行中输入语法，可以立即执行并查看到执行效果。
 *  脚本是编程：编写脚本文件，然后再执行。

**官方文档：[http://www.lua.org/manual/5.4/][http_www.lua.org_manual_5.4]**

### 1、注释 ###

lua提供两种注释方式：单行注释和多行注释

#### 1）单行注释 ####

使用两个减号；

#### 2）多行注释 ####

--[[
     多行注释
     多行注释
     --]]

### 2、关键字 ###

下列为 Lua 的保留关键字，和Java一样 保留关键字不能作为常量或变量。

![在这里插入图片描述][494a22d9a43048e4be15383cb87cbebe.png]

### 3、变量 ###

默认的情况下，定义一个变量都是全局变量；如果要用局部变量 需要声明为`local`；

#### 1）全局变量 ####

全局变量不需要声明，给一个变量赋值后便创建了这个全局变量；

*  访问一个没有初始化的全局变量也不会出错，只不过会得到结果：nil

![在这里插入图片描述][c7ad7023f58f47359fe937b4ec9fa8cd.png]

想删除一个全局变量，只需要将变量赋值为nil；换言之，当且仅当一个变量不等于nil时，这个变量存在。

![在这里插入图片描述][6981592738b948329cb65143df55911c.png]

**此外，一般以下划线开头连接一串大写字母的名字（比如 \_VERSION）被保留用于 Lua 内部全局变量。**

#### 2）局部变量 ####

-- 局部变量赋值
    local b=2

### 4、数据类型 ###

Lua 是一个动态类型语言，变量不要类型定义，只需要为变量赋值。 值可以存储在变量中，作为参数传递或结果返回。

Lua 中有 8 个基本类型分别为：nil、boolean、number、string、userdata、function、thread 和 table。

![在这里插入图片描述][8ad1570061bd4ba9a04a0ec7f05ca972.png]

#### 1）Lua数组 ####

在Lua 数组中，索引值是从 1 开始，可以指定为从 0 开始。

![在这里插入图片描述][97eb324e77674ec1b778df57653054af.png]

#### 2）字符串操作 ####

*  `..` 连接两个字符串；
 *  `string.sub()` 用于截取字符串；
    
        string.sub(s, i [, j])
    
     *  s：要截取的字符串；
     *  i：截取开始位置；
     *  j：截取结束位置，默认为 -1，最后一个字符；
 *  `string.find()` 用于字符串查找
    
        string.find (str, substr, [init, [plain]])
    
     *  在一个指定的目标字符串 str 中搜索指定的内容 substr，如果找到了一个匹配的子串，就会返回这个子串的起始索引和结束索引，不存在则返回 nil。
     *  `init` 指定了搜索的起始位置，默认为 1，可以一个负数，表示从后往前数的字符个数。
     *  `plain` 表示是否使用简单模式，默认为 false，true 只做简单的查找子串的操作，false 表示使用正则模式匹配。

### 5、if-else ###

条件表达式结果可以是任何值，Lua认为false和nil为假，true和非nil为真。

整体的if-else结构和我们使用的高级语言（Java、GO）类似，区别在于：LUA中的if()表达式满足之后想要做一些其余逻辑，需要紧跟`then`，并且流程控制以`end`结尾。

if(xxx) then
        print("xxx")
    else if(xx) then
        print("xx")
    else
       print("x")
    end

### 6、循环 ###

#### 1）for循环 ####

Lua 编程语言中 for语句有两大类：数组for循环、泛型for循环

##### 1> 数组for循环 #####

**语法格式：**

for var=exp1,exp2,exp3 do  
        <执行体>  
    end

*  var 从 exp1 变化到 exp2，每次变化以 exp3 为步长递增 var，并执行一次 “执行体”。exp3 是可选的，如果不指定，默认为1。

![在这里插入图片描述][559b982d8b8647a4b0b388805838b85f.png]

##### 2> 泛型for循环 #####

通过一个迭代器函数来遍历所有值，类似 java 中的 foreach 语句；

**语法格式：**

--打印数组a的所有值  
    a = {
        "one", "two", "three"}
    for i, v in ipairs(a) do
        print(i, v)
    end

*  i 是数组索引值，v 是对应索引的数组元素值。
 *  ipairs是Lua提供的一个迭代器函数，用来迭代数组。

![在这里插入图片描述][14637c48602f4fbbac8058995b6efc0e.png]

#### 2）while循环 ####

while 循环语句在判断条件为 true 时会重复执行循环体语句。

**语法格式：**

while(condition)
    do
       statements
    end

*  statements(循环体语句) 可以是一条或多条语句，condition(条件) 可以是任意表达式；
 *  在 condition(条件) 为 true 时执行循环体语句。

![在这里插入图片描述][bef32f576efd4c0cb9158d369bdfd8f0.png]

#### 3）break提前退出循环 ####

和Java中的break一个作用，用于退出当前循环或语句；

### 7、函数 ###

在Lua中，函数是对语句和表达式进行抽象的主要方法。类似于Java中的方法。

**Lua 函数主要有两种用途：**

*  完成指定的任务，这种情况下函数作为调用语句使用；
 *  计算并返回值，这种情况下函数作为赋值语句的表达式使用；

**函数的编写方式如下：**

--[[ 函数返回两个值的最大值 --]]
    function max(num1, num2)
       if (num1 > num2) then
          result = num1;
       else
          result = num2;
       end
       return result; 
    end
    -- 调用函数
    print("两值比较最大值为 ",max(10,4))
    print("两值比较最大值为 ",max(5,6))

![在这里插入图片描述][b0fba0eb4462499abe3d24277820f325.png]

## 三、Java中执行Lua脚本 ##

Java中执行Lua脚本有两种方式：字符串的方式、文件的方式；

Java中想要执行LUA脚本，首先需要在pom中引入相关依赖：

### 1、字符串方式 ###

对于简单的lua脚本，可以直接用java字符串写；

package com.saint.base.lua;
    
    import org.luaj.vm2.Globals;
    import org.luaj.vm2.LuaValue;
    import org.luaj.vm2.lib.jse.JsePlatform;
    
    public class LuaString {
        
        public static void main(String[] args) {
        
            String luaStr = "print 'Saint is best man'";
            Globals globals = JsePlatform.standardGlobals();
            LuaValue luaValue = globals.load(luaStr);
            luaValue.call();
        }
    }

**控制台输出：**

![在这里插入图片描述][0062e28bf246416e9e79af829afd36bf.png]

### 2、文件方式 ###

对于一些比较常用的、复杂的脚本可以选择存放在文件中，在Java中再调用lua文件；

package com.saint.base.lua;
    
    import org.luaj.vm2.Globals;
    import org.luaj.vm2.LuaValue;
    import org.luaj.vm2.lib.jse.JsePlatform;
    
    import java.io.FileNotFoundException;
    
    public class LuaFile {
        
        public static void main(String[] args) throws FileNotFoundException {
        
            // lua脚本的文件路径
            String luaPath = "/xxxx/javaTest.lua";
            Globals globals = JsePlatform.standardGlobals();
            //加载脚本文件login.lua，并编译
            globals.loadfile(luaPath).call();
            LuaValue func1 = globals.get(LuaValue.valueOf("print1"));
            func1.call();
    
            LuaValue func2 = globals.get(LuaValue.valueOf("print2"));
            String luaResp = func2.call(LuaValue.valueOf("saint-input-param")).toString();
            System.out.println("lua file return is : " + luaResp);
        }
    }

**lua脚本文件：**

![在这里插入图片描述][efa8c2b4b6674c99a416c92c427605f3.png]

**控制台输出：**

![在这里插入图片描述][130c1d0f1cbc4c638c50be315f400218.png]

### 3、Luaj概述 ###

Luaj在包装执行具体的Lua代码时, 有三种不同的模式；

*  纯脚本解析执行(不选用任何Compiler)
 *  To Lua字节码(LuaC, lua-to-lua-bytecode compiler)（默认选用）
 *  To Java字节码(LuaJC, lua-to-java-bytecode compiler)

#### 1）线程安全问题 ####

Luaj中的Globals对象不是线程安全的, 因此最佳实践是每个线程一个Globals对象。

*  事实上, 可以采用ThreadLocal的方式来存储该对象。

#### 2）性能问题 ####

Lua脚本在JAVA中运行，相比于直接运行Java代码会慢很多，大约1000倍。

## 四、Redis + Lua（EVAL命令） ##

在使用Redisson、Jedis+Lua时，我们可以通过redis客户端集成的、手写的LUA脚本来保证一系列命令在Redis中可以"原子执行"。

*  在redis执行lua脚本时，相当于一个redis级别的锁，不能执行其他操作，类似于原子操作，这也是redisson实现的一个关键点。

**比如Redisson中的lua脚本：**  
![在这里插入图片描述][edef60e5425f4194a8e987b71ab535da.png]

*  Redisson如何实现分布式锁，可以看文章：[https://saint.blog.csdn.net/article/details/128176338][https_saint.blog.csdn.net_article_details_128176338]

**lua脚本中有如下几个概念：**

> 1.  **redis.call()**：执行redis命令。
> 2.  **KEYS\[n\]**：指脚本中第n个参数，比如KEYS\[1\]指脚本中的第一个参数。
> 3.  **ARGV\[n\]**：指脚本中第n个参数的值，比如ARGV\[1\]指脚本中的第一个参数的值。
> 4.  **返回值中nil与false同一个意思。**

### 1、EVAL命令 ###

redis2.6.0版本起 采用内置的Lua解释器 通过EVAL命令去执行脚本；

redis中的EVAL命令可以用于执行一段lua代码。**命令格式如下：**

![在这里插入图片描述][4a1beb569b5443f39ff7633c06c75b86.png]

*  第一个参数script：表示lua脚本的内容；
 *  第二参数numkeys：表示有多少个键值对。
 *  其余参数：先把numkeys个key列出来，再把numkeys个arg列出来。

**Lua脚本中可以使用2个函数调用redis命令；**

*  redis.call()
 *  redis.pcall()

**redis.call()与redis.pcall()相似，二者唯一不同之处：**

*  如果执行的redis命令执行失败，redis.call()将产生一个Lua error，从而迫使EVAL命令返回一个错误给命令的调用者；
 *  然而redis.pcall()将会捕捉这个错误，并返回代表这个错误的Lua表。

#### 使用示例 ####

有那么一段逻辑；

*  如果Redis某个key的整数值 和 某个value相等，则将key对应的整数值 + 1000；否则将key的值设置为9999；

**lua脚本执行命令如下：**

EVAL "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('INCRBY', KEYS[1], 1000); else redis.call('set', KEYS[1], 9999); return nil; end;" 1 test 100

**根据test值的不同，不同的执行结果如下：**

![在这里插入图片描述][84de530fa72344e99c1d5ff1bec1802c.png]

## 五、总结 ##

Lua入个门，知道基本的Lua脚本怎么写，尤其是Redis + lua的使用。

再到很多网关中都会使用一些lua脚本。

[4fc3a3fda05342feb207ce73e75e5dca.png]: https://img-blog.csdnimg.cn/4fc3a3fda05342feb207ce73e75e5dca.png
[bffac633256441e0bcd28bd32a98042a.png]: https://img-blog.csdnimg.cn/bffac633256441e0bcd28bd32a98042a.png
[a3758cfd8d254f38a1a4af50f04f58ca.png]: https://img-blog.csdnimg.cn/a3758cfd8d254f38a1a4af50f04f58ca.png
[http_www.lua.org_manual_5.4]: http://www.lua.org/manual/5.4/
[494a22d9a43048e4be15383cb87cbebe.png]: https://img-blog.csdnimg.cn/494a22d9a43048e4be15383cb87cbebe.png
[c7ad7023f58f47359fe937b4ec9fa8cd.png]: https://img-blog.csdnimg.cn/c7ad7023f58f47359fe937b4ec9fa8cd.png
[6981592738b948329cb65143df55911c.png]: https://img-blog.csdnimg.cn/6981592738b948329cb65143df55911c.png
[8ad1570061bd4ba9a04a0ec7f05ca972.png]: https://img-blog.csdnimg.cn/8ad1570061bd4ba9a04a0ec7f05ca972.png
[97eb324e77674ec1b778df57653054af.png]: https://img-blog.csdnimg.cn/97eb324e77674ec1b778df57653054af.png
[559b982d8b8647a4b0b388805838b85f.png]: https://img-blog.csdnimg.cn/559b982d8b8647a4b0b388805838b85f.png
[14637c48602f4fbbac8058995b6efc0e.png]: https://img-blog.csdnimg.cn/14637c48602f4fbbac8058995b6efc0e.png
[bef32f576efd4c0cb9158d369bdfd8f0.png]: https://img-blog.csdnimg.cn/bef32f576efd4c0cb9158d369bdfd8f0.png
[b0fba0eb4462499abe3d24277820f325.png]: https://img-blog.csdnimg.cn/b0fba0eb4462499abe3d24277820f325.png
[0062e28bf246416e9e79af829afd36bf.png]: https://img-blog.csdnimg.cn/0062e28bf246416e9e79af829afd36bf.png
[efa8c2b4b6674c99a416c92c427605f3.png]: https://img-blog.csdnimg.cn/efa8c2b4b6674c99a416c92c427605f3.png
[130c1d0f1cbc4c638c50be315f400218.png]: https://img-blog.csdnimg.cn/130c1d0f1cbc4c638c50be315f400218.png
[edef60e5425f4194a8e987b71ab535da.png]: https://img-blog.csdnimg.cn/edef60e5425f4194a8e987b71ab535da.png
[https_saint.blog.csdn.net_article_details_128176338]: https://saint.blog.csdn.net/article/details/128176338
[4a1beb569b5443f39ff7633c06c75b86.png]: https://img-blog.csdnimg.cn/4a1beb569b5443f39ff7633c06c75b86.png
[84de530fa72344e99c1d5ff1bec1802c.png]: https://img-blog.csdnimg.cn/84de530fa72344e99c1d5ff1bec1802c.png