В чем разница между Console.WriteLine и Console.Out.WriteLineAsync в асинхронном методе?

Если вы посмотрите декомпилированный исходный код Console.WriteLine, вы увидите

[MethodImpl(MethodImplOptions.NoInlining)]
public static void WriteLine() => Console.Out.WriteLine();

Итак, это в основном то же самое. Консоль поддерживает запись в основные потоки In, Out, Err. Я думаю, что Console.WriteLine — это просто удобная оболочка для записи в Out, потому что она наиболее часто используется.

С точки зрения производительности разница, скорее всего, незначительна, поскольку запись текста в консоль происходит очень быстро. Лично я бы сказал, что Console.WriteLine следует использовать вместо Console.Out.WriteLineAsync. Как показало тестирование, Console.Out.WriteLineAsync иногда работает быстрее на несколько микросекунд или около того, но не всегда.

Поскольку оба пишут в консоль, видимой разницы между Console.WriteLine и Console.Out.WriteLineAsync нет.

Свойство Console.Out — это статическое TextWriter, которое открывает дескриптор консоли и записывает туда текст. Вместо этого каждый метод Write и WriteAsync будет писать в консоль.

Когда вы вызываете метод Console.WriteLine, он вместо этого вызывает Console.Out.WriteLine, и поскольку каждый метод Write в свойстве Console.Out записывает непосредственно в консоль, он записывает в консоль новую строку.

Однако у TextWriter также есть методы .WriteLineAsync (помимо других методов асинхронной записи). Поскольку от TextWriter может наследовать что угодно, также должен быть способ писать текст асинхронно. Итак, Console.Out.WriteLineAsync просто выводит текст с новой строки на консоль и реализуется, потому что является частью TextWriter.

В общем, разницы скорее всего нет, так как оба пишут в консоль. .WriteLineAsync реализован, потому что он должен быть реализован, поскольку это метод, который переопределяет TextWriter.

В синхронных и асинхронных методах лично я бы рекомендовал использовать Console.WriteLine.

Помимо технических отличий, еще одним отличием является то, что Console.Out.WriteLineAsync не получил широкого распространения.

См. Методы TextWriter.

Проблема с фрагментом cw Visual Studio 2022

Насколько я понимаю, более старая версия Visual Studio 2022 вставляла await Console.Out.WriteLineAsync в асинхронный метод вместо Console.WriteLine, который изменился после обновления. Visual Studio 2022 действительно это делает (17.9.6).

Я не совсем понимаю, почему его удалили, потому что в Интернете, похоже, нет никакой информации. Я предполагаю, что удаление связано с тем, что await Console.Out.WriteLineAsync больше не используется широко и это почти то же самое, что и Console.WriteLine, но не уверен, почему VS рекомендовал его раньше.

Если вы хотите преобразовать все вызовы await Console.Out.WriteLineAsync в Console.WriteLine во всей базе кода (будь то проект или решение), нажмите Ctrl + Shift + H, чтобы открыть диалоговое окно «Заменить в файлах», в котором можно заменить await Console.Out.WriteLineAsync на Console.WriteLine.

Нет абсолютно никакой разницы между Console.WriteLine() и await Console.Out.WriteLineAsync(). Console.Out.WriteLineAsync всегда возвращает завершенное Task. Это всегда синхронная операция:

Task task = Console.Out.WriteLineAsync();
Console.WriteLine(task == Task.CompletedTask);

Выход:

True

Онлайн-демо.

Когда Console.Out.WriteLineAsync() возвращается, текст уже напечатан в консоли. Асинхронного измерения нет. Переключателя потока нет. Вся работа выполняется синхронно в текущем потоке.

Любая незначительная разница в производительности, которую вы могли заметить, может быть связана с незначительными ошибками в методологии тестирования или случайными факторами. Нет никаких причин, по которым один подход может быть быстрее другого. Оба делают одно и то же, совершенно одинаковым образом.

Я нашел реальный ответ, просмотрев исходный код на GitHub и осознав, что Console.Out.WriteLineAsync не имеет смысла (Out — это синхронизированный TextWriter). Последний поиск Console.Out.WriteLineAsync в Google после просмотра исходного кода вернул обсуждение в выпуске Semantic Snippets GH в репозитории Roslyn.

Его снова изменили на Console.WriteLine, потому что, как написал Стивен Тауб в обсуждении проблемы

Console.Out всегда является синхронизированным средством записи текста (TextWriter.Synchronized), при этом все операции охраняются монитором; все операции, записывающие данные в консоль, защищены одной и той же блокировкой, и каждый раз, когда мы пытались это изменить, нам приходилось откатывать назад, потому что значительное количество приложений взяли на себя зависимость от возможности делать такие вещи, как lock (Console.Out) { Console.ForegroundColor = ...; ... multiple writes ...; Console.ResetColor(); }. Асинхронные операции на таком записывающем устройстве преобразуются в синхронные. Использование await Console.Out.WriteLineAsync(...) вместо Console.WriteLine(...) не имеет никаких преимуществ, а только накладные расходы/более сложный код.

В выпуске Semantic Snippets GH neuec в 2023 году отметил, что WriteLineAsync не нужен:

В последней версии Visual Studio cw стал Console.Out.WriteLineAsync в асинхронном контексте, но я думаю, что в этом нет необходимости.

Это плохая функция, если ее не вернуть обратно к Console.WriteLine или не сделать настраиваемой.

Потому что

ConsoleStream имеет только синхронную запись. https://source.dot.net/#System.Console/System/IO/ConsoleStream.cs,c0e0ba628fa4c224

UnixConsoleStream: https://source.dot.net/#System.Console/System/ConsolePal.Unix.ConsoleStream.cs,13bf065fbb4646d5

WindowsConsoleStream: https://github.com/dotnet/runtime/blob/f9f7f8079377039a8d42269434a41ca55d14d591/src/libraries/System.Console/src/System/ConsolePal.Windows.cs#L1076

Другими словами, я не думаю, что Async имеет смысл.

Далее он также указывает, что Console.Out — это синхронизированная программа записи текста, которая синхронно выполняет асинхронные операции и возвращает выполненную задачу.

[MethodImpl(MethodImplOptions.Synchronized)]
public override Task WriteLineAsync()
{
    WriteLine();
    return Task.CompletedTask;
}

Кстати, я никогда не писал, что асинхронность будет быстрее. Во всяком случае, это может быть немного медленнее из-за сгенерированного конечного автомата и обратных вызовов, если асинхронные операции действительно выполняются. Если код выполняется синхронно, мы платим стоимость конечного автомата без всякой выгоды. Это случай only overhead / more complicated code, о котором рассказывает Стивен Тауб.