about_Script_Internationalization
简短说明
介绍脚本国际化功能,使脚本可以轻松地在用户界面中向用户显示消息和说明 (UI) 语言。
长说明
借助 PowerShell 脚本国际化功能,可以使用用户语言显示帮助和用户消息,从而更好地为世界各地的用户提供服务。
脚本国际化功能在执行期间查询操作系统的 UI 区域性,导入相应的翻译文本字符串,并将其显示给用户。 使用“数据”部分,可以将文本字符串与代码分开存储,以便轻松识别和提取它们。 新的 cmdlet ConvertFrom-StringData
将文本字符串转换为类似于字典的哈希表,以便于转换。
为了支持国际帮助文本,PowerShell 包含以下功能:
一个“数据”部分,用于将文本字符串与代码说明分开。 有关“数据”部分的详细信息,请参阅 about_Data_Sections。
新的自动变量
$PSCulture
和$PSUICulture
。$PSCulture
存储系统上用于日期、时间和货币等元素的 UI 语言的名称。 变量$PSUICulture
存储系统上用于用户界面元素(如菜单和文本字符串)的 UI 语言的名称。一个 cmdlet,
ConvertFrom-StringData
用于将文本字符串转换为类似字典的哈希表,以便于转换。 有关详细信息,请参阅 ConvertFrom-StringData。存储已翻译文本字符串的新文件类型
.psd1
。 这些文件.psd1
存储在脚本目录的语言特定子目录中。一个 cmdlet,
Import-LocalizedData
用于在运行时将指定语言的已翻译文本字符串导入脚本。 此 cmdlet 识别并导入任何 Windows 支持的语言的字符串。 有关详细信息,请参阅 Import-LocalizedData。
数据部分:存储默认字符串
使用脚本中的“数据”部分以默认语言存储文本字符串。 将字符串排列为 here-string 中的键/值对。 每个键/值对必须位于单独的行上。 如果包含批注,则批注必须位于单独的行上。
cmdlet ConvertFrom-StringData
将 here-string 中的键/值对转换为类似于字典的哈希表,该哈希表存储在 Data 节变量的值中。
在以下示例中,脚本的 World.ps1
“数据”部分包含 English-United 状态 (en-US) 脚本的提示消息集。 cmdlet ConvertFrom-StringData
将字符串转换为哈希表,并将其存储在 变量中 $msgtable
。
$msgTable = Data {
#culture="en-US"
ConvertFrom-StringData @'
helloWorld = Hello, World.
errorMsg1 = You cannot leave the user name field blank.
promptMsg = Please enter your user name.
'@
}
有关 here-strings 的详细信息,请参阅 about_Quoting_Rules。
PSD1 文件:存储已翻译的字符串
将每种 UI 语言的脚本消息保存在与脚本和文件扩展名相同的单独文本文件中 .psd1
。 将文件存储在具有区域性名称的脚本目录的子目录中,格式如下:
<language>-<region>
示例:de-DE、ar-SA 和 zh-Hans
例如,如果 World.ps1
脚本存储在 C:\Scripts
目录中,则会创建类似于以下内容的文件目录结构:
C:\Scripts
C:\Scripts\World.ps1
C:\Scripts\de-DE\World.psd1
C:\Scripts\ar-SA\World.psd1
C:\Scripts\zh-CN\World.psd1
...
World.psd1
脚本目录的 de-DE 子目录中的文件可能包含以下语句:
ConvertFrom-StringData -StringData @'
helloWorld = Hallo, Welt.
errorMsg1 = Das Feld Benutzername darf nicht leer sein.
promptMsg = Geben Sie Ihren Benutzernamen ein.
'@
同样, World.psd1
脚本目录的 ar-SA 子目录中的文件可能包含以下语句:
ConvertFrom-StringData -StringData @'
helloWorld = مرحبًا أيها العالَم
errorMsg1 = لا يمكنك ترك حقل اسم المستخدم فارغًا
promptMsg = يرجى إدخال اسم المستخدم الخاص بك
'@
Import-LocalizedData:已翻译字符串的动态检索
若要检索当前用户的 UI 语言的字符串,请使用 Import-LocalizedData
cmdlet。
Import-LocalizedData
查找自动变量的值$PSUICulture
,并在与值匹配$PSUICulture
的子目录中导入文件的内容<script-name>.psd1
。 然后,它将导入的内容保存在 由 BindingVariable 参数的值指定的变量中。
Import-LocalizedData -BindingVariable msgTable
例如,如果 Import-LocalizedData
命令出现在脚本中 C:\Scripts\World.ps1
,并且 的 $PSUICulture
值为“ar-SA”, Import-LocalizedData
则会查找以下文件:
C:\Scripts\ar-SA\World.psd1
然后,它将文件中的阿拉伯语文本字符串导入变量 $msgTable
,替换可能在脚本的“数据”部分中 World.ps1
定义的任何默认字符串。
因此,当脚本使用 $msgTable
变量显示用户消息时,消息以阿拉伯语显示。
例如,以下脚本以阿拉伯语显示“请输入用户名”消息:
if (!($username)) { $msgTable.promptMsg }
如果 Import-LocalizedData
找不到 .psd1
与 的值 $PSUIculture
匹配的文件,则不会替换 的值 $msgTable
,并且对 $msgTable.promptMsg
的调用将显示回退 en-US 字符串。
示例
此示例演示如何在脚本中使用脚本国际化功能,以在计算机上设置的语言向用户显示一周中的某一天。
下面是 Sample1.ps1 脚本文件的完整列表。
该脚本以名为 Day ($Day) 的数据部分开头,其中包含一个 ConvertFrom-StringData
命令。 提交到 ConvertFrom-StringData
的表达式是一个 here-string,其中包含默认 UI 区域性(en-US)中键/值对中的日期名称。 cmdlet ConvertFrom-StringData
将 here-string 中的键/值对转换为哈希表,然后将其保存在变量的值 $Day
中。
命令Import-LocalizedData
在目录中导入与自动变量的值$PSUICulture
匹配的文件内容.psd1
,然后将其保存在 变量中$Day
,替换 Data 节中定义的 值$Day
。
其余命令将字符串加载到数组中并显示它们。
$Day = Data {
#culture="en-US"
ConvertFrom-StringData -StringData @'
messageDate = Today is
d0 = Sunday
d1 = Monday
d2 = Tuesday
d3 = Wednesday
d4 = Thursday
d5 = Friday
d6 = Saturday
'@
}
Import-LocalizedData -BindingVariable Day
#Build an array of weekdays.
$a = $Day.d0, $Day.d1, $Day.d2, $Day.d3, $Day.d4, $Day.d5, $Day.d6
# Get the day of the week as a number (Monday = 1).
# Index into $a to get the name of the day.
# Use string formatting to build a sentence.
"{0} {1}" -f $Day.messageDate, $a[(Get-Date -UFormat %u)] | Out-Host
.psd1
支持脚本的文件保存在脚本目录的子目录中,名称与值匹配$PSUICulture
。
下面是 的完整列表 .\de-DE\sample1.psd1
:
# culture="de-DE"
ConvertFrom-StringData @'
messageDate = Heute ist
d0 = Sonntag
d1 = Montag
d2 = Dienstag
d3 = Mittwoch
d4 = Donnerstag
d5 = Freitag
d6 = Samstag
'@
因此,在值为 $PSUICulture
de-DE 的系统上运行 Sample.ps1 时,脚本的输出为:
Heute ist Freitag