Winform 實現(xiàn)進度條彈窗和任務(wù)控制

更新時間：2020年12月28日 09:06:30 作者：獨立觀察員•博客

這篇文章主要介紹了Winform 實現(xiàn)進度條彈窗和任務(wù)控制的方法，幫助大家更好的利用c# winform進行開發(fā)，感興趣的朋友可以了解下

最近要給一個 Winform 項目添加功能，需要一個能顯示進度條的彈窗，還要求能夠中止任務(wù)，所以就做了一個，在此做個記錄總結(jié)。雖然用的是比較老的 Winform 技術(shù)，不過其中的原理都是相通的。

一、彈窗前臺

首先提供一個 Winform 控件居中的小技巧：

將控件放在 TableLayoutPanel 容器中，然后將控件的 Anchor 屬性設(shè)置為 None，這樣控件就能在容器中居中了：

將容器的 Anchor 屬性設(shè)置為 Top, Left, Right，這樣容器就能隨著窗口左右拉伸了：

最終彈窗界面如下：

使用了 CSkin 界面庫（v16.1.14.3），（注意：如果拖拽 dll 到工具箱拖不了，可以使用右鍵復(fù)制粘貼的方式），窗體繼承 Skin_DevExpress，進度條使用 SkinProgressBar，按鈕使用 SkinButton，主要是使用了一些圓角效果：

二、彈窗后臺

先添加兩個事件供外界訂閱，分別為窗體載入時觸發(fā)的執(zhí)行操作事件，和點擊中止按鈕后觸發(fā)的終止操作事件：

/// <summary>
/// 執(zhí)行操作事件
/// </summary>
public event Action OperateAction;

/// <summary>
/// 終止操作事件
/// </summary>
public event Action AbortAction;

/// <summary>
/// 中止按鈕點擊事件
/// </summary>
private void btn_Abort_Click(object sender, EventArgs e)
{
  AbortAction?.Invoke();
  DialogResult = DialogResult.Abort;
  //Close(); //不需要手動關(guān)閉;
}

/// <summary>
/// 窗體載入事件
/// </summary>
private void FormProgressDialog_Load(object sender, EventArgs e)
{
  Task.Factory.StartNew(() =>
  {
    OperateAction?.Invoke();
    DialogResult = DialogResult.OK;
  });
}

點擊中止按鈕后還將彈窗結(jié)果設(shè)為 Abort，會自動關(guān)閉彈窗；而業(yè)務(wù)操作正常執(zhí)行完畢，彈窗結(jié)果為 OK。

供外界設(shè)置文本信息以及進度條進度的方法如下：

/// <summary>
/// 設(shè)置顯示信息(值為null時保持不變)
/// </summary>
/// <param name="rtfTitleContent">富文本格式的標(biāo)題內(nèi)容</param>
/// <param name="totalMessage">總體消息</param>
/// <param name="currentMessage">當(dāng)前消息</param>
public void SetInfo(string rtfTitleContent = null, string totalMessage = null, string currentMessage = null)
{
  if (rtfTitleContent != null) rtb_Title.Rtf = rtfTitleContent;
  if (totalMessage != null) lbl_Total.Text = totalMessage;
  if (currentMessage != null) lbl_Current.Text = currentMessage;
}

/// <summary>
/// 設(shè)置進度
/// </summary>
/// <param name="currentValue">當(dāng)前數(shù)值</param>
/// <param name="totalValue">總數(shù)值</param>
public void SetProsess(double currentValue, double totalValue)
{
  try
  {
    progressBar.Value = (int)(currentValue / totalValue * 100);
  }
  catch (Exception ex)
  {
    Console.WriteLine(ex);
  }
}

剩下就是兩個設(shè)置富文本框 RichTextBox 的方法，包括設(shè)置彩色內(nèi)容和隱藏 RichTextBox 光標(biāo)的方法，文末會給出代碼地址，此處不再贅述。

三、使用方法

首先映入眼簾的是兩個成員變量，一個是用于任務(wù)取消的 CancellationTokenSource 對象，另一個是用于線程同步的 AutoResetEvent 對象（用于取消任務(wù)后的一些信息同步）；然后是主測試方法（一個按鈕點擊事件方法）中的一些信息設(shè)置：

然后設(shè)置 CancellationTokenSource 對象的 Token，給它注冊一個取消任務(wù)時調(diào)用的委托方法，里面先等待同步信號結(jié)果再進行本次執(zhí)行結(jié)果的判斷：

接下來訂閱彈窗中的那兩個事件，在執(zhí)行操作事件中開啟任務(wù)，并傳遞 Token；在中止事件中停止任務(wù)：

需要注意的是，停止任務(wù)后，任務(wù)內(nèi)部并不會自己停止，需要判斷 Token 的 IsCancellationRequested 字段來決定相應(yīng)的操作，比如結(jié)束循環(huán)。然后，因為在之前注冊的取消的委托方法中，進行了等待，所以我們在執(zhí)行完業(yè)務(wù)方法（BusinessMethod）并設(shè)置好相關(guān)狀態(tài)值后，需要判斷任務(wù)是否取消，如果取消，說明注冊的取消的委托方法中已經(jīng)在等待了，所以要調(diào)用 Set () 進行放行。

