怎么设计一个高质量的接口API设计

简介: 什么是幂等性?对于同一笔业务交易,不管调用多少次,只会成功处理一次。二、幂等性设计我们转账业务为例,来说明一下这个问题,转账接口一定要做到幂等性,否则会出现重复转账的问题。调用转账接口从A中转100元资金给B,参数中会携带业务流水号biz_no和源账户A,目的账户B,和转账金额100,业务流水号biz_no是唯一的。转账接口实现有以下实现方式。

涉及思路
一、什么是幂等性?对于同一笔业务交易,不管调用多少次,只会成功处理一次。二、幂等性设计我们转账业务为例,来说明一下这个问题,转账接口一定要做到幂等性,否则会出现重复转账的问题。调用转账接口从A中转100元资金给B,参数中会携带业务流水号biz_no和源账户A,目的账户B,和转账金额100,业务流水号biz_no是唯一的。转账接口实现有以下实现方式


1 方式1(普通方式)过程如下:

1.接收到转账请求

2.根据biz_no查询当前订单是否处理过3.如果订单已处理直接返回,若未处理,插入一条流水,继续向下执行4.开启本地事务5.本地系统给A扣减100,B账户加1006.插入记账流水表7.将订单状态置为成功8.提交本地事务上面的过程,对于同一笔订单,如果上游重复调用了两次次,会出现什么问题?当两次次请求同时到达第2步时候,查询订单都是未处理的,会继续向下执行,最终本A会转两次钱给B,总共转了200。此方式适用于单机模式,按顺序串行执行的情况。分析:这次出现出现重复转账的原因是,两次请求同时进来,在第一次请求插入流水提交事务之前,第二次又进来了,有人会说:如果第一次请求进来的时候,我加锁,等我处理完了,才释放锁,第二次请求就得等待,直到第一次请求释放锁,再进来,那就没问题了。


2 方式2(jvm加锁方式)方式1中由于并发出现了问题,此时我们使用java中的Lock加锁,来防止并发操作,过程如下:

1.转账接口接收到上游的转账申请请求;

2.调用java中的Lock加锁

3.根据biz_no查询当前订单是否处理过

4.如果订单已处理直接返回,若未处理,插入一条流水,继续向下执行

5.如果订单已处理直接返回,若未处理,继续向下执行

6 开启本地事务

7.本地系统给A扣减100,B账户加100

8.插入记账流水表

9.将订单状态置为成功

10.提交本地事务

11.释放Lock锁分析问题:Lock只能在一个jvm中起效,如果多个请求都被同一套系统处理,上面这种使用Lock的方式是没有问题的,不过互联网系统中,多数是采用集群方式部署,同一套代码后面会部署多套,如果上游同时发来多个请求经过负载均衡转发到不同的机器,上面的锁就不起效了。此时对于多个请求相当于无锁处理了,又会出现方式1中的结果。此时我们需要分布式锁来做处理。


3 方式3(悲观锁方式)使用数据库中悲观锁实现。悲观锁类似于方式二中的Lock,只不过是依靠数据库来实现的。数据中悲观锁使用for update来实现,过程如下:

1.接收到转账申请请求

2.打开本地事物

3.查询订单信息并加悲观锁select * from t_order where biz_no = #{bizNo} for update;

4.判断订单是已处理

5.如果订单已处理直接返回,若未处理,插入一条流水,继续向下执行

6.本地系统给A扣减100,B账户加100

7.插入记账流水表8.将订单状态置为成功

8.提交本地事物分析:重点在于for update,对for update,做一下说明:


1.当线程A执行for update,数据会对当前记录加锁进行行锁,其他线程执行到此行代码的时候,会等待线程A释放锁之后,才可以获取锁,继续后续操作。


2.事物提交时,for update获取的锁会自动释放。方式

3可以正常实现我们需要的效果,能保证接口的幂等性,不过存在一些缺点:1.这种方式性能比较差,并发情况下,后面线程会长期处于等待状态,占用了很多线程,让这些线程处于无效等待状态,我们的web服务中的线程数量一般都是有限的,如果大量线程由于获取for update锁处于等待状态,不利于系统并发操作。


4 方式4(乐观锁方式)依靠数据库中的乐观锁来实现。

1.接收到转账申请请求

2.查询订单信息select * from t_order where biz_no = #{bizNo};

3.判断订单是已处理

4.如果订单已处理直接返回,若未处理,插入一条流水,继续向下执行

5.打开本地事物

6.本地系统给A扣减100,B账户加100

7.插入记账流水表

8.将订单状态置为成功,注意这块是重点,伪代码:update t_order set status = 1 where biz_no = #{bizNo} where status = 0;//上面的update操作会返回影响的行数numif(num==1){ //表示更新成功 提交事务;}else{ //表示更新失败 回滚事务;}注意:update t_order set status = 1 where biz_no = #{bizNo} where status = 0; 是依靠乐观锁来实现的,status=0作为条件去更新.执行这条sql的时候,如果有多个线程同时到达这条代码,数据内部会保证update同一条记录会排队执行,最终最有一条update会执行成功,其他未成功的,他们的num为0,然后根据num来进行提交或者回滚操作。


5 方式5(唯一约束方式)依赖数据库中唯一约束来实现。我们可以创建一个表:CREATE TABLE t_unique_controler ( id bigint(20) NOT NULL AUTO_INCREMENT, unique_biz_no varchar(64) NOT NULL DEFAULT ‘’ COMMENT ‘流水号’, PRIMARY KEY (id), UNIQUE KEY unique_biz_no (unique_biz_no) COMMENT ‘保证业务唯一性’) ENGINE=InnoDB;对于任何一笔转账请求,有一个唯一全局的业务流水号,请求进来来的时候,先查询t_unique_controler表中是否存在相关记录,若不存在,继续放行。过程如下:


