C#中的异步方法

就是有点傻2024-08-23 19:31

异步方法介绍

在C#中，异步编程是一种允许应用程序在等待长时间运行的操作完成时继续执行其他任务的技术。C# 5.0 引入了基于 async 和 await 关键字的异步编程模型，这使得编写异步代码变得更加简单和直观。

以下是C#中异步方法的一些关键点：

  1. 定义异步方法 ：使用 async 修饰符定义一个方法，这表明该方法包含异步操作。

    cs 复制代码 
    public async Task<int> FetchDataAsync()
{
    // 异步操作
}

  2. 返回类型 ：异步方法通常返回 Task 或 Task<T> 类型。Task 表示一个异步操作的完成，而 Task<T> 表示一个异步操作的完成，并且返回一个值。

  3. 使用 await ：await 关键字用于等待异步操作完成，而不会阻塞调用线程。它只能用于异步方法中。

    cs 复制代码 
    public async Task DoSomethingAsync()
{
    int result = await FetchDataAsync();
    // 使用 result 进行其他操作
}

  4. 异常处理 ：异步方法中的异常可以通过 try-catch 块捕获。

    cs 复制代码 
    public async Task DoSomethingAsync()
{
    try
    {
        await FetchDataAsync();
    }
    catch (Exception ex)
    {
        // 处理异常
    }
}

  5. 配置异步上下文 ：使用 ConfigureAwait 可以配置 await 是否需要在原始的同步上下文中继续执行。

    cs 复制代码 
    public async Task DoSomethingAsync()
{
    await SomeAsyncMethod().ConfigureAwait(false);
}

  6. 取消异步操作 ：可以通过 CancellationToken 来取消异步操作。

    cs 复制代码 
    public async Task DoWorkAsync(CancellationToken cancellationToken)
{
    while (!cancellationToken.IsCancellationRequested)
    {
        // 执行工作
    }
}

  7. 组合使用 async 和 await ：可以在一个异步方法中调用多个异步方法，并使用 await 来等待它们。

    cs 复制代码 
    public async Task CombineAsyncOperationsAsync()
{
    await Task1Async();
    await Task2Async();
}

  8. 避免死锁 ：在UI应用程序中，避免在异步方法中使用 .Result 或 .Wait()，因为这可能会导致死锁。

  9. 使用 async 与 await 的最佳实践：

    • 只在确实需要异步操作时使用 async 和 await。

    • 避免在性能敏感的代码路径中使用 async 和 await，因为它们会增加调用栈的开销。

    • 考虑使用 async 主函数来启动异步应用程序。

使用async 和 await 关键字写一个返回值为int的方法

在C#中，如果你想创建一个使用 async 和 await 关键字的异步方法，并且该方法的返回类型是 int，你可以使用 Task<int> 作为返回类型。这是因为 async 方法必须返回 Task 或 Task<T> 类型。下面是一个简单的例子：

cs 复制代码 
using System;
using System.Threading.Tasks;
​
public class Example
{
    // 异步方法，返回类型为 Task<int>
    public async Task<int> GetNumberAsync()
    {
        // 模拟异步操作，例如从数据库或网络获取数据
        await Task.Delay(1000); // 模拟异步等待1秒
​
        // 返回一个整数
        return 42;
    }
​
    // 调用异步方法的示例
    public async Task RunExampleAsync()
    {
        int number = await GetNumberAsync();
        Console.WriteLine("The number is: " + number);
    }
}

在这个例子中，GetNumberAsync 是一个异步方法，它返回一个 Task<int>。方法内部使用 await Task.Delay(1000); 来模拟一个异步操作，比如网络请求或数据库访问，这里只是简单地等待了1秒钟。然后，方法返回一个整数 42。

RunExampleAsync 方法展示了如何调用 GetNumberAsync 方法，并使用 await 来等待其完成。一旦 GetNumberAsync 完成，它返回的整数被存储在变量 number 中，并打印出来。

使用async 和 await 关键字写一个没有返回值的方法

在C#中，如果你想要编写一个没有返回值的异步方法，你可以使用 Task 作为方法的返回类型。这样，方法就可以使用 async 和 await 关键字，并且可以在等待异步操作完成时释放当前线程。下面是一个没有返回值的异步方法的例子：

