在一些耗時的操作過程中，在長時間運行時可能會導(dǎo)致用戶界面 (UI) 處于停止響應(yīng)狀態(tài)，用戶在這操作期間無法進行其他的操作，為了不使UI層處于停止響應(yīng)狀態(tài)，我們傾向推薦用戶使用BackgroundWorker來進行處理，這個后臺的線程處理，可以很好的實現(xiàn)常規(guī)操作的同時，還可以及時通知UI，包括當(dāng)前處理信息和進度等，這個BackgroundWorker的處理在百度里面也是有很多使用的介紹，本文主要是做一些自己的使用總結(jié)，希望也能給讀者提供一個參考。

在使用BackgroundWorker的過程中，我們可以定義自己的狀態(tài)參數(shù)信息，從而實現(xiàn)線程狀態(tài)的實時跟蹤以及進度和信息提示，方便我們及時通知UI進行更新。本篇隨筆主要針對一些數(shù)據(jù)采集過程的處理，在網(wǎng)上采集特定的數(shù)據(jù)往往需要耗時幾個小時以上，如果采用常規(guī)的同步操作，比較麻煩，而如果引入一些SmartThreadPool這些第三方類庫有顯得臃腫，而且資源耗費的也很嚴(yán)重，因此使用BackgroundWorker相對比較輕型的方案比較吸引我。

采集的數(shù)據(jù)處理

例如是我采集數(shù)據(jù)的一個局部界面，主要是根據(jù)一些參數(shù)進行數(shù)據(jù)的采集，采集過程可以通過狀態(tài)欄和右邊的標(biāo)簽進行反饋，在狀態(tài)欄顯示采集進度等信息，實現(xiàn)比較友好的信息顯示。

一般我們定義后臺線程處理，可以在該窗體定義一個變量即可，如下代碼所示：

private BackgroundWorker worker = new BackgroundWorker();

然后就是對這個后臺線程處理對象的一些事件進行實現(xiàn)即可，如下代碼所示：

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

public MainFrame()
{
InitializeComponent();

Portal.gc.InitData();

worker.WorkerSupportsCancellation = true; //支持取消
worker.WorkerReportsProgress = true; //支持報告進度
worker.DoWork += worker_DoWork; //處理過程
worker.RunWorkerCompleted += worker_RunWorkerCompleted; //完成操作
worker.ProgressChanged += worker_ProgressChanged; //報告進度
}

例如進度條的通知，主要就是計算總?cè)蝿?wù)的數(shù)量，以及當(dāng)前完成的人數(shù)數(shù)量，我們實現(xiàn)代碼如下所示：

/// <summary>
/// 進度條的通知
/// </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} , 項目名稱為:{2}", stateInfo.TotalRecords, stateInfo.CompletedRecord + 1, stateInfo.CurrentItemName);
this.lblTips.Text = message;
this.barTips.Caption = message;

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

這里我們看到了，這個里面使用了一個自定義的狀態(tài)參數(shù)CollectStateInfo ，這個是我們用來在后臺進程處理過程中傳遞的一個對象，可以記錄當(dāng)前采集的相關(guān)信息，CollectStateInfo 類的定義如下所示。

/// <summary>
/// 狀態(tài)對象數(shù)據(jù)
/// </summary>
public class CollectStateInfo
{
/// <summary>
/// 當(dāng)前期數(shù)(年份+期數(shù))
/// </summary>
public string YearQSNumber { get; set; }

/// <summary>
/// 任務(wù)開始時間
/// </summary>
public DateTime StartTime { get; set; }

private DateTime m_EndTime = DateTime.Now;

/// <summary>
/// 任務(wù)開始時間
/// </summary>
public DateTime EndTime
{
get
{
return m_EndTime;
}
set
{
//設(shè)置結(jié)束時間的時候，獲取耗時
m_EndTime = value;
this.TimeSpanUsed = value.Subtract(this.StartTime);
}
}

/// <summary>
/// 任務(wù)用時
/// </summary>
public TimeSpan TimeSpanUsed { get; set; }

/// <summary>
/// 任務(wù)數(shù)量
/// </summary>
public int TotalRecords { get; set; }

private int m_CompletedRecord = 0;

/// <summary>
/// 完成數(shù)量
/// </summary>
public int CompletedRecord
{
get
{
return m_CompletedRecord;
}
set
{
m_CompletedRecord = value;
if (TotalRecords > 0)
{
this.CurrentProgress = Convert.ToInt32(value * 100.0 / TotalRecords);
}
}
}

/// <summary>
/// 當(dāng)前進度
/// </summary>
public int CurrentProgress { get; set; }

/// <summary>
/// 當(dāng)前采集的項目
/// </summary>
public string CurrentItemName { get; set; }

/// <summary>
/// 默認構(gòu)造函數(shù)
/// </summary>
/// <param name="total"></param>
public CollectStateInfo()
{
this.StartTime = DateTime.Now;
this.EndTime = DateTime.Now;
}

/// <summary>
/// 構(gòu)造函數(shù)
/// </summary>
/// <param name="total">任務(wù)數(shù)量</param>
/// <param name="qsNumber">采集當(dāng)前期數(shù)</param>
public CollectStateInfo(int total, string qsNumber, int completed) :this()
{
this.TotalRecords = total;
this.YearQSNumber = qsNumber;
this.CompletedRecord = completed;
}

}

