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。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
这15个Vue指令，让你的项目开发爽到爆

这15个Vue指令，让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件，按住 Control 和回车键再显示它吗？小菜一碟： <template
阅读更多...
Hadoop企业开发案例调优场景

Hadoop企业开发案例调优场景

需求 （1）需求：从1G数据中，统计每个单词出现次数。服务器3台，每台配置4G内存，4核CPU，4线程。 （2）需求分析： 1G / 128m = 8个MapTask；1个ReduceTask；1个mrAppMaster 平均每个节点运行10个 / 3台 ≈ 3个任务（4    3    3） HDFS参数调优 （1）修改：hadoop-env.sh export HDFS_NAMENOD
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2