방법: 스레드로부터 안전한 Windows Forms 컨트롤 호출How to: Make thread-safe calls to Windows Forms controls

다중 스레딩에는 Windows Forms 앱의 성능을 향상 시킬 수 있습니다 하지만 Windows Forms 컨트롤에 대 한 액세스 본질적으로 스레드로부터 안전 하지 않습니다.Multithreading can improve the performance of Windows Forms apps, but access to Windows Forms controls isn't inherently thread-safe. 다중 스레딩 코드 매우 심각 하 고 복잡 한 버그를 노출할 수 있습니다.Multithreading can expose your code to very serious and complex bugs. 컨트롤을 조작 하는 두 개 이상의 스레드가 컨트롤 일관성 없는 상태로 강제 적용 하 고 경합, 교착 상태 및 중지 또는 중단을 발생 시킬 수 있습니다.Two or more threads manipulating a control can force the control into an inconsistent state and lead to race conditions, deadlocks, and freezes or hangs. 구현 하는 경우 다중 스레드 앱에서는 해야 스레드로부터 안전한 방식으로 크로스 스레드 컨트롤을 호출 합니다.If you implement multithreading in your app, be sure to call cross-thread controls in a thread-safe way. 자세한 내용은 관리 되는 모범 사례 스레딩합니다.For more information, see Managed threading best practices.

안전 하 게 해당 컨트롤을 만들지 않은 스레드에서 Windows Forms 컨트롤을 호출 하는 방법은 두 가지입니다.There are two ways to safely call a Windows Forms control from a thread that didn't create that control. 사용할 수는 System.Windows.Forms.Control.Invoke 생성에서 컨트롤을 호출 하는 주 스레드에서 대리자를 호출 하는 방법입니다.You can use the System.Windows.Forms.Control.Invoke method to call a delegate created in the main thread, which in turn calls the control. 구현할 수 있습니다 또는 System.ComponentModel.BackgroundWorker, 결과 대 한 보고에서 백그라운드 스레드에서 수행 된 작업을 구분 하는 이벤트 구동 모델을 사용 하는 합니다.Or, you can implement a System.ComponentModel.BackgroundWorker, which uses an event-driven model to separate work done in the background thread from reporting on the results.

안전 하지 않은 크로스 스레드 호출Unsafe cross-thread calls

사람이 만든 스레드에서 직접 컨트롤을 호출할 수는 없습니다.It's unsafe to call a control directly from a thread that didn't create it. 다음 코드 조각에 대 한 안전 하지 않은 호출을 보여 줍니다는 System.Windows.Forms.TextBox 제어 합니다.The following code snippet illustrates an unsafe call to the System.Windows.Forms.TextBox control. 합니다 Button1_Click 이벤트 처리기를 만듭니다 WriteTextUnsafe 주 스레드를 설정 하는 스레드 TextBox.Text 속성을 직접.The Button1_Click event handler creates a new WriteTextUnsafe thread, which sets the main thread's TextBox.Text property directly.

private void Button1_Click(object sender, EventArgs e)
{
    thread2 = new Thread(new ThreadStart(WriteTextUnsafe));
    thread2.Start();
}
private void WriteTextUnsafe()
{
    textBox1.Text = "This text was set unsafely.";
}
Private Sub Button1_Click(ByVal sender As Object, e As EventArgs) Handles Button1.Click
    Thread2 = New Thread(New ThreadStart(AddressOf WriteTextUnsafe))
    Thread2.Start()
End Sub

Private Sub WriteTextUnsafe()
    TextBox1.Text = "This text was set unsafely."
End Sub

Visual Studio 디버거를 발생 시켜 이러한 안전 하지 않은 스레드 호출을 감지는 InvalidOperationException 메시지와 함께 크로스 스레드 작업이 유효 하지 않습니다. Control ""에서 만든 스레드가 아닌 스레드에서 액세스 합니다.The Visual Studio debugger detects these unsafe thread calls by raising an InvalidOperationException with the message, Cross-thread operation not valid. Control "" accessed from a thread other than the thread it was created on. InvalidOperationException 항상 안전 하지 않은 크로스 스레드 호출에 대 한 Visual Studio 디버그 하는 동안 발생 하 고 앱 런타임 시 발생할 수 있습니다.The InvalidOperationException always occurs for unsafe cross-thread calls during Visual Studio debugging, and may occur at app runtime. 문제를 해결 해야 하지만 설정 하 여 예외를 비활성화할 수 있습니다 합니다 Control.CheckForIllegalCrossThreadCalls 속성을 false입니다.You should fix the issue, but you can disable the exception by setting the Control.CheckForIllegalCrossThreadCalls property to false.

