Winform 讓跨線程訪問變得更簡單

前言

　　由於多線程可能導致對控件訪問的不一致，導致出現問題。C#中默認是要線程安全的，即在訪問控件時需要首先判斷是否跨線程，如果是跨線程的直接訪問，在運行時會拋出異常。近期在項目中碰到這個問題，首先想到的是，關閉跨線程檢查，因為做的Winform沒有多么復雜，圖省事就直接這樣做了，之后又出了一點點問題，還是必需通過委托的方式來實現。

資源下載

　　測試示例

解決跨線程訪問

　　網上的資料很多，這里直接摘抄。

　　1、關閉跨線程檢查。

　　2、通過委托的方式，在控件的線程上執行。

　　具體的代碼如下：

using System;
using System.Threading;
using System.Windows.Forms;

namespace WindowsFormsApplication1
{
    public partial class Form2 : Form
    {
        public Form2()
        {
            InitializeComponent();
            //方法一：不進行跨線程安全檢查  
            CheckForIllegalCrossThreadCalls = false;
        }

        private void button1_Click(object sender, EventArgs e)
        {
            Thread th1 = new Thread(new ThreadStart(CalNum));
            th1.Start();  
        }

        private void CalNum()
        {
            SetCalResult(DateTime.Now.Second);
        }

        //方法二：檢查是否跨線程，然后將方法加入委托，調用委托  
        public delegate void SetTextHandler(int result);
        private void SetCalResult(int result)
        {
            if (label2.InvokeRequired == true)
            {
                SetTextHandler set = new SetTextHandler(SetCalResult);//委托的方法參數應和SetCalResult一致  
                label2.Invoke(set, new object[] { result }); //此方法第二參數用於傳入方法,代替形參result  
            }
            else
            {
                label2.Text = result.ToString();
            }
        }
    }
}

改進

　　在我的Winform程序中，子線程涉及到對多個控件的更改，於是封裝了一下，我這里使用的是拓展方法，只有在.net 3.5上才能支持，如果是.net2.0的環境，需要添加

namespace System.Runtime.CompilerServices
{
    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class | AttributeTargets.Assembly)]
    public class ExtensionAttribute : Attribute { }
}

　　封裝如下：

using System.Threading;
using System.Windows.Forms;

namespace WindowsFormsApplication1
{
   public static class Class1
    {
       /// <summary>
       /// 跨線程訪問控件 在控件上執行委托
       /// </summary>
       /// <param name="ctl">控件</param>
       /// <param name="del">執行的委托</param>
       public static void CrossThreadCalls(this Control ctl, ThreadStart del)
       {
           if (del == null) return;
           if (ctl.InvokeRequired)
               ctl.Invoke(del, null);
           else
               del();
       }
    }
}

　　具體的測試如下：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Threading;
using System.Windows.Forms;

namespace WindowsFormsApplication1
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            var th = new Thread(() =>
            {
                //label1.Enabled = false;
                label1.CrossThreadCalls(() => { label1.Enabled = !label1.Enabled; });
                WriteMessage(DateTime.Now.ToString());
            });
            th.IsBackground = true;
            th.Start();
        }


        public void WriteMessage(string msg)
        {
            label1.CrossThreadCalls(() =>
            {
                label1.Text = msg;
            });
        }
    }
}

　　這樣一行代碼就可以完成跨線程訪問啦。

　　經過9樓朋友的提醒，發現直接在控件上調用BeginInvoke也是可以的，看來是自己Winform編程太少，在此記錄一下。這里采用的是匿名方法轉換成委托，和無參委托+lambda表達式2種寫法。

　　下面的例子是直接在Label控件上調用的，而事實上，控件上調用BeginInvoke和Invoke的方法含義是在創建該控件的線程上執行或者異步執行某個委托。既然如此，我的窗體控件和窗體本身都是同一個線程（主線程）來創建的，那么是不是在form上調用，委托內部去改變其他控件的值也是可以的呢？事實上，將下面的代碼中label1換成this，結果也是完全正確。　　

        private void button4_Click(object sender, EventArgs e)
        {
            label1.BeginInvoke(new ThreadStart(() =>
            {
                label1.Text = DateTime.Now.ToString();
            }));
        }

        private void button5_Click(object sender, EventArgs e)
        {
            label1.BeginInvoke((MethodInvoker)delegate
            {
                label1.Text = DateTime.Now.ToString() + " :匿名方法";
            });
        }

　　舉一反三，有些控件上不支持BeginInvoke和Invoke，比如說，是statusStrip控件內部的組件，如toolStripStatusLabel。此時就可以在其他組件上調用Invoke，或者BeginInvoke來控制它了。詳見示例。

            this.BeginInvoke(new Action(() =>
            {
                toolStripStatusLabel1.Text = DateTime.Now.ToString();
            }));