PowerShell中的函数返回值

我已经开发了一个PowerShell函数，该函数执行许多有关配置SharePoint Team网站的操作。最终，我希望函数以String的形式返回预配置站点的URL，因此在函数末尾，我具有以下代码：

$rs = $url.ToString();
return $rs;

调用此函数的代码如下：

$returnURL = MyFunction -param 1 ...

所以我期待一个String，但是不是。而是，它是System.Management.Automation.PSMethod类型的对象。为什么返回该类型而不是String类型？

PowerShell具有真正古怪的返回语义-至少从更传统的编程角度来看时是如此。有两个主要想法可以帮助您解决问题：

• 捕获所有输出，并返回
• return关键字实际上只是指示逻辑出口点

因此，以下两个脚本块将有效地执行完全相同的操作：

$a = "Hello, World"
return $a

$a = "Hello, World"
$a
return

第二个示例中的$ a变量在管道上保留为输出，并且如上所述，返回了所有输出。实际上，在第二个示例中，您可以完全省略该返回值，并且您将获得相同的行为（当函数自然完成并退出时，将暗示该返回值）。

没有更多的函数定义，我无法说出为什么要得到PSMethod对象。我的猜测是您可能有一些未捕获的行，而是被放置在输出管道上的行。

还值得注意的是，您可能不需要这些分号-除非您将多个表达式嵌套在一行上。

您可以在TechNet 的about_Return页面上或通过help return从PowerShell本身调用命令来了解有关返回语义的更多信息。

PowerShell的这一部分可能是最愚蠢的方面。函数执行期间生成的任何无关输出都会污染结果。有时没有任何输出，然后在某些情况下，除了计划的返回值之外，还有一些其他计划外的输出。

因此，我从原始函数调用中删除了赋值，因此输出最终显示在屏幕上，然后逐步执行，直到我不打算进行的操作在调试器窗口中弹出（使用PowerShell ISE）。

甚至像在外部范围中保留变量之类的东西[boolean]$isEnabled也会导致输出，例如，除非您这样做，否则它会烦人地吐出False [boolean]$isEnabled = $false。

另一个好方法是$someCollection.Add("thing")吐出新的收藏计数。

使用PowerShell 5，我们现在可以创建类。将函数更改为类，然后return将仅返回紧接其之前的对象。这是一个简单的例子。

class test_class {
    [int]return_what() {
        Write-Output "Hello, World!"
        return 808979
    }
}
$tc = New-Object -TypeName test_class
$tc.return_what()

如果这是一个函数，则预期输出为

Hello World
808979

但是作为一个类，唯一返回的是整数808979。一个类有点像保证它只会返回声明的类型或void的保证。

作为一种解决方法，我一直在返回从函数中返回的数组中的最后一个对象……这不是一个很好的解决方案，但是总比没有好：

someFunction {
   $a = "hello"
   "Function is running"
   return $a
}

$b = someFunction
$b = $b[($b.count - 1)]  # Or
$b = $b[-1]              # Simpler

总而言之，写同一件事的一种更简单的方式可能是：

$b = (someFunction $someParameter $andAnotherOne)[-1]

我传递了一个带有单个结果成员的简单Hashtable对象，以避免返回疯狂，因为我也想输出到控制台。它通过引用传递。

function sample-loop($returnObj) {
  for($i = 0; $i -lt 10; $i++) {
    Write-Host "loop counter: $i"
    $returnObj.result++
  }
}

function main-sample() {
  $countObj = @{ result = 0 }
  sample-loop -returnObj $countObj
  Write-Host "_____________"
  Write-Host "Total = " ($countObj.result)
}

main-sample

您可以在我的GitHub项目unpackTunes上看到真实的示例用法。

不看代码就很难说。确保函数不会返回一个以上的对象，并且要捕获其他调用产生的任何结果。你得到什么：

@($returnURL).count

无论如何，有两个建议：

将对象转换为字符串：

...
return [string]$rs

或者只是将其括在双引号中，与上面相同，但键入要短一些：

...
return "$rs"

在这些情况下，卢克对函数结果的描述似乎正确。我只希望了解根本原因，PowerShell产品团队会对此行为做些事情。这似乎很常见，花费了我太多的调试时间。

为了解决这个问题，我一直在使用全局变量，而不是从函数调用中返回并使用值。

这是有关使用全局变量的另一个问题： 从函数中设置全局PowerShell变量，其中全局变量名是传递给函数的变量

以下仅返回4作为答案。当您替换字符串的添加表达式时，它将返回第一个字符串。

Function StartingMain {
  $a = 1 + 3
  $b = 2 + 5
  $c = 3 + 7
  Return $a
}

Function StartingEnd($b) {
  Write-Host $b
}

StartingEnd(StartingMain)

也可以对数组执行此操作。下面的示例将返回“文本2”

Function StartingMain {
  $a = ,@("Text 1","Text 2","Text 3")
  Return $a
}

Function StartingEnd($b) {
  Write-Host $b[1]
}

StartingEnd(StartingMain)

请注意，您必须在函数本身下方调用该函数。否则，它将在第一次运行时返回一个不知道“ StartingMain”是什么的错误。

现有的答案是正确的，但有时您实际上并没有使用a Write-Output或a 显式返回某些内容return，但是函数结果中仍有一些神秘的价值。这可能是内置函数的输出，例如New-Item

PS C:\temp> function ContrivedFolderMakerFunction {
>>    $folderName = [DateTime]::Now.ToFileTime()
>>    $folderPath = Join-Path -Path . -ChildPath $folderName
>>    New-Item -Path $folderPath -ItemType Directory
>>    return $true
>> }
PS C:\temp> $result = ContrivedFolderMakerFunction
PS C:\temp> $result


    Directory: C:\temp


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         2/9/2020   4:32 PM                132257575335253136
True

在创建目录时，所有额外的噪音都会被收集并输出到输出中。减轻这种情况的简单方法是将其添加| Out-Null到New-Item语句的末尾，或者可以将结果分配给变量，而不必使用该变量。看起来像这样...

PS C:\temp> function ContrivedFolderMakerFunction {
>>    $folderName = [DateTime]::Now.ToFileTime()
>>    $folderPath = Join-Path -Path . -ChildPath $folderName
>>    New-Item -Path $folderPath -ItemType Directory | Out-Null
>>    # -or-
>>    $throwaway = New-Item -Path $folderPath -ItemType Directory 
>>    return $true
>> }
PS C:\temp> $result = ContrivedFolderMakerFunction
PS C:\temp> $result
True

New-Item可能是其中最著名的，但是其他StringBuilder.Append*()方法包括所有方法以及SqlDataAdapter.Fill()方法。

作为一种替代，return我建议Write-Output。

Write-Output 可以从管道中获取输入，然后将其转发到管道中，或者将其打印到控制台（如果这是最后一条命令）。

但是，Write-Output不会像结束脚本那样结束脚本return，如果应该在循环中使用，转发输出等，这可能是一个优势。