SpringBoot集成Redis,多命令管道操作及Lua保持多命令原子性执行

Jony_zhang
665 阅读6分钟

「这是我参与2022首次更文挑战的第3天，活动详情查看：2022首次更文挑战」

springboot集成redis

1、在pom.xml文件中添加如下依赖\

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>4.0.1</version>
</dependency>

2、java代码中执行Redis操作

public static void main(String[] args) {
    JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();
    jedisPoolConfig.setMaxTotal(20);
    jedisPoolConfig.setMaxIdle(10);
    jedisPoolConfig.setMinIdle(5);

    JedisPool jedisPool = new JedisPool(jedisPoolConfig, "192.168.253.131", 6379, 3000, null);

    Jedis jedis = null;
    try {
        //从redis连接池里拿出一个连接执行命令
        jedis = jedisPool.getResource();

        //******* jedis普通操作示例 ********
        System.out.println(jedis.set("cat", "eat fish"));
        System.out.println(jedis.get("cat"));
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        //注意这里不是关闭连接，在JedisPool模式下，Jedis会被归还给资源池。
        if (jedis != null)
            jedis.close();
    }
}

Redis管道（Pipeline）--不具备原子性

客户端可以一次性发送多个请求而不用等待服务器的响应，待所有命令都发送完后再一次性读取服务的响应，这样可以极大的降低多条命令执行的网络传输开销，管道执行多条命令的网络开销实际上只相当于一次命令执行的网络开销。需要注意到是用pipeline方式打包命令发送，redis必须在处理完所有命令前先缓存起所有命令的处理结果。打包的命令越多，缓存消耗内存也越多。所以并不是打包的命令越多越好。pipeline中发送的每个command都会被server立即执行，如果执行失败，将会在此后的响应中得到信息；也就是pipeline并不是表达“所有command都一起成功”的语义，管道中前面命令失败，后面命令不会有影响，继续执行。

代码示例\

public static void main(String[] args) {
    JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();
    jedisPoolConfig.setMaxTotal(20);
    jedisPoolConfig.setMaxIdle(10);
    jedisPoolConfig.setMinIdle(5);

    JedisPool jedisPool = new JedisPool(jedisPoolConfig, "192.168.253.131", 6379, 3000, null);

    Jedis jedis = null;
    try {
        //从redis连接池里拿出一个连接执行命令
        jedis = jedisPool.getResource();

        //******* jedis管道作示例 ********
        Pipeline pl = jedis.pipelined();
        for (int i = 0; i < 10; i++) {
            pl.incr("pipelineKey");
            pl.set("jony" + i, "hello");
            //模拟管道报错-设置不存在的偏移量
            pl.setbit("jony", -1, true);
        }
        List<Object> results = pl.syncAndReturnAll();
        System.out.println(results);
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        //注意这里不是关闭连接，在JedisPool模式下，Jedis会被归还给资源池。
        if (jedis != null)
            jedis.close();
    }
}

执行结果
[1, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range,
2, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range,
3, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range,
4, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range,
5, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range,
6, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range,
7, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range,
8, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range,
9, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range, 10, OK, redis.clients.jedis.exceptions.JedisDataException: ERR bit offset is not an integer or out of range]
说明：代码for循环中前两个命令执行成功，第三个命令执行失败，执行失败的命令无法阻止前两条命令的停止和回滚，无法实现事务操作

Lua脚本执行多命令--具有原子性（命令执行全部成功或者全部失败）

Redis在2.6推出了脚本功能，允许开发者使用Lua语言编写脚本传到Redis中执行。使用脚本的好处如下:

1、减少网络开销：本来5次网络请求的操作，可以用一个请求完成，原先5次请求的逻辑放在redis服务器上完成。使用脚本，减少了网络往返时延。这点跟管道类似。

2、原子操作：Redis会将整个脚本作为一个整体执行，中间不会被其他命令插入。管道不是原子的，不过redis的批量操作命令(类似mset)是原子的。

3、替代redis的事务功能：redis自带的事务功能很鸡肋，而redis的lua脚本几乎实现了常规的事务功能，官方推荐如果要使用redis的事务功能可以用redis lua替代。

