【面试系列】如何保证接口的幂等性

news2024/11/24 14:41:17

为什么需要实现幂等性

在接口调用时一般情况下都能正常返回信息不会重复提交,不过在遇见以下情况时可以就会出现问题,如:

  • 前端重复提交表单:在填写一些表格时候,用户填写完成提交,很多时候会因网络波动没有及时对用户做出提交成功响应,致使用户认为没有成功提交,然后一直点提交按钮,这时就会发生重复提交表单请求。
  • 用户恶意进行刷单:例如在实现用户投票这种功能时,如果用户针对一个用户进行重复提交投票,这样会导致接口接收到用户重复提交的投票信息,这样会使投票结果与事实严重不符。
  • 接口超时重复提交:很多时候 HTTP 客户端工具都默认开启超时重试的机制,尤其是第三方调用接口时候,为了防止网络波动超时等造成的请求失败,都会添加重试机制,导致一个请求提交多次。
  • 消息进行重复消费:当使用 MQ 消息中间件时候,如果发生消息中间件出现错误未及时提交消费信息,导致发生重复消费。

使用幂等性最大的优势在于使接口保证任何幂等性操作,免去因重试等造成系统产生的未知的问题。

解决方案

防重 Token 令牌

针对客户端连续点击或者调用方的超时重试等情况,例如提交订单,此种操作就可以用 Token 的机制实现防止重复提交。简单的说就是调用方在调用接口的时候先向后端请求一个全局 ID(Token),请求的时候携带这个全局 ID 一起请求(Token 最好将其放到 Headers 中),后端需要对这个 Token 作为 Key,用户信息作为 Value 到 Redis 中进行键值内容校验,如果 Key 存在且 Value 匹配就执行删除命令,然后正常执行后面的业务逻辑。如果不存在对应的 Key 或 Value 不匹配就返回重复执行的错误信息,这样来保证幂等操作。

在这里插入图片描述

TokenService定义了获取token和验证token的逻辑。

@Slf4j
@Service
public class TokenService {

    @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;
    }

}

TokenController定义了获取token和测试接口幂等性的接口

@Slf4j
@RestController
public class TokenController {

    @Autowired
    private TokenService tokenService;

    /**
     * 获取 Token 接口
     *
     * @return Token 串
     */
    @GetMapping("/token")
    public String getToken() {
        // 获取用户信息(这里使用模拟数据)
        // 注:这里存储该内容只是举例,其作用为辅助验证,使其验证逻辑更安全,如这里存储用户信息,其目的为:
        // - 1)、使用"token"验证 Redis 中是否存在对应的 Key
        // - 2)、使用"用户信息"验证 Redis 的 Value 是否匹配。
        String userInfo = "charles";
        // 获取 Token 字符串,并返回
        return tokenService.generateToken(userInfo);
    }

    /**
     * 接口幂等性测试接口
     *
     * @param token 幂等 Token 串
     * @return 执行结果
     */
    @PostMapping("/test")
    public String test(@RequestHeader(value = "token") String token) {
        // 获取用户信息(这里使用模拟数据)
        String userInfo = "charles";
        // 根据 Token 和与用户相关的信息到 Redis 验证是否存在对应的信息
        boolean result = tokenService.validToken(token, userInfo);
        // 根据验证结果响应不同信息
        return result ? "正常调用" : "重复调用";
    }

}

TokenTest多次访问一个接口,只有第一次访问是成功的。

/**
 * @author charles
 * @date 2023/5/3 13:55
 */
@Slf4j
@SpringBootTest
public class TokenTest {

    @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) {
                System.out.println("正常调用");
            } else {
                System.out.println("重复调用");
            }
        }
    }
}

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/494497.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

C++之编译链接

目录 线程基础静态链接静态链接装载与动态链接库与运行库 关于隔离&#xff1a; 物理地址是实在存在的虚拟地址是虚拟的&#xff0c;并不存在&#xff0c;每个进程都有自己独立的虚拟空间&#xff0c;而且每个进程只能访问自己的地址空间&#xff0c;这样就有效地做到了进程的…

