PowerShell Out-File cmdlet：如何将输出重定向到文件？

作为 PowerShell 初学者，您需要了解的最重要的 cmdlet 之一是 Out-File。这个非常有用的 cmdlet 允许您将 PowerShell 命令和脚本的输出导出到文本文件中。无论您需要记录结果、生成报告、记录事件还是保存数据以供以后使用，PowerShell 都有多个命令可以帮助您输出到文件。

在这份综合指南中，您将了解作为 PowerShell 初学者有效使用 Out-File 所需的一切。我们将介绍 cmdlet 的基础知识，包括不同的命令、语法、格式化输出、附加与覆盖文件以及实际示例。

什么是输出文件 Cmdlet？

Out-File cmdlet 将 PowerShell 命令的输出发送到文本文件。输出将写入指定的路径和文件名。这对于许多目的都很有用，例如生成报告、创建备份或记录事件。默认情况下，Out-File 创建一个新文件或使用输出覆盖现有文件。它提供了几个参数来自定义输出文件的行为和格式。 PowerShell 中有多个可用于输出文件的命令，包括 Out-File、Add-Content 和 Set-Content。

Out-File 是输出到文件的最基本命令。它将命令的输出保存到文件中，覆盖任何现有内容。另一方面，Add-Content 将输出附加到现有文件的末尾。 Set-Content 与 Out-File 类似，但它会覆盖整个文件，而不是仅仅追加到文件中。

了解 PowerShell 中写入文件的不同 cmdlet

在深入研究具体命令之前，我们先看看 Out-File、Add-Content 和 Set-Content 之间的区别。

• Out-File：此命令将命令的输出保存到文件中。它会覆盖文件中的任何现有内容。默认文件格式是 Unicode，但您可以使用编码参数指定不同的格式。
• 添加内容：此命令将命令的输出附加到现有文件的末尾。如果该文件不存在，则会创建该文件。默认文件格式是 Unicode，但您可以使用编码参数指定不同的格式。
• Set-Content：此命令用命令的输出覆盖文件的全部内容。如果该文件不存在，则会创建该文件。默认文件格式是 Unicode，但您可以使用编码参数指定不同的格式。

使用 PowerShell Out-File Cmdlet - 语法和示例

Out-File 是输出到文件的最基本命令。它将命令的输出保存到文件中，覆盖任何现有内容。这是基本语法：

Out-File 
[-FilePath] <String> 
[[-Encoding] {unknown | string | unicode | bigendianunicode | utf8 | utf7 | utf32 | ascii | default | oem}] 
[-Append] 
[-Confirm] 
[-Force] 
[-InputObject <PSObject>] 
[-NoClobber] 
[-NoNewline]
[-WhatIf] 
[-Width <Int32>] 
[<CommonParameters>]

以下是 PowerShell 中 Out-File cmdlet 的重要参数列表：

如果指定，cmdlet 会将输出附加到现有文件的末尾，而不是覆盖它。

指定字符编码。值包括 ascii、utf8、utf7、utf32、unicode、 bigendianunicode 和 默认。 utf8NoBOM 可能在较新的 PowerShell 版本中可用。

除安全设置外，允许 cmdlet 覆盖阻止命令成功的限制。例如，Out-File 将覆盖文件，即使它具有只读属性。

指定要写入文件的输入。它接受一个对象。

指示 cmdlet 不应覆盖（替换）现有文件。如果与 -Append 一起使用，该参数将被忽略。

省略输出末尾的换行符。如果您不想引入额外的空行，这很有用。

FilePath 参数指定输出文件的路径。它可以是相对路径或绝对路径。您还可以使用 -LiteralPath，它精确地获取输入的值，而不将任何字符解释为通配符。

指定每行输出中的字符数。当输出宽度不应超过指定的字符数时，此参数很有用。 Windows PowerShell 控制台主机的默认值为 80 个字符。

使用 Out-File cmdlet：基本示例

要使用输出文件，您只需将命令的输出通过管道传送给它即可。例如，假设您有一个命令可以检索系统上运行的进程列表。您可以使用以下命令将此输出重定向到文件：

command | Out-File -FilePath "C:\Path\To\File.txt"

-FilePath 参数指定保存输出的文件的路径和名称。这是一个例子：

Get-Process | Out-File -FilePath C:\Logs\Processes.txt

此命令会将进程列表保存到指定路径中名为 Processes.txt 的文件中。

关于输出文件需要了解的关键事项：

• 它将命令输出写入文本文件
• 您可以使用 -FilePath 参数指定文件路径和名称
• 如果文件不存在则创建文件，如果存在则覆盖文件

