您当前的位置:首页 > 电脑百科 > 程序开发 > 架构

在分布式系统中,SpringBoot 实现接口幂等性

时间:2023-03-07 13:51:15  来源:今日头条  作者:

在分布式系统中,接口幂等性是一个非常重要的概念,它保证了在同样的条件下,同一请求的多次执行所产生的效果都是相同的。在实际开发中,为了防止重复提交或者重复操作带来的问题,我们需要考虑如何实现接口幂等性。

下面我将介绍如何在 SpringBoot + MySQL + MyBatisPlus + Druid 的环境下实现接口幂等性。

  1. 什么是接口幂等性?

接口幂等性是指,对于相同的输入,接口的输出结果应该相同。换句话说,如果接口已经处理了一个请求并返回了结果,那么在相同的输入条件下,该接口的后续请求应该返回相同的结果,而不会产生任何新的副作用。

  1. 如何实现接口幂等性?

要实现接口幂等性,需要考虑以下几个方面:

  • 请求唯一标识:每个请求都应该有一个唯一的标识,可以是请求参数的组合或者是一个单独的参数。
  • 幂等性校验:每次请求到达服务器时,服务器需要判断该请求是否已经被处理过,如果已经被处理过,则直接返回处理结果,否则执行请求操作,并记录请求的唯一标识,以便后续的幂等性校验。

在 SpringBoot + MySQL + MybatisPlus + Druid 的环境下,我们可以通过以下方式实现接口幂等性:

  • 在请求参数中添加一个幂等性校验码(比如 UUID),用于唯一标识每个请求。
  • 在请求处理前,先查询幂等性校验码是否已经存在于数据库中,如果存在则说明该请求已经被处理过,直接返回结果。
  • 如果幂等性校验码不存在于数据库中,则执行请求操作,并将幂等性校验码插入到数据库中。

下面是实现接口幂等性的示例代码:

在请求参数中添加一个幂等性校验码:

public class RequestDTO {
    private String idempotenceKey;
    // other request fields and methods
}

在 MybatisPlus 中创建对应的实体类:

@Data
@TableName("idempotence_key")
public class IdempotenceKey {
    @TableId(type = IdType.ASSIGN_UUID)
    private String id;
    private String key;
    private Date createTime;
}

在 Controller 中实现幂等性校验:

@RestController
public class UserController {
    @Autowired
    private UserService userService;

    @PostMApping("/user")
    public String createUser(@RequestBody RequestDTO request) {
        // 幂等性校验
        if (checkIdempotence(request.getIdempotenceKey())) {
            return "success";
        }
        // 执行请求操作
        userService.createUser(request);
        // 插入幂等性校验码
        saveIdempotence(request.getIdempotenceKey());
        return "success";
    }
}

在 Service 中实现幂等性校验和插入幂等性校验码:

@Service
public class UserService {
    @Autowired
    private IdempotenceKeyMapper idempotenceKeyMapper;

    public void createUser(RequestDTO request) {
        // 创建用户
        // ...
    }

    private boolean checkIdempotence(String key) {
        IdempotenceKey idempotenceKey = idempotenceKeyMapper.selectOne(new LambdaQueryWrapper<IdempotenceKey>().eq(IdempotenceKey::getKey, key));
        return idempotenceKey != null;
    }

    private void saveIdempotence(String key) {
        IdempotenceKey idempotenceKey = new IdempotenceKey();
        idempotenceKey.setKey(key);
        idempotenceKey.setCreateTime(new Date());
        idempotenceKeyMapper.insert(idempotenceKey);
    }
}

这里使用了 MybatisPlus 的 LambdaQueryWrapper 进行查询,并使用自动生成的 UUID 作为幂等性校验码。

全局实现幂等性校验可以使用AOP(面向切面编程)来实现,在方法执行前先进行幂等性校验,如果已经执行过该方法,则直接返回结果。可以通过自定义注解来标记需要进行幂等性校验的方法。