上面的對象，主要用來記錄任務(wù)的總數(shù)，以及當(dāng)前進行的數(shù)量，還包括一些其他信息，如任務(wù)的開始時間，結(jié)束時間等等，我們可以把一些常規(guī)的任務(wù)信息，放到這里面來傳遞即可。

另一個后臺進程處理的關(guān)鍵事件就是處理過程的代碼實現(xiàn)，主要就是采集處理的邏輯內(nèi)容，如下所示。

void worker_DoWork(object sender, DoWorkEventArgs e)
{
CollectStateInfo info = e.Argument as CollectStateInfo;
if (info != null)
{
LinkJob job = new LinkJob();
var stateInfo = job.Execute(this.worker, info);
e.Result = stateInfo;
}
}

這個里面我么主要到它的e.Argument 就是我們傳遞的對象，通過類型轉(zhuǎn)換我們就可以獲得對應(yīng)的信息，然后進行具體的處理了。

另外一個就是當(dāng)整個后臺進程完成處理后，我們需要進行相關(guān)的提示和狀態(tài)處理，實現(xiàn)代碼如下所示。

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

string message = "采集操作完成";
CollectStateInfo stateInfo = e.Result as CollectStateInfo;
if (stateInfo != null && stateInfo.CompletedRecord == stateInfo.TotalRecords)
{
message += string.Format("，完成采集網(wǎng)址{0}個,耗時為：{1}分鐘{2}秒。", stateInfo.TotalRecords, stateInfo.TimeSpanUsed.Minutes, stateInfo.TimeSpanUsed.Seconds);

//清空數(shù)據(jù)即可
JobParameterHelper.ClearData();
}
else
{
message += string.Format("，用戶取消處理,耗時為：{1}分鐘{2}秒。", stateInfo.TotalRecords, stateInfo.TimeSpanUsed.Minutes, stateInfo.TimeSpanUsed.Seconds);
}
MessageDxUtil.ShowTips(message);
}

而我們開始任務(wù)，則通過按鈕觸發(fā)后臺線程的異步接口調(diào)用即可，如下代碼所示。

if (!worker.IsBusy)
{
this.btnStartCollect.ImageOptions.Image = Resources.Button_Stop;
this.lblTips.Text = "數(shù)據(jù)采集中....，單擊按鈕可停止采集";
this.btnStartCollect.Text = "停止采集";

var totalCount = BLLFactory<URLLink>.Instance.GetRecordCount();//數(shù)量為總數(shù)
var stateInfo = new CollectStateInfo(totalCount, yearQSNumber, skipCount);

worker.RunWorkerAsync(stateInfo);
//改變狀態(tài)
IsThreadRunning = !IsThreadRunning;
}

這里面我們設(shè)置提示開始采集數(shù)據(jù)后，然后構(gòu)建一個可以用于傳遞的線程采集對象給后臺線程，通過異步調(diào)用worker.RunWorkerAsync(stateInfo); 即可實現(xiàn)任務(wù)的開始操作。

如果任務(wù)總之，我們調(diào)用取消接口即可。

if (MessageDxUtil.ShowYesNoAndWarning("采集正在進行中，您確認停止采集嗎？") == System.Windows.Forms.DialogResult.Yes)
{
worker.CancelAsync();

//改變狀態(tài)
IsThreadRunning = !IsThreadRunning;

//還原按鈕狀態(tài)
InitCollectState();

啟動采集界面進行相應(yīng)的處理即可，如下所示。

采集過程的進度可以通過狀態(tài)欄實時的顯示出來，這個有賴于我們定義的狀態(tài)類，可以很方便進行UI的信息通知。

以上就是使用后臺 線程BackgroundWorker處理任務(wù)的一些總結(jié)，希望給讀者帶來一些參考價值，在我們做一些耗時的操作的時候，可以考慮使用這個后臺線程BackgroundWorker處理任務(wù)，從而實現(xiàn)較好的界面通知，也不會造成UI界面的停頓卡死狀態(tài)。

DevExpress | 下載試用

DevExpress Universal 10月正式發(fā)布今年第二個重大版本——v21.2，此版本正式官宣支持Visual Studio 2022 & .NET6，同時與微軟最新發(fā)布的Windows 11完美兼容，全面解決用戶各種使用場景問題。 與時俱進，從未止步！

本文轉(zhuǎn)載自：

DevExpress技術(shù)交流群5：742234706      歡迎一起進群討論