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

Question

我有一个 .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 概念。我可以不在脚本文件中定义函数吗？

请注意，我已将执行策略设置为“RemoteSigned”。我知道要在文件名前面使用点来运行 .ps1 文件： .\myFile.ps1

Answer 1

在 PowerShell 命令行上尝试一下：

. .\MyFunctions.ps1
A1

点运算符用于脚本包含，又名“点源”（或 "点源表示法")

Answer 2

你所说的叫做点源。这是邪恶的。但不用担心，有一种更好、更简单的方法来完成您想要的事情模块（听起来比实际更可怕）。使用模块的主要好处是，如果需要，您可以从 shell 中卸载它们，并且它可以防止函数中的变量爬入 shell（一旦您点了函数文件的源代码，请尝试从shell 中的函数，你就会明白我的意思）。

首先，将包含所有函数的 .ps1 文件重命名为 MyFunctions.psm1 （您刚刚创建了一个模块！）。现在，为了正确加载模块，您必须对该文件执行一些特定的操作。首先，要让 Import-Module 查看模块（您使用此 cmdlet 将模块加载到 shell 中），它必须位于特定位置。模块文件夹的默认路径是 $home\Documents\WindowsPowerShell\Modules。

在该文件夹中，创建一个名为 MyFunctions 的文件夹，并将 MyFunctions.psm1 文件放入其中（模块文件必须驻留在与 PSM1 文件名称完全相同的文件夹中）。

完成后，打开 PowerShell，然后运行以下命令：

Get-Module -listavailable

如果您看到一个名为 MyFunctions 的命令，则说明您做得对，并且您的模块已准备好加载（这只是为了确保设置正确，您只需执行此操作一次）。

要使用该模块，请在 shell 中键入以下内容（或将此行放入您的 $profile 中，或将其作为脚本中的第一行）：

Import-Module MyFunctions

您现在可以运行您的函数。最酷的一点是，一旦你有 10-15 个函数，你就会忘记其中几个函数的名字。如果您将它们放在模块中，则可以运行以下命令来获取模块中所有函数的列表：

Get-Command -module MyFunctions

这非常好，在前端进行设置所需的一点点努力是值得的。

Answer 3

<代码>。 “$PSScriptRoot\MyFunctions.ps1”
MyA1Func

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

PS 我不同意“一切都是模块”的规则。我的脚本由 GIT 之外的其他开发人员使用，因此我不喜欢在脚本运行之前将内容放在特定位置或修改系统环境变量。这只是一个脚本（或两个或三个）。

Answer 4

您可以将功能添加到：

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

该功能将可用。

配置文件的实际位置由 $PROFILE 变量确定，只需在 powershell 终端中输入该位置就会告诉您要编辑的文件。

Answer 5

如果您的文件只有一个要调用/公开的主函数，那么您也可以使用以下命令启动该文件：

Param($Param1)

然后您可以按如下方式调用它：

.\MyFunctions.ps1 -Param1 'value1'

如果您只想轻松调用该函数，这会更加方便无需导入该函数。

Answer 6

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

首先，您需要通过运行以下命令来检查以确保该函数已加载：

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

并检查它是否出现在列表中（应该是 1 的列表！），然后让我们知道您得到的输出！

Answer 7

假设我在路径 C:\Temp\TestScript.sp1

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

另外，当您在 powershell 编辑器中使用调用运算符 (&) 执行脚本文件时，它也不会添加到 powershell 编辑器的当前作用域中，如下所示

Answer 8

假设您有一个名为 Dummy-Name.psm1 的模块文件，其中有一个名为 Function-Dumb() 的方法

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

Answer 9

最简单的更改是在 global 作用域中设置 A1 函数

MyFunctions.ps1

function global:A1
{
    Write-Host "A1 is running!"
}

然后它就可以工作：

$ ./MyFunctions.ps1
$ A1
A1 is running!