接口幂等性校验（使用拦截器+自定义注解+redis解决问题）

最新推荐文章于 2024-05-03 17:05:11 发布
最新推荐文章于 2024-05-03 17:05:11 发布
阅读量1.5k 收藏 4
点赞数
文章标签： redis java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42926855/article/details/122911482
版权

概念：

幂等性，通俗的说就是一个接口，多次发起同一个请求，必须保证操作只能执行一次

比如：

  • 订单接口，不能多次创建订单
  • 支付接口，重复支付同一笔订单只能扣一次钱
  • 支付宝回调接口，可能会多次回调，必须处理重复回调
  • 普通表单提交接口，因为网络超时等原因多次点击提交，只能成功一次

等等…

常见解决方案有：

  1. 唯一索引 – 防止新增脏数据

  2. token机制 – 防止页面重复提交

  3. 悲观锁 – 获取数据的时候加锁(锁表或锁行)

  4. 乐观锁 – 基于版本号version实现，在更新数据那一刻校验数据

  5. 分布式锁 – redis(jedis、redisson)或zookeeper实现

    等等

流程：

  1. 当页面加载的时候通过接口获取token（UUID）
  2. 当访问接口时，会经过拦截器，如果发现该接口有自定义的幂等检查注解，说明该接口需要验证幂等性
  3. 查看请求头里是否有key=token的值，如果有，并且删除成功，那么接口就访问成功，否则为重复提交
  4. 如果发现该接口没有自定义的幂等检查注解，则直接放行

代码

自定义注解 MidengCheck
  • 自定义一个注解，定义此注解的主要目的是把它添加在需要实现幂等的方法上，凡是某个方法注解了它，都会实现自动幂等。
  • 后台利用反射如果扫描到这个注解，就会处理这个方法实现自动幂等
  • 使用元注解ElementType.METHOD表示它只能放在方法上，RetentionPolicy.RUNTIME表示它在运行时。
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义注解做接口的幂等校验 annotation
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MidengCheck {
}
service层 redis工具类 RedisService
/**
 * Redis工具服务类
 */
@Component
public class RedisService {

    @Autowired
    private RedisTemplate redisTemplate;

