about_Data_Sections

  • 项目

简短说明

解释了 Data 节，该节将文本字符串和其他只读数据与脚本逻辑相隔离。

长说明

专为 PowerShell 设计的脚本可以有一个或多个仅包含数据的 Data 节。 可以在任何脚本、函数或高级函数中包含一个或多个 Data 节。 Data 节的内容仅限于 PowerShell 脚本语言的指定子集。

将数据与代码逻辑分离可以更轻松地识别和管理逻辑和数据。 它允许你为文本（例如错误消息和帮助字符串）使用单独的字符串资源文件。 它还隔离了代码逻辑，这有利于安全和验证测试。

在 PowerShell 中，Data 节用于支持脚本国际化。 可以使用 Data 节更轻松地隔离、定位和处理将翻译成多种用户界面 (UI) 语言的字符串。

Data 节是 PowerShell 2.0 的一项功能。 在未经修改的情况下，包含 Data 节的脚本无法在 PowerShell 1.0 中运行。

语法

Data 节的语法如下：

DATA [<variable-name>] [-supportedCommand <cmdlet-name>] {
    <Permitted content>
}

Data 关键字是必需的。 此名称不区分大小写。 允许的内容仅限于以下元素：

  • 除 -match 之外的所有 PowerShell 运算符

  • If、Else 和 ElseIf 语句

  • 以下自动变量：$PsCulture、$PsUICulture、$True、$False 和 $Null

  • 注释

  • 管道

  • 用分号 (;) 分隔的语句

  • 文本，例如：

    a
1
1,2,3
"PowerShell 2.0"
@( "red", "green", "blue" )
@{ a = 0x1; b = "great"; c ="script" }
[XML] @'
<p> Hello, World </p>
'@

  • Data 节中允许的 Cmdlet。 默认情况下，仅允许使用 ConvertFrom-StringData cmdlet。

  • 你通过使用 -SupportedCommand 参数在 Data 节中允许的 Cmdlet。

在 Data 节中使用 ConvertFrom-StringData cmdlet 时，可以将键值对括在带有单引号或双引号的字符串中，或者括在带有单引号或双引号的 here-string 中。 但是，包含变量和子表达式的字符串必须括在带有单引号的字符串中，或括在带有单引号的 here-string 中，以使变量不会扩展且子表达式不可执行。

-SupportedCommand

可以使用 -SupportedCommand 参数指示 cmdlet 或函数仅生成数据。 它旨在允许用户将 cmdlet 和函数包含在他们编写或测试的 Data 节中。

-SupportedCommand 的值是包含一个或多个 cmdlet 或函数名称的逗号分隔列表。

例如，以下 Data 节包括用户编写的 cmdlet Format-Xml，它用于格式化 XML 文件中的数据：

DATA -supportedCommand Format-Xml
{
    Format-Xml -Strings string1, string2, string3
}

使用 Data 节

若要使用 Data 节的内容，请将其赋给某个变量并使用变量表示法来访问该内容。

例如，以下 Data 节包含一个 ConvertFrom-StringData 命令，该命令将 here-string 转换为哈希表。 哈希表将被赋给 $TextMsgs 变量。

$TextMsgs 变量不是 Data 节的一部分。

$TextMsgs = DATA {
    ConvertFrom-StringData -StringData @'
Text001 = Windows 7
Text002 = Windows Server 2008 R2
'@
}

若要访问 $TextMsgs 中哈希表内的键和值，请使用以下命令。

$TextMsgs.Text001
$TextMsgs.Text002

另外，还可以将变量名称放在 Data 节的定义中。 例如：

DATA TextMsgs {
    ConvertFrom-StringData -StringData @'
Text001 = Windows 7
Text002 = Windows Server 2008 R2
'@
}

$TextMsgs

结果与以上示例相同。

Name                           Value
----                           -----
Text001                        Windows 7
Text002                        Windows Server 2008 R2

示例

简单数据字符串。

DATA {
    "Thank you for using my PowerShell Organize.pst script."
    "It is provided free of charge to the community."
    "I appreciate your comments and feedback."
}

包含允许的变量的字符串。

DATA {
    if ($null) {
        "To get help for this cmdlet, type get-help new-dictionary."
    }
}

使用 ConvertFrom-StringData cmdlet 的带单引号的 here-string：

DATA {
    ConvertFrom-StringData -stringdata @'
Text001 = Windows 7
Text002 = Windows Server 2008 R2
'@
}

使用 ConvertFrom-StringData cmdlet 的带双引号的 here-string：

DATA  {
    ConvertFrom-StringData -stringdata @"
Msg1 = To start, press any key.
Msg2 = To exit, type "quit".
"@
}

一个 Data 节，其中包含用户编写的用于生成数据的 cmdlet：

DATA -supportedCommand Format-XML {
    Format-Xml -strings string1, string2, string3
}

另请参阅