[转]C#Invoke和BeginInvoke应用详解

发布时间 2023-09-19 13:45:27作者: CastleWu

最近,在研究Invoke的使用,但是真的是一头雾水,网上看了很多资料,感觉还是看不懂,因为对于入门级的小白,想像不出Invoke的应用场景,更谈不上如何用了?

1、Invoke到底是什么?

Invoke的本质只是一个方法,方法一定是要通过对象来调用的。

一般来说,Invoke其实用法只有两种情况:

  • Control的Invoke
  • Delegate的Invoke

也就是说,Invoke前面要么是一个控件,要么是一个委托对象

2、什么时候用Invoke

2.1 Control的Invoke

Control的Invoke一般用于解决跨线程访问的问题,比如你想操作一个按钮button,你就要用button.Invoke,你想操作一个文本label,你就要用label.Invoke,但是大家会发现很麻烦,如果我想既操作button,又操作label,能不能写在一起呢?当然可以。
我们知道,主窗体是一个Form,Form自然也是继承Control的,所以Form也有Invoke的方法,可以直接调用Form.Invoke,这就是我们常见的this.Invoke。
这就是为什么有的Invoke前面啥都没有的问题,其实前面是this,只不过省略了。

2.2 Delegate的Invoke

Delegate的Invoke其实就是从线程池中调用委托方法执行,Invoke是同步的方式,会卡住调用它的UI线程。很抽象吧。

3、实验

我们来做个简单的实验。

3.1 新建一个From ,来个Button,我想实现的功能是,点击Button时, Button 变成Disable,并开始显示计算1到8(每隔1秒加1),加到8后,跳出循环,然后把Button Enable,很简单吧。

小事情拉,于是开始行动,很快就搞定了,代码如下:

  1. namespace InvokeTest1
  2. {
  3. public partial class Form1 : Form
  4. {
  5. public Form1()
  6. {
  7. InitializeComponent();
  8. }
  9. /// <summary>
  10. /// Butten 点击事件
  11. /// </summary>
  12. /// <param name="sender"></param>
  13. /// <param name="e"></param>
  14. private void btnAddFunction_Click_1(object sender, EventArgs e)
  15. {
  16. btnAddFunction.Enabled = false;
  17. for (int i = 1; i < 8; i++)
  18. {
  19. btnAddFunction.Text = i.ToString();
  20. Thread.Sleep(1000);
  21. }
  22. btnAddFunction.Text = "点击开始运行";
  23. btnAddFunction.Enabled = true;
  24. }
  25. }
  26. }

开始运行,点击Button,控件是变成Disable,但是没有实现计数呀,而是一直就这样停止8秒,就像被卡住了一样。

 8秒后,Button控件直接变成Enable。没有1---8出现,逻辑不对啊,怎么回事?????

原因:直接主线程休眠是达不到效果的,此时桌面还处于假死状态,更新不了text值。代码放在了UI线程执行,阻塞了UI的显示,所以中间的结果你看不到。

3.2 找到了原因,那就好办了,既然代码放在了UI线程,那就新建个线程,在那里面更新UI控件好了。信心满满的开始行动。

  1. namespace InvokeTest1
  2. {
  3. public partial class Form1 : Form
  4. {
  5. public Form1()
  6. {
  7. InitializeComponent();
  8. }
  9. /// <summary>
  10. /// Butten 点击事件
  11. /// </summary>
  12. /// <param name="sender"></param>
  13. /// <param name="e"></param>
  14. private void btnAddFunction_Click_1(object sender, EventArgs e)
  15. {
  16. //启动一个线程,在这个线程里更新Button值
  17. new Thread(ThreadTask).Start();
  18. }
  19. /// <summary>
  20. /// 线程函数
  21. /// </summary>
  22. public void ThreadTask()
  23. {
  24. btnAddFunction.Enabled = false;
  25. for (int i = 1; i < 8; i++)
  26. {
  27. btnAddFunction.Text = i.ToString();
  28. Thread.Sleep(1000);
  29. }
  30. btnAddFunction.Text = "点击开始运行";
  31. btnAddFunction.Enabled = true;
  32. }
  33. }
  34. }

