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。

相关文章

基于C++的UDP网络通信系统设计与实现详解

基于C++的UDP网络通信系统设计与实现详解

《基于C++的UDP网络通信系统设计与实现详解》在网络编程领域,UDP作为一种无连接的传输层协议,以其高效、低延迟的特性在实时性要求高的应用场景中占据重要地位,下面我们就来看看如何从零开始构建一个完整... 目录前言一、UDP服务器UdpServer.hpp1.1 基本框架设计1.2 初始化函数Init详解
阅读更多...
Java中Map的五种遍历方式实现与对比

Java中Map的五种遍历方式实现与对比

《Java中Map的五种遍历方式实现与对比》其实Map遍历藏着多种玩法,有的优雅简洁,有的性能拉满,今天咱们盘一盘这些进阶偏基础的遍历方式,告别重复又臃肿的代码,感兴趣的小伙伴可以了解下... 目录一、先搞懂：Map遍历的核心目标二、几种遍历方式的对比1. 传统EntrySet遍历（最通用）2. Lambd
阅读更多...
Spring Boot 中 RestTemplate 的核心用法指南

Spring Boot 中 RestTemplate 的核心用法指南

《SpringBoot中RestTemplate的核心用法指南》本文详细介绍了RestTemplate的使用,包括基础用法、进阶配置技巧、实战案例以及最佳实践建议,通过一个腾讯地图路线规划的案... 目录一、环境准备二、基础用法全解析1. GET 请求的三种姿势2. POST 请求深度实践三、进阶配置技巧1
阅读更多...
springboot+redis实现订单过期(超时取消)功能的方法详解

springboot+redis实现订单过期(超时取消)功能的方法详解

《springboot+redis实现订单过期(超时取消)功能的方法详解》在SpringBoot中使用Redis实现订单过期（超时取消）功能,有多种成熟方案,本文为大家整理了几个详细方法,文中的示例代... 目录一、Redis键过期回调方案（推荐）1. 配置Redis监听器2. 监听键过期事件3. Redi
阅读更多...
Spring Boot 处理带文件表单的方式汇总

Spring Boot 处理带文件表单的方式汇总

《SpringBoot处理带文件表单的方式汇总》本文详细介绍了六种处理文件上传的方式,包括@RequestParam、@RequestPart、@ModelAttribute、@ModelAttr... 目录方式 1：@RequestParam接收文件后端代码前端代码特点方式 2：@RequestPart接
阅读更多...
SpringBoot整合Zuul全过程

SpringBoot整合Zuul全过程

《SpringBoot整合Zuul全过程》Zuul网关是微服务架构中的重要组件,具备统一入口、鉴权校验、动态路由等功能,它通过配置文件进行灵活的路由和过滤器设置,支持Hystrix进行容错处理,还提供... 目录Zuul网关的作用Zuul网关的应用1、网关访问方式2、网关依赖注入3、网关启动器4、网关全局变
阅读更多...
SpringBoot全局异常拦截与自定义错误页面实现过程解读

SpringBoot全局异常拦截与自定义错误页面实现过程解读

《SpringBoot全局异常拦截与自定义错误页面实现过程解读》本文介绍了SpringBoot中全局异常拦截与自定义错误页面的实现方法,包括异常的分类、SpringBoot默认异常处理机制、全局异常拦... 目录一、引言二、Spring Boot异常处理基础2.1 异常的分类2.2 Spring Boot默
阅读更多...
基于SpringBoot实现分布式锁的三种方法

基于SpringBoot实现分布式锁的三种方法

《基于SpringBoot实现分布式锁的三种方法》这篇文章主要为大家详细介绍了基于SpringBoot实现分布式锁的三种方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、基于Redis原生命令实现分布式锁1. 基础版Redis分布式锁2. 可重入锁实现二、使用Redisso
阅读更多...
SpringBoo WebFlux+MongoDB实现非阻塞API过程

SpringBoo WebFlux+MongoDB实现非阻塞API过程

《SpringBooWebFlux+MongoDB实现非阻塞API过程》本文介绍了如何使用SpringBootWebFlux和MongoDB实现非阻塞API,通过响应式编程提高系统的吞吐量和响应性能... 目录一、引言二、响应式编程基础2.1 响应式编程概念2.2 响应式编程的优势2.3 响应式编程相关技术
阅读更多...
SpringBoot的全局异常拦截实践过程

SpringBoot的全局异常拦截实践过程

《SpringBoot的全局异常拦截实践过程》SpringBoot中使用@ControllerAdvice和@ExceptionHandler实现全局异常拦截,@RestControllerAdvic... 目录@RestControllerAdvice@ResponseStatus(...)@Except
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2