在WinForm開(kāi)發(fā)中有時(shí)候我們?yōu)榱瞬挥绊懼鱑I線程的處理，以前我們使用后臺(tái)線程BackgroundWorker來(lái)處理一些任務(wù)操作，不過(guò)隨著異步處理提供的便利性，我們可以使用Async-Awati異步任務(wù)處理替換原來(lái)的后臺(tái)線程BackgroundWorker處理方式，更加的簡(jiǎn)潔明了。

在一些耗時(shí)的操作過(guò)程中，在長(zhǎng)時(shí)間運(yùn)行時(shí)可能會(huì)導(dǎo)致用戶界面 (UI) 處于停止響應(yīng)狀態(tài)，因此使用使用Async-Awati異步任務(wù)處理或者后臺(tái)線程BackgroundWorker來(lái)處理一些任務(wù)操作很有必要。

 在使用BackgroundWorker的過(guò)程中，我們可以定義自己的狀態(tài)參數(shù)信息，從而實(shí)現(xiàn)線程狀態(tài)的實(shí)時(shí)跟蹤以及進(jìn)度和信息提示，方便我們及時(shí)通知UI進(jìn)行更新。

現(xiàn)在使用Async-Awati異步任務(wù)處理，一樣可以在處理過(guò)程中通知UI更新進(jìn)度和提示信息。

1. 回顧BackgroundWorker后臺(tái)線程的處理代碼

我們先來(lái)了解一下BackgroundWorker后臺(tái)線程的操作代碼，對(duì)比下再介紹使用Async-Awati異步任務(wù)處理和通知操作。

一般的使用代碼是需要初始化后臺(tái)線程對(duì)象的，如下代碼所示。

public partial class MainFrame : BaseForm
{
/// <summary>
/// 增加一個(gè)變量來(lái)記錄線程狀態(tài)
/// </summary>
private bool IsThreadRunning = false;
private BackgroundWorker worker = new BackgroundWorker();

public MainFrame()
{
InitializeComponent();

Portal.gc.InitData();

worker.WorkerSupportsCancellation = true; //支持取消
worker.WorkerReportsProgress = true; //支持報(bào)告進(jìn)度
worker.DoWork += worker_DoWork; //處理過(guò)程
worker.RunWorkerCompleted += worker_RunWorkerCompleted; //完成操作
worker.ProgressChanged += worker_ProgressChanged; //報(bào)告進(jìn)度
}

例如進(jìn)度條的通知，主要就是計(jì)算總?cè)蝿?wù)的數(shù)量，并用于顯示當(dāng)前的任務(wù)進(jìn)度信息，實(shí)例代碼如下所示：

/// <summary>
/// 進(jìn)度條的通知
/// </summary>
void worker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
this.barProgress.EditValue = e.ProgressPercentage;
CollectStateInfo stateInfo = e.UserState as CollectStateInfo;
if (stateInfo != null)
{
var message = string.Format("正在采集 {0} 的 {1} , 項(xiàng)目名稱為:{2}", stateInfo.TotalRecords, stateInfo.CompletedRecord + 1, stateInfo.CurrentItemName);
this.lblTips.Text = message;
this.barTips.Caption = message;

//記錄運(yùn)行位置
JobParameterHelper.SaveData(new CurrentJobParameter(stateInfo));
}
}

后臺(tái)進(jìn)程處理的關(guān)鍵事件就是處理過(guò)程的代碼實(shí)現(xiàn)，它處理任務(wù)的時(shí)候，把當(dāng)前的狀態(tài)通過(guò)事件方式通知UI顯示。

private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
{
BackgroundWorker worker = sender as BackgroundWorker;
Random r = new Random();
int numCount = 0;
while (worker.CancellationPending == false)
{
int num = r.Next(0, 10000);
if (num % 5 == 0)
{
numCount++;
worker.ReportProgress(0, num);
Thread.Sleep(1000);
}
}
e.Result = numCount;
}

觸發(fā)任務(wù)開(kāi)始的時(shí)候，我們調(diào)用代碼如下所示。

if (!worker.IsBusy)
{
worker.RunWorkerAsync(stateInfo);
}

任務(wù)完成后，通知更新界面即可。

void worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
//還原按鈕狀態(tài)
InitCollectState();
IsThreadRunning = false;

string message = "采集操作完成";
MessageDxUtil.ShowTips(message);
}

2. 使用Async-Awati異步任務(wù)處理代替BackgroundWorker

為了測(cè)試使用Asyn-Await異步處理，我創(chuàng)建一個(gè)簡(jiǎn)單的Demo程序，用于測(cè)試其效果。

窗體里面放置一個(gè)按鈕，觸發(fā)按鈕執(zhí)行任務(wù)操作，并逐步提示進(jìn)度條信息，完成后提示任務(wù)完成。

