使用后台線程BackgroundWorker處理任務的總結

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

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

采集的數據處理

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

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

        private BackgroundWorker worker = new BackgroundWorker();

然后就是對這個后台線程處理對象的一些事件進行實現即可，如下代碼所示

    public partial class MainFrame : BaseForm
    {
        /// <summary>
        /// 增加一個變量來記錄線程狀態
        /// </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;       //報告進度
        }

例如進度條的通知，主要就是計算總任務的數量，以及當前完成的人數數量，我們實現代碼如下所示

        /// <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));
            }
        }

這里我們看到了，這個里面使用了一個自定義的狀態參數CollectStateInfo ，這個是我們用來在后台進程處理過程中傳遞的一個對象，可以記錄當前采集的相關信息，CollectStateInfo 類的定義如下所示。

    /// <summary>
    /// 狀態對象數據
    /// </summary>
    public class CollectStateInfo
    {
        /// <summary>
        /// 當前期數(年份+期數)
        /// </summary>
        public string YearQSNumber { get; set; }

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

        private DateTime m_EndTime = DateTime.Now;

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

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

        /// <summary>
        /// 任務數量
        /// </summary>
        public int TotalRecords { get; set; }

        private int m_CompletedRecord = 0;

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

        /// <summary>
        /// 當前進度
        /// </summary>
        public int CurrentProgress { get; set; }

        /// <summary>
        /// 當前采集的項目
        /// </summary>
        public string CurrentItemName { get; set; }

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

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

    }

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

另一個后台進程處理的關鍵事件就是處理過程的代碼實現，主要就是采集處理的邏輯內容，如下所示。

        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 就是我們傳遞的對象，通過類型轉換我們就可以獲得對應的信息，然后進行具體的處理了。

另外一個就是當整個后台進程完成處理后，我們需要進行相關的提示和狀態處理，實現代碼如下所示。

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

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

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

而我們開始任務，則通過按鈕觸發后台線程的異步接口調用即可，如下代碼所示。

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

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

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

這里面我們設置提示開始采集數據后，然后構建一個可以用於傳遞的線程采集對象給后台線程，通過異步調用worker.RunWorkerAsync(stateInfo); 即可實現任務的開始操作。

如果任務總之，我們調用取消接口即可。

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

                    //改變狀態
                    IsThreadRunning = !IsThreadRunning;

                    //還原按鈕狀態
                    InitCollectState();
                }

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

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

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