在某些情况下,WEB API 可能需要很长时间来处理请求,而客户端如果一直等待工作完成是不可行的,比如连接超时等。
这时,可以使用“异步 Request-Reply 模式”。
异步 Request-Reply 模式
异步 Request-Reply 模式是指:在后端处理需要是异步处理但前端仍需要明确响应的情况下,将后端处理与前端分离。
整体流程如下:
客户端应用程序对业务 API 进行调用,在后端触发长时间运行的操作;
API 立即返回响应。返回 HTTP 202 Accepted (接受) 状态码,确认已收到请求进行处理,响应包含一个标头,包含了客户端可以轮询状态的 API 地址,以检查长时间运行的操作的结果;;
客户端轮询这个状态 API,如果操作未完成,则返回 HTTP 202,否则返回 HTTP 200, 并包含实际的响应数据。
下面我们来演示如何在 ASP.NET Core 中实现。
Demo
我们用等待20秒模拟一个长时间 API 操作:
[HttpGet]
[Route("get")]
public async Task<IEnumerable<WeatherForecast>> Get()
{await Task.Delay(20000);var rng = new Random();return Enumerable.Range(1, 5).Select(index => new WeatherForecast{Date = DateTime.Now.AddDays(index),TemperatureC = rng.Next(-20, 55),Summary = Summaries[rng.Next(Summaries.Length)]}).ToArray();
}
首先,我们创建一个新 API 操作:
[HttpGet]
[Route("async/get")]
public async Task<IActionResult> AsyncGet()
{string id = Guid.NewGuid().ToString();string responseValue = $@"/status/{id}";_cache.SetString(id, responseValue);Task.Factory.StartNew(() =>{var result = Get().Result;_cache.SetString(id + "_result", JsonConvert.SerializeObject(result));});return Accepted(responseValue);
}
具体作用就是把长时间交由 Task 执行,执行结果将放到分布式缓存中,然后立刻返回 HTTP 202 Accepted。
客户端不再访问原来的请求地址,而是使用此新地址:
然后,我们创建一个状态 API 用于轮询:
[HttpGet]
[Route("/status/{id}")]
public IActionResult Status(string id)
{var result = _cache.GetString(id + "_result");if (!string.IsNullOrEmpty(result)){return Ok(result);}return Accepted(_cache.GetString(id));
}
客户端根据 ID 进行轮询。
当操作还未完成时,继续返回 HTTP 202:
当操作完成时,返回分布式缓存中的结果:
结论
如果你的 API 有长时间运行的操作,应将轮询信息尽快地返回给调用方,以便他们可以检查进度。
想了解更多内容,请关注我的个人公众号”My IO“