안전한 크로스 스레드 호출Safe cross-thread calls

다음 코드 예제에서는 안전 하 게 사람이 만든 스레드에서 Windows Forms 컨트롤을 호출 하는 두 가지를 보여 줍니다.The following code examples demonstrate two ways to safely call a Windows Forms control from a thread that didn't create it:

  1. System.Windows.Forms.Control.Invoke 메서드를 호출 컨트롤 기본 스레드에서 대리자를 호출 합니다.The System.Windows.Forms.Control.Invoke method, which calls a delegate from the main thread to call the control.
  2. System.ComponentModel.BackgroundWorker 이벤트 구동 모델을 제공 하는 구성 요소입니다.A System.ComponentModel.BackgroundWorker component, which offers an event-driven model.

두 예에서 모두 시뮬레이션 하기 위해 1 초 동안 백그라운드 스레드가 대기한 스레드에서 수행 되 고 작동 합니다.In both examples, the background thread sleeps for one second to simulate work being done in that thread.

빌드하고에서.NET Framework 앱으로 이러한 예제를 실행할 수 있습니다는 C# 또는 Visual Basic 명령줄입니다.You can build and run these examples as .NET Framework apps from the C# or Visual Basic command line. 자세한 내용은 csc.exe를 사용한 명령줄 빌드 하거나 (Visual Basic) 명령줄에서 빌드합니다.For more information, see Command-line building with csc.exe or Build from the command line (Visual Basic).

.NET Core 3.0 부터는 수 또한 빌드 및 실행 예제에서는.NET Core 앱을 Windows로.NET Core Windows Forms에 있는 폴더에서 <폴더 이름 >.csproj 프로젝트 파일입니다.Starting with .NET Core 3.0, you can also build and run the examples as Windows .NET Core apps from a folder that has a .NET Core Windows Forms <folder name>.csproj project file.

예제: Invoke 메서드를 사용 하 여 대리자를 사용 하 여Example: Use the Invoke method with a delegate

다음 예제에는 Windows Forms 컨트롤에 스레드로부터 안전한 호출을 보장 하기 위한 패턴을 보여 줍니다.The following example demonstrates a pattern for ensuring thread-safe calls to a Windows Forms control. 쿼리는 System.Windows.Forms.Control.InvokeRequired 컨트롤 비교 하는 속성의 호출 스레드 id와 같습니다. 스레드 ID를 만들기It queries the System.Windows.Forms.Control.InvokeRequired property, which compares the control's creating thread ID to the calling thread ID. 스레드 Id 동일한 경우 컨트롤을 직접 호출 합니다.If the thread IDs are the same, it calls the control directly. 스레드 Id가 서로 호출을 Control.Invoke 실제 호출을 제어 하는 기본 스레드에서 대리자를 사용 하 여 메서드.If the thread IDs are different, it calls the Control.Invoke method with a delegate from the main thread, which makes the actual call to the control.

합니다 SafeCallDelegate 설정을 사용 합니다 TextBox 컨트롤의 Text 속성입니다.The SafeCallDelegate enables setting the TextBox control's Text property. 합니다 WriteTextSafe 메서드 쿼리 InvokeRequired합니다.The WriteTextSafe method queries InvokeRequired. 경우 InvokeRequired 반환 true, WriteTextSafe 전달 합니다 SafeCallDelegateInvoke 실제 컨트롤 호출 하는 방법입니다.If InvokeRequired returns true, WriteTextSafe passes the SafeCallDelegate to the Invoke method to make the actual call to the control. 하는 경우 InvokeRequired 반환 falseWriteTextSafe 설정의 TextBox.Text 직접.If InvokeRequired returns false, WriteTextSafe sets the TextBox.Text directly. 합니다 Button1_Click 이벤트 처리기가 새 스레드를 만들고 실행 합니다 WriteTextSafe 메서드.The Button1_Click event handler creates the new thread and runs the WriteTextSafe method.

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

