C#异步方法返回void与Task的区别详解

前言

在C#中使用异步方法，我们通常会使用async和await关键字，这些关键字使得异步编程看起来更加简单，但是如果对异步编程的底层原理不了解，就很容易用错异步方法的返回类型。本文将详细讲解C#异步方法返回void和Task的区别。

异步方法返回void的问题

在C#中，我们可以定义一个异步方法返回类型为void。

public async void AsyncMethod()
{
    // 异步方法的执行过程
}

然而，async void方法存在一些问题，它们往往会导致代码难以维护和调试。

1. 无法获取异步方法的状态

由于async void方法没有返回值，我们无法通过方法的返回值来获取异步方法的状态。也就是说，我们无法知道异步方法是否已经完成，或者异步方法是否抛出了异常。这使得调试异步方法的代码变得非常棘手。

2. 异常无法被抛出

当异步方法抛出异常时，异常通常会被传递给调用者。但是，当异步方法的返回类型为void时，异常就无法被抛出了。这可能会导致异常被忽略，并使得调试代码变得更加困难。

3. 无法使用await等待异步方法完成

当异步方法返回类型为void时，我们无法使用await关键字等待异步方法的完成。这意味着我们无法在异步方法完成后执行其他的代码。

异步方法返回Task的好处

在C#中，我们通常建议使用async Task方法来定义异步方法，而不是async void。

public async Task AsyncMethod()
{
    // 异步方法的执行过程
}

async Task方法与async void方法相比，有以下好处。

1. 可以获取异步方法的状态

当异步方法返回类型为Task时，我们可以通过方法返回的Task对象来获取异步方法的状态。这使得我们可以轻松地判断异步方法是否已经完成，或者是否已经抛出了异常。

public async Task RunAsync()
{
    Task task = AsyncMethod();
    // 判断异步方法是否已经完成
    if (! task.IsCompleted)
    {
        Console.WriteLine("异步方法还未完成");
    }
    try
    {
        await task;
    }
    catch(Exception ex)
    {
        Console.WriteLine($"异步方法抛出了异常：{ex.Message}");
    }
    Console.WriteLine("异步方法已完成");
}

2. 异常可以被抛出

当异步方法抛出异常时，异常会被封装在Task对象中，我们可以通过Task对象来获取异常信息。

public async Task AsyncMethod()
{
    throw new Exception("抛出异常");
}

public async Task RunAsync()
{
    Task task = AsyncMethod();
    try
    {
        await task;
    }
    catch(Exception ex)
    {
        Console.WriteLine($"异步方法抛出了异常：{ex.Message}");
    }
}

3. 可以使用await等待异步方法完成

当异步方法返回Task时，我们可以使用await关键字等待异步方法的完成。

public async Task<string> AsyncMethod()
{
    await Task.Delay(2000);
    return "hello, world!";
}

public async Task RunAsync()
{
    string result = await AsyncMethod();
    Console.WriteLine(result);
}