如何使用 PowerShell 写入输出

PowerShell Write-Output cmdlet 用于将对象或变量发送到 PowerShell 管道。当它是管道中的最后一个命令时，输出将显示在控制台中。

Write-Output 基本上相当于其他编程语言中的 echo 或 print 的 PowerShell。

在本文中，我们将了解如何使用 Write-Output cmdlet 以及与 Write-Host cmdlet 和 Return 语句的区别。

PowerShell 写入输出 Cmdlet

写入输出 cmdlet 将向 PowerShell 的成功流发送对象、字符串或变量值。当 cmdlet 是管道中的最后一个时，结果将显示在控制台中。

您可以将 Write-Output cmdlet 视为其他编程语言中的 Echo 或 Print 命令的等效命令。命令 Echo 甚至是 PowerShell 中 Write-Output cmdlet 的别名。

通常，您不需要使用 Write-Output cmdlet，因为大多数 cmdlet 的默认行为是，如果后面没有通过管道传输任何内容，则默认显示输出。例如，要查看计算机上所有正在运行的进程，您可以使用 Get-Process cmdlet：

# Both command will return the same result:
Get-Process 
Get-Process | Write-Output

或者，当您想查看变量的值时，可以在其后面通过管道写入输出，但这不是必需的：

$var = "Hello world"

# These will all produce the same result in console
$var
$var | Write-Host
Write-Host $var
$var | Write-Output

写输出与写主机

当我们谈论 Write-Output cmdlet 时，经常会遇到的问题是，它与 Write-Host 有什么区别，以及何时使用什么？尽管这两个 cmdlet 经常在控制台中显示结果，但两者之间存在重要区别。

使用 Write-Host cmdlet，您可以将字符串直接打印到控制台。但是，使用 Write-Output 时，您会将字符串发送到 PowerShell 的成功流 (stdout)。理解这种差异非常重要。

看一下下面的示例，该函数从 CSV 文件中获取用户，如果用户存在于 Azure AD 中，它将将该用户添加到特定组。现在为了跟踪正在发生的情况，我们使用了 Write-Host cmdlet：

Function Add-UsersToGroup {
  # Import the CSV File
  $users = (Import-Csv -Path $path -Delimiter $delimiter -header "name").name

  # Find the users in the Active Directory
  $users | ForEach-Object {
      $user = Get-AzureADUser -filter "$filter eq '$_'" | Select-Object ObjectID 

      if ($user) {
          Add-AzureADGroupMember -ObjectId $group -RefObjectId $user
          Write-Host "$_ added to the group"
      }else {
          Write-Warning "$_ not found in Azure AD"
      }
  }
}

当您在控制台本地运行脚本时，这非常有用。但是当您在 Azure Runbook 中使用此函数时，或者想要将结果写入日志文件时？ Write-Host 的输出将丢失，因为它被写入控制台。

如果我们在这种情况下使用Write-Output，那么用户添加到组的成功消息将被发送到 PowerShell 的成功流。这使我们能够查看 Azure Runbook 日志中的结果或将此脚本的结果重定向到日志文件。

简而言之，您应该将 Write-Host 用于仅直接在控制台中运行的交互式脚本。但对于作为后台作业运行的脚本或在 Azure Runbook 中运行的脚本，您确实应该使用 Write-Output。

返回与写输出

另外，一个常见的问题是 PowerShell 中的 return 和 Write-Output 之间有什么区别？两者之间最大的区别是 return 语句将退出函数或脚本块。而 Write-Output cmdlet 仅返回值，但不会退出该函数。

我们可以通过下面的例子看出两者的区别：

function calculation {
  param ($value)

  Write-Output "Please wait. Working on calculation..."
  Write-Output $value += 42
}

calculation -value 8

# Result
Please wait. Working on calculation...
8
+=
42

在上面的示例中，我们仅使用了 Write-Output cmdlet。正如您在结果中看到的，计算并未执行，而是单独返回每个对象。

function calculation {
  param ($value)

  return "Please wait. Working on calculation..."
  return $value += 42
}

calculation -value 8

# Result
Please wait. Working on calculation...

如果我们使用 return 语句，则仅返回字符串，因为 return 语句将退出函数。

因此，要显示消息并返回计算结果，我们需要同时使用两者：

function calculation {
  param ($value)

  Write-Output "Please wait. Working on calculation..."
  return $value += 42
}

calculation -value 8

# Result
Please wait. Working on calculation...
50

在写入输出中使用变量

值得一提的是，我们可以在 write-output cmdlet 的输出中使用变量。使用双引号 " " 时，可以将简单的字符串变量包含在写入输出的字符串中。请记住，您不能在用单引号 ' ' 括起来的字符串内使用变量。此处的区别在于 PowerShell 仅处理用双引号括起来的字符串。

$user = "megan@a-d.site"
Write-Output "Getting mailbox of $user"

# Result
Getting mailbox of megan@a-d.site

但是在使用对象时，您可能已经注意到无法输出对象的项目。例如，这个不会工作：

$user = [PSCustomObject]@{
    DisplayName = "Megan"
    Email = "megan@a-d.site"
}

Write-Output "Getting mailbox of $user.displayname"

# Result
Getting mailbox of @{DisplayName=Megan; Email=megan@a-d.site}.displayname

要显示用户对象的显示名称，我们需要将其括在括号中，如下所示：

$user = [PSCustomObject]@{
    DisplayName = "Megan"
    Email = "megan@a-d.site"
}

Write-Output "Getting mailbox of $($user.DisplayName)"

# Result
Getting mailbox of Megan

包起来

请记住，PowerShell 的默认行为是将 cmdlet 的结果发送到成功流，而成功流则显示在控制台中。通常您不需要使用 Write-Output cmdlet。

但是，当您想要显示作为后台作业运行或在 Azure Runbook 中运行的函数或脚本的信息或进度时，请确保使用 Write-Output cmdlet。

我希望这篇文章对您有所帮助，如果您有任何疑问，请在下面发表评论。