以下是一个简单的示例代码:

  1. 自定义注解 Idempotent:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Idempotent {
    long expireSeconds() default 60;
}
  1. 编写 AOP 切面,用于拦截带有 @Idempotent 注解的方法:
@Aspect
@Component
public class IdempotentAspect {
    @Autowired
    private IdempotenceKeyMapper idempotenceKeyMapper;

    @Pointcut("@annotation(com.example.demo.annotation.Idempotent)")
    public void idempotentPointcut() {}

    @Around("idempotentPointcut()")
    public Object idempotentAround(ProceedingJoinPoint point) throws Throwable {
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        Idempotent idempotent = method.getAnnotation(Idempotent.class);
        String key = getKey(point);

        if (StringUtils.isBlank(key)) {
            throw new RuntimeException("幂等性校验码不能为空");
        }

        if (checkIdempotence(key)) {
            throw new RuntimeException("请勿重复操作");
        }

        saveIdempotence(key, idempotent.expireSeconds());
        return point.proceed();
    }

    private boolean checkIdempotence(String key) {
        IdempotenceKey idempotenceKey = idempotenceKeyMapper.selectOne(new LambdaQueryWrapper<IdempotenceKey>().eq(IdempotenceKey::getKey, key));
        return idempotenceKey != null;
    }

    private void saveIdempotence(String key, long expireSeconds) {
        IdempotenceKey idempotenceKey = new IdempotenceKey();
        idempotenceKey.setKey(key);
        idempotenceKey.setCreateTime(new Date());
        idempotenceKey.setExpireTime(new Date(System.currentTimeMillis() + expireSeconds * 1000));
        idempotenceKeyMapper.insert(idempotenceKey);
    }

    private String getKey(ProceedingJoinPoint point) {
        Object[] args = point.getArgs();
        if (args.length == 0) {
            return null;
        }
        return args[0].toString();
    }
}
  1. 在需要进行幂等性校验的方法上添加 @Idempotent 注解:
 
@Service
public class UserService {
    @Autowired
    private IdempotenceKeyMapper idempotenceKeyMapper;

    @Idempotent(expireSeconds = 60)
    public void createUser(String username) {
        // 创建用户
        // ...
    }
}

通过以上方式,在方法执行前会先进行幂等性校验,如果已经执行过该方法,则直接返回结果,不会再次执行。

在实际应用中,需要考虑一些特殊情况的处理,以提高幂等性校验的准确性和可靠性。下面列举一些可能遇到的情况:

  1. 请求超时处理:由于幂等性校验码是有过期时间的,如果客户端发起的请求在幂等性校验码过期后才到达服务器,那么该请求就不应该再被视为重复请求。为了解决这个问题,可以在幂等性校验码表中记录请求的时间戳,并在校验幂等性校验码时进行时间戳比较,以判断请求是否超时。

在幂等性校验码表中添加一个请求时间戳的字段,将请求时间戳一并存储,以便在校验幂等性校验码时进行时间戳比较。

