Spring Boot + Redis 实现接口幂等性 | 分布式开发必知！

2024-09-02 10:38
文章标签 java 实现 接口 开发 redis spring 分布式 boot 必知

本文主要是介绍Spring Boot + Redis 实现接口幂等性 | 分布式开发必知！，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

点击上方“朱小厮的博客”，选择“设为星标”

回复”1024“获取独家整理的学习资料

640?wx_fmt=jpeg

来源：http://tinyurl.com/y5k2sx5t

一、概念

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

  • 订单接口, 不能多次创建订单

  • 支付接口, 重复支付同一笔订单只能扣一次钱

  • 支付宝回调接口, 可能会多次回调, 必须处理重复回调

  • 普通表单提交接口, 因为网络超时等原因多次点击提交, 只能成功一次 等等

二、常见解决方案

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

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

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

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

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

  6. 状态机 -- 状态变更, 更新数据时判断状态

三、本文实现

本文采用第2种方式实现, 即通过redis + token机制实现接口幂等性校验

四、实现思路

为需要保证幂等性的每一次请求创建一个唯一标识 token, 先获取 token, 并将此 token存入redis, 请求接口时, 将此 token放到header或者作为请求参数请求接口, 后端接口判断redis中是否存在此 token:

  • 如果存在, 正常处理业务逻辑, 并从redis中删除此 token, 那么, 如果是重复请求, 由于 token已被删除, 则不能通过校验, 返回 请勿重复操作提示

  • 如果不存在, 说明参数不合法或者是重复请求, 返回提示即可

五、项目简介

  • springboot

  • redis

  • @ApiIdempotent注解 + 拦截器对请求进行拦截

  • @ControllerAdvice全局异常处理

  • 压测工具: jmeter

说明:

  • 本文重点介绍幂等性核心实现, 关于springboot如何集成redis、ServerResponse、ResponseCode等细枝末节不在本文讨论范围之内, 有兴趣的小伙伴可以查看作者的Github项目: https://github.com/wangzaiplus/springboot/tree/wxw

六、代码实现

pom

        <!-- Redis-Jedis -->	<dependency>	<groupId>redis.clients</groupId>	<artifactId>jedis</artifactId>	<version>2.9.0</version>	</dependency>	<!--lombok 本文用到@Slf4j注解, 也可不引用, 自定义log即可-->	<dependency>	<groupId>org.projectlombok</groupId>	<artifactId>lombok</artifactId>	<version>1.16.10</version>	</dependency>

JedisUtil

package com.wangzaiplus.test.util;	
import lombok.extern.slf4j.Slf4j;	
import org.springframework.beans.factory.annotation.Autowired;	
import org.springframework.stereotype.Component;	
import redis.clients.jedis.Jedis;	
import redis.clients.jedis.JedisPool;	
@Component	
@Slf4j	
public class JedisUtil {	@Autowired	private JedisPool jedisPool;	private Jedis getJedis() {	return jedisPool.getResource();	}	/**	* 设值	*	* @param key	* @param value	* @return	*/	public String set(String key, String value) {	Jedis jedis = null;	try {	jedis = getJedis();	return jedis.set(key, value);	} catch (Exception e) {	log.error("set key:{} value:{} error", key, value, e);	return null;	} finally {	close(jedis);	}	}	/**	* 设值	*	* @param key	* @param value	* @param expireTime 过期时间, 单位: s	* @return	*/	public String set(String key, String value, int expireTime) {	Jedis jedis = null;	try {	jedis = getJedis();	return jedis.setex(key, expireTime, value);	} catch (Exception e) {	log.error("set key:{} value:{} expireTime:{} error", key, value, expireTime, e);	return null;	} finally {	close(jedis);	}	}	/**	* 取值	*	* @param key	* @return	*/	public String get(String key) {	Jedis jedis = null;	try {	jedis = getJedis();	return jedis.get(key);	} catch (Exception e) {	log.error("get key:{} error", key, e);	return null;	} finally {	close(jedis);	}	}	/**	* 删除key	*	* @param key	* @return	*/	public Long del(String key) {	Jedis jedis = null;	try {	jedis = getJedis();	return jedis.del(key.getBytes());	} catch (Exception e) {	log.error("del key:{} error", key, e);	return null;	} finally {	close(jedis);	}	}	/**	* 判断key是否存在	*	* @param key	* @return	*/	public Boolean exists(String key) {	Jedis jedis = null;	try {	jedis = getJedis();	return jedis.exists(key.getBytes());	} catch (Exception e) {	log.error("exists key:{} error", key, e);	return null;	} finally {	close(jedis);	}	}	/**	* 设值key过期时间	*	* @param key	* @param expireTime 过期时间, 单位: s	* @return	*/	public Long expire(String key, int expireTime) {	Jedis jedis = null;	try {	jedis = getJedis();	return jedis.expire(key.getBytes(), expireTime);	} catch (Exception e) {	log.error("expire key:{} error", key, e);	return null;	} finally {	close(jedis);	}	}	/**	* 获取剩余时间	*	* @param key	* @return	*/	public Long ttl(String key) {	Jedis jedis = null;	try {	jedis = getJedis();	return jedis.ttl(key);	} catch (Exception e) {	log.error("ttl key:{} error", key, e);	return null;	} finally {	close(jedis);	}	}	private void close(Jedis jedis) {	if (null != jedis) {	jedis.close();	}	}	
}

