about_Scopes

简短说明

介绍 PowerShell 中的范围概念，并演示如何设置和更改元素的范围。

长说明

PowerShell 通过限制可读取和更改变量、别名、函数和 PowerShell 驱动器 (PSDrives) 访问。 PowerShell 使用范围规则来确保不会对其他范围内的项进行意外更改。

范围规则

启动 PowerShell 时，主机 (pwsh.exe) 创建 PowerShell 运行空间。 主机进程可以有多个运行空间。 每个运行空间都有自己的会话状态和作用域容器。 不能跨 runspace 实例访问会话状态和范围。

以下是范围的基本规则：

• 范围可以嵌套。 外部范围称为父范围。 任何嵌套范围都是该父级的子范围。
• 项在创建它的范围和任何子作用域中可见，除非显式将其设为私有项。
• 可以为当前范围以外的范围声明变量、别名、函数和 PowerShell 驱动器。
• 除非显式指定其他范围，否则只能在创建其范围内更改在范围内创建的项。
• 当运行空间中运行的代码引用项时，PowerShell 会从当前范围开始搜索范围层次结构，然后逐个执行每个父范围。 如果找不到该项，则会在当前范围内创建新项。 如果找到匹配项，则会从找到 的作用域中检索项的值。 如果更改值，则会将项复制到当前范围，以便更改仅影响当前范围。
• 如果显式创建一个与其他范围内的项共享其名称的项，则原始项可能被新项隐藏，但不会被重写或更改。

父级和子范围

可以通过调用脚本或函数创建新的子范围。 调用范围是父范围。 调用的脚本或函数是子范围。 调用的函数或脚本可以调用其他函数，从而创建其根范围是全局范围的子范围的层次结构。

注意

模块中的函数不在调用范围的子作用域中运行。 模块具有自己的会话状态，该状态链接到导入模块的范围。 所有模块代码在具有其自己的根作用域的特定于模块的层次结构中运行。 有关详细信息，请参阅本文的 模块 部分。

创建子范围时，它包括具有 AllScope 选项的所有别名和变量，以及一些自动变量。 本文稍后将讨论此选项。

除非显式将项设为私有项，否则父范围中的项可供子范围使用。 在子作用域中创建或更改的项不会影响父范围，除非在创建项时显式指定范围。

若要查找特定范围内的项，请使用 或 Get-Alias的 Get-Variable Scope 参数。

例如，若要获取本地范围中的所有变量，请键入：

Get-Variable -Scope local

若要获取全局范围中的所有变量，请键入：

Get-Variable -Scope global

引用变量、别名或函数时，PowerShell 将搜索当前范围。 如果未找到该项，则搜索父范围。 此搜索一直重复到全局范围。 如果变量在父范围中是私有的，则通过范围链继续搜索。 示例 4 显示了范围搜索中私有变量的效果。

PowerShell 范围名称

PowerShell 为某些范围定义名称，以便更轻松地访问该范围。 PowerShell 定义以下命名范围：

• 全局：在 PowerShell 启动时或创建新会话或运行空间时生效的范围。 PowerShell 启动时存在的变量和函数（如自动变量和首选项变量）在全局范围内创建。 PowerShell 配置文件中的变量、别名和函数也在全局范围内创建。 全局范围是 runspace 中的根父范围。
• 本地：当前范围。 本地范围可以是全局范围或任何其他范围。
• 脚本：脚本文件运行时创建的范围。 脚本中的命令在脚本范围内运行。 对于脚本中的命令，脚本范围是本地范围。

对于支持范围的 cmdlet，范围可以通过描述一个范围到另一个范围的相对位置的数字来引用范围。 作用域 0 表示当前 (本地) 范围，范围 1 是当前范围的父级，范围 2 是当前范围的祖父级。 此模式一直持续到到达根范围。

范围修饰符

变量、别名或函数名称可以包含以下任一可选范围修饰符：

• global: - 指定名称存在于 全局 范围中。

• local: - 指定名称存在于 “本地 ”作用域中。 当前范围始终为 本地 范围。

• private: - 指定名称为 Private ，并且仅对当前范围可见。

  注意

  private: 不是范围。 这是一 个选项 ，用于更改定义项的范围之外的项的辅助功能。

