6

在可以针对任何合理的主机实现运行的脚本中,是否有任何理智、可靠的合同规定是否Write-Host在给定的 PowerShell 主机实现中受支持?

(假设我理解Write-Hostand Write-Output/之间的区别,并且Write-Verbose我肯定想要Write-Host语义,如果支持的话,对于这个特定的人类可读文本。)

我想过尝试询问$Host变量,或者$Host.UI/$Host.UI.RawUI但我发现的唯一相关差异是:

  • $Host.Name

    • Windows powershell.exe 命令行有$Host.Name = 'ConsoleHost'
    • 伊势有$Host.Name = 'Windows PowerShell ISE Host'
    • SQL Server 代理作业步骤有$Host.Name = 'Default Host'
    • 我没有安装任何非 Windows 版本,但我希望它们有所不同
  • $Host.UI.RawUI

    • Windows powershell.exe 命令行返回所有属性的值$Host.UI.RawUI
    • ISE$null对 的某些属性不返回任何值(或 )$Host.UI.RawUI,例如$Host.UI.RawUI.CursorSize
    • SQL Server 代理作业步骤不返回任何值$Host.UI.RawUI
    • 同样,我无法签入任何其他平台

维护$Host.Name支持的值列表Write-Host似乎有点负担,尤其是现在 PowerShell 是跨平台的。我会合理地希望脚本能够从任何主机调用并且只是做正确的事情

背景

我编写了一个脚本,可以从 PowerShell 命令提示符、ISE 或 SQL Server 代理作业中合理运行。该脚本的输出完全是文本的,供人类阅读。从命令提示符或 ISE 运行时,输出使用Write-Host.

SQL Server 作业可以通过两种不同的方式设置,并且都支持将输出捕获到 SQL Server 代理日志查看器中:

  1. 通过 CmdExec 步骤,这是简单的命令行执行,其中 Job Step 命令文本是可执行文件及其参数,因此您调用 powershell.exe 可执行文件。捕获的输出是过程的标准输出/标准输出:

    powershell.exe -Command x:\pathto\script.ps1 -Arg1 -Arg2 -Etc
    
  2. 通过 PowerShell 步骤,其中 Job Step 命令文本是由其自己的嵌入式 PowerShell 主机实现解释的原始 PS 脚本。捕获的输出是通过Write-Outputor写入的任何内容Write-Error

    #whatever
    Do-WhateverPowershellCommandYouWant
    x:\pathto\script.ps1 -Arg1 -Arg2 -Etc
    

由于 SQL Server 主机实现的其他一些弱点,我发现您可以使用Write-Output或发出输出Write-Error,但不能同时使用。如果作业步骤失败(即如果您throwWrite-Error 'foo' -EA 'Stop'),您只会在日志中获得错误流,如果成功,您只会在日志中获得输出流。

此外,嵌入式 PS 实现不支持Write-Host. 至少到 SQL Server 2016,Write-Host抛出一个System.Management.Automation.Host.HostException带有消息A command that prompt the user failed because the host program or the command type does not support user interaction

为了支持我所有的用例,到目前为止,我开始使用一个自定义函数Write-Message,该函数基本上设置为(简化):

 $script:can_write_host = $true
 $script:has_errors = $false
 $script:message_stream = New-Object Text.StringBuilder

 function Write-Message {
     Param($message, [Switch]$iserror)

     if ($script:can_write_host) {
         $private:color = if ($iserror) { 'Red' } else { 'White' }
         try { Write-Host $message -ForegroundColor $private:color }
         catch [Management.Automation.Host.HostException] { $script:can_write_host = $false }
     }
     if (-not $script:can_write_host) {
         $script:message_stream.AppendLine($message) | Out-Null
     }
     if ($iserror) { $script:has_errors = $true }
 }

 try { 
     <# MAIN SCRIPT BODY RUNS HERE #>
 }
 catch { 
     Write-Message -Message ("Unhandled error: " + ($_ | Format-List | Out-String)) -IsError
 }
 finally {
     if (-not $script:can_write_host) {
         if ($script:has_errors) { Write-Error ($script:message_stream.ToString()) -EA 'Stop' }
         else { Write-Output ($script:message_stream.ToString()) }
     }
 } 

从 SQL Server 2019(可能更早)开始,它似乎Write-Host不再在嵌入式 SQL Server 代理 PS 主机中引发异常,而是一个不向输出或错误流发出任何内容的空操作。由于没有例外,我的脚本Write-Message函数无法再可靠地检测它是否应该使用Write-HostStringBuilder.AppendLine

SQL Server 代理作业的基本解决方法是使用更成熟的 CmdExec 步骤类型(其中Write-OutputWrite-Host两者都被捕获为标准输出),但我更喜欢 PowerShell 步骤类型,因为(除其他原因外)它能够可靠地拆分命令多行,所以我很想看看是否有更全面的、基于 PowerShell 的方法来解决是否Write-Host对我所在的主机有用的问题。

4

1 回答 1

0

另一种实时跟踪脚本输出的方法是将输出推送到日志文件,然后使用 trace32 实时监控它。这只是一种解决方法,但它可能对您有用。

Add-Content -Path "C:\Users\username\Documents\PS_log.log" -Value $variablewithvalue
于 2021-09-29T13:54:17.253 回答