软件工程课程网站开发,深圳专业网站建设企业,休闲采摘园网站建设,企业网站带后台API的幂等性#xff08;Idempotent#xff09;#xff0c;是指调用某个方法1次或N次对资源产生的影响结果都是相同的。GET请求默认是幂等的#xff0c;因为它只是查询资源#xff0c;而不会修改资源。而POST请求默认是不幂等的#xff0c;多次调用POST方法可能会产生不同… API的幂等性Idempotent是指调用某个方法1次或N次对资源产生的影响结果都是相同的。GET请求默认是幂等的因为它只是查询资源而不会修改资源。而POST请求默认是不幂等的多次调用POST方法可能会产生不同的结果并会创建多个资源。想象一下你在扫码支付时输入金额后点击了2次“确定”按钮肯定不希望扣2次款。幂等性保证了操作只会执行一次。1.思路使用ASP.NET Core过滤器来处理POST请求检查请求头中的幂等键IdempotencyKey。如果在缓存中未检查到IdempotencyKey则真实执行操作并缓存响应数据否则直接返回缓存的响应数据。这样操作只能对资源产生一次影响。原理示意图如下2.实现2.1 IdempotentAttributeFilter创建自定义Filter。使用OnActionExecuting方法在执行操作前检查缓存如有缓存直接返回context.Result使用OnResultExecuted方法在执行操作后缓存响应。代码如下public class IdempotentAttributeFilter : IActionFilter, IResultFilter
{private readonly IDistributedCache _distributedCache;private bool _isIdempotencyCache false;const string IdempotencyKeyHeaderName IdempotencyKey;private string _idempotencyKey;public IdempotentAttributeFilter(IDistributedCache distributedCache){_distributedCache distributedCache;}public void OnActionExecuting(ActionExecutingContext context){Microsoft.Extensions.Primitives.StringValues idempotencyKeys;context.HttpContext.Request.Headers.TryGetValue(IdempotencyKeyHeaderName, out idempotencyKeys);_idempotencyKey idempotencyKeys.ToString();var cacheData _distributedCache.GetString(GetDistributedCacheKey());if (cacheData ! null){context.Result JsonConvert.DeserializeObjectObjectResult(cacheData);_isIdempotencyCache true;return;}}public void OnResultExecuted(ResultExecutedContext context){//已缓存if (_isIdempotencyCache){return;}var contextResult context.Result;DistributedCacheEntryOptions cacheOptions new DistributedCacheEntryOptions();cacheOptions.AbsoluteExpirationRelativeToNow new TimeSpan(24, 0, 0);//缓存:_distributedCache.SetString(GetDistributedCacheKey(), JsonConvert.SerializeObject(contextResult), cacheOptions);}public void OnActionExecuted(ActionExecutedContext context){}public void OnResultExecuting(ResultExecutingContext context){}private string GetDistributedCacheKey(){return Idempotency: _idempotencyKey;}
}
2.2 IdempotentAttribute创建自定义Attribute。声明了IdempotentAttribute的Class或者Method在运行时会创建IdempotentAttributeFilter。代码如下[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple false, Inherited false)]
public class IdempotentAttribute : Attribute, IFilterFactory
{public bool IsReusable false;public IFilterMetadata CreateInstance(IServiceProvider serviceProvider){var distributedCache (IDistributedCache)serviceProvider.GetService(typeof(IDistributedCache));var filter new IdempotentAttributeFilter(distributedCache);return filter;}
}
3.使用3.1 创建项目新建ASP.NET Core Web API项目实现代码如下private static ListWeatherForecast _db new ListWeatherForecast();[HttpPost]
public WeatherForecast Post(int temperature)
{var data new WeatherForecast { TemperatureC temperature };_db.Add(data);return data;
}[HttpGet]
public IEnumerableWeatherForecast Get()
{return _db.Select(p new WeatherForecast{TemperatureC p.TemperatureC,Summary Summaries[rng.Next(Summaries.Length)]}).ToArray();
}
这里用一个静态变量模拟数据库POST请求写入数据GET请求读取数据。3.2 设置幂等为Post方法加上Idempotent Attribute[Idempotent]
public WeatherForecast Post(int temperature)
3.3 注册分布式缓存从上面的原理图我们可以看到必须增加分布式缓存用于保存幂等键的值和响应数据。修改Startup.cspublic void ConfigureServices(IServiceCollection services)
{...services.AddDistributedMemoryCache();
}
3.4 测试运行Web API使用不同IdempotencyKey执行POST请求然后获取数据:可以看到同一IdempotencyKey执行了2次但是只写入了一条数据成功结论为了确保关键Web API的高可用性和业务连续性实现幂等性是重要的一步。如果你觉得这篇文章对你有所启发请关注我的个人公众号”My IO“记住我