真实现了数字的更新。

 功能是实现了,但没有达到我的目的,主角都没有登场,就谢幕了啊。网上查看了资料,说,这种方法,是不稳定的,特别是主窗口控件比较多的时候,很容易出错,造成画面混乱。为什么呢?因为控件是在主线程中创建的(比如this.Controls.Add(...);),进入控件的事件响应函数时,是在控件所在的线程,并不是主线程。在控件的事件响应函数中改变控件的状态,可能与主线程发生线程冲突。如果主线程正在重绘控件外观,此时在别的线程改变控件外观,就会造成画面混乱。

4、主角出场

4.1 C#的委托机制,一般有下面几种方式。

  1. //第一种
  2. btnAddFunction.Invoke(new EventHandler(delegate{button1.Text = "关闭";}));
  3. //第二种
  4. this.Invoke(new EventHandler(delegate{button1.Text = "关闭";}));
  5. //第三种 网上说自C# 3.0开始就有了
  6. this.Invoke(new Action(() =>{ button1.Text = "关闭";}));

现在应用最多就是第3种了,因为现在版本基本上都是4.0以上了,所以线程函数改为如下的:

  1. namespace InvokeTest1
  2. {
  3. public partial class Form1 : Form
  4. {
  5. public Form1()
  6. {
  7. InitializeComponent();
  8. }
  9. /// <summary>
  10. /// Butten 点击事件
  11. /// </summary>
  12. /// <param name="sender"></param>
  13. /// <param name="e"></param>
  14. private void btnAddFunction_Click_1(object sender, EventArgs e)
  15. {
  16. //启动一个线程,在这个线程里更新Button值
  17. new Thread(ThreadTask).Start();
  18. }
  19. /// <summary>
  20. /// 线程函数
  21. /// </summary>
  22. public void ThreadTask()
  23. {
  24. //首先将button对象禁用
  25. this.Invoke(new Action(() =>
  26. {
  27. btnAddFunction.Enabled = false;
  28. }));
  29. for (int i = 0; i < 10; i++)
  30. {
  31. this.Invoke(new Action(() =>
  32. {
  33. btnAddFunction.Text = i.ToString();
  34. }));
  35. Thread.Sleep(1000);
  36. }
  37. //虽然不是循环内,请不要忘记,你的调用依然在辅助线程中,所以,还是需要invoke的。
  38. this.Invoke(new Action(() =>
  39. {
  40. btnAddFunction.Text = "点击开始运行";
  41. btnAddFunction.Enabled = true;
  42. }));
  43. }
  44. }
  45. }

4.2 Control的Invoke标准用法

其实,对于Control的Invoke,更标准的用法是先加判断,再调用。

  1. if (this.lbl_Value.InvokeRequired)
  2. {
  3. this.lbl_Value.Invoke(new Action(() =>
  4. {
  5. this.lbl_Value.Text = "Invoke功能测试";
  6. }));
  7. }
  8. else
  9. {
  10. this.lbl_Value.Text = "Invoke测试失效";
  11. }

InvokeRequired是Control的一个属性,官方解释为:
获取一个值,该值指示调用方在对控件进行方法调用时是否必须调用 Invoke 方法,因为调用方位于创建控件所在的线程以外的线程中。如果控件的 Handle 是在与调用线程不同的线程上创建的(说明您必须通过 Invoke 方法对控件进行调用),则为 true;否则为 false。

简单来说,就是如果通过多线程去操作这个控件,那么这个属性则为True,否则为False。

