PowerShell / 运维PowerShell 对象的序列化和反序列化
1. 概述
在 PowerShell 中，对象的 序列化 和 反序列化 是将 对象 转换为 字符串格式以便存储或传输，然后从字符串还原为对象的过程。这在许多应用中都非常有用，特别是当你需要将对象保存到文件、传递给远程服务器或存储在数据库中时。
本文接下来将分别介绍如何在 PowerShell 中执行对象的 序列化 和 反序列化 操作。
2. 序列化：将对象转化为字符串
要将对象序列化为字符串，你可以使用 PowerShell 中的 ConvertTo-Json cmdlet。以下是一个示例，演示如何将对象序列化为 JSON 字符串：
# 创建一个示例对象 $person = @{ FirstName = "Jack" LastName = "Lee" Age = 29 } # 将对象序列化为 JSON 字符串 $jsonString = $person | ConvertTo-Json # 打印 JSON 字符串 Write-Host "JSON 字符串：" Write-Host $jsonString
运行输出的结果为：
JSON 字符串： { "Age": 29, "FirstName": "Jack", "LastName": "Lee" }
在上面的示例中，我们首先创建了一个示例对象 $person，然后使用 ConvertTo-Json 将其转换为 JSON 字符串。你可以使用这个字符串将对象保存到文件或传递给其他地方。
3. 反序列化：从字符串还原对象
要从字符串中还原对象，你可以使用 ConvertFrom-Json cmdlet。以下是一个示例，演示如何从 JSON 字符串中还原对象：
# JSON 字符串 $jsonString = '{ "FirstName": "Jack", "LastName": "Lee", "Age": 28 }' # 从 JSON 字符串中还原对象 $person = $jsonString | ConvertFrom-Json # 打印还原后的对象 Write-Host "还原后的对象：" Write-Host "FirstName: $($person.FirstName)" Write-Host "LastName: $($person.LastName)" Write-Host "Age: $($person.Age)"
运行输出的结果为：
还原后的对象： FirstName: Jack LastName: Lee Age: 28
在上面的示例中，我们首先有一个 JSON 字符串 $jsonString，然后使用 ConvertFrom-Json 将其还原为对象。还原后的对象可以像普通对象一样访问其属性。
注意：对象的属性和结构必须与原始对象的 JSON 表示一致，否则反序列化可能会失败。
通过序列化和反序列化，可以在 PowerShell 中轻松地将对象保存、传输和恢复，这对于许多应用场景都非常有用。无论是与文件系统、网络通信还是数据库交互，对象的序列化和反序列化都是强大的工具。
附录：命令与选项参数解析
F.1 ConvertTo-Json命令
用于将对象转换为 JSON 格式的字符串。它允许你将 PowerShell 对象序列化为 JSON 格式，以便于存储、传输和与其他系统进行数据交互。该命令的格式为：
ConvertTo-Json [-InputObject] <PSObject> [-Depth <int>] [-Compress] [-EscapeHandling <String>] [-Pretty] [<CommonParameters>]
其中：
-InputObject: 这是必需的参数，指定要转换为 JSON 的 PowerShell 对象。可以是标量值、数组、哈希表、自定义对象等。
-Depth: 用于指定 JSON 对象的嵌套深度。默认情况下，深度为 2，这意味着最多转换两层嵌套的对象。如果你的对象有更多层嵌套，你可以通过指定更大的深度来处理。但要注意，设置深度太大可能导致生成的 JSON 数据非常复杂。
-Compress: 如果指定了这个选项，生成的 JSON 字符串将不包含额外的空格和缩进，使其更紧凑。这对于减小 JSON 数据的大小非常有用。
-EscapeHandling: 用于指定在生成 JSON 字符串时如何处理转义字符。可选的值包括：
Default：使用默认的转义处理方式。EscapeHtml：转义 HTML 字符。EscapeNonAscii：转义非 ASCII 字符。
# 定义一个复杂的 PowerShell 哈希表对象 $complexObject = @{ Name = "Jack" Info = @{ Age = 29 Address = @{ Street = "Xuefu Road, Nanshan District" City = "Shenzhen" } } } # 将对象转换为 JSON 字符串，设置深度为 4 $jsonString = $complexObject | ConvertTo-Json -Depth 4 # 打印 JSON 字符串到控制台 Write-Host "生成的 JSON 字符串内容：" Write-Host $jsonString
运行结果为：
生成的 JSON 字符串内容： { "Name": "Jack", "Info": { "Age": 29, "Address": { "City": "Shenzhen", "Street": "Xuefu Road, Nanshan District" } } }
F.2 ConvertFrom-Json命令
ConvertFrom-Json用于将JSON格式的字符串转换为自定义对象或哈希表。JSON是一种常用于网站的数据交换格式，该命令可以帮助你将这些JSON格式的数据转换成PowerShell中易于操作的对象。
该命令的语法格式为：
ConvertFrom-Json [-InputObject] <String> [-AsHashtable] [-Depth <Int32>] [-NoEnumerate] [<CommonParameters>]
其中：
-InputObject: 指定要转换为JSON对象的JSON字符串。-AsHashtable: 将JSON转换为哈希表对象。从PowerShell 7.3开始，这个对象是OrderedHashtable，并保留了JSON中键的顺序。-Depth: 设置允许JSON输入的最大深度，默认为1024。-NoEnumerate: 指定不要枚举输出，用于确保可以通过ConvertTo-Json进行JSON往返。
ConvertFrom-Json cmdlet将JSON格式的字符串转换为自定义的PSObject或哈希表对象，其中每个字段在JSON字符串中都对应一个属性。JSON常常用于网站上以文本形式表示对象的数据。该cmdlet在处理JSON字符串的每一行时，会将属性添加到新对象中。
JSON标准允许具有重复的键名，但在PSObject和Hashtable类型中是不允许的。例如，如果JSON字符串包含重复的键，该cmdlet只会使用最后一个键。请参见下面的其他示例。
要从任何对象生成JSON字符串，请使用ConvertTo-Json cmdlet。
示例
示例 1：将DateTime对象转换为JSON对象
以下命令使用ConvertTo-Json和ConvertFrom-Json cmdlet将从Get-Date cmdlet获取的DateTime对象转换为JSON对象，然后再转换为PSCustomObject。
Get-Date | Select-Object -Property * | ConvertTo-Json | ConvertFrom-Json
这个示例使用Select-Object cmdlet获取DateTime对象的所有属性。它使用ConvertTo-Json cmdlet将DateTime对象转换为JSON格式的字符串，然后使用ConvertFrom-Json cmdlet将JSON格式的字符串转换为PSCustomObject对象。
示例 2：从Web服务获取JSON字符串并转换为PowerShell对象
以下命令使用Invoke-WebRequest cmdlet从Web服务获取JSON字符串，然后使用ConvertFrom-Json cmdlet将JSON内容转换为可以在PowerShell中管理的对象。
# 确保Invoke-WebRequest使用TLS 1.2 [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 $j = Invoke-WebRequest 'https://api.github.com/repos/PowerShell/PowerShell/issues' | ConvertFrom-Json
你也可以使用Invoke-RestMethod cmdlet，它会自动将JSON内容转换为对象。
示例 3：将JSON字符串转换为自定义对象
这个示例展示了如何使用ConvertFrom-Json cmdlet将JSON文件转换为PowerShell自定义对象。
Get-Content -Raw JsonFile.JSON | ConvertFrom-Json
这个命令使用Get-Content cmdlet获取JSON文件中的字符串。使用-Raw参数返回整个文件作为单个JSON对象，然后使用管道运算符将分隔的字符串发送到ConvertFrom-Json cmdlet，将其转换为自定义对象。
示例 4：将JSON字符串转换为哈希表
这个示例展示了使用-AsHashtable开关来克服ConvertFrom-Json命令的一些限制的示例。
'{ "key":"value1", "Key":"value2" }' | ConvertFrom-Json -AsHashtable
JSON字符串包含两个键值对，键只有大小写不同。没有开关的话，该命令将会报错。
示例 5：往返一个包含单个元素数组的JSON字符串
这个示例展示了如何使用-NoEnumerate开关来往返一个包含单个元素的JSON数组。
Write-Output "With -NoEnumerate: $('[1]' | ConvertFrom-Json -NoEnumerate | ConvertTo-Json -Compress)" Write-Output "Without -NoEnumerate: $('[1]' | ConvertFrom-Json | ConvertTo-Json -Compress)"
JSON字符串包含一个包含单个元素的数组。没有开关，将JSON转换为PSObject，然后再使用ConvertTo-Json命令转换回来会得到一个单个整数。
参数
-AsHashtable: 将JSON转换为哈希表对象。-Depth: 允许JSON输入的最大深度。-InputObject: 要转换为JSON对象的JSON字符串。-NoEnumerate: 指定输出不要枚举。
输入和输出
- 输入：JSON字符串。
- 输出：PSCustomObject（自定义对象）或OrderedHashtable（有序哈希表）。
注意
- 该cmdlet使用Newtonsoft Json.NET实现。
- 从PowerShell 6开始，
ConvertTo-Json会尝试将格式为时间戳的字符串转换为DateTime值。- PSObject类型会保持属性的顺序与JSON字符串中的顺序相同。从PowerShell 7.3开始，
AsHashtable参数会创建一个OrderedHashtable，键值对按JSON字符串中的顺序添加，有序哈希表会保持这个顺序。
