保证接口幂等性(token机制)

现在继续讲一讲保证接口的幂等性——使用token机制,并编写代码实现!

1. 概念

        Token机制是实现接口幂等性的一种常见策略,尤其是在处理如订单创建、支付确认等敏感操作时,确保即使用户因网络延迟、误操作等原因重复提交请求,系统也能保证结果的一致性,避免产生多次订单、多次扣款等问题。

2. Token机制的实现原理

1. 生成Token:在客户端首次发起请求之前,服务端为该特定操作生成一个唯一的Token(通常是一个随机字符串)。这个Token需要具备不可预测性和时效性,以确保安全性。
2. 传递Token:生成的Token随初始请求一起发送给客户端,客户端在后续的相同操作请求中携带此Token。
3. 存储Token:服务端接收到Token后,将其存储在一个全局可访问的地方,如Redis数据库,键值对形式存储,键通常是Token值,值可以是操作标识或者过期时间等元数据。
4. 验证Token:当客户端再次发起相同的请求时,必须包含第一次请求时获得的Token。服务端接收请求后,首先检查提供的Token是否有效(比如是否存在于Redis中,是否过期)。
5. 执行操作与删除Token:如果Token有效,服务端执行请求对应的业务逻辑一次,并在操作完成后从存储中移除或标记Token为已使用,防止同一Token被再次使用。
6. 幂等性保障:如果因为网络重传或其他原因导致相同的请求再次到达,由于Token已经被验证并处理过,服务端将识别出重复请求,并直接返回第一次操作的结果或告知请求已经处理,从而保证接口的幂等性。

具体时序历程图如下:

3. 代码实现

1.创建一个spring boot项目来实现吧,引入依赖

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

    </dependencies>

2. 编写RedisService.java,实现Redis保存Token、删除Token以及判断是否存在等操作。

package org.example;

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.concurrent.TimeUnit;

/**
 * @Author: stukk
 * @Description: Redis业务方法类
 * @DateTime: 2024-04-29 16:13
 **/
@Service
public class RedisService {

    @Resource
    private RedisTemplate redisTemplate;

    public Boolean set(String key, Object value, Long times) {
        Boolean result = false;
        try {
            ValueOperations ops = redisTemplate.opsForValue();
            ops.set(key,value);
            redisTemplate.expire(key,times, TimeUnit.SECONDS);
            result = true;
        }catch (Exception e){
            e.printStackTrace();
        }
        return result;
    }

    public Boolean exists(String key) {
        return redisTemplate.hasKey(key);
    }

    public Boolean remove(String key) {
        if(exists(key)){
            return redisTemplate.delete(key);
        }
        return false;
    }


}

3. 编写TokenService.java,创建Token还有检查请求头是否携带token

package org.example;

import io.netty.util.internal.StringUtil;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.util.UUID;

/**
 * @Author: stukk
 * @Description: Token 业务类
 * @DateTime: 2024-04-29 16:31
 **/
@Service
public class TokenService {


    @Resource
    private RedisService redisService;

    /**
     * 创建Token
     * @return
     */
    public String createToken(){
        String uuid = UUID.randomUUID().toString();
        redisService.set(uuid,uuid,10000L);
        return uuid;
    }

    /**
     * 校验Token
     * @param request
     * @return
     */
    public Boolean checkToken(HttpServletRequest request){
        String token = request.getHeader("token");
        if(StringUtil.isNullOrEmpty(token)){
            throw new RuntimeException("token不存在");
        }
        if(!redisService.exists(token)){
            throw new RuntimeException("重复的操作");
        }
        Boolean remove = redisService.remove(token);
        if(!remove){
            throw new RuntimeException("重复的操作");
        }
        return true;
    }

}

4. 写一个注解Idempotence,用来在AOP中拦截请求进行token的校验。

package org.example.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @Author: stukk
 * @Description:
 * @DateTime: 2024-04-29 17:19
 **/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Idempotence {
    String value() default "";
}
package org.example.aop;

import org.example.servicve.TokenService;
import org.example.annotation.Idempotence;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @Author: stukk
 * @Description: 定义IdempotenceInterceptor拦截器
 * @DateTime: 2024-04-29 17:23
 **/
@Component
public class IdempotenceInterceptor implements HandlerInterceptor {

    @Resource
    private TokenService tokenService;

    /*
     * @Description: 拦截器
     * @Param: [request, response, handler]
     * @return: boolean
     **/
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(!(handler instanceof HandlerMethod)){
            return true;
        }
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Idempotence idempotence = handlerMethod.getMethodAnnotation(Idempotence.class); //获取注解
        if(idempotence != null){
            return tokenService.checkToken(request);
        }
        return true;
    }

}

注册拦截器

package org.example.config;

import org.example.aop.IdempotenceInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