字符设备驱动开发

1、字符设备驱动简介 字符设备是 Linux 驱动中最基本的一类设备驱动&#xff0c;字符设备就是一个一个字节&#xff0c;按照字节 流进行读写操作的设备&#xff0c;读写数据是分先后顺序的。比如我们最常见的点灯、按键、IIC、SPI&#xff0c; LCD 等等都是字符设备&#xff0c…

不断积累,步步高升:记录我的Python学习历程-python中f-string介绍

最近在看python基础的时候&#xff0c;又发现一个之前没怎么掌握的字符串格式化的小技巧&#xff0c;f-string f-string 格式化 f-string是Python3.6引入的一种字符串格式化方式&#xff0c;它提供了一种简洁、直观的方式来将变量值嵌入到字符串中。在 f-string 中&#xff0c;…

2022 Hubei Provincial Collegiate Programming Contest B. Potion(easy version)

题目链接 Output For each testcase, if Twilight Sparkle couldn’t make the specific mixture, print a single integer: −1. Otherwise, print the minimum number of operation 1 to do that. Example input 3 3 5 1 1 2 6 1 1 5 7 1 1 output 4 3 -1 题目大意 题目保证…

顺序表---(数据结构的开始)

目录 前言&#xff1a; 1.线性表的性质 2.静态数组or动态数组 2.1静态数组 2.2动态数组 3.结构体的创建 4*接口函数的详细讲解 4.1初始化结构体 4.2尾插 4.3打印数据 4.4用完后销毁创建的堆空间 4.5 尾删 4.6头插 4.7头删 4.8查找 4.9任意位置插入 4.10任意位…

正则表达式规则

元字符&#xff1a; 正则表达式主要依赖于元字符。 元字符不代表他们本身的字面意思&#xff0c;他们都有特殊的含义。一些元字符写在方括号中的时候有一些特殊的意思。以下是一些元字符的介绍&#xff1a; 运算符优先级&#xff1a; 正则表达式从左到右进行计算&#xff0c;…

idea一些不常见但是非常有用的sql

1.这个功能适合生产环境遇到故障&#xff0c;然后本地&#xff0c;但是前提是jvm配置了如下参数&#xff0c;还有一个就是要保证线上代码和本地的一致&#xff0c;这样就可以本地调式远程代码 在linux 运行 java -agentlib:jdwptransportdt_socket,servery,suspendn,address500…

牛客 BM19 寻找峰值

描述 给定一个长度为n的数组nums&#xff0c;请你找到峰值并返回其索引。数组可能包含多个峰值&#xff0c;在这种情况下&#xff0c;返回任何一个所在位置即可。 1.峰值元素是指其值严格大于左右相邻值的元素。严格大于即不能有等于 2.假设 nums[-1] nums[n] -∞ 3.对于所有…

中台产品经理01:中台落地工具MSS模型

众所周知&#xff0c;每家企业的内部经营管理都是大相径庭的&#xff0c;就算相同行业的两家企业其内部也会有显著的特殊性&#xff0c;因此企业对于自身中台的建设需求也一定是不同的&#xff0c;可以说中台建设必须是为企业量身定制的。 而在每家企业的中台建设中&#xff0…

Visual Studio 2022 搭建GLFW OpenGL开发环境

最近工作需要 需要写一个全景的视频播放器 网上搜了下大概解决方案是 ffmpegopengl b站有很多视频 按照视频 搭建了OpenGL的开发环境 先去GLFW的网站下载 windows平台的库文件 为什么使用GLFW 因为GLFW是跨平台的 我下的是64位版本解压后有目录如下 包含了动态库和静态…

医院不良事件管理系统源码,PHP语言开发,填写上报、流转审批、发生原因分析定位

