Quelle est la différence entre «Write-Host», «Write-Output» ou «[console] :: WriteLine»?

Il existe plusieurs manières de sortir des messages. Quelle est la différence réelle entre la sortie quelque chose par l' intermédiaire Write-Host, Write-Outputou [console]::WriteLine?

Je remarque également que si j'utilise:

write-host "count=" + $count

Le +est inclus dans la sortie. Pourquoi ça? L'expression ne devrait-elle pas être évaluée pour produire une seule chaîne concaténée avant d'être écrite?

Write-Outputdoit être utilisé lorsque vous souhaitez envoyer des données dans la canalisation, mais que vous ne souhaitez pas nécessairement les afficher à l'écran. Le pipeline finira par l'écrire out-defaultsi rien d'autre ne l'utilise en premier.

Write-Host doit être utilisé lorsque vous souhaitez faire le contraire.

[console]::WriteLineest essentiellement ce qui Write-Hostse fait dans les coulisses.

Exécutez ce code de démonstration et examinez le résultat.

function Test-Output {
    Write-Output "Hello World"
}

function Test-Output2 {
    Write-Host "Hello World" -foreground Green
}

function Receive-Output {
    process { Write-Host $_ -foreground Yellow }
}

#Output piped to another function, not displayed in first.
Test-Output | Receive-Output

#Output not piped to 2nd function, only displayed in first.
Test-Output2 | Receive-Output 

#Pipeline sends to Out-Default at the end.
Test-Output 

Vous devrez mettre l'opération de concaténation entre parenthèses, afin que PowerShell traite la concaténation avant de tokeniser la liste de paramètres pour Write-Host, ou d'utiliser l'interpolation de chaîne

write-host ("count=" + $count)
# or
write-host "count=$count"

BTW - Regardez cette vidéo de Jeffrey Snover expliquant le fonctionnement du pipeline. À l'époque où j'ai commencé à apprendre PowerShell, j'ai trouvé que c'était l'explication la plus utile du fonctionnement du pipeline.

En dehors de ce qu'Andy a mentionné, il y a une autre différence qui pourrait être importante - write-host écrit directement sur l'hôte et ne renvoie rien, ce qui signifie que vous ne pouvez pas rediriger la sortie, par exemple, vers un fichier.

---- script a.ps1 ----
write-host "hello"

Maintenant, exécutez dans PowerShell:

PS> .\a.ps1 > someFile.txt
hello
PS> type someFile.txt
PS>

Comme on le voit, vous ne pouvez pas les rediriger dans un fichier. Cela peut être surprenant pour quelqu'un qui ne fait pas attention.

Mais si vous utilisez plutôt la sortie d'écriture, la redirection fonctionnera comme prévu.

Voici une autre façon d'accomplir l'équivalent de Write-Output. Mettez simplement votre chaîne entre guillemets:

"count=$count"

Vous pouvez vous assurer que cela fonctionne de la même manière que Write-Output en exécutant cette expérience:

"blah blah" > out.txt

Write-Output "blah blah" > out.txt

Write-Host "blah blah" > out.txt

Les deux premiers afficheront "bla bla" vers out.txt, mais le troisième ne le sera pas.

"help Write-Output" donne un indice de ce comportement:

Cette cmdlet est généralement utilisée dans les scripts pour afficher des chaînes et d'autres objets sur la console. Cependant, comme le comportement par défaut est d'afficher les objets à la fin d'un pipeline, il n'est généralement pas nécessaire d'utiliser l'applet de commande.

Dans ce cas, la chaîne elle-même "count = $ count" est l'objet à la fin d'un pipeline et est affichée.

Pour les utilisations de Write-Host, PSScriptAnalyzerproduit le diagnostic suivant:

Évitez d'utiliser, Write-Hostcar cela peut ne pas fonctionner sur tous les hôtes, ne pas fonctionner lorsqu'il n'y a pas d'hôte et (avant PS 5.0) ne peut pas être supprimé, capturé ou redirigé. Au lieu de cela, l' utilisation Write-Output, Write-Verboseou Write-Information.

Consultez la documentation derrière cette règle pour plus d'informations. Extraits pour la postérité:

L'utilisation de Write-Hostest fortement déconseillée sauf dans l'utilisation de commandes avec le Showverbe. Le Showverbe signifie explicitement "montrer à l'écran, sans autres possibilités".

ShowCette vérification n'est pas appliquée aux commandes avec le verbe.

Jeffrey Snover a un article de blog Write-Host considéré comme nocif dans lequel il affirme que Write-Host est presque toujours la mauvaise chose à faire car il interfère avec l'automatisation et fournit plus d'explications derrière le diagnostic, mais ce qui précède est un bon résumé.

D'après mes tests, Write-Output et [Console] :: WriteLine () fonctionnent bien mieux que Write-Host.

En fonction de la quantité de texte à rédiger, cela peut être important.

Ci-dessous si le résultat de 5 tests chacun pour Write-Host, Write-Output et [Console] :: WriteLine ().

Dans mon expérience limitée, j'ai constaté que lorsque je travaillais avec n'importe quel type de données du monde réel, j'avais besoin d'abandonner les applets de commande et de passer directement aux commandes de niveau inférieur pour obtenir des performances décentes de mes scripts.

measure-command {$count = 0; while ($count -lt 1000) { Write-Host "hello"; $count++ }}

1312ms
1651ms
1909ms
1685ms
1788ms


measure-command { $count = 0; while ($count -lt 1000) { Write-Output "hello"; $count++ }}

97ms
105ms
94ms
105ms
98ms


measure-command { $count = 0; while ($count -lt 1000) { [console]::WriteLine("hello"); $count++ }}

158ms
105ms
124ms
99ms
95ms

Concernant [Console] :: WriteLine () - vous devriez l'utiliser si vous allez utiliser des pipelines dans CMD (pas dans PowerShell). Supposons que vous souhaitiez que votre ps1 diffuse beaucoup de données sur stdout et un autre utilitaire pour les consommer / les transformer. Si vous utilisez Write-Host dans le script, ce sera beaucoup plus lent.