C# Winform跨线程更新UIkongjian

概述


C#Winform编程中，跨线程直接更新UI控件的做法是不正确的，会时常出现“线程间操作无效: 从不是创建控件的线程访问它”的异常。处理跨线程更新Winform UI控件常用的方法有4种： 
1. 通过UI线程的SynchronizationContext的Post/Send方法更新； 
2. 通过UI控件的Invoke/BegainInvoke方法更新；


3. 通过BackgroundWorker取代Thread执行异步操作； 
4. 通过设置窗体属性，取消线程安全检查来避免"跨线程操作异常"（非线程安全，建议不使用）。 
下文中对以上3种方法应用进行举例说明，希望能对初识C# Winform的同学们有些帮助。


成文表分享交流之意，惶恐水平有限，文中 理解和表述有错误之处还请大家多被批评指正。


正文


1.


用法： 


//共分三步
        //第一步：获取UI线程同步上下文（在窗体构造函数或FormLoad事件中）
        /// <summary>
        /// UI线程的同步上下文
        /// </summary>
        SynchronizationContext m_SyncContext = null;
        public Form1()
        {
            InitializeComponent();
            //获取UI线程同步上下文
            m_SyncContext = SynchronizationContext.Current;
            //Control.CheckForIllegalCrossThreadCalls = false;
        }
        //第二步：定义线程的主体方法
        /// <summary>
        /// 线程的主体方法
        /// </summary>
        private void ThreadProcSafePost()
        {
            //...执行线程任务


            //在线程中更新UI（通过UI线程同步上下文m_SyncContext）
            m_SyncContext.Post(SetTextSafePost, "This text was set safely by SynchronizationContext-Post.");


            //...执行线程其他任务
        }
        //第三步：定义更新UI控件的方法
        /// <summary>
        /// 更新文本框内容的方法
        /// </summary>
        /// <param name="text"></param>
        private void SetTextSafePost(object text)
        {
            this.textBox1.Text = text.ToString();
        }
        //之后,启动线程
        /// <summary>
        /// 启动线程按钮事件
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void setSafePostBtn_Click(object sender, EventArgs e)
        {
            this.demoThread = new Thread(new ThreadStart(this.ThreadProcSafePost));
            this.demoThread.Start();
        }
说明：三处加粗部分是关键。该方法的主要原理是：在线程执行过程中，需要更新到UI控件上的数据不再直接更新，而是通过UI线程上下文的Post/Send方法，将数据以异步/同步消息的形式发送到UI线程的消息队列；UI线程收到该消息后，根据消息是异步消息还是同步消息来决定通过异步/同步的方式调用SetTextSafePost方法直接更新自己的控件了。


在本质上，向UI线程发送的消息并是不简单数据，而是一条委托调用命令。


// 在线程中更新UI（通过UI线程同步上下文m_SyncContext） 
m_SyncContext.Post ( SetTextSafePost , " This text was set safely by SynchronizationContext-Post. " ); 
可以这样解读这行代码：向UI线程的同步上下文（m_SyncContext）中提交一个异步消息(UI线程，你收到消息后以异步的方式执行委托,调用方法 SetTextSafePost，参数是“this text was ....”).


2.通过UI控件的Invoke/BegainInvoke方法更新


用法：与方法1类似，可分为三个步骤。


// 共分三步


        // 第一步：定义委托类型
        // 将text更新的界面控件的委托类型
        delegate void SetTextCallback(string text);


        //第二步：定义线程的主体方法
        /// <summary>
        /// 线程的主体方法
        /// </summary>
        private void ThreadProcSafe()
        {
            //...执行线程任务


            //在线程中更新UI（通过控件的.Invoke方法）
            this.SetText("This text was set safely.");


            //...执行线程其他任务
        }
        //第三步：定义更新UI控件的方法
        /// <summary>
        /// 更新文本框内容的方法
        /// </summary>
        /// <param name="text"></param>
        private void SetText(string text)
        {
            // InvokeRequired required compares the thread ID of the 
            // calling thread to the thread ID of the creating thread. 
            // If these threads are different, it returns true. 
            if (this.textBox1.InvokeRequired)//如果调用控件的线程和创建创建控件的线程不是同一个则为True
            {
                while (!this.textBox1.IsHandleCreated)
                {
                    //解决窗体关闭时出现“访问已释放句柄“的异常
                    if (this.textBox1.Disposing || this.textBox1.IsDisposed)
                        return;
                }
                SetTextCallback d = new SetTextCallback(SetText);
                this.textBox1.Invoke(d, new object[] { text });
            }
            else
            {
                this.textBox1.Text = text;
            }
        }
        //之后,启动线程
        /// <summary>
        /// 启动线程按钮事件
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void setTextSafeBtn_Click(
            object sender,
            EventArgs e)
        {
            this.demoThread =
                new Thread(new ThreadStart(this.ThreadProcSafe));


            this.demoThread.Start();
        }
说明：这个方法是目前跨线程更新UI使用的主流方法，使用控件的Invoke/BegainInvoke方法，将委托转到UI线程上调用，实现线程安全的更新。原理与方法1类似，本质上还是把线程中要提交的消息，通过控件句柄调用委托交到UI线程中去处理。


解决窗体关闭时出现“访问已释放句柄“的异常 部分代码参考 博客园-事理同学的文章 。


3.


用法：


