springboot项目使用lua脚本的流程概览

在 Spring Boot 3.x 项目中，利用已有的 Redis 依赖（通常是 spring-boot-starter-data-redis）来使用 Lua 脚本非常简单。使用 Lua 脚本最大的好处是可以保证多个 Redis 操作的原子性，并且能够显著减少网络开销。

下面为你整理了一套标准的实战步骤，教你如何在项目中优雅地集成和调用 Lua 脚本：

第一步：编写 Lua 脚本文件

首先，在你的 Spring Boot 项目的资源目录下创建一个 Lua 脚本文件。 建议路径：src/main/resources/lua/your_script.lua

假设我们写一个简单的“获取值，若不存在则设置默认值”的脚本：

▼
lua
复制代码
-- get_or_set_default.lua
local key = KEYS[1]
local defaultVal = ARGV[1]

local value = redis.call('GET', key)
if not value then
    redis.call('SET', key, defaultVal)
    value = defaultVal
end
return value

• KEYS：用于接收你传入的 Redis 键（数组形式）。
• ARGV：用于接收你传入的其他业务参数（数组形式）。
• redis.call()：在 Lua 脚本中执行 Redis 命令的标准方式。

第二步：将 Lua 脚本配置为 Bean

在 Spring Boot 3.x 中，推荐将 Lua 脚本封装成一个 RedisScript 的 Bean，交由 Spring 容器管理。这样不仅加载一次即可复用，Spring Data Redis 还会自动帮你处理脚本的 SHA1 缓存（即底层自动使用 EVALSHA 命令，极大提升性能）。

创建一个配置类：

▼
java
复制代码
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.data.redis.core.script.DefaultRedisScript;
import org.springframework.data.redis.core.script.RedisScript;
import org.springframework.scripting.support.ResourceScriptSource;

@Configuration
public class RedisLuaConfig {

    @Bean
    public RedisScript<String> getOrDefaultScript() {
        DefaultRedisScript<String> redisScript = new DefaultRedisScript<>();
        // 加载类路径下的 lua 脚本
        redisScript.setScriptSource(new ResourceScriptSource(new ClassPathResource("lua/get_or_set_default.lua")));
        // 指定脚本返回值的类型（支持 String, Long, Boolean, List 等）
        redisScript.setResultType(String.class);
        return redisScript;
    }
}

第三步：在业务代码中调用脚本

在你的 Service 或 Component 中，直接注入 RedisTemplate 和刚刚配置好的 RedisScript Bean，然后通过 execute 方法执行即可。

▼
java
复制代码
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.script.RedisScript;
import org.springframework.stereotype.Service;

import java.util.Collections;
import java.util.List;

@Service
public class RedisLuaService {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @Autowired
    private RedisScript<String> getOrDefaultScript;

    public String getValueOrDefault(String key, String defaultValue) {
        // 调用 execute 方法执行 Lua 脚本
        // 参数依次为：脚本对象、键的列表、其余参数（可变长参数）
        return redisTemplate.execute(
                getOrDefaultScript, 
                Collections.singletonList(key), 
                defaultValue
        );
    }
}

💡 核心注意事项

1. 序列化问题： RedisTemplate 默认的 Key 和 Value 序列化方式可能会影响 Lua 脚本的参数传递。如果你的 Key 是普通的字符串，建议确保 RedisTemplate 的 Key 序列化器使用的是 StringRedisSerializer，否则传入脚本的 Key 可能会带有额外的序列化前缀（如 \xac\xed\x00\x05t\x00...）。
2. 参数传递规则： 在 redisTemplate.execute() 方法中，KEYS 必须通过 List 传入，而 ARGV 则是跟在后面的可变长参数。在 Lua 脚本中分别通过 KEYS[1], ARGV[1] 等下标来获取。
3. 返回值类型： 在配置 DefaultRedisScript 时，务必通过 setResultType 明确指定返回值的 Java 类型，否则可能会导致类型转换异常。

按照以上三步，你就可以在 Spring Boot 3.x 项目中轻松、高性能地使用 Redis Lua 脚本来处理复杂的原子性业务逻辑了。