如何在Spring Data Redis中动态注入Lua脚本文件?

轻静姑娘_7022

轻静姑娘_7022

2026-10-20

928人浏览

原创

spring data redis 不支持自动注入lua脚本,需手动用resourceloader读取文件内容并构建redisscript对象后调用execute()执行;keys必须非空且同slot,argv顺序不可颠倒。

如何在spring data redis中动态注入lua脚本文件?

Spring Data Redis 无法直接“动态注入”Lua脚本文件

Spring Data Redis 没有提供类似 @Value("classpath:lua/xxx.lua") 自动读取并注册脚本的机制。所谓“动态注入”,实际是指在运行时加载本地 Lua 文件内容、构建 RedisScript 对象,并传给 execute() 方法——它不涉及 Redis 服务端的 SCRIPT LOAD 或缓存管理,只是客户端拼装脚本内容再发送。

用 Resource 读取 .lua 文件内容必须手动做

Spring Boot 的 ResourceLoader 可以定位 classpath 下的 Lua 脚本,但你要自己读成字符串,不能跳过这步:

  • Resource 必须用 resource.getInputStream() 或 resource.getContentAsString(StandardCharsets.UTF_8) 获取文本内容
  • 路径写错会导致 FileNotFoundException,比如写成 lua/get_or_set_default.lua 却放在 resources/scripts/ 下
  • 脚本含中文或特殊符号时,务必指定 UTF-8 编码,否则 redis.call() 执行时报 LUA ERR Error compiling script (new way)
  • 推荐用 StringRedisTemplate 配合 DefaultRedisScript<string></string>,避免泛型擦除导致返回值类型错误

示例片段:

Resource scriptResource = resourceLoader.getResource("classpath:lua/get_or_set_default.lua");
String luaContent = StreamUtils.copyToString(scriptResource.getInputStream(), StandardCharsets.UTF_8);
DefaultRedisScript<string> script = DefaultRedisScript.<string>builder()
    .scriptText(luaContent)
    .resultType(String.class)
    .build();</string></string>

execute() 调用时 KEY 和 ARGV 顺序不能颠倒

Redis 要求所有键名(KEYS)必须显式前置,且数量由第二个参数(numKeys)严格控制;其余全算 ARGV。Spring Data Redis 的 execute(script, keys, args...) 签名容易误导:

redis-tools
redis-tools

按类别查找Redis命令、检测服务器连接、监控键数量和内存占用,支持离线速查表。

下载
  • keys 参数是 List<string></string> 或 Collection<string></string>,不是 varargs —— 它对应 KEYS[1], KEYS[2]...
  • args 是可变参数(Object...),对应 ARGV[1], ARGV[2]...
  • 如果脚本里用了 redis.call("GET", KEYS[1]),但传了空 keys 列表,会报 ERR Error running script (call to f_...): @user_script:3: user_script:3: attempt to index a nil value (field '1')
  • 集群模式下,所有 KEYS 必须落在同一个 slot,否则抛 RedisClusterException;单机模式无此限制

正确调用示例:

String result = stringRedisTemplate.execute(
    script,
    Collections.singletonList("my:key"), // ← keys 列表,长度=1
    "default:val"                        // ← args,对应 ARGV[1]
);

别把 scriptLoad 和客户端脚本加载混为一谈

Redis 的 SCRIPT LOAD 是服务端行为,返回 SHA1 值供后续 EVALSHA 复用;而 Spring Data Redis 的 execute() 默认走 EVAL,每次发完整脚本文本。除非你显式调用 redisTemplate.getConnectionFactory().getConnection().scriptLoad(...),否则不会触发服务端缓存。

  • 高频脚本建议提前 scriptLoad 一次,之后用 evalsha,减少网络传输量
  • 但 scriptLoad 返回的 SHA1 在集群模式下只对当前节点有效,跨节点需重复加载
  • 应用重启后服务端脚本不会自动重载,得自己加初始化逻辑(比如 @PostConstruct)
  • 脚本内容变更后,SHA1 改变,旧的 evalsha 会失败并报 NOSCRIPT No matching script,此时要 fallback 到 eval

真正容易被忽略的是:你写的 get_or_set_default.lua 文件本身没任何“注入”能力,它只是个文本资源;所有解析、编码、序列化、网络发送动作,都发生在你调用 execute() 的那一瞬间——没有魔法,只有你亲手组装的字符串和参数。

相关文章

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

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

下载

相关标签:

redis

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

相关专题

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

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

2025.08.06

2571

22

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

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

2026.01.26

477

25

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

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

2023.11.02

4529

19

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

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

2023.11.14

4075

11

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

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

2024.04.02

7572

6

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

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

2024.04.07

643

6

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

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

2024.04.07

756

6

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

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

2024.04.07

7482

6

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

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

2024.04.07

1160

6

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpEnv手册
phpEnv手册

共0课时 | 0人学习