• script: - 指定名称存在于 脚本 范围中。 脚本 范围是最近的上级脚本文件的范围，如果没有最近的上级脚本文件，则为 全局 。

• using:- 用于通过 和 Invoke-Command等 Start-Job cmdlet 运行脚本时访问另一个范围中定义的变量。

• workflow: - 指定名称存在于工作流中。 注意：PowerShell v6 及更高版本不支持工作流。

• <variable-namespace> - 由 PowerShell PSDrive 提供程序创建的修饰符。 例如：

  命名空间	说明
  Alias:	在当前范围内定义的别名
  Env:	在当前范围内定义的环境变量
  Function:	在当前范围内定义的函数
  Variable:	在当前范围内定义的变量

脚本的默认作用域是脚本范围。 函数和别名的默认作用域是本地范围，即使它们是在脚本中定义的。

使用范围修饰符

若要指定新变量、别名或函数的范围，请使用范围修饰符。

变量中范围修饰符的语法为：

$[<scope-modifier>:]<name> = <value>

函数中范围修饰符的语法为：

function [<scope-modifier>:]<name> {<function-body>}

以下命令不使用范围修饰符，在当前或 本地 范围内创建变量：

$a = "one"

若要在 全局 范围内创建相同的变量，请使用范围 global: 修饰符：

$global:a = "one"
Get-Variable a | Format-List *

请注意 Visibility 和 Options 属性值。

Name        : a
Description :
Value       : one
Visibility  : Public
Module      :
ModuleName  :
Options     : None
Attributes  : {}

将这与私有变量进行比较：

$private:pVar = 'Private variable'
Get-Variable pVar | Format-List *

private使用范围修饰符将 Options 属性设置为 Private。

Name        : pVar
Description :
Value       : Private variable
Visibility  : Public
Module      :
ModuleName  :
Options     : Private
Attributes  : {}

若要在 脚本 范围内创建同一变量，请使用 script: 范围修饰符：

$script:a = "one"

还可以将范围修饰符与函数配合使用。 以下函数定义在 全局 范围内创建函数：

function global:Hello {
  Write-Host "Hello, World"
}

还可以使用范围修饰符来引用不同作用域中的变量。 以下命令引用 $test 变量，首先在本地范围，然后在全局作用域中：

$test
$global:test

using: 作用域修饰符

使用 是一种特殊的范围修饰符，用于标识远程命令中的局部变量。 如果没有修饰符，PowerShell 需要在远程会话中定义远程命令中的变量。

范围 using 修饰符在 PowerShell 3.0 中引入。

对于在会话外执行的任何脚本或命令，需要 using 作用域修饰符来嵌入调用会话范围内的变量值，以便会话外代码可以访问它们。 以下 using 上下文支持范围修饰符：

• 远程执行的命令，以 Invoke-Command 使用 ComputerName、 HostName、 SSHConnection 或 Session 参数 (远程会话)
• 后台作业，从 Start-Job (进程外会话)
• 线程作业，通过 Start-ThreadJob 或 ForEach-Object -Parallel (单独的线程会话) 启动

根据上下文，嵌入的变量值可以是调用方范围内数据的独立副本或对其的引用。 在远程会话和进程外会话中，它们始终是独立的副本。

有关详细信息，请参阅 about_Remote_Variables。

在线程会话中，它们通过引用传递。 这意味着可以在不同的线程中修改子范围变量。 若要安全地修改变量，需要线程同步。

有关详细信息，请参阅：

• Start-ThreadJob
• ForEach-Object

变量值的序列化

远程执行的命令和后台作业在进程外运行。 进程外会话使用基于 XML 的序列化和反序列化使变量的值跨进程边界可用。 序列化过程将对象转换为包含原始对象属性但不包含其方法的 PSObject 。

对于一组有限的类型，反序列化会将对象解除冻结回原始类型。 解除冻结的对象是原始对象实例的副本。 它具有类型属性和方法。 对于简单类型（如 System.Version），复制是精确的。 对于复杂类型，副本不完善。 例如，解除冻结的证书对象不包括私钥。

所有其他类型的实例都是 PSObject 实例。 PSTypeNames 属性包含以反序列化为前缀的原始类型名称，例如 Deserialized.System.Data.DataTable

AllScope 选项

