“Write-Host”、“Write-Output”或“[console]::WriteLine”有什么区别？

当您想在管道中发送数据但不一定想在屏幕上显示时，应该使用 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"

顺便说一句 - 观看 Jeffrey Snover 的 video，解释管道的工作原理。当我开始学习 PowerShell 时，我发现这是对管道如何工作的最有用的解释。

---

除了 Andy 提到的之外，还有另一个可能很重要的区别 - write-host 直接写入主机并且不返回任何内容，这意味着您不能将输出重定向到文件。

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

现在在 PowerShell 中运行：

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

如图所示，您无法将它们重定向到文件中。对于不小心的人来说，这可能会令人惊讶。

但是，如果改用 write-output，您将获得重定向按预期工作。

---

这是另一种实现相当于 Write-Output 的方法。只需将您的字符串放在引号中：

"count=$count"

你可以通过运行这个实验来确保它与 Write-Output 一样工作：

"blah blah" > out.txt

Write-Output "blah blah" > out.txt

Write-Host "blah blah" > out.txt

前两个将输出 "blah blah" 到 out.txt，但第三个不会。

“help Write-Output”暗示了这种行为：

此 cmdlet 通常在脚本中用于在控制台上显示字符串和其他对象。但是，由于默认行为是在管道末尾显示对象，因此通常不需要使用 cmdlet。

在这种情况下，字符串“count=$count”本身就是管道末端的对象，并被显示出来。

---

对于 Write-Host 的用法，PSScriptAnalyzer 产生以下诊断：

避免使用 Write-Host，因为它可能不适用于所有主机，在没有主机时不起作用，并且（在 PS 5.0 之前）不能被抑制、捕获或重定向。相反，使用 Write-Output、Write-Verbose 或 Write-Information。

有关详细信息，请参阅该规则后面的 documentation。后人摘录：

除非使用带有 Show 动词的命令，否则非常不鼓励使用 Write-Host。 Show 动词明确表示“在屏幕上显示，没有其他可能性”。带有 Show 动词的命令不应用此检查。

Jeffrey Snover 有一篇博文 Write-Host Considered Harmful，其中他声称 Write-Host 几乎总是做错事，因为它会干扰自动化，并在诊断背后提供了更多解释，但以上内容很好概括。

---

根据我的测试，Write-Output 和 [Console]::WriteLine() 的性能比 Write-Host 好得多。

根据您需要写出多少文本，这可能很重要。

下面是 Write-Host、Write-Output 和 [Console]::WriteLine() 的 5 次测试的结果。

在我有限的经验中，我发现在处理任何类型的现实世界数据时，我需要放弃 cmdlet 并直接使用较低级别的命令，以便从我的脚本中获得任何不错的性能。

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 中使用管道（而不是在 powershell 中），则应使用它。假设您希望您的 ps1 将大量数据流式传输到标准输出，并使用其他一些实用程序来使用/转换它。如果您在脚本中使用 Write-Host，它会慢得多。

---