PowerShell 将主机写入文件 [带有示例]

最近，我需要将 Write-Host 的输出写入 PowerShell 中的文件中。我进行了广泛的研究以找到不同的方法和最佳实践。在本教程中，我们将通过示例讨论有关 PowerShell Write-Host to file 的所有内容。

要将 Write-Host 的输出写入 PowerShell 中的文件，您可以使用 Start-Transcript 和 Stop-Transcript cmdlet捕获所有控制台输出，或在 PowerShell 5.0 及更高版本中使用 5>&1 重定向信息流。另一种方法是重写 Write-Host 函数以包含 Out-File cmdlet，该 cmdlet 会将输出发送到控制台和指定文件。

了解 PowerShell 中的写入主机

让我们了解一下 Write-Host 在 PowerShell 中的作用。 Write-Host cmdlet 用于将文本、变量和格式化数据输出到控制台窗口。这在脚本执行期间提供了有价值的反馈，但默认情况下，它不会将输出发送到 PowerShell 管道或文件。

将写入主机输出重定向到文件

尽管 Write-Host 旨在将输出发送到控制台，但有一些解决方法可以将此输出捕获到文件中。让我们讨论一些方法以及如何实现它们。

1. 使用开始转录和停止转录

捕获控制台上显示的所有内容（包括将 PowerShell 中的 Write-Host 输出写入文件）的一种方法是使用 Start-Transcript 和 Stop-Transcript cmdlet。这些 cmdlet 启动和停止写入与 PowerShell 控制台的所有交互。

Start-Transcript -Path "C:\MyFolder\Transcript.txt"
Write-Host "This is a message for the console and transcript file."
Stop-Transcript

此脚本将创建所有控制台输出的记录，包括 Write-Host 语句，并将其保存到 Transcript.txt。

当我使用 VS code 执行 PowerShell 脚本后，您可以在下面的屏幕截图中看到输出。

2. 将 Out-File 与 Tee-Object 一起使用

另一种方法是将 Out-File cmdlet 与 Tee-Object 结合使用。 PowerShell 中的 Tee-Object cmdlet 允许您将输出同时发送到控制台和文件。

"Output from Write-Host" | Tee-Object -FilePath "C:\MyFolder\Output.txt"
Write-Host "This message will appear in the console, but not in the file."

在此示例中，只有第一行将写入 Output.txt，因为 Write-Host 不会沿管道发送数据。

3. 使用5>&1重定向信息流

从 Windows PowerShell 5.0 开始，Write-Host 是 Write-Information 的包装器，它允许您将信息流 (5) 重定向到成功输出流 (1)然后到一个文件。

Write-Host "This will go to the file." 5>&1 | Out-File "C:\MyFolder\HostOutput.txt"

此命令会将 Write-Host 输出重定向到 HostOutput.txt。

4. 使用函数捕获写主机

在 PowerShell 中，您还可以创建一个自定义函数来重写 Write-Host 以捕获其输出并将其重定向到文件。

function Write-Host {
    param([string]$message)
    $message | Out-File "C:\MyFolder\HostOutputOverride.txt" -Append
    Microsoft.PowerShell.Utility\Write-Host $message
}

Write-Host "This message will go to both the console and the file."

此函数会将每条 Write-Host 消息附加到 HostOutputOverride.txt，同时仍将其显示在控制台中。

5. 使用自定义主机

对于更高级的解决方案，您可以实现一个自定义主机来捕获 Write-Host 调用并将其重定向到文件。

class CustomHost : System.Management.Automation.Host.PSHost
{
    # Implement required members...
}

$host = New-Object CustomHost
$host.ui.WriteLine("Redirected to file") | Out-File "C:\Output\CustomHostOutput.txt"

这是一个简化的示例，完整的自定义主机实现需要更多代码来完全定义 PSHost 类成员。

最佳实践和注意事项

将 Write-Host 输出重定向到文件时，请考虑以下最佳实践：

• 谨慎使用 Write-Host，因为它用于控制台输出，而不是用于数据存储。
• 当您想要将数据发送到管道或文件时，首选 Write-Output 或 Write-Information。
• 确保正确设置文件路径和权限以避免任何访问问题。
• 请记住，重定向输出流时，默认情况下不会捕获 Write-Host 输出。

结论

而Write-Host主要用于在PowerShell中的控制台中显示消息；有多种方法将其输出重定向到 PowerShell 中的文件。

在本 PowerShell 教程中，我解释了 5 种不同的方法来将 Write-Host 的输出写入 PowerShell 中的文件。