变量和别名具有 Option 属性，该属性可以采用 AllScope 的值。 具有 AllScope 属性的项将成为你创建的任何子作用域的一部分，尽管父范围不会追溯继承它们。

具有 AllScope 属性的项在子范围中可见，并且它是该范围的一部分。 更改任何范围中的项会影响定义变量的所有范围。

管理范围

多个 cmdlet 具有 Scope 参数，可用于获取或设置 (在特定范围内创建和更改) 项。 使用以下命令查找会话中具有 Scope 参数的所有 cmdlet：

Get-Help * -Parameter scope

若要查找在特定范围内可见的变量，请使用 Scope 的 Get-Variable参数。 可见变量包括全局变量、父范围中的变量和当前作用域中的变量。

例如，以下命令获取在本地范围内可见的变量：

Get-Variable -Scope local

若要在特定范围内创建变量，请使用 范围修饰符或 的 Set-VariableScope 参数。 以下命令在全局范围内创建变量：

New-Variable -Scope global -Name a -Value "One"

还可以使用 、 Set-Alias或 Get-Alias cmdlet 的 New-AliasScope 参数来指定范围。 以下命令在全局范围内创建别名：

New-Alias -Scope global -Name np -Value Notepad.exe

若要获取特定范围内的函数， Get-Item 请在作用域中使用 cmdlet。 cmdlet Get-Item 没有 Scope 参数。

注意

对于使用 Scope 参数的 cmdlet，还可以按数字引用范围。 数字描述一个范围与另一个范围的相对位置。 范围 0 表示当前或本地范围。 范围 1 指示直接父范围。 范围 2 指示父范围的父级，依此而过。 如果已创建许多递归作用域，则编号范围非常有用。

对范围使用点源表示法

脚本和函数遵循范围规则。 在特定范围内创建它们，并且它们仅影响该范围，除非使用 cmdlet 参数或范围修饰符来更改该范围。

但是，可以使用点源表示法将脚本或函数的内容添加到当前范围。 使用点源表示法运行脚本或函数时，它会在当前范围内运行。 脚本或函数中的任何函数、别名和变量都添加到当前范围。

例如，若要从C:\Scripts脚本范围中的目录运行Sample.ps1脚本， (脚本) 的默认值，只需在命令行上输入脚本文件的完整路径即可。

c:\scripts\sample.ps1

脚本文件必须具有 .ps1 可执行的文件扩展名。 路径中包含空格的文件必须用引号引起来。 如果尝试执行带引号的路径，PowerShell 将显示带引号的字符串的内容，而不是运行脚本。 调用运算符 (&) 允许您执行包含文件名的字符串的内容。

使用调用运算符运行函数或脚本在脚本范围内运行它。 使用调用运算符与按名称运行脚本没有什么不同。

& c:\scripts\sample.ps1

可以在 about_Operators 中详细了解呼叫运算符。

若要在本地作用域中运行 Sample.ps1 脚本，请在脚本路径之前键入点和空格 (. ) ：

. c:\scripts\sample.ps1

现在，脚本中定义的任何函数、别名或变量都添加到当前范围。

无作用域限制

PowerShell 具有一些类似于范围且可能与作用域交互的选项和功能。 这些功能可能与范围或范围的行为混淆。

会话、模块和嵌套提示是自包含环境，而不是会话中全局范围的子范围。

会话

会话是运行 PowerShell 的环境。 在远程计算机上创建会话时，PowerShell 会与远程计算机建立持久连接。 通过持久连接，可以将会话用于多个相关命令。

由于会话是包含的环境，因此它有自己的范围，但会话不是创建它的会话的子范围。 会话从其自己的全局范围开始。 此范围独立于会话的全局范围。 可以在会话中创建子范围。 例如，可以运行脚本在会话中创建子范围。

模块

