Spring Boot - 结合 Redis 使用 Lua脚本

男娘i 2024-02-21 11:57 37阅读 0赞

在Spring Boot中整合Redis并使用Lua脚本：

1.  添加Spring Boot和Redis的依赖：

首先，在Spring Boot项目的`pom.xml`文件中添加Spring Boot和Spring Data Redis的依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>

1.  配置Redis连接：

在`application.properties`或`application.yml`中配置Redis的连接信息，以及 redis 配置：

server:
      port: 8080
    
    spring:
      redis:
        host: localhost
        port: 6379

RedisConfig.java

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.data.redis.connection.RedisConnectionFactory;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
    import org.springframework.data.redis.serializer.StringRedisSerializer;
    
    @Configuration
    public class RedisConfig {
        
    
        @Bean
        public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        
            RedisTemplate<String, Object> template = new RedisTemplate<>();
            template.setConnectionFactory(redisConnectionFactory);
    
            // 设置键的序列化方式为String
            template.setKeySerializer(new StringRedisSerializer());
            template.setHashKeySerializer(new StringRedisSerializer());
    
            // 设置值的序列化方式为JSON
            template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
            template.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
    
            template.afterPropertiesSet(); // 必须调用该方法，完成初始化
    
            return template;
        }
    }

1.  创建一个Spring服务来执行Lua脚本  
    在src/main/resources/ 下创建 scripts/incrementBy.lua，这样，在外部文件中维护Lua脚本，并在需要时加载并执行它。这种方法更容易维护和管理复杂的Lua脚本，同时还提供了更好的可读性。确保在加载脚本文件时处理可能的异常。

-- src/main/resources/scripts/incrementBy.lua
    local key = KEYS[1]               -- 获取第一个参数作为键名
    local incrementBy = tonumber(ARGV[1])  -- 获取第二个参数作为增量值，并将其转换为数字类型
    
    -- 存储key和incrementBy的值：仅作debug用
    -- redis.call("SET", "debug_key", key)
    -- redis.call("SET", "debug_incrementBy", incrementBy)
    
    local currentValue = redis.call("GET", key)  -- 通过GET命令获取键的当前值
    if not currentValue then
        currentValue = 0  -- 如果键不存在，将当前值初始化为0
    else
        currentValue = tonumber(currentValue)  -- 如果键存在，将当前值转换为数字类型
    end
    
    local newValue = currentValue + incrementBy  -- 计算新的值
    redis.call("SET", key, newValue)  -- 通过SET命令将新值存储到键中
    
    return newValue  -- 返回新值

创建一个服务类，用于执行Lua脚本：

import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.core.io.ClassPathResource;
    import org.springframework.data.redis.core.RedisTemplate;
    import org.springframework.data.redis.core.script.DefaultRedisScript;
    import org.springframework.stereotype.Service;
    
    import java.io.IOException;
    import java.nio.file.Files;
    import java.util.Collections;
    
    @Service
    public class RedisLuaService {
    
        @Autowired
        private RedisTemplate<String, Object> redisTemplate;
    
        public Long executeLuaScript(String key, long incrementBy) {
            ClassPathResource luaScriptResource = new ClassPathResource("scripts/incrementBy.lua");
            String luaScript;
    
            try {
                luaScript = new String(Files.readAllBytes(luaScriptResource.getFile().toPath()));
            } catch (IOException e) {
                throw new RuntimeException("Failed to read Lua script file", e);
            }
    
            DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>(luaScript, Long.class);
    
            return redisTemplate.execute(redisScript, Collections.singletonList(key), incrementBy);
        }
    
    
    }

1.  创建一个Controller来触发Lua脚本的执行：

创建一个Controller类，以便从Web应用程序中触发执行Lua脚本的操作：

import com.lfsun.demolfsunstudyredislua.service.RedisLuaService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class LuaController {
    
        @Autowired
        private RedisLuaService redisLuaService;
    
        @GetMapping("/executeLua")
        public Long executeLuaScript(@RequestParam("key") String key, @RequestParam("incrementBy") long incrementBy) {
            return redisLuaService.executeLuaScript(key, incrementBy);
        }
    }

1.  启动Spring Boot应用程序：

现在，启动Spring Boot应用程序。使用浏览器或API调用来触发执行Lua脚本的操作，例如访问`http://localhost:8080/executeLua?key=money&incrementBy=99999`我们的money就会蹭蹭蹭的往上涨。

第0次访问，还没有money：  
![在这里插入图片描述][cf3ed4daed474fe5a49a1e6380652a1a.png]  
第1次访问，money 多了99999：  
![在这里插入图片描述][ba9a8391c1cf462886e9607d09ff02b8.png]  
第n次访问，千万富翁：  
![在这里插入图片描述][ac4085d3ad94455b87d67874255def4d.png]  
debug\_key、debug\_incrementBy为debug调试用的，实际使用中删除。  
![在这里插入图片描述][0741f4e393744f018e0692e466283df4.png]

[cf3ed4daed474fe5a49a1e6380652a1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/12ae545d6a884ed0b0255cdddd1591b3.png
[ba9a8391c1cf462886e9607d09ff02b8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/17aadc0ae3924efa92f06eddb276be66.png
[ac4085d3ad94455b87d67874255def4d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/38da186ef8de46d1a54dd4da9c46e49e.png
[0741f4e393744f018e0692e466283df4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/3a103de494c6462eb5a32faeaa65e2be.png