在PowerShell中，如何在文件中定义函数并从PowerShell命令行调用它?

我有一个.ps1文件，我想在其中定义自定义函数。

假设文件名为MyFunctions。Ps1，内容如下:

Write-Host "Installing functions"
function A1
{
Write-Host "A1 is running!"
}
Write-Host "Done"

为了运行这个脚本并理论上注册A1函数，我导航到.ps1文件所在的文件夹并运行该文件:

.\MyFunctions.ps1

这个输出:

Installing functions
Done

然而，当我尝试调用A1时，我只是得到一个错误，说明没有该名称的命令/函数:

The term 'A1' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling
of the name, or if a path was included, verify that the path is correct and try again.
At line:1 char:3
+ A1 <<<<
+ CategoryInfo          : ObjectNotFound: (A1:String) [], CommandNotFoundException
+ FullyQualifiedErrorId : CommandNotFoundException

我一定误解了PowerShell的一些概念。我不能在脚本文件中定义函数吗?

请注意，我已经将我的执行策略设置为“remotessigned”。我知道运行。ps1文件时，在文件名前加一个点:.\myFile.ps1

308521 次浏览
小开
最佳答案

在PowerShell命令行上试试这个:

. .\MyFunctions.ps1
A1

点运算符用于脚本，包括“。-sourcing"(或点源表示法;)

小开

当然可以在脚本文件中定义函数(然后我倾向于在加载时通过Powershell配置文件加载它们)。

首先，你需要通过运行以下命令来确保函数已经加载:

ls function:\ | where { $_.Name -eq "A1"  }

并检查它是否出现在列表中(应该是一个1的列表!)，然后让我们知道您得到了什么输出!

小开

你正在谈论的东西叫做dot sourcing。这是邪恶的。但是不用担心，有一个更好更简单的方法来做你想要的modules(它听起来比它实际要可怕得多)。使用模块的主要好处是，如果需要，您可以从shell中卸载它们，并且它可以防止函数中的变量渗透到shell中(一旦您点源了一个函数文件，尝试从shell中的函数调用其中一个变量，您就会明白我的意思)。

因此，首先，将包含所有函数的.ps1文件重命名为MyFunctions。Psm1(您刚刚创建了一个模块!)现在要正确加载一个模块，您必须对文件做一些特定的事情。首先，Import-Module要查看模块(使用这个cmdlet将模块加载到shell中)，它必须位于特定的位置。模块文件夹的默认路径是$home\Documents\WindowsPowerShell\ modules。

在该文件夹中，创建一个名为MyFunctions的文件夹，并放置MyFunctions。模块文件必须位于与psm1文件名称完全相同的文件夹中。

一旦完成，打开PowerShell，并运行以下命令:

Get-Module -listavailable

如果您看到一个名为MyFunctions的模块，则说明您做对了，您的模块已经准备好加载了(这只是为了确保设置正确，您只需要这样做一次)。

要使用模块，在shell中输入以下内容(或将这一行放在$profile中，或将其作为脚本中的第一行):

Import-Module MyFunctions

现在可以运行函数了。很酷的一点是一旦你有了10-15个函数，你就会忘记其中一些函数的名字。如果你在一个模块中有它们，你可以运行下面的命令来获得模块中所有函数的列表:

Get-Command -module MyFunctions

这是非常甜蜜的，它需要在正面设置的一点点努力是值得的。

小开
< p > <代码>。“PSScriptRoot \ MyFunctions.ps1美元” MyA1Func < /代码> < / p >

从v3开始可用，在此之前请参阅如何获取PowerShell脚本的文件系统位置?。这很常见。

附注:我不赞同“一切都是模块”的规则。我的脚本是由GIT之外的其他开发人员使用的，所以我不喜欢在脚本运行之前把东西放在特定的地方或修改系统环境变量。它只是一个脚本(或两个，或三个)。

小开

你可以添加函数到:

c:\Users\David\Documents\WindowsPowerShell\profile.ps1

该功能将可用。

小开

如果你的文件只有一个你想调用/暴露的主函数，那么你也可以用:

Param($Param1)

然后你可以像下面这样叫它e.g.:

.\MyFunctions.ps1 -Param1 'value1'

如果您想轻松地调用该函数而不需要导入该函数，这将使它更加方便。

小开

假设您有一个名为Dummy-Name的模块文件。psm1有一个方法叫Function-Dumb()

Import-Module "Dummy-Name.psm1";
Get-Command -Module "Function-Dumb";
#
#
Function-Dumb;
小开

假设我在路径C:\Temp\TestScript.sp1上创建了一个脚本

enter image description here

这些脚本中的脚本和函数遵循scope规则。

enter image description here

当你使用call operator (&)在powershell编辑器中执行脚本文件时，它也不会被添加到powershell编辑器的当前作用域，如下所示 enter image description here < / p >

提交答案