//共分三步


        //第一步：定义BackgroundWorker对象，并注册事件（执行线程主体、执行UI更新事件）
        private BackgroundWorker backgroundWorker1 =null;
        public Form1()
        {
            InitializeComponent();


           
            backgroundWorker1 = new System.ComponentModel.BackgroundWorker();
            //设置报告进度更新
            backgroundWorker1.WorkerReportsProgress = true;
            //注册线程主体方法
            backgroundWorker1.DoWork += new DoWorkEventHandler(backgroundWorker1_DoWork);
            //注册更新UI方法
            backgroundWorker1.ProgressChanged += new ProgressChangedEventHandler(backgroundWorker1_ProgressChanged);
            //backgroundWorker1.RunWorkerCompleted += new System.ComponentModel.RunWorkerCompletedEventHandler(this.backgroundWorker1_RunWorkerCompleted);
        }


        //第二步：定义执行线程主体事件
        //线程主体方法
        public void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
        {
            //...执行线程任务


            //在线程中更新UI（通过ReportProgress方法）
            backgroundWorker1.ReportProgress(50, "This text was set safely by BackgroundWorker.");


            //...执行线程其他任务
        }
        //第三步：定义执行UI更新事件
        //UI更新方法
        public void backgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
        {
            this.textBox1.Text = e.UserState.ToString();
        }
        //之后，启动线程
        //启动backgroundWorker
        private void setTextBackgroundWorkerBtn_Click(object sender, EventArgs e)
        {
            this.backgroundWorker1.RunWorkerAsync();
        }
说明：C# Winform中执行异步任务时，BackgroundWorker是个不错的选择。它是EAP（Event based Asynchronous Pattern）思想的产物，DoWork用来执行异步任务，在任务执行过程中/执行完成后，我们可以通过ProgressChanged，ProgressCompleteded事件进行线程安全的UI更新。


需要注意的是： // 设置报告进度更新 
            backgroundWorker1.WorkerReportsProgress = true ; 
默认情况下BackgroundWorker是不报告进度的，需要显示设置报告进度属性。


4. 通过设置窗体属性，取消线程安全检查来避免"线程间操作无效异常"（非线程安全，建议不使用）


用法：将Control类的静态属性CheckForIllegalCrossThreadCalls为false。


public Form1()
        {
            InitializeComponent();
            //指定不再捕获对错误线程的调用
            Control.CheckForIllegalCrossThreadCalls = false;
        }
说明：通过设置CheckForIllegalCrossThreadCalls属性，可以指示是否捕获线程间非安全操作异常。该属性值默认为ture，即线程间非安全操作是要捕获异常的（"线程间操作无效"异常）。通过设置该属性为false简单的屏蔽了该异常。Control.CheckForIllegalCrossThreadCalls的注释如下


//
        // 摘要:
        //     获取或设置一个值，该值指示是否捕获对错误线程的调用，这些调用在调试应用程序时访问控件的 System.Windows.Forms.Control.Handle
        //     属性。
        //
        // 返回结果:
        //     如果捕获了对错误线程的调用，则为 true；否则为 false。
        [EditorBrowsable(EditorBrowsableState.Advanced)]
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
        [SRDescription("ControlCheckForIllegalCrossThreadCalls")]
        [Browsable(false)]
        public static bool CheckForIllegalCrossThreadCalls { get; set; }
综述：


文中介绍的4种方法，前三种是线程安全的 ，可在实际项目中因地制宜的使用。最后一种方法是非线程安全的，初学者可以实验体会但不建议使用它。


下面列表对比一下这四种方法 


方法 线程安全 支持异步 / 同步 其他
UI Sync Context 更新 是 Post/Send 尽量在窗体构造函数、 FormLoad 中获取同步上下文
控件 Invoke 是 control.Invoke/BegainInvoke 注意检查控件句柄是否已释放
BackgroundWorker 更新 是
ProgressChanged、RunWorkerCompleted


事件同步更新 报告进度
CheckForIllegalCrossThreadCalls


取消跨线程调用检查 否 同步更新 简单，不建议使用
分类: c#
绿色通道： 好文要顶 关注我 收藏该文与我联系 
斗爷
关注 - 0
粉丝 - 19
+加关注
00
(请您对文章做出评价)
« 上一篇：MP3 Lame 转换 参数 设置(转)
» 下一篇：sqlserver 2005范例代码查询辞典文摘
posted on 2014-08-14 16:45 斗爷 阅读(2574) 评论(0) 编辑 收藏


刷新评论刷新页面返回顶部
注册用户登录后才能发表评论，请 登录 或 注册，访问网站首页。
【推荐】50万行VC++源码: 大型组态工控、电力仿真CAD与GIS源码库
【推荐】融云即时通讯云－专注为 App 开发者提供IM云服务


最新IT新闻:
· 炒域名？从微软到宝马，大品牌们都在买.news域名
· 唱吧陈华：在大冬天来之前，企业如何融资、花钱
· CEO应向软件工程师学习的7个技能
· 生鲜风口来了，不懂物流变坑口！
· A股暴跌，要回归的中概股们还回来吗？
» 更多新闻...
最新知识库文章:
· 关于软件开发，你老板不知道的7件事
· 关于烂代码的那些事（中）
· 关于烂代码的那些事（上）
· 作为码农，我们为什么要写作
· 今天你写了自动化测试吗
» 更多知识库文章...
历史上的今天:
2012-08-14 新“24孝”行动标准
Powered by: 
博客园 
Copyright © 斗爷