/**
 * @Author: stukk
 * @Description: 注册拦截器
 * @DateTime: 2024-04-29 18:17
 **/
@Configuration
public class IdempotenceConfig implements WebMvcConfigurer {

    @Resource
    private IdempotenceInterceptor idempotenceInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(idempotenceInterceptor)
                .addPathPatterns("/**");
    }
}

5. 编写接口测试

先编写一个简单的全局异常处理器

package org.example.aop;

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;


/**
 * 全局异常处理器
 *
 * @author stukk
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(RuntimeException.class)
    public Object runtimeExceptionHandler(RuntimeException e) {
        return e.getMessage();
    }
}

测试接口如下: 

package org.example.controller;

import org.example.TokenService;
import org.example.annotation.Idempotence;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * @Author: stukk
 * @Description:
 * @DateTime: 2024-04-29 17:47
 **/
@RestController
public class TestController {

    @Resource
    private TokenService tokenService;

    @GetMapping("createToken")
    public String createToken() {
        return tokenService.createToken();
    }

    @GetMapping("test1")
    public String test1() {
        return "test1";
    }

    @GetMapping("test2")
    @Idempotence
    public String test2() {
        return "test2";
    }

}

4. 接口测试

先发送创建Token请求

没有设置token校验的接口,可以重复请求

 设置了token校验的接口,我们来试一试:

(没配置token请求头,就会报错说token不存在)

(带上token)

(第一次请求得到响应数据)

(第二次提示重复操作)

到此,我们完成了整个token机制保证接口幂等性的代码开发,在订单创建、支付的时候很适合用!结束!

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

【TDengine】mac m1解决no taos in java.library.path

前言 使用macos搭建springbootmybatisplus&#xff0c;通过mqtt将数据更新到tdenigne 3.2.3&#xff0c;数据源使用远程服务器的tdengine。 问题 启动时报错&#xff1a; Caused by: java.lang.UnsatisfiedLinkError: no taos in java.library.path 以下是官方文档 打开本…

动手学深度学习——矩阵

1. 基本概念 1.1 标量 标量由只有一个元素的张量表示。 所以标量计算与程度开发中的普通变量计算没有差异。 import torchx torch.tensor(3.0) y torch.tensor(2.0)x y, x * y, x / y, x**y(tensor(5.), tensor(6.), tensor(1.5000), tensor(9.))1.2 向量 向量泛化自标量…

Hbase学习笔记

Hbase是什么 HBase是一个高可靠、高性能、面向列、可伸缩的分布式存储系统。它利用Hadoop HDFS作为其文件存储系统,并提供实时的读写的数据库系统。HBase的设计思想来源于Google的BigTable论文,是Apache的Hadoop项目的子项目。它适合于存储大表数据,并可以达到实时级别。HB…

部署YUM仓库及NFS共享服务

YUN仓库服务 YUM概述 基于RPM包构建的软件更新机制 可以自动解决依赖关系 所有软件包由YUM集中的软件仓库提供 yum软件仓库的常用类型 本地源仓库&#xff1a;baserulfile:// 在线源仓库&#xff1a;baserulhttp:// 或 https:// ftp源仓库&#xff1a;baserulftp:// RPM…

【Java那些事】关于前端收到后端返回的时间格式“2024-04-28T14:48:41“非想要的格式

问题&#xff1a; 后端操作后返回时间格式是"2024-04-28T14:48:41" 而我们想要的是&#xff1a;"2024-04-28 14:48:41", 两个解决方法&#xff1a; 方法一&#xff1a;使用 JsonFormat注解 Data AllArgsConstructor NoArgsConstructor public class Use…

代码随想录算法训练营第五十一天| LeetCode309.最佳买卖股票时机含冷冻期、714.买卖股票的最佳时机含手续费

一、LeetCode309.最佳买卖股票时机含冷冻期 题目链接/文章讲解/视频讲解&#xff1a;https://programmercarl.com/0309.%E6%9C%80%E4%BD%B3%E4%B9%B0%E5%8D%96%E8%82%A1%E7%A5%A8%E6%97%B6%E6%9C%BA%E5%90%AB%E5%86%B7%E5%86%BB%E6%9C%9F.html 状态&#xff1a;已解决 1.思路 …

实验一: 设备密码配置与远程管理

1.实验环境 用路由器和交换机搭建实验环境 2.需求描述 实现管理员主机对交换机和路由器的远程管理 设备上配置的密码都要被加密 3.推荐步骤 对路由器配置的步骤如下&#xff1a; 实现路由器和PC的连通性配置VTY密码和特权模式密码在PC上Telnet 到路由器。 对交换机配置的…

03-JAVA设计模式-观察者模式

