在 PowerShell 中将变量写入文件 [4 种方式]

---

一、简介

在 PowerShell 脚本编写中，一项常见且关键的任务是将数据从变量写入文件。此过程在数据导出、日志记录和配置管理等各种场景中都是不可或缺的。虽然我们的主要关注点是字符串变量，但解决其他数据类型（例如数组、对象或数字）的处理也至关重要。本指南旨在提供深入了解在 PowerShell 中将各种类型的变量写入文件的不同方法，确保我们的脚本任务的稳健性和效率。

2. 使用输出文件

Out-File 是 PowerShell 中的一个基本 cmdlet，用于将输出写入文件。让我们深入研究它的用法，尤其是非字符串变量。

2.1.编写基本字符串

PowerShell 中的 Out-File cmdlet 是将输出定向到文件的直接方法。它对于写入字符串数据特别有用。例如：

使用输出文件 cmdlet：

$variable = "This is a test string"
$variable | Out-File -FilePath "output.txt"

输出.txt的内容：

This is a test string

在这里，来自 $variable 的字符串通过管道传输到 Out-File 中，并将其写入当前工作目录中的 output.txt 中。 要指定不同的位置，请提供完整路径，例如：C:\Logs\output.txt。

2.2.处理非字符串数据

Out-File 足够通用，可以处理数组或对象等非字符串变量。它将每个元素或对象属性写入文件中的新行。例如：

将输出文件与数组一起使用：

$array = 1..5
$array | Out-File -FilePath "output.txt"

输出.txt的内容：

1
2
3
4
5

由于其管道处理，Out-File 更适合较小的数据写入任务，对于大量数据来说，其速度可能会较慢。

3. 使用设置内容

与 Out-File 相比，Set-Content 是一种更直接的方法，并且通常更高效，尤其是对于较大的数据集。

3.1.字符串的基本用法

Set-Content

使用设置内容：

$variable = "Another test string"
Set-Content -Path "output.txt" -Value $variable

输出.txt的内容：

Another test string

3.2。编写复杂数据类型

Set-Content可以管理不同的数据类型，包括数组和对象。但是，对于复杂的对象，可能需要在写入之前将它们转换为合适的字符串格式：

使用设置内容：

$object = [PSCustomObject]@{Name = "John"; Age = 30}
$object | Set-Content -Path "output.txt"

输出.txt的内容：

@{Name=John; Age=30}

一般来说，Set-Content 比 Out-File 更快，特别是对于写入大型数据集，因为它不逐行处理数据。

4. 使用添加内容

4.1.追加数据

Add-Content 专门用于将数据附加到文件，非常适合日志记录或连续数据添加等场景：

使用添加内容：

$variable = "Data to append"
Add-Content -Path "output.txt" -Value $variable

4.2。附加非字符串变量

Add-Content 以与 Out-File 和 Set-Content 类似的方式处理非字符串变量，将每个元素或属性写入新行。

当需要频繁地将数据添加到现有文件中时（例如在日志记录操作中），最好使用添加内容。

5. 使用 [System.IO.File] 类

5.1.高级数据处理

对于高级用户，PowerShell 允许访问 .NET 类。 [System.IO.File] 类提供文件操作方法，适合高效处理大型或复杂的数据集。

使用系统.IO.文件：

$variable = "Data using .NET"
[System.IO.File]::WriteAllText("output.txt", $variable)

5.2。编写复杂数据类型

此方法需要将变量转换为复杂对象的字符串格式，通常通过序列化：

使用 System.IO.File 类：

$object = [PSCustomObject]@{Name = "Bob"; Age = 25}
$json = ConvertTo-Json $object
[System.IO.File]::WriteAllText("output.txt", $json)

[System.IO.File] 类方法由于直接访问 .NET 的文件 I/O 功能而提供最高的性能。

6. 探索实际例子

让我们看一下上述方法的一些实际示例。

6.1.使用输出文件

示例：将字符串数组写入文件

场景：将服务器名称数组写入文件。

使用输出文件：

$servers = @("Server1", "Server2", "Server3")
$servers | Out-File -FilePath "servers.txt"
write-host $servers

server.txt的内容：

Server1
Server2
Server3

这会将每个服务器名称写入当前工作目录中的 servers.txt 中的新行。要指定其他位置，请提供完整路径：C:\Logs\servers.txt。