    /**
     * 写入缓存
     * @param key
     * @param value
     * @return
     */
    public boolean set(final String key, Object value) {
        boolean result = false;
        try {
            ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
            operations.set(key, value);
            result = true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return result;
    }


    /**
     * 写入缓存设置时效时间
     * @param key
     * @param value
     * @param expireTime
     * @return
     */
    public boolean setEx(final String key, Object value, Long expireTime) {
        boolean result = false;
        try {
            ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
            operations.set(key, value);
            redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
            result = true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return result;
    }


    /**
     * 根据key判断缓存中是否有对应的value
     * @param key
     * @return
     */
    public boolean exists(final String key) {
        return redisTemplate.hasKey(key);
    }

    /**
     * 根据key读取缓存
     * @param key
     * @return
     */
    public Object get(final String key) {
        Object result = null;
        ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
        result = operations.get(key);
        return result;
    }

    /**
     * 根据key删除对应的value
     * @param key
     * @return
     */
    public boolean remove(final String key) {
        if (exists(key)) {
            Boolean delete = redisTemplate.delete(key);
            return delete;
        }
        return false;
    }
}
token创建和检验 TokenService
  1. token引用了redis服务，创建token采用随机算法工具类生成随机uuid字符串，然后放入到redis中(为了防止数据的冗余保留，这里设置过期时间为10000秒，具体可视业务而定)，如果放入成功，最后返回这个token值。
  2. checkToken方法就是从header中获取token到值，如若不存在，直接抛出异常（这个异常信息可以被拦截器捕捉到，然后返回给前端），如存在，则查询Redis看是否存在，不存在也抛出异常，Redis存在，那么token校验通过。

/**
 * 获取和校验Token
 */
@Component
public class TokenService {

    @Autowired
    private RedisService redisService;

    //获取token
    public String getToken() {
        String uuid = UUID.randomUUID().toString();
        //存入Redis的key添加一个统一前缀字符串
        String token = "mideng_check_prefix:" + uuid;
        //存入Redis
        boolean result = redisService.setEx(token, uuid, 10000L);
        if(result){
            return token;
        }
        return null;
    }

    public boolean checkToken(HttpServletRequest request) throws Exception {
        //从请求头中获取token的值
        String token = request.getHeader("token");
        if (StringUtils.isEmpty(token)) {
            //请求头中不存在token，那就是非法请求，直接抛出异常
            throw new Exception("Illegal request");
        }
        if (!redisService.exists(token)) {
            //请求头中存在token，但是Redis中不存在的话，也抛出异常
            throw new Exception("token error");
        }
        //代码执行到这里，说明token校验成功了，那么就需要删除Redis中的值
        boolean remove = redisService.remove(token);
        if (!remove) {
            //删除失败了
            throw new Exception("token delete error");
        }
        return true;
    }
}

拦截器的配置

web配置类，实现WebMvcConfigurationSupport，主要作用就是添加CheckIdempotentInterceptor拦截器到配置类中，这样我们写的拦截器才能生效，注意使用@Configuration注解，这样在容器启动是时候就可以添加进入context中

import org.colin.interceptor.CheckIdempotentInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import javax.annotation.Resource;

/**
 * @ClassName: WebConfiguration
 * @description: 统一拦截器配置类
 * @Version 1.1.0.1
 */
@Configuration
public class WebConfiguration extends WebMvcConfigurationSupport {

    @Resource
    private CheckIdempotentInterceptor checkIdempotentInterceptor;

    //添加拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //checkIdempotentInterceptor拦截器只对 /saveUser 请求拦截
        registry.addInterceptor(checkIdempotentInterceptor).addPathPatterns("/saveUser");
        super.addInterceptors(registry);
    }
}

下面我们就开始写拦截处理器，主要的功能是拦截到被CheckIdempotent注解的方法，然后调用tokenService的checkToken()方法校验token是否正确，如果捕捉到异常就将异常信息返回给前端。

/**
 * 幂等校验的拦截器
 */
@Component
public class MidengCheckInterceptor implements HandlerInterceptor {

    @Autowired
    private TokenService tokenService;

    /**
     * 前置处理
     * 该方法将在请求处理之前进行调用
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        //handler instanceof HandlerMethod：作用：判断请求是否是请求的方法（有些请求是请求的静态资源）
        if (!(handler instanceof HandlerMethod)) {
            //直接放行：放行非方法的请求
            return true;
        }
        //代码运行到此处，说明请求的资源就是方法了
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        //handlerMethod.getMethod()   获取到请求的方法对象
        Method method = handlerMethod.getMethod();

        //获取请求方法上面的 MidengCheck 注解
        MidengCheck methodAnnotation = method.getAnnotation(MidengCheck.class);
        if (methodAnnotation != null) {
            //进到此处，表示请求的方法上面打了 MidengCheck 注解
            //此时我就需要做接口幂等性校验了
            try {
                return tokenService.checkToken(request);
            }catch (Exception ex){
                writeJson(response, ex.getMessage());
                return false;
            }
        }
        //必须返回true，否则会拦截掉所有请求，不会执行controller方法中的内容了
        return true;
    }

    /**
     * 返回提示信息给前端
     */
    private void writeJson(HttpServletResponse response, String message){
        response.reset();
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=utf-8");
        response.setStatus(404);
        ServletOutputStream outputStream = null;
        try {
            outputStream = response.getOutputStream();
            outputStream.print(message);
            outputStream.flush();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (outputStream != null){
                try {
                    outputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}
启动类
@SpringBootApplication
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class);
    }
}
yml配置文件
server:
  port: 1010
spring:
  #redis配置
  redis:
    #使用第几个数据库（0-15）
    database: 0
    host: 127.0.0.1
    port: 6379
    #password: 123456 #密码
    timeout: 5000
测试类
@RestController
@Slf4j
public class TestController {

