如何将Redis Lua脚本与Spring Boot集成使用?

落芳吖_2376

落芳吖_2376

2026-08-22

820人浏览

原创

redistemplate 是 spring boot 调用 lua 脚本最直接稳定的入口,需通过 execute() 传 redisscript 和参数,脚本中 key 必须用 keys[]、参数用 argv[],且所有 key 需同 slot;加载本地 .lua 文件应使用 resource + inputstream 方式并设置 sha1;集群下跨 slot 操作会报 crossslot 错误,须用 {xxx} 哈希标签或拆分脚本;避免使用 stringredistemplate.execute() 防 classcastexception。

如何将redis lua脚本与spring boot集成使用?

RedisTemplate 是 Spring Boot 中调用 Lua 脚本最直接、最稳定的入口,不需要额外封装工具类或自定义连接池。

怎么用 RedisTemplate.execute() 执行 Lua 脚本

核心是调用 execute() 方法,传入 RedisScript 对象和参数。别直接拼字符串或手写 eval 命令——Spring 已经封装好安全边界。

  • RedisScript 必须声明返回类型(如 Long.class、String.class 或 List.class),否则执行时抛 IllegalArgumentException
  • 脚本中用 KEYS[1] 引用第一个 key,ARGV[1] 引用第一个参数;Spring 会自动把 keys 列表和 args 数组映射过去
  • 不要在脚本里写 redis.call("get", "hardcoded-key") ——所有 key 必须通过 KEYS 传入,否则集群模式下报错 CROSSSLOT Keys in request don't hash to the same slot
  • 示例:限流脚本 rate_limit.lua 内容为 local count = redis.call("incr", KEYS[1]); if count == 1 then redis.call("expire", KEYS[1], ARGV[1]) end; return count,Java 调用时传 Arrays.asList("rate:uid:123") 作 keys,Arrays.asList("60") 作 args

DefaultRedisScript 怎么加载本地 .lua 文件

Spring 不自动扫描 src/main/resources/lua/ 目录,必须手动读取并构造 DefaultRedisScript 实例。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载
  • 脚本文件路径用 classpath:lua/rate_limit.lua,不是相对路径或绝对路径
  • 必须显式调用 script.setSha1(...) 或让 Spring 计算 SHA1(首次执行时上传,后续用 SHA1 缓存脚本),否则每次请求都发完整脚本文本,浪费带宽
  • 如果脚本内容不变但修改了文件换行符或空格,SHA1 会变,Redis 会重复加载——建议用 git diff 确认脚本二进制一致性
  • 不推荐用 ResourceUtils.getFile("classpath:..."),它在 jar 包里会抛 FileNotFoundException;应始终用 Resource + InputStream 方式读取

集群环境下 Lua 脚本的 key 分布限制

Redis Cluster 要求一个脚本内所有 KEYS 必须落在同一个哈希槽(slot),否则直接拒绝执行。

  • 单 key 操作天然满足条件;多 key 场景必须用 {xxx} 语法保证哈希标签一致,例如 user:{123}:profile 和 user:{123}:settings
  • 不能写 redis.call("mget", KEYS[1], KEYS[2]) 且两个 key 不带相同哈希标签——运行时报 CROSSSLOT
  • 若业务必须跨 slot 操作(如用户信息+订单列表),拆成多个脚本调用,或改用客户端逻辑聚合结果
  • Lettuce 客户端默认开启 cluster 模式检测,遇到违规脚本会立即抛 RedisCommandExecutionException,而不是静默失败

为什么不用 StringRedisTemplate.execute()?

看起来更“字符串友好”,但实际埋坑:它内部仍用 RedisTemplate,只是对序列化器做了简化封装,而 Lua 脚本返回值类型由脚本本身决定,与 key/value 的序列化无关。

  • 若脚本返回数字(如计数器结果),用 StringRedisTemplate 会导致 ClassCastException:它试图把 Long 强转成 String
  • 统一用 RedisTemplate + 显式泛型(RedisTemplate<string string></string>)即可兼顾类型安全和字符串操作需求
  • 除非你确定脚本只返回字符串且永不变更,否则不要贪图省事切换模板
Lua 脚本真正难的不是语法,而是 key 设计和集群约束——写完脚本后,务必拿真实集群环境跑一次 CROSSSLOT 边界测试,比本地单机验证重要得多。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2351

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

437

25

常用的数据库软件
常用的数据库软件

常用的数据库软件有MySQL、Oracle、SQL Server、PostgreSQL、MongoDB、Redis、Cassandra、Hadoop、Spark和Amazon DynamoDB。更多关于数据库软件的内容详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.02

4289

19

内存数据库有哪些
内存数据库有哪些

内存数据库有Redis、Memcached、Apache Ignite、VoltDB、TimesTen、H2 Database、Aerospike、Oracle TimesTen In-Memory Database、SAP HANA和ache Cassandra。更多关于内存数据库相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.14

3795

11

mongodb和redis哪个读取速度快
mongodb和redis哪个读取速度快

redis 的读取速度比 mongodb 更快。原因包括:1. redis 使用简单的键值存储,而 mongodb 存储 json 格式的数据,需要解析和反序列化。2. redis 使用哈希表快速查找数据,而 mongodb 使用 b-tree 索引。因此,redis 在需要高性能读取操作的应用程序中是一个更好的选择。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.02

6872

6

redis怎么做缓存服务器
redis怎么做缓存服务器

redis 作为缓存服务器的答案:redis 是一款开源、高性能、分布式的键值存储,可作为缓存服务器使用。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.07

623

6

redis怎么解决数据一致性
redis怎么解决数据一致性

redis 提供了两种一致性模型,以维护副本数据一致性:强一致性 (sync) 确保写操作仅在复制到所有从节点后才完成;最终一致性 (async) 则在主节点上写操作后认为已完成,牺牲一致性换取性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.07

736

6

mysql和redis怎么保证双写一致性
mysql和redis怎么保证双写一致性

确保 mysql 和 redis 双写一致性的技术包括:1、事务性更新:同时更新 mysql 和 redis,保证一致性;2、主从复制:mysql 主服务器更改同步到 redis 从服务器;3、基于事件的更新:mysql 记录更改并发送到 redis等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.07

6482

6

redis缓存一般存些什么数据
redis缓存一般存些什么数据

redis缓存中存储的数据类型包括:字符串、哈希、列表、集合、有序集合、位图、地理空间数据和hyperloglog。这些数据类型适用于存储各种数据,从简单信息到复杂对象和地理位置。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.07

1140

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习