CREATE TABLE `idempotent_key` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `key` varchar(128) NOT NULL COMMENT '幂等性校验码',
  `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `expire_time` datetime NOT NULL COMMENT '过期时间',
  `request_time` datetime NOT NULL COMMENT '请求时间',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_key` (`key`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='幂等性校验码表';

在进行幂等性校验时,需要先判断幂等性校验码是否过期,如果过期则不再进行校验。

public void processRequest() {
    String key = generateIdempotentKey();
    LocalDateTime now = LocalDateTime.now();
    LocalDateTime expireTime = now.plusMinutes(5);
    LocalDateTime requestTime = now;

    // 将幂等性校验码和请求时间戳存入数据库中
    idempotentKeyDao.insert(key, expireTime, requestTime);

    // 判断请求是否过期
    LocalDateTime threshold = now.minusMinutes(5);
    if (requestTime.isBefore(threshold)) {
        // 请求已经过期,不再进行幂等性校验
        return;
    }

    // 进行幂等性校验
    boolean success = idempotentKeyDao.checkAndUpdate(key);
    if (!success) {
        // 幂等性校验失败
        return;
    }

    // 执行业务操作
    // ...
}
  1. 高并发下的幂等性校验:在高并发场景下,多个请求可能同时到达服务器进行幂等性校验,这时需要保证校验的准确性和唯一性。可以通过对幂等性校验码进行唯一索引的方式来保证每个幂等性校验码只会出现一次,避免多个请求同时通过校验。

在幂等性校验码表的 key 字段上添加唯一索引,以保证每个幂等性校验码只会出现一次。

ALTER TABLE `idempotent_key` ADD UNIQUE INDEX `uk_key` (`key`);

在进行幂等性校验时,需要使用数据库的唯一索引进行校验。

public boolean checkAndUpdate(String key) {
    // 利用数据库的唯一索引保证幂等性校验码的唯一性
    int affectedRows = jdbcTemplate.update(
            "UPDATE idempotent_key SET request_count = request_count + 1 WHERE key = ?",
            key);
    return affectedRows == 1;
}
  1. 幂等性校验码的重复利用:在一些场景下,比如一个请求执行失败需要重试,或者用户进行了一些撤销操作后需要再次执行该操作等,幂等性校验码可能会被多次使用。为了避免重复利用同一个幂等性校验码导致的校验失效,可以对幂等性校验码进行标记,标记该校验码已被使用过,避免再次使用。

在幂等性校验码表中添加一个 used 字段,标记该幂等性校验码是否已被使用过。

在进行幂等性校验时,需要判断该幂等性校验码是否已经被使用过,如果已经被使用过,则不再进行校验。

public boolean checkAndUpdate(String key) {
    // 判断幂等性校验码是否已经被使用过
    boolean used = jdbcTemplate.queryForObject(
            "SELECT used FROM idempotent_key WHERE key = ?",
            Boolean.class,
            key);
    if (used) {
        // 幂等性校验码已经被使用过,不再进行校验
        return true;
    }

    // 将幂等性校验码标记为已使用
    int affectedRows = jdbcTemplate.update(
            "UPDATE idempotent_key SET used = true WHERE key = ?",
            key);
    return affectedRows == 1;
}

幂等性校验码的生成规则:幂等性校验码的生成规则也需要考虑,应该根据业务的特点来确定。可以采用随机数、UUID、请求参数哈希等方式生成幂等性校验码。需要保证幂等性校验码在相同的请求条件下生成的结果一致。

在分布式环境下,需要保证不同实例之间共享幂等性校验码的状态。可以使用 redis 等分布式缓存来存储幂等性校验码状态。

public boolean checkAndUpdate(String key) {
    // 从 Redis 中获取幂等性校验码的状态
    boolean used = redisTemplate.opsForValue().get(key);
    if (used) {
        // 幂等性校验码已经被使用过,不再进行校验
        return true;
    }

    // 将幂等性校验码标记为已使用
    redisTemplate.opsForValue().set(key, true);

    // 执行业务操作
    // ...

    return true;
}

需要注意的是,由于 Redis 中存储的数据可能会被意外删除或过期,因此在使用 Redis 作为幂等性校验码状态存储介质时,需要考虑数据丢失或过期的情况,确保系统的可靠性和正确性。



Tags:SpringBoot   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,不构成投资建议。投资者据此操作,风险自担。如有任何标注错误或版权侵犯请与我们联系,我们将及时更正、删除。
▌相关推荐
公司用了六年的 SpringBoot 项目部署方案,稳得一批!
本篇和大家分享的是springboot打包并结合shell脚本命令部署,重点在分享一个shell程序启动工具,希望能便利工作。 profiles指定不同环境的配置 maven-assembly-plugin打发布压...【详细内容】
2024-01-10  Search: SpringBoot  点击:(163)  评论:(0)  加入收藏
SpringBoot 中的热部署和热加载
在Spring Boot开发调试中,如果我们每修改一行代码都需要重启调试,可能会比较耗时。Spring Boot团队针对这个问题提供了spring-boot-devtools(简称:Devtools)插件,试图提高开发和调...【详细内容】
2023-11-06  Search: SpringBoot  点击:(250)  评论:(0)  加入收藏
SpringBoot 调用外部接口的四种方式
1、简介在Spring-Boot项目开发中,当本模块的代码需要访问外面模块接口,或外部url链接的需求的时候, 需要使用网络连接调用,下面提供了四种方式(排除dubbo的方式)供大家选择。方式...【详细内容】
2023-11-06  Search: SpringBoot  点击:(315)  评论:(0)  加入收藏
Springboot 框架中事件监听和发布机制详细介绍
事件监听和发布是Spring Framework中的一种机制,用于实现松散耦合的组件之间的通信。下面是事件监听和发布的详细过程:事件发布的过程: 创建事件对象:首先,您需要创建一个事件类,...【详细内容】
2023-11-02  Search: SpringBoot  点击:(264)  评论:(0)  加入收藏
Springboot 中的 PropertySource 管理配置属性的机制
Spring Framework 中的 PropertySource 是一种用于管理配置属性的机制,它允许你将配置信息从各种来源(如属性文件、环境变量、数据库等)加载到应用程序中。在 Spring 中,Propert...【详细内容】
2023-10-29  Search: SpringBoot  点击:(228)  评论:(0)  加入收藏
如何将本地jar文件打包到 springboot 执行jar文件中
这一系列课程将包含Spring Boot 许多关键的技术和工具,包括 Mybatis-Plus、Redis、Mongodb、MinIO、Kafka、MySQL、消息队列(MQ)、OAuth2 等相关内容。如何将本地jar文件打包到...【详细内容】
2023-10-27  Search: SpringBoot  点击:(271)  评论:(0)  加入收藏
Java面试题之SpringBoot 框架
谈谈怎么理解 SpringBoot 框架 Spring Boot 是 Spring 开源组织下的子项目, 是 Spring 组件一站式解决方案, 主要是 简化了使用 Spring 的难度, 简省了繁重的配置, 提供了各种启...【详细内容】
2023-09-28  Search: SpringBoot  点击:(212)  评论:(0)  加入收藏
SpringBoot 并发编程学习历程
本教程大概目录: 模拟单线程情节 用Callable实现 并发编程 用DeferedResult实现异步处理###模拟单线程情节。/** * Created by Fant.J. */@RestController@Slf4jpublic class...【详细内容】
2023-09-27  Search: SpringBoot  点击:(207)  评论:(0)  加入收藏
Springboot — 用更优雅的方式发HTTP请求(RestTemplate详解)
RestTemplate是Spring提供的用于访问Rest服务的客户端,RestTemplate提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。我之前的HTTP开发是用apache的Htt...【详细内容】
2023-09-14  Search: SpringBoot  点击:(317)  评论:(0)  加入收藏
16个SpringBoot 扩展接口
1.背景Spring的核心思想就是容器,当容器refresh的时候,外部看上去风平浪静,其实内部则是一片惊涛骇浪,汪洋一片。Springboot更是封装了Spring,遵循约定大于配置,加上自动装配的机...【详细内容】
2023-08-28  Search: SpringBoot  点击:(134)  评论:(0)  加入收藏
▌简易百科推荐
对于微服务架构监控应该遵守的原则
随着软件交付方式的变革,微服务架构的兴起使得软件开发变得更加快速和灵活。在这种情况下,监控系统成为了微服务控制系统的核心组成部分。随着软件的复杂性不断增加,了解系统的...【详细内容】
2024-04-03  步步运维步步坑    Tags:架构   点击:(5)  评论:(0)  加入收藏
大模型应用的 10 种架构模式
作者 | 曹洪伟在塑造新领域的过程中,我们往往依赖于一些经过实践验证的策略、方法和模式。这种观念对于软件工程领域的专业人士来说,已经司空见惯,设计模式已成为程序员们的重...【详细内容】
2024-03-27    InfoQ  Tags:架构模式   点击:(13)  评论:(0)  加入收藏
哈啰云原生架构落地实践
一、弹性伸缩技术实践1.全网容器化后一线研发的使用问题全网容器化后一线研发会面临一系列使用问题,包括时机、容量、效率和成本问题,弹性伸缩是云原生容器化后的必然技术选择...【详细内容】
2024-03-27  哈啰技术  微信公众号  Tags:架构   点击:(10)  评论:(0)  加入收藏
DDD 与 CQRS 才是黄金组合
在日常工作中,你是否也遇到过下面几种情况: 使用一个已有接口进行业务开发,上线后出现严重的性能问题,被老板当众质疑:“你为什么不使用缓存接口,这个接口全部走数据库,这怎么能扛...【详细内容】
2024-03-27  dbaplus社群    Tags:DDD   点击:(12)  评论:(0)  加入收藏
高并发架构设计(三大利器:缓存、限流和降级)
软件系统有三个追求:高性能、高并发、高可用,俗称三高。本篇讨论高并发,从高并发是什么到高并发应对的策略、缓存、限流、降级等。引言1.高并发背景互联网行业迅速发展,用户量剧...【详细内容】
2024-03-13    阿里云开发者  Tags:高并发   点击:(6)  评论:(0)  加入收藏
如何判断架构设计的优劣?
架构设计的基本准则是非常重要的,它们指导着我们如何构建可靠、可维护、可测试的系统。下面是这些准则的转换表达方式:简单即美(KISS):KISS原则的核心思想是保持简单。在设计系统...【详细内容】
2024-02-20  二进制跳动  微信公众号  Tags:架构设计   点击:(36)  评论:(0)  加入收藏
详解基于SpringBoot的WebSocket应用开发
在现代Web应用中,实时交互和数据推送的需求日益增长。WebSocket协议作为一种全双工通信协议,允许服务端与客户端之间建立持久性的连接,实现实时、双向的数据传输,极大地提升了用...【详细内容】
2024-01-30  ijunfu  今日头条  Tags:SpringBoot   点击:(17)  评论:(0)  加入收藏
PHP+Go 开发仿简书,实战高并发高可用微服务架构
来百度APP畅享高清图片//下栽のke:chaoxingit.com/2105/PHP和Go语言结合,可以开发出高效且稳定的仿简书应用。在实现高并发和高可用微服务架构时,我们可以采用一些关键技术。首...【详细内容】
2024-01-14  547蓝色星球    Tags:架构   点击:(115)  评论:(0)  加入收藏
GraalVM与Spring Boot 3.0:加速应用性能的完美融合
在2023年,SpringBoot3.0的发布标志着Spring框架对GraalVM的全面支持,这一支持是对Spring技术栈的重要补充。GraalVM是一个高性能的多语言虚拟机,它提供了Ahead-of-Time(AOT)编...【详细内容】
2024-01-11    王建立  Tags:Spring Boot   点击:(124)  评论:(0)  加入收藏
Spring Boot虚拟线程的性能还不如Webflux?
早上看到一篇关于Spring Boot虚拟线程和Webflux性能对比的文章,觉得还不错。内容较长,抓重点给大家介绍一下这篇文章的核心内容,方便大家快速阅读。测试场景作者采用了一个尽可...【详细内容】
2024-01-10  互联网架构小马哥    Tags:Spring Boot   点击:(117)  评论:(0)  加入收藏
站内最新
站内热门
站内头条