观察者模式 什么是观察者模式 Java中的观察者模式是一种常见的设计模式&#xff0c;它允许对象&#xff08;观察者&#xff09;订阅另一个对象&#xff08;被观察者&#xff09;的状态变化&#xff0c;并在状态变化时自动得到通知。 核心&#xff1a; 观察者模式主要用于1&a…

HTML学习笔记(二)

1.HTML图像 图像标签&#xff08;<img>)和源属性&#xff08;src&#xff09; HTML中&#xff0c;图像由<img>标签来定义&#xff0c;<img>是空标签&#xff0c;只包含属性&#xff0c;没有闭合标签。在页面上显示图像需要使用源属性&#xff08;src),src是指…

Docker基本操作 Linux里边操作

docker镜像操作命令: docker images:查看所有镜像; docker rmi:删除镜像 后边可以跟镜像的名字或者id指定要删除的镜像&#xff1b; docker pull:拉取镜像&#xff1b; docker push:推送镜像到服务&#xff1b; docker save :打包镜像 后边有用法; docker load:加载镜像&…

前端JS必用工具【js-tool-big-box】,字符串反转,驼峰转换以及版本号对比

这一小节&#xff0c;我们针对前端工具包&#xff08;npm&#xff09;js-tool-big-box的使用做一些讲解&#xff0c;主要是针对字符串反转&#xff0c;aa-bb-cc转驼峰&#xff0c;以及版本号对比的内容 目录 1 安装和引入 2 字符串反转 3 带有横岗的转驼峰 3.1 转小驼峰 3…

docker-compose编排集成工具,

一、引言 我们知道使用一个 Dockerfile 模板文件可以定义一个单独的应用容器&#xff0c;如果需要定义多个容器就需要服务编排。服务编排有很多种技术方案&#xff0c;今天给大家介绍 Docker 官方产品 Docker-Compose Dockerfile 可以定义一个单独的应用容器&#xff1…

linux,从零安装mysql 8.0.30 ,并且更新至mysql 8.0.36

前言&#xff1a; 系统使用的CentOS 7&#xff0c;系统默认最小安装。 一、基础配置 配置虚拟机IP&#xff0c;需要更改的内容&#xff0c;如下红框中 修改之后 至此&#xff0c;基础配置完成。注意&#xff1a;此处虚拟机网络适配器使用的是&#xff1a;桥接模式 二、软件…

【问题实操】银河麒麟高级服务器操作系统实例,CPU软锁报错触发宕机

1.服务器环境以及配置 处理器&#xff1a; Kunpeng 920 内存&#xff1a; 256G DDR4 整机类型/架构&#xff1a; TaiShan 200 (Model 2280) 内核版本 4.19.90-23.8.v2101.ky10.aarch64 2.问题现象描述 两台搭载麒麟v10 sp1的机器均在系统CPU软锁报错时&#xff0c;触…

Springboot+mybatis升级版(Postman测试)

一、项目结构 1.导入依赖 <?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.apach…

高级数据结构与算法期中测试题

一、判断题 1、In dynamic programming algorithms, some results of subproblems have to be stored even they do not compose the optimal solution of a larger problem. T F 解析:T。在动态规划算法中,必须存储子问题的某些结果,因为他们可能需要用来…

区块链技术:NFG元宇宙电商模式

大家好&#xff0c;我是微三云周丽 随着互联网技术的迅猛发展&#xff0c;电子商务行业逐渐崛起为现代经济的重要支柱。而在这一浪潮中&#xff0c;元宇宙电商以其独特的商业模式和巨大的发展潜力&#xff0c;成为行业的新宠。其中&#xff0c;NFG作为元宇宙电商模式的代表&am…

【4110】基于小程序实现的名片管理系统

作者主页&#xff1a;Java码库 主营内容&#xff1a;SpringBoot、Vue、SSM、HLMT、Jsp、PHP、Nodejs、Python、爬虫、数据可视化、小程序、安卓app等设计与开发。 收藏点赞不迷路 关注作者有好处 文末获取源码 技术选型 【后端】&#xff1a;Java 【框架】&#xff1a;spring…

std::ignore的定义

有个全局变量。 把一个变量赋值给ignore&#xff0c;还行&#xff0c;没有拷贝等动作&#xff0c;不用担心性能损失。 VS2017D:\DevTools\VS2017\VC\Tools\MSVC\14.16.27023\include\tuple// STRUCT _Ignore struct _Ignore{ // struct that ignores assignmentstemplate<…

如何利用 GPT 自我提高写作能力

GPT革命&#xff1a;如何用AI技术重新定义写作 介绍 在我们的数字时代&#xff0c;了解自我提高写作的必要性至关重要。 随着 GPT 的兴起&#xff0c;我们正在见证书写的变革时代。 这篇扩展文章深入探讨了 GPT 如何显着提高写作技能。 拥抱未来&#xff1a; 人工智能时代的写…