1.接收到转账申请请求

2.查询t_unique_controler(条件unique_biz_no),可以判断订单是否已处理select * from t_unique_controler where unique_biz_no = #{unique_biz_no};

3.判断订单是已处理

4.如果订单已处理直接返回,若未处理,插入一条流水,继续向下执行

5.打开本地事物

6.本地系统给A扣减100,B账户加1007.插入记账流水表

7.将订单状态置为成功

8.向t_uq_dipose插入数据,插入成功,提交本地事务,插入失败,回滚本地事务,伪代码:try{ insert into t_unique_controler (unique_biz_no) values (#{unique_biz_no}); 提交本地事务:}catch(Exception e){ 回滚本地事务;}说明:对于同一笔转账请求,业务流水号unique_biz_no是一样的,当并发时,插入数据只会有一条成功,其他的会违法唯一约束,进入catch逻辑,当前事务会被回滚,最终最有一个操作会成功,从而保证了幂等性操作。关于这种方式可以写成通用的方式,不过业务量大的情况下,t_unique_controler插入数据会成为系统的瓶颈,需要考虑分表操作,解决性能问题。上面的过程中向t_unique_controler插入记录,最好放在最后执行,原因:插入操作会锁表,放在最后能让锁表的时间降到最低,提升系统的并发性。关于消息服务中,消费者如何保证消息处理的幂等性?每条消息都有一个唯一的消息id,类似于上面业务中的unique_biz_no,使用上面的方式即可实现消息消费的幂等性。三、总结1.实现幂等性常见的方式有:悲观锁(for update)、乐观锁、唯一约束2.几种方式,按照最优排序:乐观锁 > 唯一约束 > 悲观锁





相关文章
|
2天前
|
存储 缓存 运维
DataWorks操作报错合集之DataWorks根据api,调用查询文件列表接口报错如何解决
DataWorks是阿里云提供的一站式大数据开发与治理平台,支持数据集成、数据开发、数据服务、数据质量管理、数据安全管理等全流程数据处理。在使用DataWorks过程中,可能会遇到各种操作报错。以下是一些常见的报错情况及其可能的原因和解决方法。
10 1
|
3天前
|
SQL 数据管理 API
数据管理DMS产品使用合集之阿里云DMS提供API接口来进行数据导出功能吗
阿里云数据管理DMS提供了全面的数据管理、数据库运维、数据安全、数据迁移与同步等功能,助力企业高效、安全地进行数据库管理和运维工作。以下是DMS产品使用合集的详细介绍。
|
3天前
|
运维 Serverless API
Serverless 应用引擎产品使用之在阿里函数计算中开启函数计算 API 接口如何解决
阿里云Serverless 应用引擎(SAE)提供了完整的微服务应用生命周期管理能力,包括应用部署、服务治理、开发运维、资源管理等功能,并通过扩展功能支持多环境管理、API Gateway、事件驱动等高级应用场景,帮助企业快速构建、部署、运维和扩展微服务架构,实现Serverless化的应用部署与运维模式。以下是对SAE产品使用合集的概述,包括应用管理、服务治理、开发运维、资源管理等方面。
102 6
|
6天前
|
前端开发 Java 测试技术
IDEA 版 API 接口神器来了,一键生成文档,贼香!
IDEA 版 API 接口神器来了,一键生成文档,贼香!
18 0
|
7天前
|
API 开发者
邮件API接口使用的方法和步骤
AOKSEND指南:了解和使用邮件API接口,包括选择适合的接口(如AOKSEND、Mailgun、SMTP),获取访问权限,配置发件人、收件人及邮件内容,调用接口发送邮件,并处理返回结果,以高效集成邮件功能。
|
9天前
|
Java API Android开发
[NDK/JNI系列04] JNI接口方法表、基础API与异常API
[NDK/JNI系列04] JNI接口方法表、基础API与异常API
12 0
|
11天前
|
XML JSON API
api接口的使用原理是什么?
总之,API接口的使用原理基于协议、规范和约定,允许不同的应用程序或系统之间进行通信和交互。这种通信方式使得开发人员能够轻松地利用外部服务或资源,从而实现更丰富的功能和服务。
15 0
|
12天前
|
XML JSON API
快速淘宝商品详情页面API接口传输 php
PI(Application Programming Interface,应用程序接口)是一组预定义的函数、协议和工具,用于构建软件应用程序之间的交互。它允许不同的软件系统和应用通过统一的接口进行数据交换和通信
|
12天前
|
XML JSON API
深入了解API:详解应用程序接口的作用和原理
在现代软件开发领域中,API(Application Programming Interface,应用程序接口)扮演着至关重要的角色。无论是在Web开发、移动应用还是大型软件系统中,API都是不可或缺的组成部分。本文将深入探讨API的作用和原理,帮助读者更好地理解和应用API
|
14天前
|
供应链 数据挖掘 API
淘宝API接口系列:数据分析丨Erp上货丨维权控价丨商品搬家丨店铺订单管理
淘宝API接口系列在多个方面为电商业务提供了强大的支持,包括数据分析、ERP上货、维权控价、商品搬家以及店铺订单管理。下面将针对这些方面逐一进行说明。