Powershell 函数中的CmdletBinding()是怎么回事?

时间:2024-11-08 13:37:44

参考文章:

Don Jones https://technet.microsoft.com/en-us/library/ff677563.aspx

powershell 帮助文档:

help about_functions_advanced_parameters

help about_common_parameters

把这三部分内容都看完了,应该也大概了解函数中的CmdletBinding()是做什么用的了,官方的文档都是英文的,看起来一般会头大。以下就是我用通俗的语言来做的描述,更简单易懂一些。

这个功能的引入是从Powershell Version 2开始的,叫做函数的高级功能,在函数的声明出启用以后,可以调用我们所说的通用参数:

  • -Verbose

  • -Debug

  • -ErrorAction

  • -WarningAction

  • -ErrorVariable

  • -WarningVariable

  • -OutVariable

  • -OutBuffer

  • -PipeLineVariable

通过放在函数开始部分可以很简单的启用访问这些通用参数。如下所示:

[CmdletBinding()]

param()

启用这个高级属性以后,就可以很容易的通过像使用命令行一样,给函数添加一些命令行的特色,调用命令很的通用参数。以下是一个最简单的例子,打开一个ISE,把以下的内容复制下去:

function Go-Advanced {

[cmdletbinding()]param()

}

param() 这个关键字还是必须要有的,即使你没有在函数中定义任何参数;

尝试运行一下这个函数,然后再打一下中横线,怎么样,就看到能够调用的这些通用参数了吧。

Powershell 函数中的CmdletBinding()是怎么回事?

以下举几个例子来调用这些通用参数,先来说说Verbose的用法。

还是在ISE中输入以下代码

FunctionGo-Verbose{

[CmdletBinding()]Param()

Write-Verbose"Alright, you prefer talkative functions. First of all, I appreciate your wish to learn more about the common parameter -Verbose. Secondly, blah blah.."

Write-Host"This is self-explanatory, anyway."

}

再执行以下,看看是不是以下结果,通过这个例子,你就明白verbose是怎么出来的,这个单词是很难翻译的,只能是通过例子弄明白是什么意思。

Powershell 函数中的CmdletBinding()是怎么回事?

再举一个例子,就是调用ShouldContinue这个方法,这个在写程序时还是很重要的,比如你想做一些破坏性的操作,程序写的健壮是一定要跳一个框出来,问一下再去执行,那种SilientContinue做法不推荐。

以下还是代码:

Powershell 函数中的CmdletBinding()是怎么回事?

这段代码还是要在函数执行时加一个 -confirm参数的。如果想不加这个参数也要跳出这个框来,这样就需要一个额外的操作。把环境变量$ConfirmPreferece 设置成低。看以下代码和执行效果。

FunctionRemove-ByForce{

[CmdletBinding(SupportsShouldProcess)]

Param([String]$File)

$ConfirmPreference="Low"

If($PSCmdlet.ShouldContinue("Are you sure that you know what you are doing?","Delete with -Force parameter!")){

Remove-Item$File-Force

}Else{

"Mission aborted!"

}

}

Remove-ByForce test

Powershell 函数中的CmdletBinding()是怎么回事?

以上就是两个基本的例子,接下来的文章会讨论

param()中的[parameter()]对变量的影响。