ConvertTo-Json 结果意外？答案：默认-Depth为2

Question

为什么我会得到意外 结果，为什么我会获得 system.Collections.hashtable 和/或为什么往返往返（ $ json | convertfrom-json |）之类的值之类的值。 convertto-json ）失败？

Meta问题

Stackoverflow具有防止重复问题的良好机制，但据我所知，没有任何机制可以防止具有重复的问题原因。以这个问题为例：几乎每周都有一个新问题出现相同的原因，但是通常很难将其定义为重复，因为问题本身略有不同。 尽管如此，如果这个问题/回答本身最终以重复（或主题）的方式最终出现，但不幸的是，Stackoverflow没有可能写作”文章，以防止其他程序员继续写出这一“已知”陷阱引起的写作问题。

重复

一些类似问题的示例，具有相同的共同原因：

• powerShell convertto-json不会按预期转换数组 （昨天）
• powerShell convertto-json，带有嵌入式的shohted shoshtable
• ：//stackoverflow.com/questions/53287346/53287346/powershell-convertto-json-has-messed-json-format-json-format-xtup“> powerShell“ convertto-json”已经混乱了JSON格式输出
• nested Arrays and convertto-json
• powershell convertto-json缺失嵌套级别
• 如何使用powerShell？
• 不能在数组中正确转换为json
• 转换式 - json在3个级别上平坦的阵列
• 一次向PSObject添加一系列对象
• 为什么转换convertter-json drop values
• 如何将此json转移到psobject，然后返回powershell
• convertfrom-json的问题
• 与

众

… 它具有标题中的共同原因，并且由于同样的原因，它可能会更好地防止重复问题。

Answer 1

回答

ConvertTo-Json 有一个 -Depth 参数：

指定包含的对象的级别
JSON 表示。
默认值为2。

示例

要使用 JSON 文件进行完整往返，您需要增加 ConvertTo-Json cmdlet 的 -Depth：

$Json | ConvertFrom-Json | ConvertTo-Json -Depth 9

TL;DR

可能是因为 ConvertTo- Json 使用 (.Net) 完整类型名称终止比默认 -Depth (2) 更深的分支，程序员假设存在错误或 cmdlet 限制并且不要阅读帮助或关于。
就我个人而言，我认为字符串末尾有一个简单的 省略号 （三个点：...）切断分支，会有更清晰的含义（另请参阅：Github问题：8381）

为什么？

这个问题通常也会在另一个讨论中结束：为什么深度受到限制？

一些对象具有循环引用，这意味着子对象可以引用父对象（或其祖父母之一）如果将其序列化为 JSON，则会导致不定式循环。

以下面的哈希表为例，其 parent 属性引用对象本身：

$Test = @{Guid = New-Guid}
$Test.Parent = $Test

如果执行： $Test | ConvertTo-Json 默认情况下，它会方便地停止在深度级别 2：

{
    "Guid":  "a274d017-5188-4d91-b960-023c06159dcc",
    "Parent":  {
                   "Guid":  "a274d017-5188-4d91-b960-023c06159dcc",
                   "Parent":  {
                                  "Guid":  "a274d017-5188-4d91-b960-023c06159dcc",
                                  "Parent":  "System.Collections.Hashtable"
                              }
               }
}

这就是为什么自动将 -Depth 设置为很大的值并不是一个好主意。

Answer 2

更新： PowerShell 7.1在发生截断时引入了警告 。虽然这比早期版本中发生的安静截断要好，但下面建议的解决方案似乎对我来说更可取。

---

您有用的问题和答案清楚地说明了当前默认值 convert> convert> convertto-json >行为是。

至于行为的正当化：

而 -depth 对有意有意 截断输入对象树的输入对象树完整的深度，您不需要， -depth 默认 2 和悄悄截断输出量从毫无戒心的用户的观点 - 失败直到以后才能发现的序列化序列化安静的事实失败。

看似任意和安静的截断对于大多数用户来说都是令人惊讶的，并且必须在每个 convertto-json 调用中考虑它是不必要的负担。

我创建了 github问题＃8393 包含行为，特别是如下：：

• do 不是 深度限制的序列化[pscustomObject] 和 hashtable/dictionary 对象图本身（从概念上dtos（数据传输对象，“属性袋”）的潜在层次结构，例如从*-json rection返回的 convert*，具体）。

  


  
  相比之下，

  • 具有具有自动深度极限的任意（非主要）.NET类型 是有意义的，包括当它们在DTO对象图中遇到的叶子时，因为这种类型的实例可能是深度过度的对象图，甚至可能包含循环引用；例如， Get-ChildItem | convertto-json 可以用 -depth 值迅速失控，低如 4 。也就是说，通常不明智地使用JSON Serialization使用任意.NET类型：JSON是不是 设计为给定平台类型的通用序列化格式;相反，它专注于DTO，仅包含属性，有限的数据类型。

    。
    

  
  

  • 实际上，DTO和其他类型之间的这种区别在幕后 ，即在的序列化背景下 >和背景作业 。

• 使用 -depth 仅需要有意 在指定的深度处将输入对象树截断（或者主要是假设地，以便序列化到更深的层次比内部最大限制， 100 ）。

Answer 3

.. | convertto -json -depth 100 | ..

最新powershell中的最大深度为100（我的：7.3.4，从PowerShell Core重命名）。