聊聊如何快速實現異步輪詢 Web API
作者：lyl
本文將介紹如何使用異步輪詢 Web API 快速實現這一功能，并提供相應的代碼示例。
在現代Web開發中，異步處理已經成為提升應用性能和用戶體驗的關鍵技術之一。特別是在處理需要較長時間完成的操作時，如文件上傳、大數據處理或第三方服務調用，異步處理能夠有效避免客戶端的長時間等待，提高系統的吞吐量和響應速度。本文將介紹如何使用異步輪詢Web API快速實現這一功能，并提供相應的代碼示例。
一、異步輪詢模式介紹
異步輪詢模式是一種客戶端定期向服務器查詢任務狀態的設計模式。其基本流程如下：
- 客戶端向Web API發起請求。
- Web API接收請求后立即返回一個“任務ID”，并開始后臺異步處理任務。
- 客戶端使用返回的“任務ID”定期向Web API發送查詢請求，以獲取任務的處理進度和狀態。
- 當任務完成后，Web API將結果保存在某個位置，并更新任務狀態為“完成”。
- 客戶端查詢到任務完成后，再向Web API發送獲取結果的請求。
二、使用Hangfire和AsyncFlow快速實現
為了簡化異步輪詢模式的實現，我們可以利用Hangfire和AsyncFlow這兩個開源庫。Hangfire是一個后臺任務調度庫，可以將任何方法轉換為后臺任務，并將任務狀態和結果持久化。AsyncFlow則是一個異步輪詢Web API生成器，可以根據Hangfire的任務自動創建異步輪詢的API端點。
步驟一：安裝必要的NuGet包
首先，你需要在你的ASP.NET Core項目中安裝以下幾個NuGet包：
- Hangfire.AspNetCore
- Hangfire.MemoryStorage（或使用其他存儲后端，如Hangfire.SqlServer）
- AsyncFlow
步驟二：配置Hangfire和AsyncFlow
在Startup.cs中配置Hangfire和AsyncFlow：
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
// 配置Hangfire使用內存存儲（生產環境建議使用更穩定的存儲后端）
services.AddHangfire(configuration => configuration.UseMemoryStorage());
services.AddHangfireServer();
// 配置AsyncFlow
services.AddAsyncFlow();
// 其他服務配置...
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// 其他中間件配置...
// 添加Hangfire的儀表盤（可選）
app.UseHangfireDashboard();
// 配置AsyncFlow的路由
app.UseAsyncFlow();
// 其他配置...
}
}步驟三：定義后臺任務
定義一個需要異步處理的任務方法，并使用Hangfire的BackgroundJob.Enqueue方法將其加入后臺任務隊列：
public class MyLongRunningTask
{
public void PerformTask(string taskId)
{
// 模擬長時間運行的任務
Thread.Sleep(10000); // 假設任務需要10秒鐘完成
// 任務完成后，可以將結果保存到某個存儲中，例如數據庫或緩存。
}
}在API控制器中觸發任務：
[ApiController]
[Route("[controller]")]
public class MyController : ControllerBase
{
private readonly IBackgroundJobClient _jobClient;
public MyController(IBackgroundJobClient jobClient)
{
_jobClient = jobClient;
}
[HttpPost]
public IActionResult StartTask()
{
string taskId = Guid.NewGuid().ToString(); // 生成唯一的任務ID
_jobClient.Enqueue<MyLongRunningTask>(x => x.PerformTask(taskId)); // 加入后臺任務隊列
return Ok(taskId); // 返回任務ID給客戶端
}
}步驟四：客戶端輪詢
客戶端在接收到任務ID后，可以定期向AsyncFlow生成的輪詢API發送請求，以獲取任務狀態。當任務完成后，再請求獲取結果。
客戶端代碼示例（使用JavaScript和Fetch API）：
async function pollTask(taskId, interval = 2000) {
let isCompleted = false;
while (!isCompleted) {
await new Promise(resolve => setTimeout(resolve, interval)); // 等待一定時間后再次輪詢
const response = await fetch(`/async-flow/status/${taskId}`); // 發送輪詢請求到AsyncFlow的狀態API
const data = await response.json();
if (data.status === 'completed') {
isCompleted = true; // 任務完成，退出輪詢循環
// 可以在這里發送獲取結果的請求，例如：fetch(`/results/${taskId}`)
console.log('Task completed!');
} else {
console.log('Task still running...');
}
}
}
// 假設從服務器獲取到了任務ID '12345'
pollTask('12345'); // 開始輪詢任務狀態三、總結
通過使用Hangfire和AsyncFlow，我們可以快速實現異步輪詢Web API，從而優化用戶體驗和系統性能。在實際應用中，你可能還需要考慮任務失敗重試、結果存儲與檢索、安全性等方面的細節。希望本文能為你提供一個良好的起點，助你在異步編程的道路上更進一步。
責任編輯：趙寧寧
來源：
后端Q