可以使用 PowerShell 模块来共享和交付 PowerShell 工具。 模块是可以包含 cmdlet、脚本、函数、变量、别名和其他有用项的单元。 除非使用 Export-ModuleMember 或模块清单) 显式导出 (，否则模块中的项无法在模块外部访问。 因此，可以将模块添加到会话并使用公共项，而不必担心其他项可能会替代会话中的 cmdlet、脚本、函数和其他项。

默认情况下，模块将加载到运行空间的根级别 (全局) 范围。 导入模块不会更改范围。 在会话中，模块具有其自己的范围。 请考虑以下模块 C:\temp\mod1.psm1：

$a = "Hello"

function foo {
    "`$a = $a"
    "`$global:a = $global:a"
}

现在，我们创建一个全局变量 $a，为其指定一个值并调用函数 foo。

$a = "Goodbye"
foo

模块在模块范围内声明变量 $a ，然后函数 foo 输出两个作用域中变量的值。

$a = Hello
$global:a = Goodbye

模块创建链接到导入它们的范围的并行范围容器。 模块导出的项从导入范围级别开始可用。 未从模块导出的项仅在模块的范围容器中可用。 模块中的函数可以访问导入范围中的项以及模块范围容器中的项。

如果从 Module1中加载 Module2，则 Module2 将加载到 Module1 的范围容器中。 来自 Module2 的任何导出都放置在 Module1 的当前模块范围内。 如果使用 Import-Module -Scope local，则导出将置于当前范围对象中，而不是放在顶层。 如果在某个模块中使用 (或 Import-Module -Global) 加载另一个模块Import-Module -Scope global，则会将该模块及其导出加载到全局范围，而不是模块的本地作用域。 Windows 兼容性功能执行此操作以将代理模块导入全局会话状态。

嵌套提示

嵌套提示没有自己的范围。 输入嵌套提示时，嵌套提示是环境的子集。 但是，你仍在本地范围内。

脚本确实有其自己的范围。 如果要调试脚本，并且到达脚本中的断点，则输入脚本范围。

专用选项

别名和变量具有一个 Option 属性，该属性可以采用 值 Private。 可以在创建项的作用域中查看和更改具有 Private 选项的项，但不能在该范围之外查看或更改这些项。

例如，如果创建一个在全局范围内具有私有选项的变量，然后运行脚本， Get-Variable 则脚本中的命令不会显示私有变量。 在此实例中使用全局范围修饰符不会显示私有变量。

可以使用 、Set-Variable、 New-Alias和 Set-Alias cmdlet 的 New-VariableOption 参数将 Option 属性的值设置为 Private。

可见性

变量或别名的 Visibility 属性确定是否可以看到创建它的容器外部的项。 容器可以是模块、脚本或管理单元。 可见性是为容器设计的，其方式与 Option 属性的值针对范围设计的方式Private相同。

Visibility 属性采用 Public 和 Private 值。 只能在创建项的容器中查看和更改具有专用可见性的项。 如果添加或导入容器，则无法查看或更改具有专用可见性的项。

因为可见性是为容器设计的，所以它在一个范围内的工作方式不同。

• 如果创建的项在全局范围内具有专用可见性，则不能在任何范围内查看或更改该项。
• 如果尝试查看或更改具有专用可见性的变量的值，PowerShell 将返回错误消息。

可以使用 New-Variable 和 Set-Variable cmdlet 创建具有专用可见性的变量。

示例

示例 1：仅在脚本中更改变量值

以下命令更改脚本中变量的值 $ConfirmPreference 。 更改不会影响全局范围。

首先，若要在本地范围内显示变量的值 $ConfirmPreference ，请使用以下命令：

PS>  $ConfirmPreference
High

Create包含以下命令的 Scope.ps1 脚本：

$ConfirmPreference = "Low"
"The value of `$ConfirmPreference is $ConfirmPreference."

运行该脚本。 该脚本更改变量的值， $ConfirmPreference 然后在脚本范围内报告其值。 输出应类似于以下输出：

The value of $ConfirmPreference is Low.

接下来，测试当前范围内变量的 $ConfirmPreference 当前值。

PS>  $ConfirmPreference
High

此示例表明，对脚本作用域中变量的值的更改不会影响父作用域中变量的值。

示例 2：查看不同范围内的变量值

可以使用范围修饰符查看本地作用域和父作用域中的变量的值。

首先，在全局范围内定义变量 $test 。

$test = "Global"

接下来，创建定义 Sample.ps1 变量的 $test 脚本。 在脚本中，使用范围修饰符引用变量的 $test 全局或本地版本。

在 Sample.ps1中：

$test = "Local"
"The local value of `$test is $test."
"The global value of `$test is $global:test."

运行 Sample.ps1时，输出应类似于以下输出：

The local value of $test is Local.
The global value of $test is Global.

脚本完成后，会话中仅定义 的 $test 全局值。

PS> $test
Global

示例 3：更改父范围中变量的值

除非使用 Private 选项或其他方法保护项，否则可以查看和更改父作用域中变量的值。

首先，在全局范围内定义变量 $test 。

$test = "Global"

接下来，创建定义 $test 变量的 Sample.ps1 脚本。 在脚本中，使用范围修饰符引用变量的 $test 全局或本地版本。

在 Sample.ps1：

$global:test = "Local"
"The global value of `$test is $global:test."

脚本完成后，将更改 的 $test 全局值。

PS> $test
Local

示例 4：创建私有变量

通过使用范围修饰符或创建将 Option 属性设置为 Private的变量，可以将变量设为私有private:。 只能在创建私有变量的作用域中查看或更改它们。

在此示例中， ScopeExample.ps1 脚本创建五个函数。 第一个函数调用下一个函数，该函数创建一个子范围。 其中一个函数具有只能在创建它的作用域中看到的私有变量。

PS> Get-Content ScopeExample.ps1
# Start of ScopeExample.ps1
function funcA {
    "Setting `$funcAVar1 to 'Value set in funcA'"
    $funcAVar1 = "Value set in funcA"
    funcB
}

function funcB {
    "In funcB before set -> '$funcAVar1'"
    $private:funcAVar1 = "Locally overwrite the value - child scopes can't see me!"
    "In funcB after set  -> '$funcAVar1'"
    funcC
}

function funcC {
    "In funcC before set -> '$funcAVar1' - should be the value set in funcA"
    $funcAVar1 = "Value set in funcC - Child scopes can see this change."
    "In funcC after set  -> '$funcAVar1'"
    funcD
}

function funcD {
    "In funcD before set -> '$funcAVar1' - should be the value from funcC."
    $funcAVar1 = "Value set in funcD"
    "In funcD after set  -> '$funcAVar1'"
    '-------------------'
    ShowScopes
}

function ShowScopes {
    $funcAVar1 = "Value set in ShowScopes"
    "Scope [0] (local)  `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 0 -ValueOnly)'"
    "Scope [1] (parent) `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 1 -ValueOnly)'"
    "Scope [2] (parent) `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 2 -ValueOnly)'"
    "Scope [3] (parent) `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 3 -ValueOnly)'"
    "Scope [4] (parent) `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 4 -ValueOnly)'"
}
funcA
# End of ScopeExample.ps1
PS> .\ScopeExample.ps1

输出显示每个作用域中变量的值。 可以看到，私有变量仅在 创建它的作用域中 funcB可见。

Setting $funcAVar1 to 'Value set in funcA'
In funcB before set -> 'Value set in funcA'
In funcB after set  -> 'Locally overwrite the value - child scopes can't see me!'
In funcC before set -> 'Value set in funcA' - should be the value set in funcA
In funcC after set  -> 'Value set in funcC - Child scopes can see this change.'
In funcD before set -> 'Value set in funcC - Child scopes can see this change.' - should be the value from funcC.
In funcD after set  -> 'Value set in funcD'
-------------------
Scope [0] (local)  $funcAVar1 = 'Value set in ShowScopes'
Scope [1] (parent) $funcAVar1 = 'Value set in funcD'
Scope [2] (parent) $funcAVar1 = 'Value set in funcC - Child scopes can see this change.'
Scope [3] (parent) $funcAVar1 = 'Locally overwrite the value - child scopes can't see me!'
Scope [4] (parent) $funcAVar1 = 'Value set in funcA'

如 的输出所示 ShowScopes，可以使用 和指定范围 Get-Variable 编号来访问来自其他范围的变量。

示例 5：在远程命令中使用局部变量

对于在本地会话中创建的远程命令中的变量，请使用 using 范围修饰符。 PowerShell 假定远程命令中的变量是在远程会话中创建的。

语法为：

$using:<VariableName>

例如，以下命令在本地会话中创建变量 $Cred ，然后在远程命令中使用 $Cred 变量：

$Cred = Get-Credential
Invoke-Command $s {Remove-Item .\Test*.ps1 -Credential $using:Cred}

PowerShell using 3.0 中引入了范围修饰符。

另请参阅

• about_Variables
• about_Environment_Variables
• about_Functions
• about_Script_Blocks
• Start-ThreadJob