Яка різниця між "Write-Host", "Write-Output" або "[console] :: WriteLine"?

Існує ряд різних способів виведення повідомлень. Що таке ефективна різниця між виводячи що - то з допомогою Write-Host, Write-Outputабо [console]::WriteLine?

Я також помічаю, що якщо я використовую:

write-host "count=" + $count

+Отримує включені в висновок. Чому це? Чи не слід вираз оцінювати таким чином, щоб він створив єдиний об'єднаний рядок до того, як він виписаний?

Write-Outputслід використовувати, коли ви хочете надсилати дані на трубопроводі, але не обов'язково бажати відображати їх на екрані. У результаті конвеєр запише його, out-defaultякщо спочатку нічого не використовує.

Write-Host слід використовувати, коли ви хочете зробити навпаки.

[console]::WriteLineпо суті те, що Write-Hostробиться за лаштунками.

Запустіть цей демонстраційний код і вивчіть результат.

function Test-Output {
    Write-Output "Hello World"
}

function Test-Output2 {
    Write-Host "Hello World" -foreground Green
}

function Receive-Output {
    process { Write-Host $_ -foreground Yellow }
}

#Output piped to another function, not displayed in first.
Test-Output | Receive-Output

#Output not piped to 2nd function, only displayed in first.
Test-Output2 | Receive-Output 

#Pipeline sends to Out-Default at the end.
Test-Output 

Вам потрібно буде вкласти операцію конкатенації в круглі дужки, щоб PowerShell обробляв конкатенацію перед тимкенізацією списку параметрів Write-Hostабо використовував рядкову інтерполяцію

write-host ("count=" + $count)
# or
write-host "count=$count"

BTW - Перегляньте це відео Джефрі Сновер, який пояснює, як працює трубопровід. Ще коли я почав вивчати PowerShell, я виявив, що це є найбільш корисним поясненням того, як працює трубопровід.

Крім того, що Енді згадував, є ще одна відмінність, яка може бути важливою - запис-хост безпосередньо записує на хост і нічого не повертає, що означає, що ви не можете перенаправити вихід, наприклад, на файл.

---- script a.ps1 ----
write-host "hello"

Тепер запустіть в PowerShell:

PS> .\a.ps1 > someFile.txt
hello
PS> type someFile.txt
PS>

Як видно, ви не можете перенаправити їх у файл. Це може бути дивно для того, хто не є обережним.

Але якщо перейти на використання запису-виводу замість цього, ви отримаєте перенаправлення працює, як очікувалося.

Ось ще один спосіб досягти еквівалента Write-Output. Просто поставте рядок у лапки:

"count=$count"

Ви можете переконатися, що це працює так само, як і Write-Output, виконавши цей експеримент:

"blah blah" > out.txt

Write-Output "blah blah" > out.txt

Write-Host "blah blah" > out.txt

Перші два будуть виводити "бла-бла" на out.txt, а третій - не.

"help Write-Output" дає підказку на таку поведінку:

Цей командлет зазвичай використовується в сценаріях для відображення рядків та інших об'єктів на консолі. Однак, оскільки поведінка за замовчуванням полягає у відображенні об'єктів у кінці конвеєра, командлет, як правило, не потрібно.

У цьому випадку сам рядок "count = $ count" є об'єктом в кінці конвеєра і відображається.

Для використань Write-Host, PSScriptAnalyzerвиробляє такі діагностичні:

Уникайте використання, Write-Hostоскільки воно може працювати не у всіх хостів, не працює, коли немає хоста, і (до PS 5.0) не можна придушувати, захоплювати або перенаправляти. Замість цього використовуйте Write-Output, Write-Verboseабо Write-Information.

Для отримання додаткової інформації див документацію за цим правилом. Витяги для нащадків:

Використання Write-Hostсильно не перешкоджає, якщо не застосовувати команди з Showдієсловом. ShowДієслово явно означає «показати на екрані, без яких - або інших можливостей».

Команди з Showдієсловом не застосовують цю перевірку.

Джефрі Сновер має повідомлення в блозі Write-Host Вважається шкідливим, в якому він стверджує, що Write-Host майже завжди неправильне робити, оскільки це заважає автоматизації та надає більше пояснень в діагностиці, однак вищезазначене є хорошим підсумком.

З мого тестування Write-Output та [Console] :: WriteLine () працюють набагато краще, ніж Write-Host.

Залежно від того, скільки тексту потрібно написати, це може бути важливим.

Нижче, якщо результат 5 тестів кожен для Write-Host, Write-Output та [Console] :: WriteLine ().

З мого обмеженого досвіду, коли я працював з будь-якими реальними даними, мені потрібно відмовитися від командлетів і перейти безпосередньо до команд нижчого рівня, щоб отримати будь-яку гідну продуктивність зі своїх сценаріїв.

measure-command {$count = 0; while ($count -lt 1000) { Write-Host "hello"; $count++ }}

1312ms
1651ms
1909ms
1685ms
1788ms


measure-command { $count = 0; while ($count -lt 1000) { Write-Output "hello"; $count++ }}

97ms
105ms
94ms
105ms
98ms


measure-command { $count = 0; while ($count -lt 1000) { [console]::WriteLine("hello"); $count++ }}

158ms
105ms
124ms
99ms
95ms

Щодо [Console] :: WriteLine () - ви повинні використовувати його, якщо ви збираєтесь використовувати трубопроводи в CMD (не в powerhell). Скажімо, ви хочете, щоб ваш ps1 передав багато даних для stdout, а якась інша утиліта споживала / перетворювала їх. Якщо ви використовуєте Write-Host в сценарії, це буде набагато повільніше.