public class InvokeThreadSafeForm : Form
{
    private delegate void SafeCallDelegate(string text);
    private Button button1;
    private TextBox textBox1;
    private Thread thread2 = null;

    [STAThread]
    static void Main()
    {
        Application.SetCompatibleTextRenderingDefault(false);
        Application.EnableVisualStyles();
        Application.Run(new InvokeThreadSafeForm());
    }
    public InvokeThreadSafeForm()
    {
        button1 = new Button
        {
            Location = new Point(15, 55),
            Size = new Size(240, 20),
            Text = "Set text safely"
        };
        button1.Click += new EventHandler(Button1_Click);
        textBox1 = new TextBox
        {
            Location = new Point(15, 15),
            Size = new Size(240, 20)
        };
        Controls.Add(button1);
        Controls.Add(textBox1);
    }

    private void Button1_Click(object sender, EventArgs e)
    {
        thread2 = new Thread(new ThreadStart(SetText));
        thread2.Start();
        Thread.Sleep(1000);
    }

    private void WriteTextSafe(string text)
    {
        if (textBox1.InvokeRequired)
        {
            var d = new SafeCallDelegate(WriteTextSafe);
            textBox1.Invoke(d, new object[] { text });
        }
        else
        {
            textBox1.Text = text;
        }
    }

    private void SetText()
    {
        WriteTextSafe("This text was set safely.");
    }
}
Imports System.Drawing
Imports System.Threading
Imports System.Windows.Forms

Public Class InvokeThreadSafeForm : Inherits Form

    Public Shared Sub Main()
        Application.SetCompatibleTextRenderingDefault(False)
        Application.EnableVisualStyles()
        Dim frm As New InvokeThreadSafeForm()
        Application.Run(frm)
    End Sub

    Dim WithEvents Button1 As Button
    Dim TextBox1 As TextBox
    Dim Thread2 as Thread = Nothing

    Delegate Sub SafeCallDelegate(text As String)

    Private Sub New()
        Button1 = New Button()
        With Button1
            .Location = New Point(15, 55)
            .Size = New Size(240, 20)
            .Text = "Set text safely"
        End With
        TextBox1 = New TextBox()
        With TextBox1
            .Location = New Point(15, 15)
            .Size = New Size(240, 20)
        End With
        Controls.Add(Button1)
        Controls.Add(TextBox1)
    End Sub

    Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
        Thread2 = New Thread(New ThreadStart(AddressOf SetText))
        Thread2.Start()
        Thread.Sleep(1000)
    End Sub

    Private Sub WriteTextSafe(text As String)
        If TextBox1.InvokeRequired Then
            Dim d As New SafeCallDelegate(AddressOf SetText)
            TextBox1.Invoke(d, New Object() {text})
        Else
            TextBox1.Text = text
        End If
    End Sub

    Private Sub SetText()
        WriteTextSafe("This text was set safely.")
    End Sub
End Class

예제: BackgroundWorker 이벤트 처리기를 사용 하 여Example: Use a BackgroundWorker event handler

간편한 방법은 다중 스레딩을 구현 된는 System.ComponentModel.BackgroundWorker 이벤트 구동 모델을 사용 하는 구성 요소입니다.An easy way to implement multithreading is with the System.ComponentModel.BackgroundWorker component, which uses an event-driven model. 백그라운드 스레드에서 실행 되는 BackgroundWorker.DoWork main 메서드가 상호 작용 하지 않고는 이벤트입니다.The background thread runs the BackgroundWorker.DoWork event, which doesn't interact with the main thread. 주 스레드를 실행 합니다 BackgroundWorker.ProgressChangedBackgroundWorker.RunWorkerCompleted 주 스레드 컨트롤을 호출할 수 있는 이벤트 처리기입니다.The main thread runs the BackgroundWorker.ProgressChanged and BackgroundWorker.RunWorkerCompleted event handlers, which can call the main thread's controls.