自定义注解 @ApiIdempotent

package com.wangzaiplus.test.annotation;	
import java.lang.annotation.ElementType;	
import java.lang.annotation.Retention;	
import java.lang.annotation.RetentionPolicy;	
import java.lang.annotation.Target;	
/**	* 在需要保证 接口幂等性 的Controller的方法上使用此注解	*/	
@Target({ElementType.METHOD})	
@Retention(RetentionPolicy.RUNTIME)	
public @interface ApiIdempotent {	
}

  1. ApiIdempotentInterceptor拦截器

package com.wangzaiplus.test.interceptor;	
import com.wangzaiplus.test.annotation.ApiIdempotent;	
import com.wangzaiplus.test.service.TokenService;	
import org.springframework.beans.factory.annotation.Autowired;	
import org.springframework.web.method.HandlerMethod;	
import org.springframework.web.servlet.HandlerInterceptor;	
import org.springframework.web.servlet.ModelAndView;	
import javax.servlet.http.HttpServletRequest;	
import javax.servlet.http.HttpServletResponse;	
import java.lang.reflect.Method;	
/**	* 接口幂等性拦截器	*/	
public class ApiIdempotentInterceptor implements HandlerInterceptor {	@Autowired	private TokenService tokenService;	@Override	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {	if (!(handler instanceof HandlerMethod)) {	return true;	}	HandlerMethod handlerMethod = (HandlerMethod) handler;	Method method = handlerMethod.getMethod();	ApiIdempotent methodAnnotation = method.getAnnotation(ApiIdempotent.class);	if (methodAnnotation != null) {	check(request);// 幂等性校验, 校验通过则放行, 校验失败则抛出异常, 并通过统一异常处理返回友好提示	}	return true;	}	private void check(HttpServletRequest request) {	tokenService.checkToken(request);	}	@Override	public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {	}	@Override	public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {	}	
}

TokenServiceImpl

package com.wangzaiplus.test.service.impl;	
import com.wangzaiplus.test.common.Constant;	
import com.wangzaiplus.test.common.ResponseCode;	
import com.wangzaiplus.test.common.ServerResponse;	
import com.wangzaiplus.test.exception.ServiceException;	
import com.wangzaiplus.test.service.TokenService;	
import com.wangzaiplus.test.util.JedisUtil;	
import com.wangzaiplus.test.util.RandomUtil;	
import lombok.extern.slf4j.Slf4j;	
import org.apache.commons.lang3.StringUtils;	
import org.apache.commons.lang3.text.StrBuilder;	
import org.springframework.beans.factory.annotation.Autowired;	
import org.springframework.stereotype.Service;	
import javax.servlet.http.HttpServletRequest;	
@Service	
public class TokenServiceImpl implements TokenService {	private static final String TOKEN_NAME = "token";	@Autowired	private JedisUtil jedisUtil;	@Override	public ServerResponse createToken() {	String str = RandomUtil.UUID32();	StrBuilder token = new StrBuilder();	token.append(Constant.Redis.TOKEN_PREFIX).append(str);	jedisUtil.set(token.toString(), token.toString(), Constant.Redis.EXPIRE_TIME_MINUTE);	return ServerResponse.success(token.toString());	}	@Override	public void checkToken(HttpServletRequest request) {	String token = request.getHeader(TOKEN_NAME);	if (StringUtils.isBlank(token)) {// header中不存在token	token = request.getParameter(TOKEN_NAME);	if (StringUtils.isBlank(token)) {// parameter中也不存在token	throw new ServiceException(ResponseCode.ILLEGAL_ARGUMENT.getMsg());	}	}	if (!jedisUtil.exists(token)) {	throw new ServiceException(ResponseCode.REPETITIVE_OPERATION.getMsg());	}	Long del = jedisUtil.del(token);	if (del <= 0) {	throw new ServiceException(ResponseCode.REPETITIVE_OPERATION.getMsg());	}	}	
}

TestApplication

package com.wangzaiplus.test;	
import com.wangzaiplus.test.interceptor.ApiIdempotentInterceptor;	
import org.mybatis.spring.annotation.MapperScan;	
import org.springframework.boot.SpringApplication;	
import org.springframework.boot.autoconfigure.SpringBootApplication;	
import org.springframework.context.annotation.Bean;	
import org.springframework.web.cors.CorsConfiguration;	
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;	
import org.springframework.web.filter.CorsFilter;	
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;	
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;	
@SpringBootApplication	
@MapperScan("com.wangzaiplus.test.mapper")	
public class TestApplication  extends WebMvcConfigurerAdapter {	public static void main(String[] args) {	SpringApplication.run(TestApplication.class, args);	}	/**	* 跨域	* @return	*/	@Bean	public CorsFilter corsFilter() {	final UrlBasedCorsConfigurationSource urlBasedCorsConfigurationSource = new UrlBasedCorsConfigurationSource();	final CorsConfiguration corsConfiguration = new CorsConfiguration();	corsConfiguration.setAllowCredentials(true);	corsConfiguration.addAllowedOrigin("*");	corsConfiguration.addAllowedHeader("*");	corsConfiguration.addAllowedMethod("*");	urlBasedCorsConfigurationSource.registerCorsConfiguration("/**", corsConfiguration);	return new CorsFilter(urlBasedCorsConfigurationSource);	}	@Override	public void addInterceptors(InterceptorRegistry registry) {	// 接口幂等性拦截器	registry.addInterceptor(apiIdempotentInterceptor());	super.addInterceptors(registry);	}	@Bean	public ApiIdempotentInterceptor apiIdempotentInterceptor() {	return new ApiIdempotentInterceptor();	}	
}

OK, 目前为止, 校验代码准备就绪, 接下来测试验证

七、测试验证

获取 token的控制器 TokenController

package com.wangzaiplus.test.controller;	
import com.wangzaiplus.test.common.ServerResponse;	
import com.wangzaiplus.test.service.TokenService;	
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;	
@RestController	
@RequestMapping("/token")	
public class TokenController {	@Autowired	private TokenService tokenService;	@GetMapping	public ServerResponse token() {	return tokenService.createToken();	}	
}

TestController, 注意 @ApiIdempotent注解, 在需要幂等性校验的方法上声明此注解即可, 不需要校验的无影响

package com.wangzaiplus.test.controller;	
import com.wangzaiplus.test.annotation.ApiIdempotent;	
import com.wangzaiplus.test.common.ServerResponse;	
import com.wangzaiplus.test.service.TestService;	
import lombok.extern.slf4j.Slf4j;	
import org.springframework.beans.factory.annotation.Autowired;	
import org.springframework.web.bind.annotation.PostMapping;	
import org.springframework.web.bind.annotation.RequestMapping;	
import org.springframework.web.bind.annotation.RestController;	
@RestController	
@RequestMapping("/test")	
@Slf4j	
public class TestController {	@Autowired	private TestService testService;	@ApiIdempotent	@PostMapping("testIdempotence")	public ServerResponse testIdempotence() {	return testService.testIdempotence();	}	
}

获取 token

640?wx_fmt=other

查看redis

640?wx_fmt=other

测试接口安全性: 利用jmeter测试工具模拟50个并发请求, 将上一步获取到的token作为参数

640?wx_fmt=other

640?wx_fmt=other

header或参数均不传token, 或者token值为空, 或者token值乱填, 均无法通过校验, 如token值为"abcd"

640?wx_fmt=other

八、注意点(非常重要)

640?wx_fmt=other

上图中, 不能单纯的直接删除token而不校验是否删除成功, 会出现并发安全性问题, 因为, 有可能多个线程同时走到第46行, 此时token还未被删除, 所以继续往下执行, 如果不校验 jedisUtil.del(token)的删除结果而直接放行, 那么还是会出现重复提交问题, 即使实际上只有一次真正的删除操作, 下面重现一下

稍微修改一下代码:

640?wx_fmt=other

再次请求

640?wx_fmt=other

再看看控制台

640?wx_fmt=other

虽然只有一个真正删除掉token, 但由于没有对删除结果进行校验, 所以还是有并发问题, 因此, 必须校验

九、总结

其实思路很简单, 就是每次请求保证唯一性, 从而保证幂等性, 通过拦截器+注解, 就不用每次请求都写重复代码, 其实也可以利用spring aop实现。

想知道更多？扫描下面的二维码关注我

640?wx_fmt=png

相关推荐：