使用 PowerShell Out-File cmdlet 附加到现有文件

除了创建新文件或覆盖现有文件之外，输出文件还允许您将数据附加到文件中。当您想要持续更新日志文件或向现有文件添加新信息而不丢失以前的内容时，这非常有用。

以下是如何使用 Out-File 附加到文件的示例：

# PowerShell Out-File -Append example
Get-ChildItem C:\Users | Out-File -FilePath "C:\Logs\FilesList.txt" -Append

-Append 参数告诉 Out-File 将输出附加到文件末尾，而不是覆盖它。此命令会将给定路径中的文件夹名称列表附加到文件末尾，如果不存在则创建它。

PowerShell 输出文件：真实示例

PowerShell 具有多种用于处理文件输出的高级技术，例如使用变量和格式化。以下是如何在 Out-File 中使用变量的示例：

$processes = Get-Process
$processes | Out-File C:\Path\To\File.txt

此命令将 Get-Process 的输出保存到变量，然后使用 Out-File 将变量输出到文件。格式化输出是使用 PowerShell 输出到文件的另一种高级技术。以下是如何使用 Format-Table 格式化输出的示例：

Get-Process | Format-Table -AutoSize | Out-File -FilePath "C:\Logs\Process.txt"

此命令将 Get-Process 的输出格式化为表格，然后使用 Out-File 将其保存到文件中。

Out-File 为 PowerShell 中的文件管理提供了广泛的功能。以下是一些其他示例来展示其多功能性：

示例1：创建具有特定编码的文件

$Services = Get-Service
$Services | Out-File -FilePath "C:\Data\output.txt" -Encoding UTF8

此命令将使用 UTF-8 编码创建一个名为“output.txt”的新文件，并将 $myData 变量的输出保存到其中。

示例 2：将错误输出重定向到文件

在 PowerShell 中，您可以使用重定向运算符将错误输出或文本重定向到文件。操作方法如下：

Get-ChildItem -Path C:\anothernonexistentfolder 2>> "C:\Logs\ErrorLog.txt"

此命令将检索进程列表，抑制任何错误消息，并将错误输出重定向到“output.txt”文件。

您还可以使用 Try-Catch 块将错误记录到文件中：

Try {
  Get-Process -Name NotExists -ErrorAction Stop
}
Catch {
  $_.Exception | Out-File -FilePath "C:\Logs\ErrorLog.txt" -Append
}

使用 Out-File PowerShell Cmdlet 创建 CSV 文件

Out-File不仅限于创建文本文件，还支持创建CSV文件。 CSV（逗号分隔值）文件广泛用于存储和交换表格数据。要使用 Out-File 创建 CSV 文件，您需要在文件路径中将文件扩展名指定为“.csv”。此外，您可以使用 -Encoding 参数指定 CSV 文件的编码。例如：

Get-Process | Select-Object -Property ProcessName, Id, CPU | ConvertTo-Csv -NoTypeInformation | Out-File -FilePath "C:\Logs\processes.csv" -Encoding utf8

在此示例中，我们使用 ConvertTo-Csv cmdlet 将 $myData 变量转换为 CSV 格式，然后使用 UTF 将输出重定向到名为“data.csv”的文件-8编码。

然而，值得注意的是，虽然可以通过这种方式使用 Out-File，但 PowerShell 为此目的提供了一个更直接的 cmdlet，称为 Export-Csv。 Export-Csv 是一种在 PowerShell 中将对象导出到 CSV 文件的更直接的方法。它消除了对 ConvertTo-Csv 和 Out-File 的需要。如何在 PowerShell 中使用 Export-CSV cmdlet 导出到 CSV？

使用输出文件中的 Force 参数覆盖只读文件

默认情况下，Out-File 会覆盖现有文件的内容。但是，在某些情况下，您可能希望显式覆盖标记为只读的文件。 Out-File 命令提供了 -Force 参数来实现此目的。

"New content for the file" | Out-File -FilePath "C:\output.txt" -Force

在此示例中，“output.txt”文件将被 $myData 变量的输出覆盖，即使它已经存在。或者，您可以清除文件的只读属性，然后更新文件。具体方法如下：

#Clear the Read Only Property
Set-ItemProperty -Path "C:\Data\readonly.txt" -Name IsReadOnly -Value $false

#Update the file
"New content for the file" | Out-File -Path "readonly.txt"

在 PowerShell 中将输出重定向到文件

除了使用 Out-File 将命令的输出重定向到文件之外，您还可以使用重定向运算符 (>) 将输出直接写入文件。当您想要快速保存命令的输出而不显式使用 Out-File cmdlet 时，这非常有用。