有人可能就會問了，foreach 循環(huán)開始時不是判斷過是否取消了嗎？這里怎么又判斷？這是因為，比如在一輪循環(huán)中，已經(jīng)執(zhí)行過了開頭的是否已取消的判斷（IsCancellationRequested 為 false），開始執(zhí)行耗時的業(yè)務(wù)方法了，此時用戶點擊中止按鈕，IsCancellationRequested 被置為 true，所以業(yè)務(wù)方法執(zhí)行后再次判斷會得到最新的狀態(tài)，然后，循環(huán)將在下一輪開始時結(jié)束。

另外，由于實際使用這個的項目是 .NET 4.0 框架，所以 Task 的一些方法沒有，大家用新框架的話可以使用新方法?；蛘呤褂?nbsp;Microsoft.Bcl.Async 包，然后使用 TaskEx。

繼續(xù)流程，接下來以模態(tài)框方式彈出窗口，并獲取結(jié)果。業(yè)務(wù)處理方法中模擬了耗時操作并返回是否成功。

最后給出完整代碼：

#region 測試任務(wù)進度條彈窗

private CancellationTokenSource _Cts; //任務(wù)取消令牌;
private AutoResetEvent _AutoResetEvent = new AutoResetEvent(false);//參數(shù)傳 false，則 WaitOne 時阻塞等待;

/// <summary>
/// 測試任務(wù)進度彈窗
/// </summary>
private void BtnProgressDialog_Click(object sender, EventArgs e)
{
  _AutoResetEvent.Reset();
  string businessName = "業(yè)務(wù)1";

  FormProgressDialog progressWindow = new FormProgressDialog()
  {
    Text = "任務(wù)處理窗口",
  };

  progressWindow.SetColorfulTitle("業(yè)務(wù)1 ", Color.DarkOrange, true);
  progressWindow.SetColorfulTitle("正在執(zhí)行中......", Color.Black);
  progressWindow.SetInfo(null, "", "");

  List<string> orders = new List<string>(){"訂單1", "訂單2", "訂單3", "訂單4", "訂單5" }; //業(yè)務(wù)數(shù)據(jù);
  List<string> leftList = orders.Select(x => x).ToList(); //剩余（未處理）數(shù)據(jù);
  int successCount = 0; //成功數(shù)量;

  _Cts = new CancellationTokenSource();

  //注冊一個將在取消此 CancellationToken 時調(diào)用的委托;
  _Cts.Token.Register(async () =>
  {
    ShowInfo("操作終止");
    
    await Task.Run(() =>
    {
      _AutoResetEvent.WaitOne(1000 * 5); //等待有可能還在執(zhí)行的業(yè)務(wù)方法;

      if (successCount < orders.Count)
      {
        ShowInfo($"{businessName} 有 {orders.Count - successCount} 項任務(wù)被終止，可在消息框中查看具體項。");

        foreach (var leftName in leftList)
        {
          ShowInfo($"【{businessName}】的【{leftName}】執(zhí)行失敗，失敗原因：【手動終止】。");
        }
      }
    });
    
  });

  progressWindow.OperateAction += () =>
  {
    Task task = new Task(() =>
    {
      foreach (var order in orders)
      {
        //判斷是否被取消;
        if (_Cts.Token.IsCancellationRequested)
        {
          break;
        }

        progressWindow.TryBeginInvoke(new Action(() =>
        {
          progressWindow.SetInfo(null, $"共{orders.Count}項，已執(zhí)行{successCount}項", $"當(dāng)前正在執(zhí)行：{order}");
        }));

        if (BusinessMethod(order, businessName))
        {
          successCount++;
          leftList.RemoveAll(x => x == order);

          if (_Cts.Token.IsCancellationRequested)
          {
            _AutoResetEvent.Set(); //放行 Register 委托處的等待;
          }
        }

        progressWindow.TryBeginInvoke(new Action(() =>
        {
          progressWindow.SetProsess(orders.IndexOf(order) + 1, orders.Count);
        }));
      }
    }, _Cts.Token);

    task.Start();
    task.Wait();
  };

  progressWindow.AbortAction += () =>
  {
    _Cts.Cancel();
  };

  var result = progressWindow.ShowDialog();
  int leftCount = orders.Count - successCount;
  if (result == DialogResult.OK || leftCount <= 0)
  {
    ShowInfo($"{businessName} 整體完成。");
  }
  else if (result == DialogResult.Abort)
  {
    //移到 _Cts.Token.Register 處一起判斷，不然數(shù)目可能不準(zhǔn);
    //ShowInfo($"{businessName} 有 {leftCount} 項任務(wù)被終止，可在消息框中查看具體項。");
  }
}

/// <summary>
/// 業(yè)務(wù)處理方法
/// </summary>
private bool BusinessMethod(string order, string businessName)
{
  string errStr = $"【{businessName}】的 {order} 任務(wù)失敗，失敗原因：";

  //測試
  Thread.Sleep(1000 * 2);

  try
  {
    //業(yè)務(wù)方法;

    ShowInfo($"【{businessName}】的 {order} 任務(wù)執(zhí)行成功。");
    return true;
  }
  catch (Exception ex)
  {
    ShowInfo($"{errStr}{ex.Message}");
  }

  return false;
}

#endregion