    @Autowired
    private TokenService tokenService;

    //获取token值
    @GetMapping("/getToken")
    public String getToken(){
        return tokenService.getToken();
    }

    //保存用户信息
    @PostMapping("/saveUser")
    @MidengCheck
    public String saveUser(){
        //我们希望的情况是：打印一次
        log.info("----------------------------保存用户信息成功----------------------------");
        //保存用户信息的业务逻辑代码-省略....
        return "add user success";
    }

}
测试

1.浏览器输入 http://localhost:1100/getToken 获取token：mideng_check_prefix:7c29f136-9b39-4786-a15d-509428681364
2.使用Apache JMeter 测压工具 请求一百次
发现只会成功一次
在这里插入图片描述

总结：

  1. 编写自定义注解，不需要参数
  2. 编写拦截器，作用：做接口幂等性校验
  • 不是请求方法的请求，全部放行
  • 请求方法的这些请求中，需要做过滤，过滤出包含自定义注解的方法，其余的方法全部放行
  • 获取请求头中的token值，然后做非空判断、redis是否存在判断，根据该token删除Redis的值：如果删除成功，放行，如果删除失败，那么就抛出异常，不放行。
逍遥派~
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
常见幂等测试方法
laihuahua66的博客
01-31 2377
幂等测试、软件测试、自动化测试、验收测试
接口幂等性校验，太优雅了(经典)
gb4215287的博客
10-15 690
接口幂等性校验，太优雅了
2024年网安最新【安全】Java幂等性校验解决重复点击（6种实现方式）_幂等校验
最新发布
2401_84239625的博客
05-03 993
幂等是一个数学与计算机科学概念，英文 idempotent [aɪˈdempətənt]。。比如 求绝对值 的函数，就是幂等的，abs(x) = abs(abs(x))。计算机科学中，幂等表示一次和多次请求某一个资源应该具有同样的作用。满足幂等条件的性能叫做幂等性。
接口幂等性校验，太优雅了
小学生波波
08-01 4091
带你彻底搞懂接口幂等性校验
接口的幂等性判断及其主流解决方案
weixin_51066423的博客
02-02 559
防重复设计（Idempotent Design）的目的是保证一次请求的执行只对系统产生一次影响，即使在网络错误或者其他异常情况下多次请求产生了多次重复请求，对系统的影响也仅仅是一次。这种方式的优点是简单易用，不需要额外的数据库支持，但是在服务端的token存储机制不当的情况下会导致token被重复使用或者token丢失等问题。因此，使用建防重表解决接口幂等性的过程需要结合业务场景，综合考虑各种因素，再进行适当的调整和优化。接口的幂等性判断及其解决方案
接口幂等性校验
Java笔记虾
03-12 801
点击关注公众号，利用碎片时间学习一、概念幂等（idempotent、idempotence）是一个数学与计算机学概念，常见于抽象代数中。在编程中，一个幂等操作的特点是其任意多次执行所产生的...
SSM+Shiro+Redis实现项目的权限管理
05-06
3. 权限校验：在Controller层使用Shiro的注解如`@RequiresPermissions`，`@RequiresRoles`进行权限检查，或者在Service/DAO层使用Shiro API进行权限判断。 4. 分布式Session管理：集成Redis，配置`RedisSessionDAO`...
shiro中session的共享问题与完成前后端权限的校验
07-11
3. 定义过滤器链，配置需要拦截的URL及其对应的过滤器。 4. 在Spring Boot的启动类上添加注解@EnableShiro，启用Shiro配置。 Vue作为前端框架，可以通过Axios等库发送带Token的请求。同时，前端也可以根据Shiro返回...
基于springboot的权限验证+源代码+文档说明
11-29
* 如果需要使用`redis`存储方案，参考: [四、自定义缓存方案](#jump) ；或请直接使用`1.0.5`版本（有一些遗留`bug`） ## 一、使用前需要的准备 * maven中央仓库地址 [其他方式集成]...
shiro+maven+sringMVC+mybatis
10-17
这个"Shiro + Maven + SpringMVC + MyBatis"的实例，作为一个"demo"，通常包含了基本的配置文件（如pom.xml、web.xml、shiro.ini、applicationContext.xml等），示例代码（如控制器、服务、DAO等），以及可能的测试...
一个SpringBoot基础项目框架
03-05
自定义注解+拦截器实现基于RBAC接口权限校验（配套文档：https://blog.csdn.net/wujiangbo520/article/details/122057616） 全局异常处理 接口统一结果返回 一键生成数据库设计文档 大批量数据插入数据库测试 根据...
java中如何保证接口的幂等性
牛肉胡辣汤
08-15 1279
​中，表示该请求已经被处理过。请注意，上述示例只是一个简单的示范，实际的幂等性实现可能需要更复杂的逻辑和数据结构来满足具体的业务需求。​中，如果存在则返回一个表示请求已经处理过的响应。如果不存在，则继续处理请求，并将标识符添加到​。​来保存已经处理过的请求的唯一标识符。在处理每个请求之前，我们首先检查该标识符是否存在于​。在上述示例中，我们使用了一个​。
Spring Boot+Redis+拦截器+自定义Annotation实现接口幂等
xiao2431的专栏
09-07 380
业务开发中，经常会遇到重复提交的情况，无论是由于网络问题无法收到请求结果而重新发起请求，或是前端的操作抖动而造成重复提交情况。C端用户在APP上连续点击了多次提交订单，后台应该只产生一个订单；（生成多个订单那岂不是乱了套了）向支付宝发起支付请求，由于网络问题或系统BUG重发，支付宝应该只扣一次钱。(扣多次钱那岂不是也乱了套了)很显然，声明幂等的服务认为，外部调用者会存在多次调用的情况，为了防止外部多次调用对系统数据状态的发生多次改变，将服务设计成幂等。提示：以下是本篇文章正文内容，下面案例可供参考。
接口幂等测试
weixin_43500974的博客
03-03 423
接口测试幂等
面试官：如何实现幂等性校验？
这个时代，作为程序员可能要学习小程序
11-01 817
点击上方关注 “终端研发部”设为“星标”，和你一起掌握更多数据库知识作者 |wangzaiplus来源 | https://www.jianshu.com/p/6189275403ed一、概念幂等性, 通俗的说就是一个接口, 多次发起同一个请求, 必须保证操作只能执行一次比如:订单接口, 不能多次创建订单支付接口, 重复支付同一笔订单只能扣一次钱支付宝回调接口, 可能会多次回调, 必须处理重复回...
保证接口幂等性的9种方法
weixin_39158966的博客
03-27 761
首先看看幂等性的概念：。调用接口发生异常并且重复尝试时，总是会造成系统所无法承受的损失，所以必须阻止这种现象的发生。比如下面这些情况，如果没有实现接口幂等性会有很严重的后果：支付接口，重复支付会导致多次扣钱；订单接口，同一个订单可能会多次创建。
接口幂等性最佳实践--redis+注解
Maybe_9527的博客
09-19 509
redis+注解实现接口幂等性
接口幂等性有了解过吗？如何测试？
m0_53396342的博客
04-16 924
软件测试面试题：接口幂等性有了解过吗？如何测试？
如何保证接口幂等性（10种方案必有一个合适你）
weixin_44379605的博客
09-27 2587
接口幂等性就是说用户使用相同的参数请求同一个接口无论是一次还是多次都应该是一样的。不会因为多次的点击产生不同效果。举个栗子：一个用户在手机APP上提200块钱，然后一不小心点击了两次，那么就应该只提取出200块钱，不应该出来400（当然，真实场景下取钱操作是一个复杂事务，不可能一个接口点击就出来了）。对于这种场景下，即使用户点了两次也应该只取出一次的钱，就是接口幂等性。
Spring Boot+Redis+拦截器+自定义Annotation如何实现接口自动幂等.docx
11-24
Spring Boot+Redis+拦截器+自定义Annotation如何实现接口自动幂等.docx

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值