SpringBoot實現接口冪等性的4種方案

UPDATE my_table SET price=price+50,version=version+1 WHERE id=1 AND version=5

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>

 <parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>2.3.4.RELEASE</version>
 </parent>

 <groupId>mydlq.club</groupId>
 <artifactId>springboot-idempotent-token</artifactId>
 <version>0.0.1</version>
 <name>springboot-idempotent-token</name>
 <description>Idempotent Demo</description>

 <properties>
  <java.version>1.8</java.version>
 </properties>

 <dependencies>
  <!--springboot web-->
  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <!--springboot data redis-->
  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-data-redis</artifactId>
  </dependency>
  <dependency>
   <groupId>org.apache.commons</groupId>
   <artifactId>commons-pool2</artifactId>
  </dependency>
  <!--lombok-->
  <dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
  </dependency>
 </dependencies>

 <build>
  <plugins>
   <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
   </plugin>
  </plugins>
 </build>
</project>

spring:
 redis:
 ssl: false
 host: 127.0.0.1
 port: 6379
 database: 0
 timeout: 1000
 password:
 lettuce:
  pool:
  max-active: 100
  max-wait: -1
  min-idle: 0
  max-idle: 20

import java.util.Arrays;
import java.util.UUID;
import java.util.concurrent.TimeUnit;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.core.script.DefaultRedisScript;
import org.springframework.data.redis.core.script.RedisScript;
import org.springframework.stereotype.Service;

@Slf4j
@Service
public class TokenUtilService {

 @Autowired
 private StringRedisTemplate redisTemplate;

 /**
  * 存入 Redis 的 Token 鍵的前綴
  */
 private static final String IDEMPOTENT_TOKEN_PREFIX = "idempotent_token:";

 /**
  * 創建 Token 存入 Redis，並返回該 Token
  *
  * @param value 用於輔助驗證的 value 值
  * @return 生成的 Token 串
  */
 public String generateToken(String value) {
  // 實例化生成 ID 工具對象
  String token = UUID.randomUUID().toString();
  // 設置存入 Redis 的 Key
  String key = IDEMPOTENT_TOKEN_PREFIX + token;
  // 存儲 Token 到 Redis，且設置過期時間為5分鐘
  redisTemplate.opsForValue().set(key, value, 5, TimeUnit.MINUTES);
  // 返回 Token
  return token;
 }

 /**
  * 驗證 Token 正確性
  *
  * @param token token 字符串
  * @param value value 存儲在Redis中的輔助驗證信息
  * @return 驗證結果
  */
 public boolean validToken(String token, String value) {
  // 設置 Lua 腳本，其中 KEYS[1] 是 key，KEYS[2] 是 value
  String script = "if redis.call('get', KEYS[1]) == KEYS[2] then return redis.call('del', KEYS[1]) else return 0 end";
  RedisScript<Long> redisScript = new DefaultRedisScript<>(script, Long.class);
  // 根據 Key 前綴拼接 Key
  String key = IDEMPOTENT_TOKEN_PREFIX + token;
  // 執行 Lua 腳本
  Long result = redisTemplate.execute(redisScript, Arrays.asList(key, value));
  // 根據返回結果判斷是否成功成功匹配並刪除 Redis 鍵值對，若果結果不為空和0，則驗證通過
  if (result != null && result != 0L) {
   log.info("驗證 token={},key={},value={} 成功", token, key, value);
   return true;
  }
  log.info("驗證 token={},key={},value={} 失敗", token, key, value);
  return false;
 }
}

import lombok.extern.slf4j.Slf4j;
import mydlq.club.example.service.TokenUtilService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@Slf4j
@RestController
public class TokenController {

 @Autowired
 private TokenUtilService tokenService;

 /**
  * 獲取 Token 接口
  *
  * @return Token 串
  */
 @GetMapping("/token")
 public String getToken() {
  // 獲取用戶信息（這裡使用模擬數據）
  // 註：這裡存儲該內容隻是舉例，其作用為輔助驗證，使其驗證邏輯更安全，如這裡存儲用戶信息，其目的為:
  // - 1)、使用"token"驗證 Redis 中是否存在對應的 Key
  // - 2)、使用"用戶信息"驗證 Redis 的 Value 是否匹配。
  String userInfo = "mydlq";
  // 獲取 Token 字符串，並返回
  return tokenService.generateToken(userInfo);
 }

 /**
  * 接口冪等性測試接口
  *
  * @param token 冪等 Token 串
  * @return 執行結果
  */
 @PostMapping("/test")
 public String test(@RequestHeader(value = "token") String token) {
  // 獲取用戶信息（這裡使用模擬數據）
  String userInfo = "mydlq";
  // 根據 Token 和與用戶相關的信息到 Redis 驗證是否存在對應的信息
  boolean result = tokenService.validToken(token, userInfo);
  // 根據驗證結果響應不同信息
  return result ? "正常調用" : "重復調用";
 }
}

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

 public static void main(String[] args) {
  SpringApplication.run(Application.class, args);
 }

}

import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

@Slf4j
@SpringBootTest
@RunWith(SpringRunner.class)
public class IdempotenceTest {

 @Autowired
 private WebApplicationContext webApplicationContext;

 @Test
 public void interfaceIdempotenceTest() throws Exception {
  // 初始化 MockMvc
  MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
  // 調用獲取 Token 接口
  String token = mockMvc.perform(MockMvcRequestBuilders.get("/token")
    .accept(MediaType.TEXT_HTML))
    .andReturn()
    .getResponse().getContentAsString();
  log.info("獲取的 Token 串：{}", token);
  // 循環調用 5 次進行測試
  for (int i = 1; i <= 5; i++) {
   log.info("第{}次調用測試接口", i);
   // 調用驗證接口並打印結果
   String result = mockMvc.perform(MockMvcRequestBuilders.post("/test")
     .header("token", token)
     .accept(MediaType.TEXT_HTML))
     .andReturn().getResponse().getContentAsString();
   log.info(result);
   // 結果斷言
   if (i == 0) {
    Assert.assertEquals(result, "正常調用");
   } else {
    Assert.assertEquals(result, "重復調用");
   }
  }
 }

}