為了在異步處理中提示進(jìn)度信息，我們引入了Progress 線程通知對(duì)象。

定義一個(gè)線程通知的Progress對(duì)象，如下所示。這里的int也可以換為自定義的對(duì)象類，以方便承載更多的信息。

var reporter = new Progress<int>(progressChanged);

其中progressChanged 是我們定義的一個(gè)通知UI顯示進(jìn)度的處理函數(shù)，如下所示。

/// <summary>
/// 報(bào)告進(jìn)度
/// </summary>
/// <param name="percentage">當(dāng)前進(jìn)度</param>
void progressChanged(int percentage)
{
this.progressBar1.EditValue = percentage;

this.progressPanel.Caption = percentage == 100 ? "任務(wù)已完成": "任務(wù)正在處理";
this.progressPanel.Description = String.Format("完成【{0}%】", percentage);
}

接著我們定義一個(gè)處理任務(wù)的WorkStart方法，接收一個(gè)Progress對(duì)象，如下代碼所示。

var reporter = new Progress<int>(progressChanged);
var result = await this.WorkStart(reporter);

為了簡(jiǎn)單樣式異步調(diào)用，我們這里只是延遲了一下處理任務(wù)，實(shí)際處理的話，調(diào)用異步方法即可。

/// <summary>
/// 執(zhí)行任務(wù)
/// </summary>
private async Task<CommonResult> WorkStart(IProgress<int> progress)
{
var result = new CommonResult();
for(int i = 0; i < 100; i++)
{
await Task.Delay(100);
progress.Report(i + 1);
}
result.Success = true;

return result;
}

我們可以看到，任務(wù)每次執(zhí)行到一個(gè)節(jié)點(diǎn)，就會(huì)調(diào)用對(duì)象方法Report進(jìn)行通知處理。

而任務(wù)完成后，我們簡(jiǎn)單的通知處理即可。整段代碼如下所示。

/// <summary>
/// Async Await異步線程處理
/// </summary>
public partial class FrmAsyncAwaitDemo : DevExpress.XtraEditors.XtraForm
{
public FrmAsyncAwaitDemo()
{
InitializeComponent();

this.progressBar1.Visible = false;
this.progressPanel.Visible = false;
}

private async void btnStart_Click(object sender, EventArgs e)
{
this.btnStart.Enabled = false;
this.progressBar1.Visible = true;
this.progressPanel.Visible = true;

var reporter = new Progress<int>(progressChanged);
var result = await this.WorkStart(reporter);
this.WorkCompleted(result);
}

/// <summary>
/// 任務(wù)完成
/// </summary>
/// <param name="result">返回結(jié)果CommonResult</param>
void WorkCompleted(CommonResult result)
{
if (result.Success)
{
//操作成功的處理
}

var alert = new AlertControl();
alert.FormLocation = AlertFormLocation.TopRight;
alert.AutoFormDelay = 2000;
alert.Show(this, "任務(wù)提示", result.Success ? "任務(wù)處理完成，操作成功" : result.ErrorMessage);

this.progressBar1.Visible = false;
this.progressPanel.Visible = false;
this.btnStart.Enabled = true;
}

/// <summary>
/// 報(bào)告進(jìn)度
/// </summary>
/// <param name="percentage">當(dāng)前進(jìn)度</param>
void progressChanged(int percentage)
{
this.progressBar1.EditValue = percentage;

this.progressPanel.Caption = percentage == 100 ? "任務(wù)已完成": "任務(wù)正在處理";
this.progressPanel.Description = String.Format("完成【{0}%】", percentage);
}

/// <summary>
/// 執(zhí)行任務(wù)
/// </summary>
private async Task<CommonResult> WorkStart(IProgress<int> progress)
{
var result = new CommonResult();
for(int i = 0; i < 100; i++)
{
await Task.Delay(100);
progress.Report(i + 1);
}
result.Success = true;

return result;
}
}

在我們實(shí)際的案例中，文件上傳處理就使用了這種方式來(lái)通知UI線程，任務(wù)處理的代碼如下所示。

因此使用Async-Awati異步任務(wù)處理代替BackgroundWorker，代碼更加簡(jiǎn)便，而且使用 IProgress接口類來(lái)處理通知，也是非常方便的。

DevExpress WinForm | 下載試用

DevExpress WinForm擁有180+組件和UI庫(kù)，能為Windows Forms平臺(tái)創(chuàng)建具有影響力的業(yè)務(wù)解決方案。DevExpress WinForms能完美構(gòu)建流暢、美觀且易于使用的應(yīng)用程序，無(wú)論是Office風(fēng)格的界面，還是分析處理大批量的業(yè)務(wù)數(shù)據(jù)，它都能輕松勝任！

本文轉(zhuǎn)載自：

DevExpress技術(shù)交流群6：600715373      歡迎一起進(jìn)群討論