「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"

ところで、パイプラインがどのように機能するかを説明するジェフリー・スノーバーのこのビデオを見てください。PowerShellの学習を始めたとき、これがパイプラインのしくみについて最も役立つ説明であることがわかりました。

Andyが述べたこととは別に、重要な可能性のある別の違いがあります。write-hostはホストに直接書き込み、何も返さないため、出力をファイルなどにリダイレクトできません。

---- 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

最初の2つは「何とか何とか」をout.txtに出力しますが、3番目は出力しません。

「help Write-Output」は、この動作のヒントを提供します。

このコマンドレットは通常、スクリプトで使用され、文字列やその他のオブジェクトをコンソールに表示します。ただし、既定の動作では、パイプラインの最後にオブジェクトを表示するため、通常、コマンドレットを使用する必要はありません。

この場合、文字列自体「count = $ count」はパイプラインの最後のオブジェクトであり、表示されます。

用法についてWrite-Host、PSScriptAnalyzer次の診断を生成します。

Write-Hostすべてのホストで機能しない可能性があり、ホストがない場合は機能せず、（PS 5.0より前の）抑制、キャプチャー、またはリダイレクトできないため、使用を避けてください。代わりに、使用Write-Output、Write-VerboseまたはWrite-Information。

詳細については、そのルールの背後にあるドキュメントを参照してください。後世の抜粋：

使用がWrite-Host大幅に持つコマンドの使用でない限り推奨されてShow動詞。Show動詞は、明示的に「ノー他の可能性と、画面上のショーを、」意味します。

Show動詞を含むコマンドには、このチェックが適用されていません。

Jeffrey Snoverのブログ投稿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（）について-（Powershellではなく）CMDでパイプラインを使用する場合は、これを使用する必要があります。たとえば、ps1で大量のデータをstdoutにストリーミングし、他のユーティリティでそれを消費/変換したいとします。スクリプトでWrite-Hostを使用すると、速度が大幅に低下します。