示例：保存命令输出

场景：保存正在运行的服务列表。

保存命令输出：

Get-Service | Where-Object {$_.Status -eq "Running"} | Out-File -Path "running_services.txt"

running_services.txt的内容：

Status   Name               DisplayName                           
------   ----               -----------                           
Running  wuauserv           Windows Update                        
Running  WinDefend          Windows Defender Service              
... (other running services)

此命令将正在运行的服务的详细信息写入当前目录中的 running_services.txt 中。

6.2.使用设置内容

示例：写入多行配置数据

场景：存储多行配置数据。

使用设置内容：

$configData = @"
[settings]
version=1.0
path=C:\Program Files\MyApp
"@
Set-Content -Path "config.ini" -Value $configData

config.ini的内容：

[settings]
version=1.0
path=C:\Program Files\MyApp

这将使用提供的数据在当前目录中创建 config.ini。使用特定目录的完整路径。

示例：存储详细的进程信息

场景：存储有关进程的详细信息。

存储详细的进程信息：

$processInfo = Get-Process -Name "notepad" | Format-List *
$processInfo | Set-Content -Path "process_info.txt"

process_info.txt的内容：

Name : notepad
Id : 1234
HandleCount : 152
... (other process details)

将有关记事本的所有信息存储在当前目录的 process_info.txt 中。

6.3.使用添加内容

示例：创建日志文件

场景：记录不同脚本执行阶段的事件。

使用添加内容：

"Starting process..." | Add-Content -Path "event_log.txt"
# Some operations...
"Process completed successfully." | Add-Content -Path "event_log.txt"

event_log.txt的内容：

Starting process...
Process completed successfully.

将消息附加到当前 PowerShell 工作目录中的 event_log.txt。

示例：附加错误日志

场景：在错误处理例程中附加错误消息

使用添加内容：

try {
    # Code that might produce an error
} catch {
    $_.Exception.Message | Add-Content -Path "error_log.txt"
}

error_log.txt的内容：

Exception calling "Execute" with "0" argument(s): "Execution failed."

将捕获的异常消息附加到当前目录中的 error_log.txt 中。

6.4.使用 [System.IO.File] 类

示例：写入 JSON 数据

场景：将对象保存为 JSON。

 Class"]$user = [PSCustomObject]@{Name = "John Doe"; Age = 28; Department = "IT"}
$json = ConvertTo-Json $user
[System.IO.File]::WriteAllText("C:\Data\user.json", $json)

user.json的内容：

{
  "Name": "John Doe",
  "Age": 28,
  "Department": "IT"
}

自定义对象转换为 JSON 并将其保存在指定路径 C:\Data 的 user.json 中。

示例：导出 CSV 数据

场景：将对象导出到 CSV 文件。

导出 CSV 数据：

$employees = @(
    [PSCustomObject]@{Name = "Alice"; Age = 30},
    [PSCustomObject]@{Name = "Bob"; Age = 25}
)
$csv = $employees | ConvertTo-Csv -NoTypeInformation
[System.IO.File]::WriteAllLines("C:\Data\employees.csv", $csv)

员工.csv的内容：

"Name","Age","Department"
"Alice",30,"HR"
"Bob",25,"IT"

将对象数组转换为 CSV 并将其写入指定目录 C:\Data 中的 employees.csv。

每种方法都展示了独特的应用程序，可满足不同类型的数据和场景，为 PowerShell 脚本编写任务提供灵活性和效率。

7. 性能比较

• Out-File 和 Set-Content：适合中小型数据。
• 添加内容：非常适合将数据附加到现有文件。
• [System.IO.File]：非常适合高效处理大型或复杂的数据集。

八、结论

在PowerShell中将变量写入文件可以通过多种方法有效实现，每种方法都有独特的优势和适合的场景。 Out-File 和 Set-Content 对于大多数数据类型来说都很简单，非常适合中小型数据写入任务。 Add-Content 在需要附加数据的场景中表现出色，尤其是日志记录。对于处理大型或复杂的数据集，[System.IO.File] 类方法是最有效的，可提供高性能和灵活性。了解这些方法及其应用可以确保我们的 PowerShell 脚本通用、高效，并且能够处理各种数据写入需求。