  • 《科普 | 明星公司之Netflix》

  • 《看我如何作死 | 将CPU、IO打爆》

  • 《看我如何作死 | 网络延迟、丢包、中断一个都没落下》

  • 《看我如何假死！》

  • 《这次我们看看阿里的人是如何蹂躏CPU的》

加技术群入口（备注：技术）：>>>Learn More<<

免费资料入口（备注：1024）：>>>Learn More<<

免费星球入口：>>>Free<<<

内推通道>>>>

点个"在看"呗^_^

这篇关于Spring Boot + Redis 实现接口幂等性 | 分布式开发必知！的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1129734。

相关文章

Java设计模式---迭代器模式(Iterator)解读

Java设计模式---迭代器模式(Iterator)解读

《Java设计模式---迭代器模式(Iterator)解读》：本文主要介绍Java设计模式---迭代器模式(Iterator),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录1、迭代器（Iterator）1.1、结构1.2、常用方法1.3、本质1、解耦集合与遍历逻辑2、统一
阅读更多...
Java内存分配与JVM参数详解(推荐)

Java内存分配与JVM参数详解(推荐)

《Java内存分配与JVM参数详解(推荐)》本文详解JVM内存结构与参数调整,涵盖堆分代、元空间、GC选择及优化策略,帮助开发者提升性能、避免内存泄漏,本文给大家介绍Java内存分配与JVM参数详解,... 目录引言JVM内存结构JVM参数概述堆内存分配年轻代与老年代调整堆内存大小调整年轻代与老年代比例元空
阅读更多...
深度解析Java DTO(最新推荐)

深度解析Java DTO(最新推荐)

《深度解析JavaDTO(最新推荐)》DTO（DataTransferObject）是一种用于在不同层（如Controller层、Service层）之间传输数据的对象设计模式,其核心目的是封装数据,... 目录一、什么是DTO？DTO的核心特点：二、为什么需要DTO？（对比Entity）三、实际应用场景解析
阅读更多...
Java 线程安全与 volatile与单例模式问题及解决方案

Java 线程安全与 volatile与单例模式问题及解决方案

《Java线程安全与volatile与单例模式问题及解决方案》文章主要讲解线程安全问题的五个成因（调度随机、变量修改、非原子操作、内存可见性、指令重排序）及解决方案,强调使用volatile关键字... 目录什么是线程安全线程安全问题的产生与解决方案线程的调度是随机的多个线程对同一个变量进行修改线程的修改操
阅读更多...
关于集合与数组转换实现方法

关于集合与数组转换实现方法

《关于集合与数组转换实现方法》：本文主要介绍关于集合与数组转换实现方法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、Arrays.asList()1.1、方法作用1.2、内部实现1.3、修改元素的影响1.4、注意事项2、list.toArray()2.1、方
阅读更多...
从原理到实战深入理解Java 断言assert

从原理到实战深入理解Java 断言assert

《从原理到实战深入理解Java断言assert》本文深入解析Java断言机制,涵盖语法、工作原理、启用方式及与异常的区别,推荐用于开发阶段的条件检查与状态验证,并强调生产环境应使用参数验证工具类替代... 目录深入理解 Java 断言（assert）：从原理到实战引言：为什么需要断言？一、断言基础1.1 语
阅读更多...
深度解析Java项目中包和包之间的联系

深度解析Java项目中包和包之间的联系

《深度解析Java项目中包和包之间的联系》文章浏览阅读850次，点赞13次，收藏8次。本文详细介绍了Java分层架构中的几个关键包：DTO、Controller、Service和Mapper。_jav... 目录前言一、各大包1.DTO1.1、DTO的核心用途1.2. DTO与实体类(Entity)的区别1
阅读更多...
Java中的雪花算法Snowflake解析与实践技巧

Java中的雪花算法Snowflake解析与实践技巧

《Java中的雪花算法Snowflake解析与实践技巧》本文解析了雪花算法的原理、Java实现及生产实践,涵盖ID结构、位运算技巧、时钟回拨处理、WorkerId分配等关键点,并探讨了百度UidGen... 目录一、雪花算法核心原理1.1 算法起源1.2 ID结构详解1.3 核心特性二、Java实现解析2.
阅读更多...
使用Python实现可恢复式多线程下载器

使用Python实现可恢复式多线程下载器

《使用Python实现可恢复式多线程下载器》在数字时代,大文件下载已成为日常操作,本文将手把手教你用Python打造专业级下载器,实现断点续传,多线程加速,速度限制等功能,感兴趣的小伙伴可以了解下... 目录一、智能续传：从崩溃边缘抢救进度二、多线程加速：榨干网络带宽三、速度控制：做网络的好邻居四、终端交互
阅读更多...
SpringBoot整合liteflow的详细过程

SpringBoot整合liteflow的详细过程

《SpringBoot整合liteflow的详细过程》：本文主要介绍SpringBoot整合liteflow的详细过程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋...  liteflow 是什么？ 能做什么？总之一句话：能帮你规范写代码逻辑 ，编排并解耦业务逻辑，代码
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2