cs 复制代码 
using System;
using System.Threading.Tasks;
​
public class Example
{
    // 异步方法，没有返回值，返回类型为 Task
    public async Task DoWorkAsync()
    {
        // 模拟异步操作，例如从数据库或网络获取数据
        await Task.Delay(1000); // 模拟异步等待1秒
​
        // 执行一些操作，但没有返回值
        Console.WriteLine("Work is done!");
    }
​
    // 调用异步方法的示例
    public static async Task Main(string[] args)
    {
        var example = new Example();
        
        // 调用异步方法并等待其完成
        await example.DoWorkAsync();
    }
}

在这个例子中，DoWorkAsync 是一个没有返回值的异步方法，它返回一个 Task。方法内部使用 await Task.Delay(1000); 来模拟一个异步操作，这里只是简单地等待了1秒钟。然后，方法输出一条消息 "Work is done!"。

Main 方法在这个例子中被标记为 async，这样它就可以使用 await 来调用 DoWorkAsync 方法。Main 方法等待 DoWorkAsync 方法完成，然后程序继续执行。

Main 方法是程序的入口点，通常它是同步的。但是，如果你的应用程序是异步的，你可以将 Main 方法标记为 async，以便使用 await。在上面的例子中，Main 方法是 async 的，这样它就可以等待 DoWorkAsync 方法完成。

异步方法里面的await使用方法

在异步方法中，await 关键字用于等待一个异步操作完成，同时不会阻塞当前线程。以下是一些关于如何在异步方法中使用 await 的要点：

  1. 使用 await 等待 Task ：当你调用一个返回 Task 或 Task<T> 的异步方法时，你可以使用 await 来等待这个任务完成。

    cs 复制代码 
    public async Task DoSomethingAsync()
{
    await SomeAsyncMethod();
}

  2. 使用 await 等待 Task<T> ：如果异步方法返回 Task<T>，你可以使用 await 来等待任务完成，并获取返回的值。

    cs 复制代码 
    public async Task<int> GetNumberAsync()
{
    return await SomeAsyncMethodThatReturnsInt();
}

  3. 在 await 后处理异常 ：使用 await 的表达式可以包含在 try-catch 块中，以便捕获并处理在等待期间发生的异常。

    cs 复制代码 
    public async Task DoSomethingAsync()
{
    try
    {
        await SomeAsyncMethodThatMightThrow();
    }
    catch (Exception ex)
    {
        // 处理异常
    }
}

  4. 使用 await 与 async 循环 ：你可以在异步循环中使用 await，例如使用 while 循环等待异步操作。

    cs 复制代码 
    public async Task KeepDoingWorkAsync()
{
    while (true)
    {
        await Task.Delay(1000); // 等待1秒
        // 执行一些操作
    }
}

  5. 使用 await 与 async 条件语句 ：你可以在异步方法中使用 if 或 switch 语句，并在其中使用 await。

    cs 复制代码 
    public async Task ProcessDataAsync(bool condition)
{
    if (condition)
    {
        await SomeAsyncMethod();
    }
    else
    {
        await AnotherAsyncMethod();
    }
}

  6. 使用 await 与多个异步操作 ：你可以使用 await 来同时等待多个异步操作完成，使用 Task.WhenAll 方法。

    cs 复制代码 
    public async Task ProcessMultipleAsyncTasks()
{
    var task1 = Task.Run(() => SomeAsyncMethod());
    var task2 = Task.Run(() => AnotherAsyncMethod());
    await Task.WhenAll(task1, task2);
}

  7. 使用 await 与配置上下文 ：使用 ConfigureAwait 可以配置 await 是否需要在原始的同步上下文中继续执行。

    cs 复制代码 
    public async Task DoWorkAsync()
{
    await SomeAsyncMethod().ConfigureAwait(false);
}

  8. 避免在异步方法中使用 .Result 或 .Wait()：这可能会导致死锁，尤其是在UI应用程序中。

使用 await 的关键是要记住它只能在异步方法中使用，并且它会让当前方法的执行暂停，直到被等待的任务完成。这允许其他操作在同一线程上运行，从而提高应用程序的响应性和效率。

在异步编程中，如何避免使用 Result 或 Wait() 来避免死锁？