实例化一个 this invoke的用法

  1. using System.Threading;
  2. public delegate void MyInvoke(string str);//invoke方法创建委托
  3. private void btnStartThread_Click(object sender, EventArgs e)
  4. {
  5. Thread thread = new Thread(new ThreadStart(DoWord));
  6. thread.Start();
  7. }
  8. public void DoWord()
  9. {
  10. MyInvoke mi = new MyInvoke(SetTxt);//实例化一个委托,并且指定委托方法
  11. BeginInvoke(mi,new object[]{"abc"}); //调用invoke方法
  12. }
  13. public void SetTxt(string str)//委托对应的方法
  14. {
  15. txtReceive.Text += str;
  16. }

4.3 Delegate的Invoke 标准写法

对于Delegate的Invoke,我们一般判断这个方法之前,也是做个判断,判断这个委托对象是否为Null,所以更标准的写法如下:

  1. DelegateInvokeFun testDelegate = new DelegateInvokeFun(DelegateInvokeMethod);
  2. testDelegate?.Invoke();

5、 Invoke和BeginInvoke

Control.Invoke 和 Control.BeginInvoke

5.1 测试实例1 利用 控件中的Invoke 和 BeginInvoke 方法

作用1:在线程中执行访问和修改UI内容

作用2:Invoke可以阻塞线程,等待UI操作返回

作用3:BeginInvoke不阻塞线程,后台刷新UI,提高程序的流畅性
 

  1. public partial class frmMain : Form
  2. {
  3. public frmMain ()
  4. {
  5. InitializeComponent();
  6. }
  7. public void ThreadRun()
  8. {
  9. while (true)
  10. {
  11. Thread.Sleep(1);
  12. this.Invoke(new Action(() =>
  13. {
  14. MessageBox.Show("Invoke的方法");
  15. // 在该this(Form)控件的线程中执行Action中的委托
  16. // 你可以在此获取UI变量 或者 改变UI变量
  17. // 但是 ThreadRun线程会被阻塞 等待 Action 执行完成
  18. }));
  19. this.BeginInvoke(new Action(() =>
  20. {
  21. MessageBox.Show("BeginInvoke的方法");
  22. // 在该this(Form)控件的线程中执行Action中的委托
  23. // 你可以在此获取UI变量 或者 改变UI变量
  24. // 但是 ThreadRun线程不会被阻塞继续向下执行
  25. }));
  26. }
  27. }
  28. }

5.2 测试实例2 Action 等delegate 中Invoke和BeginInvoke的作用

作用1.Invoke在当前函数中立即执行,相当于直接调用该Action所注册的所有函数,阻塞当前函数帧

作用2.BeginInvoke在当前函数帧中开辟这个线程去执行Action所注册的函数,不阻塞当前函数帧

作用3.BeginInvoke 中有2额外两个参数 (arg1 回调委托,任意参数)用于beginInvoke完成后,执行该某些动作,

注意:结束完回调的函数 所在线程  为调用beginInvoke 的线程
 

  1. private void Form1_Load(object sender, EventArgs e)
  2. {
  3. // 在当前函数所在线程中执行,当前函数线程阻塞
  4. ShowMsg += (str) => { Debug.WriteLine(str); };
  5. ShowMsg.Invoke("This is Invoke test!");
  6. // 开辟一个线程执行 BeginInvoke Test,当前函数线程不阻塞
  7. ShowMsg.BeginInvoke(" BeginInvoke Test", null, null);
  8. // AsyncCallback 回调委托
  9. // IAsyncResult 异步执行的结果,可以自我继承,添加自定义参数 用于显示异步执行的状态
  10. // index(object类型) 外部传参,存储在IAsyncResult.AsyncState中
  11. AsyncCallback asyncCallback = ar => { Debug.WriteLine($"beginInvoke 执行完成 回调{ar.AsyncState}"); };
  12. int index = 0;
  13. ShowMsg.BeginInvoke(" BeginInvoke Test", asyncCallback, index);
  14. }

