幂等性文档分享.docVIP

幂等性

幂等性强调的是外界通过接口对系统内部的影响，只要一次或多次调用对某一个资源应该具有同样的副作用就行。

注：是对资源造成的副作用必须是一样的，但是返回值允许不同！

目前API网关支持基于用友MDD框架开发的接口的幂等性。

MDD幂等性说明

MDD框架已提供一套幂等性方案，MDD幂等性目前只支持单条数据保存接口（MDD框架后续会增加批量保存接口的幂等性），只对body体是data的结构有效，通过resubmitCheckKey字段来进行控制。

MDD幂等性解决方案

调用方调用MDD幂等的OpenAPI时，在原参数中增加resubmitCheckKey参数（长度不能超过32位）

若body参数中的data结构是对象，则在此对象里增加一个resubmitCheckKey参数，如下：

原body体：

{

data:{

id:,

code:,

name:

}

}

需要进行幂等性的body体：

{

data:{

id:,

code:,

name:,

resubmitCheckKey:951ada30e0969e954f5d9058fff6a512

}

}

resubmitCheckKey生成规则：

场景一：根据上游单据进行保存，就将上游单据ID作为resubmitCheckKey

场景二：没有上游单据的，调用方需按API幂等处理要求，传参数resubmitCheckKey，且要保证同一个接口在租户内resubmitCheckKey值一定是唯一的，避免2个不同单据的数据保存时由于resubmitCheckKey重复，造成单据无法保存的情况

注：网关为了保证租户间生成的key互不影响，会在resubmitCheckKey基础上拼接apiid和tenantid

网关接收到请求后，若是MDD幂等API，网关会判断是否有调用方传递的resubmitCheckKey的缓存，若没有缓存则调用后端服务，并将后端服务返回的结果给调用方，若后端服务返回了成功结果，网关会缓存resubmitCheckKey和请求成功返回的结果数据；若有缓存，则说明是重复提交，网关不再调用后端服务，直接将缓存的请求成功结果数据返回给调用方；

注：网关缓存的resubmitCheckKey和请求成功返回的结果数据只保留1小时，超过1小时的请求，网关会直接调用后端服务，此时MDD框架的幂等机制会生效，会将上次成功返回的主键id返回给调用方。

3.幂等接口的返回值格式说明支持幂等的接口在不同场景下返回的结构有所不同，调用方一定要对不同场景返回的格式进行兼容处理

场景一：当调用方第一次调用接口，后端服务处理成功后，返回成功结果，此时返回结果结构和API文档里描述的返回结构完全一致，data里是完整的业务对象，例如：

{

code:200,

message:操作成功,

data:{

id:2172175075348736,

code:CGA20001000113,

bustype_code:A20001,

currency_code:CNY,

currency_moneyDigit:2,

currency_priceDigit:2,,

vendor_code:0000000001,

vouchdate:2021-03-0500:00:00,

verifystate:0,

pubts:2021-03-1511:30:45,

purchaseOrders:[

{

id:2172175075348737,

bustype:0,

rowno:1,

status:Insert,

proDescFlag:0,

totalRecieveQty:0,

storageqty:0,

pubts:2021-03-1511:30:45

}

]

}

}

场景二：当调用方使用同一个resubmitCheckKey，若在第一次成功调用请求1小时内又重复调用，网关会返回第一次请求成功的返回结果，即和场景一格式一样

场景三：当调用方使用同一个resubmitCheckKey，若在第一次成功调用请求1小时后又重复