사용 하 여 스레드로부터 안전한 호출을 BackgroundWorker, 백그라운드 스레드에서 작업을 수행 하는 메서드를 만듭니다 및에 바인딩하는 DoWork 이벤트입니다.To make a thread-safe call by using BackgroundWorker, create a method in the background thread to do the work, and bind it to the DoWork event. 백그라운드 작업의 결과를 보고 주 스레드에서 다른 메서드를 만들고에 바인딩하는 ProgressChanged 또는 RunWorkerCompleted 이벤트입니다.Create another method in the main thread to report the results of the background work, and bind it to the ProgressChanged or RunWorkerCompleted event. 백그라운드 스레드를 시작 하려면 호출 BackgroundWorker.RunWorkerAsync합니다.To start the background thread, call BackgroundWorker.RunWorkerAsync.

이 예제에서는 사용 합니다 RunWorkerCompleted 이벤트 처리기를 설정 합니다 TextBox 컨트롤의 Text 속성.The example uses the RunWorkerCompleted event handler to set the TextBox control's Text property. 사용 하는 예제는 ProgressChanged 이벤트 참조 BackgroundWorker합니다.For an example using the ProgressChanged event, see BackgroundWorker.

using System;
using System.ComponentModel;
using System.Drawing;
using System.Threading;
using System.Windows.Forms;

public class BackgroundWorkerForm : Form
{
    private BackgroundWorker backgroundWorker1;
    private Button button1;
    private TextBox textBox1;

    [STAThread]
    static void Main()
    {
        Application.SetCompatibleTextRenderingDefault(false);
        Application.EnableVisualStyles();
        Application.Run(new BackgroundWorkerForm());
    }
    public BackgroundWorkerForm()
    {
        backgroundWorker1 = new BackgroundWorker();
        backgroundWorker1.DoWork += new DoWorkEventHandler(BackgroundWorker1_DoWork);
        backgroundWorker1.RunWorkerCompleted += new RunWorkerCompletedEventHandler(BackgroundWorker1_RunWorkerCompleted);
        button1 = new Button
        {
            Location = new Point(15, 55),
            Size = new Size(240, 20),
            Text = "Set text safely with BackgroundWorker"
        };
        button1.Click += new EventHandler(Button1_Click);
        textBox1 = new TextBox
        {
            Location = new Point(15, 15),
            Size = new Size(240, 20)
        };
        Controls.Add(button1);
        Controls.Add(textBox1);
    }
    private void Button1_Click(object sender, EventArgs e)
    {
        backgroundWorker1.RunWorkerAsync();
    }

    private void BackgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
    {
        // Sleep 2 seconds to emulate getting data.
        Thread.Sleep(2000);
        e.Result = "This text was set safely by BackgroundWorker.";
    }

    private void BackgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
        textBox1.Text = e.Result.ToString();
    }
}
Imports System.ComponentModel
Imports System.Drawing
Imports System.Threading
Imports System.Windows.Forms

Public Class BackgroundWorkerForm : Inherits Form

    Public Shared Sub Main()
        Application.SetCompatibleTextRenderingDefault(False)
        Application.EnableVisualStyles()
        Dim frm As New BackgroundWorkerForm()
        Application.Run(frm)
    End Sub

    Dim WithEvents BackgroundWorker1 As BackgroundWorker
    Dim WithEvents Button1 As Button
    Dim TextBox1 As TextBox

    Private Sub New()
        BackgroundWorker1 = New BackgroundWorker()
        Button1 = New Button()
        With Button1
            .Text = "Set text safely with BackgroundWorker"
            .Location = New Point(15, 55)
            .Size = New Size(240, 20)
        End With
        TextBox1 = New TextBox()
        With TextBox1
            .Location = New Point(15, 15)
            .Size = New Size(240, 20)
        End With
        Controls.Add(Button1)
        Controls.Add(TextBox1)
    End Sub

    Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
        BackgroundWorker1.RunWorkerAsync()
    End Sub

    Private Sub BackgroundWorker1_DoWork(sender As Object, e As DoWorkEventArgs) _
     Handles BackgroundWorker1.DoWork
        ' Sleep 2 seconds to emulate getting data.
        Thread.Sleep(2000)
        e.Result = "This text was set safely by BackgroundWorker."
    End Sub

    Private Sub BackgroundWorker1_RunWorkerCompleted(sender As Object, e As RunWorkerCompletedEventArgs) _
     Handles BackgroundWorker1.RunWorkerCompleted
        textBox1.Text = e.Result.ToString()
    End Sub
End Class

참고자료See also