Get-Process > "C:\output.txt"

在此示例中，Get-Process 命令的输出将使用 > 运算符直接写入“output.txt”文件。同样，要追加到现有文件而不是覆盖文件，请使用 >> 运算符：

Get-Process >> "C:\output.txt"

仅重定向错误：

使用 2> 运算符重定向错误。例如，如果您想将错误从命令重定向到名为“errors.txt”的文件：

附加错误：

如果要将错误附加到文件而不是覆盖它，请使用 2>> 运算符：

Get-ChildItem -Path C:\nonexistentfolder 2>> errors.txt

重定向所有输出：
如果要将所有输出（标准和错误）重定向到同一文件，请使用 *>：

Get-ChildItem -Path C:\nonexistentfolder *> alloutput.txt

以下是其他有用的重定向运算符的列表：

• 1> 或 >：重定向标准输出
• 2>：重定向错误输出
• 3>：重定向警告输出
• 4>: 重定向详细输出
• 5>：重定向调试输出
• 6>：重定向信息输出

将输出通过管道传输到 PowerShell 中的文件

将输出重定向到文件的另一种方法是使用管道 (|) 运算符以及 Out-File cmdlet。当您想要在将输出保存到文件之前对其执行其他操作时，此方法非常有用。

Get-Process | Select-Object -Property Name, CPU, Memory | Out-File -FilePath "C:\Logs\output.txt"

在此示例中，我们使用 Select-Object cmdlet 仅从 Get-Process 命令的输出中检索特定属性。然后，我们使用 Out-File cmdlet 将修改后的输出保存到“output.txt”文件中。

使用 Out-File 管理文件编码

编码在文件管理中起着至关重要的作用，尤其是在处理不同语言和特殊字符时。 Out-File 提供了 -Encoding 参数，允许您指定输出文件的编码。

Out-File 使用的默认编码是 ASCII，但您可以指定其他编码类型，例如 UTF-8、UTF-16 或 Unicode。例如：

Get-Process | Out-File -FilePath "C:\output.txt" -Encoding UTF8

此命令会将 Get-Process 命令的输出保存到名为“output.txt”的文件中，并使用 UTF-8 编码。

如果 Out-File 不存在则创建文本文件

有时，仅当文件尚不存在时，您可能才需要创建该文件。 Out-File 提供了一种使用 -Force 参数来实现此目的的便捷方法。

通过指定 -Force 参数，Out-File 将创建一个新文件（如果该文件不存在）。如果该文件已存在，该命令将覆盖现有文件。当您想在将输出重定向到该文件之前确保该文件存在时，这会很有用。

Get-Process | Out-File -FilePath "C:\output.txt" -Force

在此示例中，如果“output.txt”文件尚不存在，则将创建该文件，并且 Get-Process 命令的输出将重定向到该文件。

使用 Out-File 分隔 CSV 文件中的列

使用 CSV 文件时，通常使用逗号以外的字符分隔列。例如，假设您有一个 CSV 文件，其中包含制表符分隔值而不是逗号。您可以使用 Out-File 创建一个新的 CSV 文件，并以制表符作为分隔符：

Get-Service | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File -FilePath "C:\data\Services.csv"