6 应用 测速下载多个文件时耗用的时间 - 异步编程实现

  1. using System;
  2. using System.Collections.Generic;
  3. using System.ComponentModel;
  4. using System.Data;
  5. using System.Drawing;
  6. using System.IO;
  7. using System.Linq;
  8. using System.Text;
  9. using System.Threading.Tasks;
  10. using System.Windows.Forms;
  11. namespace InvokeDemo
  12. {
  13. public partial class 异步编程 : Form
  14. {
  15. public delegate string delegateObj(string paht);
  16. public 异步编程()
  17. {
  18. InitializeComponent();
  19. delobj = new delegateObj(copyFile);
  20. }
  21. delegateObj delobj=null;
  22. /// <summary>
  23. /// 同步拷贝文件,并输出文件名称
  24. /// </summary>
  25. /// <param name="sender"></param>
  26. /// <param name="e"></param>
  27. private void button1_Click(object sender, EventArgs e)
  28. {
  29. String[] paths = Directory.GetFiles(@"F:\迅雷下载");
  30. for (int i = 0; i < paths.Length; i++)
  31. {
  32. this.listBox1.Items.Add(copyFile(paths[i]));
  33. }
  34. }
  35. /// <summary>异步拷贝文件,并输出文件名
  36. ///
  37. /// </summary>
  38. /// <param name="sender"></param>
  39. /// <param name="e"></param>
  40. private void button2_Click(object sender, EventArgs e)
  41. {
  42. String[] paths = Directory.GetFiles(@"F:\迅雷下载");
  43. for (int i = 0; i < paths.Length; i++)
  44. {
  45. delobj.BeginInvoke(paths[i], callback, Path.GetFileName(paths[i]));//最后一个参数是回调状态 ,如果不需要回调函数的话,直接null,这样就不需要调用EndInvoke,单纯的BeginInvoke即可
  46. }
  47. }
  48. public void callback(IAsyncResult result)
  49. {
  50. string filename = "";
  51. //if (this.listBox1.InvokeRequired)
  52. //{
  53. // filename = this.listBox1.EndInvoke(result).ToString();
  54. // this.listBox1.Items.Add(filename + "复制成功");
  55. // this.listBox2.Items.Add(result.AsyncState.ToString() + "复制成功");
  56. //}
  57. filename = delobj.EndInvoke(result);
  58. //this.listBox1.Items.Add(filename + "复制成功");
  59. //this.listBox2.Items.Add(result.AsyncState.ToString() + "复制成功");
  60. Console.WriteLine(result.AsyncState.ToString() + "复制成功");
  61. }
  62. /// <summary>
  63. /// 拷贝文件用
  64. /// </summary>
  65. /// <param name="filename"></param>
  66. public string copyFile(string filename)
  67. {
  68. if (filename.EndsWith("desktop.ini"))
  69. return "desktop.ini";
  70. if (File.Exists(@"F:\迅雷下载2\" + Path.GetFileName(filename)))
  71. {
  72. File.Delete(@"F:\迅雷下载2\" + Path.GetFileName(filename));
  73. }
  74. File.Copy(filename, @"F:\迅雷下载2\" + Path.GetFileName(filename));
  75. return Path.GetFileName(filename);
  76. }
  77. }
  78. }

转自https://blog.csdn.net/qq_57798018/article/details/128225946?utm_medium=distribute.pc_relevant.none-task-blog-2~default~baidujs_baidulandingword~default-1-128225946-blog-131415017.235^v38^pc_relevant_anti_t3_base&spm=1001.2101.3001.4242.2&utm_relevant_index=4

自己实际用到的一个例子:
其中,在WriteText()里实际调用控件做处理。
private void AddMsg(string msg, LineColors color)
{
if (this.InvokeRequired)
{
this.Invoke(new Action(() => this.AddMsg(msg, color)));
return;
}
//this.richTextBox1.Text += msg + Environment.NewLine;
WriteText(DateTime.Now.ToString() + " " + msg, color);
}