SpringBoot集成Redis并调用Lua脚本的示例详解

更新时间：2025年07月17日 09:02:36 作者：超级小忍

Redis 是一个高性能的内存数据库,广泛用于缓存、计数器、分布式锁等场景,本文主要和大家详细介绍了SpringBoot如何集成Redis并调用Lua脚本,需要的小伙伴可以了解下

前言

Redis 是一个高性能的内存数据库，广泛用于缓存、计数器、分布式锁等场景。在某些业务中，我们需要对多个 Redis 操作进行原子性处理，以保证数据一致性，这时就可以使用 Redis 提供的 Lua 脚本功能。

Spring Boot 通过 RedisTemplate 对 Redis 进行了良好的封装，也支持我们方便地调用 Lua 脚本。本文将带你一步步实现 Spring Boot 中如何：

加载 Lua 脚本
调用 Lua 脚本
实现一个实际业务逻辑：获取 key，若不存在则设置默认值并返回

一、项目准备

创建 Spring Boot 项目

你可以使用 Spring Initializr 创建一个新项目，选择以下依赖：

Spring Web
Spring Data Redis
Lettuce（Redis 客户端）

或者手动创建 Maven 项目后添加如下依赖：

<!-- Spring Boot Starter -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

<!-- Web 支持 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- Redis 支持 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

<!-- Lettuce 客户端 -->
<dependency>
    <groupId>io.lettuce.core</groupId>
    <artifactId>lettuce-core</artifactId>
    <version>6.2.4</version>
</dependency>

二、编写 Lua 脚本文件

我们将创建一个简单的 Lua 脚本：如果 key 不存在，则设置默认值；存在则直接返回当前值。

脚本内容：get_or_set_default.lua

路径建议为：src/main/resources/lua/get_or_set_default.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

三、加载 Lua 脚本到 Redis

我们可以利用 Spring 的生命周期回调（如 @PostConstruct）来加载 Lua 脚本，并保存其 SHA1 校验码，后续通过 EVALSHA 来调用。

创建脚本加载类：LuaScriptLoader.java

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.script.DefaultRedisScript;
import org.springframework.stereotype.Service;

import javax.annotation.PostConstruct;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;

@Service
public class LuaScriptLoader {

    private final RedisTemplate<String, Object> redisTemplate;

    // 存储脚本的 SHA1 值
    public static String GET_OR_SET_DEFAULT_SHA;

    public LuaScriptLoader(RedisTemplate<String, Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    @PostConstruct
    public void loadScripts() throws IOException {
        Path scriptPath = Paths.get("src/main/resources/lua/get_or_set_default.lua");
        String scriptContent = Files.readString(scriptPath);

        DefaultRedisScript<String> redisScript = new DefaultRedisScript<>();
        redisScript.setScriptText(scriptContent);
        redisScript.setResultType(String.class);

        // 执行 SCRIPT LOAD 命令加载脚本
        GET_OR_SET_DEFAULT_SHA = redisTemplate.execute(
                redisScript,
                Collections.singletonList("dummyKey"),
                "defaultValue"
        );

        System.out.println("Lua Script SHA1: " + GET_OR_SET_DEFAULT_SHA);
    }
}

注意：

我们使用了一个 dummyKey 和 dummyValue 来执行一次脚本，只是为了触发脚本加载。
实际调用时使用的是 EVALSHA 命令。

四、封装 Lua 脚本调用服务

我们创建一个服务类来封装 Lua 脚本的调用逻辑。

创建服务类：RedisLuaService.java

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;

import java.util.Collections;

@Service
public class RedisLuaService {

    private final RedisTemplate<String, Object> redisTemplate;

    public RedisLuaService(RedisTemplate<String, Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    /**
     * 调用 Lua 脚本：根据 key 获取值，若不存在则设置默认值并返回
     */
    public String getOrSetDefault(String key, String defaultValue) {
        return (String) redisTemplate.execute(
                LuaScriptLoader.GET_OR_SET_DEFAULT_SHA,
                Collections.singletonList(key),
                defaultValue
        );
    }
}

五、创建 REST 接口进行测试

为了方便测试，我们创建一个简单的接口。

创建控制器类：RedisLuaController.java

import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/redis")
public class RedisLuaController {

    private final RedisLuaService redisLuaService;

    public RedisLuaController(RedisLuaService redisLuaService) {
        this.redisLuaService = redisLuaService;
    }