在此命令中，我们使用“ConvertTo-Csv”cmdlet 将数据转换为 CSV 格式，并使用“`t”转义序列指定制表符作为分隔符。

在输出文件中使用分隔符

除了为 CSV 文件指定分隔符之外，Out-File 还允许您对其他类型的文件使用分隔符。当您想要分隔文本文件中的值或自定义输出的格式时，这非常有用。例如，假设您有一个生成数字列表的脚本，并且您想用分号分隔它们：

$numbers = 1, 2, 3, 4, 5
$numbers -join ";" | Out-File -FilePath "C:\numbers.txt"

在此示例中，我们使用 -join 运算符将 $numbers 数组的元素与分号分隔符连接起来，然后将输出重定向到名为“numbers.txt”的文件。 TXT”。

使用 Out-File 从 CSV 文件中删除标头

使用 CSV 文件时，您可能会遇到需要从文件中删除标题（第一行）的情况。 Out-File 提供了一种使用 -NoClobber 参数实现此目的的简单方法。

通过指定 -NoClobber 参数，Out-File 将防止覆盖现有文件。当您想要从 CSV 文件中删除标头而不修改其余内容时，这会很有用。

$CSVData = Get-Content -Path "C:\data\Services.csv" | Select-Object -Skip 1
$CSVData | Out-File -FilePath "C:\data\ServicesV2.csv" -NoClobber

在此示例中，我们使用 Get-Content cmdlet 读取“data.csv”文件的内容，并使用 Select-Object cmdlet 跳过第一行。然后，我们将修改后的内容重定向回同一文件而不覆盖它，从而有效地删除标头。

将 PowerShell 输出组合到文件和控制台：Tee-Object 命令

Tee-Object 命令允许您将命令的结果输出到文件和控制台。将其视为数据的“T 形路口”；它从一个源获取输入并将其定向到两个目的地。这是基本语法：

command | Tee-Object -FilePath "C:\Logs\Commands.txt"

此命令会将命令的输出保存到指定路径中名为 File.txt 的文件中，并将其显示在 PowerShell 控制台中。例如。，

Get-command -Module PnP.PowerShell | Tee-Object -FilePath "C:\Logs\Commands.txt"

当您使用 Tee-Object 时，您可以将数据沿着管道发送到另一个命令，并同时将其保存到文件或变量中。您还可以使用 -Append 附加到文件。 Microsoft 关于 Tee-Object cmdlet 的参考

解决 PowerShell 输出到文件的常见问题

虽然 PowerShell 输出到文件是一个强大的工具，但它有时会遇到问题。以下是一些常见问题及其解决方案：

• 文件访问被拒绝：确保您拥有访问该文件所需的权限，并且当前未在其他程序中打开该文件。
• 找不到文件：仔细检查文件的路径和名称，以确保它存在并且没有拼写错误。
• 编码问题：确保您的文件使用正确的编码。 Unicode 是默认值，但您可能需要根据需要指定不同的编码。

结论和后续步骤

在这份综合指南中，我们探讨了您需要了解的有关 PowerShell Out-file 以进行有效文件管理的所有信息。我们学习了如何将输出重定向到文件、追加数据、创建 CSV 文件、管理文件编码、创建文件（如果不存在）、分隔 CSV 文件中的列以及使用分隔符。我们还学习了如何删除标头、覆盖文件、将输出直接写入文件以及通过管道将输出传输到文件。通过掌握这些技术，您将能够很好地处理 PowerShell 脚本中的任何输出到文件的需求。

有了这些知识，您现在就可以掌握 PowerShell Out-File 并增强您的文件管理能力。

经常问的问题：

PowerShell 中的 out-file 是什么？

Out-File 是 PowerShell 中的一个 cmdlet，用于将输出发送到文件。它允许您将命令或脚本的输出重定向到文本文件。您可以指定文件路径和名称，并选择是覆盖现有文件还是将输出附加到该文件。

PowerShell 中 out-file 的替代方案是什么？

Set-Content：此 cmdlet 可用于将内容写入文件，类似于 out-file。它允许您指定文件路径和要写入的内容。

添加内容和输出文件有什么区别？

Add-Content cmdlet 用于将内容附加到现有文件。默认情况下，它将新内容添加到文件末尾，而不覆盖任何现有内容。当您想要不断向文件添加新数据而不丢失以前的数据时，这非常有用。

如何在 PowerShell 中将文件读取为文本？

要在 PowerShell 中将文件读取为文本，可以使用 Get-Content cmdlet。以下是如何执行此操作的示例：

$content = Get-Content -Path "C:\path\to\file.txt"

如何通过管道将输出传输到 PowerShell 中的文件？

要将输出通过管道传输到 PowerShell 中的文件，可以使用“>”符号，后跟文件路径。例如，如果要将命令的输出重定向到名为“output.txt”的文件，则可以使用以下语法：“command > output.txt”。

如何在 PowerShell 中将输出写入日志文件？

Out-File cmdlet 可用于将 PowerShell 命令的输出发送到文件。例如，您可以使用以下命令将命令的输出写入文件：输出文件 C:\Logs\Log.txt。这会将 Get-ChildItem 命令的输出写入 Log.txt 文件。

如何将 PowerShell 输出重定向到 CSV 文件？

要将 PowerShell 输出重定向到 CSV 文件，您可以使用 Export-Csv cmdlet。操作方法如下：

Get-Service | Select-Object Name, DisplayName, Status | Export-Csv "C:\Data\Services.csv" -NoTypeInformation -Encoding UTF8

如何将 PowerShell 输出重定向到文件？

您可以使用“Out-File”cmdlet 或使用“>”重定向运算符将 PowerShell 输出重定向到文件。示例：Get-Process |输出文件-FilePath“C:\output.txt”

我可以将 PowerShell 输出附加到现有文件吗？

是的，您可以使用带有“-Append”参数的“Out-File”cmdlet 将 PowerShell 输出附加到现有文件。例如，Get-Process | Out-File -FilePath "C:\output.txt" -Append 将输出添加到现有文件。