医疗安全不良事件管理系统源码提供不良事件的上报、事件审核处理、时间按分析、事件跟踪与持续改进&#xff0c;事件提醒、权限控制、外部上报等功能。从报告内容填写上报、流转审批、发生原因分析定位、处置对策的制定、统计汇总等方面&#xff0c;提供了不良事件处理的全过程…

[Leetcode] 0705. 设计哈希集合

705. 设计哈希集合 English Version 题目描述 不使用任何内建的哈希表库设计一个哈希集合(HashSet)。 实现 MyHashSet 类&#xff1a; void add(key) 向哈希集合中插入值 key 。bool contains(key) 返回哈希集合中是否存在这个值 key 。void remove(key) 将给定值 key 从哈希集…

这些神仙问题,整垮了chatGpt

垮掉&#xff0c;全部垮掉 今天刚上了一个chat聊天功能&#xff0c;网友们就不甘落后&#xff0c;纷纷展示了自己的技能。分分钟给我整垮了。 神仙问题 玉皇大帝住在平流层还是对流层&#xff1f;空腹的时候可以吃饭吗&#xff1f;自来水不能直接喝&#xff0c;那么用自来水…

CAD二次开发--根据内部点识别最近外部边界范围即boundary命令代码实现(含源码)

在AutoCAD中我们知道使用Boundary(BO)命令可以快速找到内部点附近的最近边界范围(通常要求闭合)。然而网上很多文章却停留在如何用BO命令,并没有讲如何用代码去实现!本文将实现代码贴出来并进行简单介绍。 先看下实现效果图吧! 该功能在某些时候还是具备一定的实…

yolov8 浅记

目录 Pre: 1. YOLOv8 概述 2. 模型结构设计 3. Loss 计算 4.训练数据增强 5. 训练策略 6、部署推理 End Pre: yolo系列发布时间&#xff1a; 先贴一下yolo各系列的发布时间&#xff08;说出来很丢人&#xff0c;我以为 yolox是 最新的&#xff09;&#xff1a; yoloX 2…

【leetcode刷题】2659. 将数组清空(树状数组初体验)

目录 题目截图题目分析ac code树状数组模版树状数组总结 题目截图 题目分析 直接模拟的话就是平方复杂度&#xff0c;会超时间复杂度我们删掉一个最小的&#xff0c;然后就要删次小的&#xff0c;如何找到其中间隔的距离呢&#xff1f;间隔中可能有一些又被删掉了&#xff1f;…

循环队列、双端队列

循环队列、双端队列 1. 循环队列1.1 循环队列1.2 代码实现1.3 力扣622. 设计循环队列2. 双端队列 1. 循环队列 1.1 循环队列 特殊的队列&#xff0c;首尾相连&#xff0c;空间可重复利用&#xff1b;环形队列常使用数组实现&#xff0c;且为了方便队列的判空、判满处理&#x…

二十七、BGP技术总结

文章目录 BGP&#xff1a;边界网关路由协议&#xff08;Border Gateway Protocol&#xff09;概述1、路由协议分类1.1、IGP&#xff1a;Interior Gateway Protocol&#xff08;内部网关协议&#xff09;1.2、EGP&#xff1a;Exterior Gateway Protocol&#xff08;外部网关协议…

人机智能中几个困难问题浅析

1、人机之间与人人之间信任的区别人机之间的信任与人人之间的信任存在以下异同&#xff1a;①信任对象。人机之间的信任的对象是计算机系统、算法、机器人等&#xff0c;而人人之间的信任的对象是其他人。②信任方式。人机之间的信任是基于技术、安全协议等建立的&#xff0c;例…

Baumer工业相机堡盟工业相机如何联合BGAPISDK和Halcon实现图像的线性灰度变换Emphasize 算法增强(C#)

Baumer工业相机堡盟工业相机如何联合BGAPISDK和Halcon实现图像的线性灰度变换算法增强&#xff08;C#&#xff09; Baumer工业相机Baumer工业相机使用图像算法增加图像的技术背景Baumer工业相机通过BGAPI SDK联合Halcon使用Emphasize 线性灰度变换增强算法1.引用合适的类文件2.…