官网文档上有这样一段话：
A Redis script is transactional by definition, so everything you can do with a Redis transaction, you can also do with a script, and usually the script will be both simpler and faster.
从Redis2.6.0版本开始，通过内置的Lua解释器，可以使用EVAL命令对Lua脚本进行求值。EVAL命令的格式如下
EVAL script numkeys key [key ...] arg [arg ...]
script参数是一段Lua脚本程序，它会被运行在Redis服务器上下文中，这段脚本不必(也不应该)定义为一个Lua函数。numkeys参数用于指定键名参数的个数。键名参数 key [key ...] 从EVAL的第三个参数开始算起，表示在脚本中所用到的那些Redis键(key)，这些键名参数可以在 Lua中通过全局变量KEYS数组，用1为基址的形式访问( KEYS[1] ， KEYS[2] ，以此类推)。

在命令的最后，那些不是键名参数的附加参数 arg [arg ...] ，可以在Lua中通过全局变量ARGV数组访问，访问的形式和KEYS变量类似( ARGV[1] 、 ARGV[2] ，诸如此类)。例如

127.0.0.1:6379> eval "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}" 2 mykey1 mykey2 val1 val2
1) "mykey1"
2) "mykey2"
3) "val1"
4) "val2"

image.png 其中 "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}" 是被求值的Lua脚本，数字2指定了键名参数的数量， key1和key2是键名参数，分别使用 KEYS[1] 和 KEYS[2] 访问，而最后的 first 和 second 则是附加参数，可以通过 ARGV[1] 和 ARGV[2] 访问它们。

在 Lua 脚本中，可以使用redis.call()函数来执行Redis命令\

public static void main(String[] args) {
        JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();
        jedisPoolConfig.setMaxTotal(20);
        jedisPoolConfig.setMaxIdle(10);
        jedisPoolConfig.setMinIdle(5);

        // timeout，这里既是连接超时又是读写超时，从Jedis 2.8开始有区分connectionTimeout和soTimeout的构造函数
        JedisPool jedisPool = new JedisPool(jedisPoolConfig, "192.168.253.131", 6379, 3000, null);

        Jedis jedis = null;
        try {
            //从redis连接池里拿出一个连接执行命令
            jedis = jedisPool.getResource();
            //******* lua脚本示例 ********
            //模拟一个商品减库存的原子操作
            //lua脚本命令执行方式：redis-cli --eval /tmp/test.lua , 10
            jedis.set("product_10001", "15");  //初始化商品10001的库存
            String script = " local count = redis.call('get', KEYS[1]) " +
                    " local a = tonumber(count) " +
                    " local b = tonumber(ARGV[1]) " +
                    " if a >= b then " +
                    "   redis.call('set', KEYS[1], a-b) " +
                    //模拟语法报错回滚操作
//                    "   bb == 0 " +
                    "   return 1 " +
                    " end " +
                    " return 0 ";
            Object obj = jedis.eval(script, Arrays.asList("product_10001"), Arrays.asList("10"));
            System.out.println(obj);

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            //注意这里不是关闭连接，在JedisPool模式下，Jedis会被归还给资源池。
            if (jedis != null)
                jedis.close();
        }
    }

其中核心Lua脚本

String script = " local count = redis.call('get', KEYS[1]) " +
                    " local a = tonumber(count) " +
                    " local b = tonumber(ARGV[1]) " +
                    " if a >= b then " +
                    "   redis.call('set', KEYS[1], a-b) " +
                    //模拟语法报错回滚操作
                    // "   bb == 0 " +
                    "   return 1 " +
                    " end " +
                    " return 0 ";

解析：
首先，通过redis.call 执行 redis的get命令，也就是传入参数的KEYS[1];
其次，将获得的count值赋值给a,同时将传入ARGV[1]的值赋值给b;
然后，判断a是否大于等于b,是，则把a-b更新到传入KEYS[1]中，并且返回1，否则返回0\

其中bb==0为语法错误，人为构建异常，在set新值之后，查看原子性。

Object obj = jedis.eval(script, Arrays.asList("product_10001"), Arrays.asList("10"));

以上代码，通脱jedis.eval进行执行Lua脚本，并且传入KEYS[1]以及ARGV[1]两个参数

执行结果：
1、将异常代码注释(返回值为1)

image.png 同时查看redis中product_1001的值

image.png 2、将异常代码放开（代码执行异常）

image.png 查看redis中的值（可以看到值依然为15）

image.png

总结：redis执行Lua脚本可以保持原子性，被当做一条命令执行，执行全部成功或者执行全部失败。注意，不要在Lua脚本中出现死循环和耗时的运算，否则redis会阻塞，将不接受其他的命令， 所以使用时要注意不能出现死循环、耗时的运算。redis是单进程、单线程执行脚本。管道不会阻塞redis。

avatar
文章
阅读
粉丝