如何在 ASP.NET Core 中的 void 方法上使用 async/await？

Question

我正试图进入异步的东西。我想让我的一个方法异步，因为它需要一段时间才能完成，所以我尝试了这个：

public static async Task GenerateExcelFile(HashSet<string> codes, ContestViewModel model)
{
    var totalCodeToDistribute = model.NbrTotalCodes - (model.NbrCodesToPrinter + model.NbrCodesToClientService);
    if (model.NbrTotalCodes > 0)
    {
        using (var package = new ExcelPackage())
        {
                         
            await DoStuff(some, variables, here);
                        
            package.SaveAs(fileInfo);
        }
    }
}

所以我可以在我的控制器中这样调用它：

 await FilesGenerationUtils.GenerateExcelFile(uniqueCodesHashSet, model);

但是当涉及到“await”关键字时，它表示“Type void is not awaitable”

这是等待 void 方法的一种方式还是不是最佳实践？如果是这样，最好的方法是什么？

控制器：

[HttpPost]
        [ValidateAntiForgeryToken]
        public async Task<IActionResult> Index(ContestViewModel model)
        {
            var contentRootPath = _hostingEnvironment.ContentRootPath;

            DirectoryUtils.OutputDir = new DirectoryInfo(contentRootPath + Path.DirectorySeparatorChar
                                                                         + "_CodesUniques" + Path.DirectorySeparatorChar
                                                                         + model.ProjectName +
                                                                         Path.DirectorySeparatorChar
                                                                         + "_Codes");
            var directory = DirectoryUtils.OutputDir;

            var selectedAnswer = model.SelectedAnswer;

            var uniqueCodesHashSet = new HashSet<string>();

            try
            {
                
                while (uniqueCodesHashSet.Count < model.NbrTotalCodes)
                {
                    var generatedString = RandomStringsUtils.Generate(model.AllowedChars, model.UniqueCodeLength);
                    uniqueCodesHashSet.Add(generatedString.ToUpper());
                }

                #region FOR TXT FILES

                if (selectedAnswer == FileExtension.TXT.GetStringValue())
                {
                   await FilesGenerationUtils.GenerateTxtFiles(uniqueCodesHashSet, model, directory);
                }

                #endregion

                #region FOR XLSX FILES

                if (selectedAnswer == FileExtension.XLSX.GetStringValue())
                {
                    await FilesGenerationUtils.GenerateExcelFile(uniqueCodesHashSet, model);
                }

                #endregion
             
       
                return View();
            }
            catch (Exception ex)
            {
                Console.Write(ex);
            }

            return View();
        }

如果我理解了你们所说的，我必须创建一个可以等待的方法。如果我使用这样的东西，我会正确吗：

public static Task DoStuff(ExcelWorksheet sheet, HashSet<string> codes, int rowIndex, int count, int maxRowValue)
        {
            foreach (var code in codes)
            {
                sheet.Row(rowIndex);
                sheet.Cells[rowIndex, 1].Value = code;
                rowIndex++;
                count++;
                if (rowIndex == maxRowValue && count < (codes.Count - 1))
                {
                    sheet.InsertColumn(1, 1);
                    rowIndex = 1;
                }
            }
            //What should be returned?!
            return null;
        }

Answer 1

您可以编写异步 void 方法，但不能等待这些方法：

public static class Program
{
    public static async Task Main()
    {
        const int mainDelayInMs = 500;
        AsyncVoidMethod();
        await Task.Delay(mainDelayInMs);
        Console.WriteLine($"end of {nameof(Main)}");
    }

    static async void AsyncVoidMethod()
    {
        await Task.Delay(1000);
        Console.WriteLine($"end of {nameof(AsyncVoidMethod)}");
    }
}

如您所见，AsyncVoidMethod 是异步的，但我不能写 await AsyncVoidMethod();。

（大多数情况下）不应该使用异步 void 方法，因为您不能等待任务完成，并且可能无法处理抛出的任何异常（因此它可能会使您的应用程序崩溃）：Why exactly is void async bad?

Answer 2

当你的方法在后台阻塞时，假装你的方法是异步的通常没有什么好处。如果你需要一个任务，你可以在 Task.Run 中包装阻塞方法来创建一个等待任务。您仍将使用和阻塞线程，而不是当前线程。

推荐阅读：https://blog.stephencleary.com/2013/11/taskrun-etiquette-examples-using.html