WPF 异步

news2024/9/23 9:35:40

在 WPF 中，异步编程非常重要，尤其是为了保持 UI 线程的响应性。由于 WPF 的 UI 操作必须在主线程上进行，耗时的任务（如文件读写、网络请求等）如果直接在 UI 线程上执行，会导致 UI 冻结，界面无法响应用户操作。因此，使用异步编程可以避免这些问题，使得任务能够在后台线程中执行，同时保持 UI 流畅。

1. 异步编程的基本概念

异步编程可以通过以下几种方式实现：

async/await 关键词：这是最常见的异步编程方式，能够让耗时操作在后台执行，同时保持代码的可读性和清晰度。
Task 类：异步操作通常会返回一个 Task，用来表示操作的状态和结果。
Dispatcher：由于 WPF 的 UI 操作只能在主线程上完成，当后台任务执行完毕后，需要使用 Dispatcher 回到 UI 线程更新 UI。

2. 使用 `async`/`await` 进行异步操作

async 和 await 是 .NET 中处理异步操作的核心关键词。通过这两个关键词，可以让异步任务在后台运行，而不阻塞主线程。

示例：通过 async/await 读取文件并在读取完成后更新 UI。

private async void ReadFileButton_Click(object sender, RoutedEventArgs e)
{
    string filePath = "path_to_file.txt";
    
    // 异步读取文件内容
    string fileContent = await ReadFileAsync(filePath);
    
    // 更新 UI
    FileContentTextBox.Text = fileContent;
}

private async Task<string> ReadFileAsync(string filePath)
{
    using (StreamReader reader = new StreamReader(filePath))
    {
        return await reader.ReadToEndAsync();
    }
}

解释：

await 关键字在后台执行文件读取操作，UI 线程不会被阻塞。
任务完成后，返回文件内容并更新 TextBox。

3. 处理异步任务中的异常

在异步编程中，异常处理和同步代码略有不同。通常，异步任务中的异常需要在调用 await 时捕获。

示例：

private async void LoadDataAsync()
{
    try
    {
        await Task.Run(() =>
        {
            // 模拟一个异常
            throw new InvalidOperationException("Something went wrong");
        });
    }
    catch (Exception ex)
    {
        // 异常处理逻辑
        MessageBox.Show($"Error: {ex.Message}");
    }
}

解释：

异常会在 await 处抛出，因此异常处理需要在异步方法调用的地方进行捕获。

4. 避免 UI 冻结的常见异步操作

异步操作通常用于以下场景：

文件操作：文件的读写操作可以在后台执行，避免阻塞 UI。
网络请求：通过异步调用外部 API 或下载数据，可以使 UI 保持响应。
数据库查询：长时间的数据库查询可以通过异步执行，避免界面卡顿。
计算密集型任务：如大量数据处理或复杂算法，可以通过异步方式放到后台执行。

示例：异步网络请求：

private async void DownloadButton_Click(object sender, RoutedEventArgs e)
{
    string url = "https://example.com/data";
    
    // 异步下载数据
    string result = await DownloadDataAsync(url);
    
    // 更新 UI
    ResultTextBox.Text = result;
}

private async Task<string> DownloadDataAsync(string url)
{
    using (HttpClient client = new HttpClient())
    {
        return await client.GetStringAsync(url);
    }
}

5. 在异步任务中更新 UI

WPF 的 UI 元素必须在 UI 线程中更新，无法直接从后台线程操作 UI。为了在异步任务完成后更新 UI，需要切换回 UI 线程。Dispatcher 类提供了这种机制。

示例：在后台任务完成后使用 Dispatcher 更新 UI。

private async void LongRunningTask_Click(object sender, RoutedEventArgs e)
{
    await Task.Run(() =>
    {
        // 模拟耗时任务
        Thread.Sleep(3000);
        
        // 回到UI线程
        Application.Current.Dispatcher.Invoke(() =>
        {
            StatusLabel.Content = "Task Completed!";
        });
    });
}

解释：

在异步任务中，通过 Dispatcher.Invoke 切换回 UI 线程，确保可以安全地操作 UI 控件。

6. 使用 `Task.Run` 执行后台任务

有时，我们可能需要将一个计算密集型或耗时的操作放到后台线程运行。Task.Run 是一种常见的方式，将任务放到线程池中执行。

示例：

private async void ComputeTask_Click(object sender, RoutedEventArgs e)
{
    int result = await Task.Run(() => PerformLongCalculation());
    
    ResultLabel.Content = $"Calculation Result: {result}";
}

private int PerformLongCalculation()
{
    // 模拟长时间计算
    Thread.Sleep(2000);
    return 42;
}

7. `Dispatcher.Invoke` 与 `Dispatcher.BeginInvoke` 的区别

在使用 Dispatcher 时，有两种调用方法：

Dispatcher.Invoke：同步调用，会阻塞当前线程，直到操作完成。
Dispatcher.BeginInvoke：异步调用，立即返回，不会阻塞当前线程。

通常在异步操作中推荐使用 Dispatcher.BeginInvoke 来避免阻塞主线程。

示例：

private async void UpdateUITask_Click(object sender, RoutedEventArgs e)
{
    await Task.Run(() =>
    {
        // 模拟后台任务
        Thread.Sleep(3000);
        
        // 使用 BeginInvoke 回到 UI 线程
        Application.Current.Dispatcher.BeginInvoke(new Action(() =>
        {
            StatusLabel.Content = "Task Completed!";
        }));
    });
}

8. `CancellationToken` 实现任务取消

在某些场景下，用户可能希望能够取消正在执行的异步任务。CancellationToken 提供了一种机制，允许在异步操作中检查是否需要取消任务。

示例：

private CancellationTokenSource _cts;

private async void StartCancellableTask_Click(object sender, RoutedEventArgs e)
{
    _cts = new CancellationTokenSource();
    try
    {
        await Task.Run(() => LongRunningOperation(_cts.Token), _cts.Token);
        StatusLabel.Content = "Operation Completed";
    }
    catch (OperationCanceledException)
    {
        StatusLabel.Content = "Operation Canceled";
    }
}

private void LongRunningOperation(CancellationToken token)
{
    for (int i = 0; i < 10; i++)
    {
        // 检查任务是否取消
        token.ThrowIfCancellationRequested();
        Thread.Sleep(1000); // 模拟长时间操作
    }
}

private void CancelTask_Click(object sender, RoutedEventArgs e)
{
    _cts.Cancel();
}

解释：

通过 CancellationToken 来检查任务是否已经被取消，并通过 ThrowIfCancellationRequested 抛出异常以终止任务。

9. `Progress<T>` 实现任务进度更新

在异步任务执行时，有时需要将任务进度反馈给用户。可以使用 IProgress<T> 接口来实现进度报告。

示例：

private async void StartProgressTask_Click(object sender, RoutedEventArgs e)
{
    var progress = new Progress<int>(percent =>
    {
        ProgressBar.Value = percent;
    });

    await Task.Run(() => LongRunningTaskWithProgress(progress));
}

private void LongRunningTaskWithProgress(IProgress<int> progress)
{
    for (int i = 0; i <= 100; i += 10)
    {
        // 报告进度
        progress.Report(i);
        Thread.Sleep(500); // 模拟长时间操作
    }
}

解释：