SpringBoot集成Redis并調(diào)用Lua腳本的示例詳解
前言
Redis 是一個高性能的內(nèi)存數(shù)據(jù)庫，廣泛用于緩存、計數(shù)器、分布式鎖等場景。在某些業(yè)務(wù)中，我們需要對多個 Redis 操作進(jìn)行原子性處理，以保證數(shù)據(jù)一致性，這時就可以使用 Redis 提供的 Lua 腳本功能。
Spring Boot 通過 RedisTemplate 對 Redis 進(jìn)行了良好的封裝，也支持我們方便地調(diào)用 Lua 腳本。本文將帶你一步步實(shí)現(xiàn) Spring Boot 中如何：
- 加載 Lua 腳本
- 調(diào)用 Lua 腳本
- 實(shí)現(xiàn)一個實(shí)際業(yè)務(wù)邏輯：獲取 key，若不存在則設(shè)置默認(rèn)值并返回
一、項(xiàng)目準(zhǔn)備
創(chuàng)建 Spring Boot 項(xiàng)目
你可以使用 Spring Initializr 創(chuàng)建一個新項(xiàng)目，選擇以下依賴：
- Spring Web
- Spring Data Redis
- Lettuce（Redis 客戶端）
或者手動創(chuàng)建 Maven 項(xiàng)目后添加如下依賴：
<!-- 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 腳本文件
我們將創(chuàng)建一個簡單的 Lua 腳本：如果 key 不存在，則設(shè)置默認(rèn)值；存在則直接返回當(dāng)前值。
腳本內(nèi)容：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 的生命周期回調(diào)（如 @PostConstruct）來加載 Lua 腳本，并保存其 SHA1 校驗(yàn)碼，后續(xù)通過 EVALSHA 來調(diào)用。
創(chuàng)建腳本加載類：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);
// 執(zhí)行 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 來執(zhí)行一次腳本，只是為了觸發(fā)腳本加載。
- 實(shí)際調(diào)用時使用的是
EVALSHA命令。
四、封裝 Lua 腳本調(diào)用服務(wù)
我們創(chuàng)建一個服務(wù)類來封裝 Lua 腳本的調(diào)用邏輯。
創(chuàng)建服務(wù)類：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;
}
/**
* 調(diào)用 Lua 腳本：根據(jù) key 獲取值，若不存在則設(shè)置默認(rèn)值并返回
*/
public String getOrSetDefault(String key, String defaultValue) {
return (String) redisTemplate.execute(
LuaScriptLoader.GET_OR_SET_DEFAULT_SHA,
Collections.singletonList(key),
defaultValue
);
}
}
五、創(chuàng)建 REST 接口進(jìn)行測試
為了方便測試，我們創(chuàng)建一個簡單的接口。
創(chuàng)建控制器類：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);
}
}
六、運(yùn)行測試
1. 啟動 Redis 服務(wù)
確保你本地或服務(wù)器上已經(jīng)啟動了 Redis：
redis-server
2. 啟動 Spring Boot 應(yīng)用
使用 IDE 或命令行啟動 Spring Boot 項(xiàng)目：
mvn spring-boot:run
3. 測試訪問
訪問如下 URL：
http://localhost:8080/redis/get-or-set?key=test_lua&defaultValue=hello_redis
第一次請求：
Redis 中沒有 test_lua 鍵，會自動設(shè)置為 hello_redis，并返回該值。
第二次請求：
即使不傳 defaultValue，也會返回 hello_redis，因?yàn)殒I已存在。
七、注意事項(xiàng)
| 項(xiàng)目 | 說明 |
|---|---|
| 腳本緩存 | Redis 會緩存加載過的 Lua 腳本，但重啟后失效，需重新加載 |
| 調(diào)試?yán)щy | Lua 腳本不能輸出日志，建議先在 Redis CLI 中測試后再集成 |
| 性能考量 | Lua 腳本是單線程執(zhí)行的，避免復(fù)雜運(yùn)算 |
| 異常處理 | 在 Java 層應(yīng)對腳本執(zhí)行失敗做容錯處理 |
| 參數(shù)傳遞 | KEYS 是數(shù)組，ARGV 是參數(shù)數(shù)組，順序要對應(yīng) |
八、進(jìn)階建議
- 將所有 Lua 腳本統(tǒng)一管理，使用配置中心或數(shù)據(jù)庫存儲
- 結(jié)合 AOP 或攔截器，實(shí)現(xiàn) Lua 腳本調(diào)用的自動重試機(jī)制
- 使用 Redisson 等高級庫簡化 Lua 腳本操作
- 使用 Spring Cache 抽象層結(jié)合 Lua 腳本實(shí)現(xiàn)更復(fù)雜的緩存策略
示例結(jié)構(gòu)圖
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
總結(jié)
本文詳細(xì)介紹了如何在 Spring Boot 中調(diào)用 Redis 的 Lua 腳本，包括：
- 添加必要的依賴
- 編寫 Lua 腳本
- 使用
RedisTemplate加載和調(diào)用腳本 - 構(gòu)建完整的調(diào)用流程與接口測試
Lua 腳本非常適合用來實(shí)現(xiàn)一些需要原子性的 Redis 操作，是構(gòu)建高并發(fā)系統(tǒng)的重要工具之一。
到此這篇關(guān)于SpringBoot集成Redis并調(diào)用Lua腳本的示例詳解的文章就介紹到這了,更多相關(guān)SpringBoot集成Redis調(diào)用Lua內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
關(guān)于maven項(xiàng)目中使用BCrypt加密方式
BCrypt是一種基于Blowfish加密算法的密碼散列函數(shù),用于安全存儲和驗(yàn)證用戶密碼,它通過引入鹽和工作因子增加計算復(fù)雜度,有效防止彩虹表攻擊和破解,BCrypt具備適應(yīng)性工作因子、成本參數(shù)調(diào)整、迭代哈希和密鑰擴(kuò)展等特點(diǎn),被廣泛應(yīng)用于Web應(yīng)用程序的安全性設(shè)計中2024-10-10
這篇文章主要介紹了Java遞歸算法遍歷部門代碼示例，具有一定借鑒價值，需要的朋友可以參考下。2017-12-12
Java日常練習(xí)題,每天進(jìn)步一點(diǎn)點(diǎn)(7)
下面小編就為大家?guī)硪黄狫ava基礎(chǔ)的幾道練習(xí)題(分享)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧，希望可以幫到你2021-07-07
在剛開始學(xué)習(xí)Java的時候，就了解了Java基礎(chǔ)中的變量，雖然知道這個以后會經(jīng)常用到，但沒想到了基本語法這里，竟然又冒出來了成員變量和局部變量。變來變?nèi)ヌ菀鬃屓烁銜灹?，今天我們就挑揀出來梳理一下?/div> 2016-07-07
Spring?Boot中使用Spring?Retry重試框架的操作方法
這篇文章主要介紹了Spring?Retry?在SpringBoot?中的應(yīng)用,介紹了RetryTemplate配置的時候，需要設(shè)置的重試策略和退避策略，需要的朋友可以參考下2022-04-04
SpringBoot解決數(shù)據(jù)庫時間和返回時間格式不一致的問題
這篇文章主要介紹了SpringBoot解決數(shù)據(jù)庫時間和返回時間格式不一致的問題,文章通過代碼示例和圖文結(jié)合的方式講解的非常詳細(xì),對大家的學(xué)習(xí)和工作有一定的幫助,需要的朋友可以參考下2024-03-03
java多線程通過CompletableFuture組裝異步計算單元
這篇文章主要為大家介紹了java多線程通過CompletableFuture組裝異步計算單元，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-04-04
Idea進(jìn)行pull的時候Your local changes would be
這篇文章主要介紹了Idea進(jìn)行pull的時候Your local changes would be overwritten by merge.具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-11-11
IntelliJ IDEA中查看文件內(nèi)所有已聲明的方法(類似eclipse的outline)
今天小編就為大家分享一篇關(guān)于IntelliJ IDEA中查看文件內(nèi)所有已聲明的方法(類似eclipse的outline)，小編覺得內(nèi)容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2018-10-10
java8升級java21方法步驟(完整pom文件升級及代碼修改)
在從Java?8升級至Java?211的過程中,需要對多個POM文件進(jìn)行升級,涉及parent、web、service等模塊,文中通過代碼介紹的非常詳細(xì),對大家學(xué)習(xí)或者使用java具有一定的參考借鑒價值,需要的朋友可以參考下2024-11-11最新評論