命令行与文本处理 / 系统课时

定义脚本参数

定义脚本参数

本课通过一个完整脚本定义位置参数、命名参数、默认值、开关参数和必填参数,并验证 PowerShell 的绑定与类型转换行为。完成后,你可以让脚本入口更清晰,同时在处理逻辑运行前拦截缺失值和非法值。

学习目标

  • 定义常用脚本参数及其默认行为
  • 区分位置绑定、名称绑定和开关参数
  • 使用验证属性提前拒绝无效输入

参数区的基本规则

脚本参数使用 param() 声明,并应位于脚本的第一段可执行内容。参数名就是调用接口,类型约束负责转换输入,属性负责描述是否必填、位置和合法范围。

[CmdletBinding()] 会让脚本具备高级函数式的参数行为,包括公共参数、详细输出和更完整的绑定错误。面向重复使用或自动化调用的脚本,通常应启用它。

完整参数示例

下面的脚本把 Name 定义为第一个必填位置参数,把 Count 定义为带默认值的第二个位置参数。UpperCase 是开关参数,只要调用时出现就表示启用。

powershell
[CmdletBinding()]
param(
    [Parameter(Mandatory, Position = 0)]
    [ValidateNotNullOrEmpty()]
    [string]$Name,

    [Parameter(Position = 1)]
    [ValidateRange(1, 100)]
    [int]$Count = 1,

    [switch]$UpperCase,

    [ValidateNotNullOrEmpty()]
    [string]$Prefix = 'Hello'
)

$message = "$Prefix, $Name"

if ($UpperCase) {
    $message = $message.ToUpperInvariant()
}

1..$Count | ForEach-Object {
    '{0}: {1}' -f $_, $message
}

将脚本保存为 Show-Greeting.ps1,然后同时使用位置参数和命名参数调用:

powershell
.\Show-Greeting.ps1 Alice 2 -UpperCase -Prefix Hi

预期输出:

text
1: HI, ALICE
2: HI, ALICE

这里 Alice 绑定到位置 0 的 Name,2 绑定到位置 1 的 Count,其余参数按名称绑定。若省略 Count,脚本会使用默认值 1。

参数类型与绑定行为

PowerShell 通常先按显式参数名绑定,再处理位置参数,随后尝试类型转换与验证。调用 -Count '2' 时,字符串可以转换成整数;调用 -Count abc 或 -Count 0 时,参数绑定阶段就会失败,脚本主体不会执行。

参数形式 定义方式 调用示例 关键行为
必填参数 Mandatory -Name Alice 缺失时交互提示或直接失败
位置参数 Position = 0 Alice 依赖参数顺序,简短但可读性较低
默认值 $Count = 1 省略 -Count 未绑定时采用默认值
开关参数 [switch] -UpperCase 出现为真,省略为假
命名参数 参数名调用 -Prefix Hi 顺序不重要,可读性更高

自动化任务不应依赖必填参数的交互提示,因为无人值守环境可能一直等待输入。调用方应显式传入必填参数,并把绑定错误记录为失败结果。

判断参数是否由调用者提供

默认值只能告诉你最终取值,不能说明调用者是否显式传参。需要区分“未传入”和“明确传入默认值”时,可以查询自动变量 $PSBoundParameters。

例如,$PSBoundParameters.ContainsKey('Count') 为真,表示调用者确实提供了 Count;为假则表示脚本使用了默认值。这种判断适合决定是否覆盖配置文件中的现有值。

设计参数接口的边界

对外脚本优先使用清晰的命名参数,只有最常用且顺序稳定的少量参数才设置位置。位置参数过多会让调用难以审查,也容易在新增参数后产生兼容问题。

验证属性应尽量靠近参数声明,例如用 [ValidateSet()] 限制枚举、用 [ValidateRange()] 限制数值。验证只能检查输入形式,涉及文件权限、远程状态或跨参数关系时,仍需在初始化区编写明确检查。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

定义脚本参数

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通