    @GetMapping("/get-or-set")
    public String getOrDefault(
            @RequestParam String key,
            @RequestParam(required = false, defaultValue = "default_value") String defaultValue) {
        return redisLuaService.getOrSetDefault(key, defaultValue);
    }
}

六、运行测试

1. 启动 Redis 服务

确保你本地或服务器上已经启动了 Redis：

redis-server

2. 启动 Spring Boot 应用

使用 IDE 或命令行启动 Spring Boot 项目：

mvn spring-boot:run

3. 测试访问

访问如下 URL：

http://localhost:8080/redis/get-or-set?key=test_lua&defaultValue=hello_redis

第一次请求：

Redis 中没有 test_lua 键，会自动设置为 hello_redis，并返回该值。

第二次请求：

即使不传 defaultValue，也会返回 hello_redis，因为键已存在。

七、注意事项

项目	说明
脚本缓存	Redis 会缓存加载过的 Lua 脚本，但重启后失效，需重新加载
调试困难	Lua 脚本不能输出日志，建议先在 Redis CLI 中测试后再集成
性能考量	Lua 脚本是单线程执行的，避免复杂运算
异常处理	在 Java 层应对脚本执行失败做容错处理
参数传递	KEYS 是数组，ARGV 是参数数组，顺序要对应

八、进阶建议

将所有 Lua 脚本统一管理，使用配置中心或数据库存储
结合 AOP 或拦截器，实现 Lua 脚本调用的自动重试机制
使用 Redisson 等高级库简化 Lua 脚本操作
使用 Spring Cache 抽象层结合 Lua 脚本实现更复杂的缓存策略

示例结构图

src/
├── main/
│ ├── java/
│ │ └── com.example.demo/
│ │ ├── DemoApplication.java
│ │ ├── service/
│ │ │ ├── RedisLuaService.java
│ │ │ └── LuaScriptLoader.java
│ │ └── controller/
│ │ └── RedisLuaController.java
│ └── resources/
│ └── lua/
│ └── get_or_set_default.lua
└── pom.xml

总结

本文详细介绍了如何在 Spring Boot 中调用 Redis 的 Lua 脚本，包括：

添加必要的依赖
编写 Lua 脚本
使用 RedisTemplate 加载和调用脚本
构建完整的调用流程与接口测试

Lua 脚本非常适合用来实现一些需要原子性的 Redis 操作，是构建高并发系统的重要工具之一。

到此这篇关于SpringBoot集成Redis并调用Lua脚本的示例详解的文章就介绍到这了,更多相关SpringBoot集成Redis调用Lua内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java 实战项目之疫情防控管理系统详解
读万卷书不如行万里路，只学书上的理论是远远不够的，只有在实战中才能获得能力的提升，本篇文章手把手带你用Java实现一个疫情防控管理系统,大家可以在过程中查缺补漏，提升水平
2021-11-11
Java程序包装成桌面应用程序方式
这篇文章主要介绍了Java程序包装成桌面应用程序方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-01-01
DUCC配置平台实现一个动态化线程池示例代码
这篇文章主要为大家介绍了DUCC配置平台实现一个动态化线程池示例代码，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-02-02
SpringBoot war包部署到Tomcat服务器
这篇文章主要介绍了SpringBoot war包部署到Tomcat服务器，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-03-03
Java @Pointcut注解表达式案例详解
这篇文章主要介绍了Java @Pointcut注解表达式案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-09-09
深入理解Java线程创建方式(最新推荐)
作为一名Java开发者,我深刻体会到,对线程的深入理解往往区分了初级和高级程序员,在这篇文章中,我将分享我对Java线程的个人理解,从基础概念到底层实现,希望能为你提供有价值的见解,感兴趣的朋友跟随小编一起看看吧
2025-10-10
Java实现雪花算法的示例代码
SnowFlow算法是Twitter推出的分布式id生成算法，主要核心思想就是利用64bit的long类型的数字作为全局的id。本文将用Java语言实现雪花算法，感兴趣的可以学习一下
2022-03-03
百度Java面试题前200页精选（下）
这篇文章主要为大家分享了Java面试资源下篇，百度“Java面试题”前200页都在这里了，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-12-12
Nacos入门过程的坑--获取不到配置的值问题
这篇文章主要介绍了Nacos入门过程的坑--获取不到配置的值问题及解决，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-01-01
Java中的Optional类用法详细讲解
这篇文章详细介绍了Java中Optional类的使用,包括创建Optional对象,Optional对象的常用方法,如get、orElse、orElseGet、orElseThrow等,以及Optional类结合Lambda表达式和StreamAPI的使用,需要的朋友可以参考下
2024-10-10