在异步编程中，避免使用 .Result 或 .Wait() 是非常重要的，因为这些方法会导致同步等待异步操作的完成，这可能会在某些情况下（尤其是UI应用程序中）导致死锁。以下是一些避免使用 .Result 或 .Wait() 的最佳实践：

  1. 始终使用 await ：这是最简单也是最直接的方法。使用 await 可以确保异步方法在等待另一个异步操作时不会阻塞调用线程。

    cs 复制代码 
    public async Task DoSomethingAsync()
{
    await SomeAsyncOperation();
}

  2. 使用异步的所有者：如果你需要在异步方法外部访问异步操作的结果，考虑将异步方法的调用者作为所有者，并通过回调或事件来通知结果。

  3. 使用 TaskCompletionSource ：如果你需要从同步代码中触发异步操作的完成，可以使用 TaskCompletionSource 来包装你的操作。

    cs 复制代码 
    public class AsyncWrapper
{
    private TaskCompletionSource<int> tcs = new TaskCompletionSource<int>();
​
    public Task<int> Task => tcs.Task;
​
    public void DoWorkAndSetResult(int result)
    {
        // 执行一些工作
        tcs.SetResult(result);
    }
}
​
// 使用
var wrapper = new AsyncWrapper();
wrapper.Task.ContinueWith(t => {
    // 处理结果
});
wrapper.DoWorkAndSetResult(42);

  4. 使用 async 和 await 与事件 ：如果你需要在异步操作完成后通知多个监听者，可以使用事件，并使用 async 和 await 来订阅和触发事件。

  5. 避免在UI线程上同步等待 ：特别是在Windows Forms或WPF应用程序中，不要在UI线程上使用 .Result 或 .Wait() 等待异步操作，因为这可能会导致应用程序挂起。

  6. 使用 CancellationToken ：如果你需要取消异步操作，使用 CancellationToken 来请求取消，而不是尝试同步等待操作完成。

    cs 复制代码 
    public async Task DoWorkWithCancellationAsync(CancellationToken cancellationToken)
{
    while (!cancellationToken.IsCancellationRequested)
    {
        // 执行工作
        await Task.Delay(1000, cancellationToken);
    }
}

  7. 使用 ConfigureAwait(false) ：在调用 await 时使用 ConfigureAwait(false) 可以避免在同一个上下文中继续执行，这有助于避免死锁，特别是在UI应用程序中。

    cs 复制代码 
    public async Task DoSomethingAsync()
{
    await SomeAsyncOperation().ConfigureAwait(false);
}

  8. 使用异步API ：尽可能使用异步API，而不是它们的同步版本。例如，使用 ReadAsStringAsync() 而不是 ReadAsByteArray() 然后调用 Task.Run() 来异步处理结果。

相关推荐
LateFrames2 小时前
C# 中，0.1 在什么情况下不等于 0.1 ？
开发语言·c#
mudtools7 小时前
解放双手！使用Roslyn生成代码让你的 HTTP 客户端开发变得如此简单
低代码·c#·.net
张人玉10 小时前
WPF 数据绑定与转换器详解
c#·wpf·light
主宰者10 小时前
WPF CalcBinding简化判断逻辑
c#·.net·wpf
就是有点傻20 小时前
使用PaddleOCRSharp大模型精选文字识别
c#
LeonDL16821 小时前
【通用视觉框架】基于C#+Winform+OpencvSharp开发的视觉框架软件，全套源码，开箱即用
人工智能·c#·winform·opencvsharp·机器视觉软件框架·通用视觉框架·机器视觉框架
数据的世界011 天前
技术变革：为何C#与.NET是未来的开发方向
java·c#·.net
大龄Python青年1 天前
C#快入教程：Linux安装.NET
linux·c#·.net
我是唐青枫1 天前
C#.NET Random 深入解析：随机数生成原理与最佳实践
c#·.net
光头闪亮亮1 天前
电子发票解析工具-c#桌面应用开发案例详解
c#
热门推荐
01GitHub 镜像站点02UV安装并设置国内源03综合整理：pdf预览显示：你尝试预览的文件可能对你的计算机有害。如果你信任此文件以及其来源，请打开此文件以看其内容，如何解决以正常预览文件04Linux下V2Ray安装配置指南05安娜的档案(Anna’s Archive) 镜像网站/国内最新可访问入口（持续更新）06npm使用国内淘宝镜像的方法07《大数据技术原理与应用》实验报告三 熟悉HBase常用操作08BongoCat - 跨平台键盘猫动画工具09NVIDIA显卡驱动、CUDA、cuDNN 和 TensorRT 版本匹配指南10GitLab 零基础入门指南：从安装到项目管理全流程