`if` ステートメントについて知りたかったことのすべて

[アーティクル]
01/20/2024

他の多くの言語と同様に、PowerShell には、スクリプト内でコードを条件付き実行するためのステートメントがあります。それらのステートメントの 1 つが If ステートメントです。本日は、PowerShell の最も基本的なコマンドの 1 つについて詳しく説明します。

注意

この記事のオリジナルバージョンは、@KevinMarquette 氏のブログに掲載されました。このコンテンツを共有してくださった Kevin 氏に、PowerShell チームより感謝を申し上げます。 PowerShellExplained.com のブログをご確認ください。

条件付き実行

多くの場合、スクリプトでは決定を下し、それらの決定に基づいて異なるロジックを実行する必要があります。これが、条件付き実行の意味です。評価するステートメントまたは値が 1 つあると、その評価に基づいてコードの別のセクションを実行します。これがまさに、if ステートメントで行われることです。

`if` ステートメント

次に、if ステートメントの基本的な例を示します。

$condition = $true
if ( $condition )
{
    Write-Output "The condition was true"
}

最初に if ステートメントが実行することは、かっこ内の式を評価することです。 $true に評価されると、中かっこ内の scriptblock が実行されます。値が $false であった場合、そのスクリプトブロックはスキップされます。

前の例では、if ステートメントは $condition 変数を評価するだけでした。 $true であったため、スクリプトブロック内の Write-Output コマンドが実行されたでしょう。

一部の言語では、if ステートメントの後に単一行のコードを配置し、それを実行することができます。それは PowerShell には当てはまりません。正常に動作するには、中かっこで囲んだ完全な scriptblock を指定する必要があります。

比較演算子

if ステートメントの最も一般的な用途は、2 つの項目を互いに比較することです。 PowerShell には、さまざまな比較シナリオのために特別な演算子が用意されています。比較演算子を使用する場合、左側の値が右側の値と比較されます。

-eq (等価性)

-eq は、値が互いに等しいことを確認するため、2 つの値の間で等価性のチェックを行います。

$value = Get-MysteryValue
if ( 5 -eq $value )
{
    # do something
}

この例では、既知の値 5 を取得し、それを $value と比較して、それらが一致しているかどうかを確認します。

考えられるユースケースの 1 つは、値に対してアクションを実行する前に、値の状態をチェックすることです。サービスを取得し、その状態が実行中であることを確認してから、それに対して Restart-Service を呼び出すことができます。

C# のような他の言語では、等価性のチェックに == を使用する (例: 5 == $value) のが一般的ですが、これは PowerShell では機能しません。別のよくある誤りは、変数に値を代入するために予約されている等号 (例: 5 = $value) を使用することです。既知の値を左側に配置することで、その誤りを発生しにくくします。

この演算子 (およびその他) には、いくつかのバリエーションがあります。

-eq (大文字と小文字が区別されない等価性)
-ieq (大文字と小文字が区別されない等価性)
-ceq (大文字と小文字が区別される等価性)

-ne (等しくない)

多くの演算子には、逆の結果をチェックする、関連する演算子があります。 -ne は、値が互いに等しくないことを確認します。

if ( 5 -ne $value )
{
    # do something
}

値が 5 でない場合にのみアクションが実行されるようにするには、これを使用します。適切なユースケースとしては、サービスが実行中の状態かどうかを確認してからその起動を試みる場合が挙げられます。

バリエーション:

-ne (大文字と小文字が区別されない、等しくない)
-ine (大文字と小文字が区別されない、等しくない)
-cne (大文字と小文字が区別される、等しくない)

これらは、-eq の逆のバリエーションです。私は、他の演算子のバリエーションをリストにするときには、これらの型を一緒にグループ化します。

-gt -ge -lt -le (より大きい、より小さい)

これらの演算子は、ある値が別の値より大きいか小さいかを調べて確認するときに使用されます。 -gt -ge -lt -le は、GreaterThan、GreaterThanOrEqual、LessThan、および LessThanOrEqual を表しています。

if ( $value -gt 5 )
{
    # do something
}

バリエーション:

-gt (より大きい)
-igt (より大きい、大文字と小文字が区別されない)
-cgt (より大きい、大文字と小文字が区別される)
-ge (以上)
-ige (以上、大文字と小文字が区別されない)
-cge (以上、大文字と小文字が区別される)
-lt (より小さい)
-ilt (より小さい、大文字と小文字が区別されない)
-clt (より小さい、大文字と小文字が区別される)
-le (以下)
-ile (以下、大文字と小文字が区別されない)
-cle (以下、大文字と小文字が区別される)

私には、これらの演算子で、大文字と小文字を区別するオプション、区別しないオプションを使用する理由がわかりません。

-like (ワイルドカードの一致)

PowerShell には、ワイルドカードベースの独自のパターン一致構文があり、-like 演算子と共に使用できます。これらのワイルドカードパターンは、かなり基本的なものです。

? は任意の 1 文字と一致します。
* は任意の数の文字と一致します。

$value = 'S-ATX-SQL01'
if ( $value -like 'S-*-SQL??')
{
    # do something
}

指摘しておくことが重要なのは、パターンは文字列全体に一致するという点です。文字列の途中にある何かと一致させる必要がある場合は、文字列の両端に * を付ける必要があります。

$value = 'S-ATX-SQL02'
if ( $value -like '*SQL*')
{
    # do something
}

バリエーション:

-like (大文字と小文字が区別されないワイルドカード)
-ilike (大文字と小文字が区別されないワイルドカード)
-clike (大文字と小文字が区別されるワイルドカード)
-notlike (大文字と小文字が区別されないワイルドカード不一致)
-inotlike (大文字と小文字が区別されないワイルドカード不一致)
-cnotlike (大文字と小文字が区別されるワイルドカード不一致)

-match (正規表現)

-match 演算子を使用すると、正規表現に基づく一致があるか、文字列を調べられます。これは、ワイルドカードパターンでは十分な柔軟性が得られない場合に使用します。

$value = 'S-ATX-SQL01'
if ( $value -match 'S-\w\w\w-SQL\d\d')
{
    # do something
}

正規表現パターンは、既定では文字列内の任意の場所に一致します。そのため次のように、一致させる部分文字列を指定できます。

$value = 'S-ATX-SQL01'
if ( $value -match 'SQL')
{
    # do something
}

正規表現は独自の複雑な言語であり、詳しく調べる価値があります。私は別の記事で、-match の詳細と正規表現を使用するさまざまな方法について説明しています。

バリエーション:

-match (大文字と小文字が区別されない正規表現)
-imatch (大文字と小文字が区別されない正規表現)
-cmatch (大文字と小文字が区別される正規表現)
-notmatch (大文字と小文字が区別されない正規表現不一致)
-inotmatch (大文字と小文字が区別されない正規表現不一致)
-cnotmatch (大文字と小文字が区別される正規表現不一致)

-is (型)

-is 演算子を使用して値の型を調べられます。

if ( $value -is [string] )
{
    # do something
}

これは、複数のクラスを使用している場合や、パイプライン上でさまざまなオブジェクトを受け入れている場合に使用できます。入力として、サービスまたはサービス名のいずれかを使用できます。次に、サービスがあるかどうかを調べて、名前しかない場合はサービスをフェッチします。

if ( $Service -isnot [System.ServiceProcess.ServiceController] )
{
    $Service = Get-Service -Name $Service
}

バリエーション:

-is (型)
-isnot (型でない)

コレクション演算子

1 つの値を指定して前出の演算子を使用すると、結果は $true または $false になります。これは、コレクションの操作時には少し異なる方法で処理されます。コレクション内の各項目が評価されて、演算子からは、$true に評価されるすべての値が返されます。

PS> 1,2,3,4 -eq 3
3

これは、if ステートメントでも正しく機能します。そのため、演算子によって値が返されると、ステートメント全体は $true になります。

$array = 1..6
if ( $array -gt 3 )
{
    # do something
}

これについては、指摘する必要がある小さな罠が細部に潜んでいます。このように -ne 演算子を使用すると、誤ってロジックを逆に考えてしまいやすくなります。コレクションで -ne を使用すると、コレクション内のいずれかの項目が値と一致しない場合に、$true が返されます。

PS> 1,2,3 -ne 4
1
2
3

これは巧みな技法のようですが、これをより効率的に処理する演算子 -contains および -in が用意されています。そして、期待したことは -notcontains によって行われます。

-contains

-contains 演算子は、値があるか、コレクションを調べます。一致が見つかるとすぐに $true が返されます。

$array = 1..6
if ( $array -contains 3 )
{
    # do something
}

これは、コレクションに値が含まれているかどうかを確認する場合の推奨される方法です。 Where-Object (または -eq) を使用すると、毎回リスト全体が処理され、大幅に低速になります。

バリエーション:

-contains (大文字と小文字が区別されない一致)
-icontains (大文字と小文字が区別されない一致)
-ccontains (大文字と小文字が区別される一致)
-notcontains (大文字と小文字が区別されない不一致)
-inotcontains (大文字と小文字が区別されない不一致)
-cnotcontains (大文字と小文字が区別される不一致)

-in

-in 演算子は、右側にコレクションがあること以外は、-contains 演算子とまったく同じです。

$array = 1..6
if ( 3 -in $array )
{
    # do something
}

バリエーション:

-in (大文字と小文字が区別されない一致)
-iin (大文字と小文字が区別されない一致)
-cin (大文字と小文字が区別される一致)
-notin (大文字と小文字が区別されない不一致)
-inotin (大文字と小文字が区別されない不一致)
-cnotin (大文字と小文字が区別される不一致)

論理演算子

論理演算子は、他の式を反転または結合するために使用されます。

-not

-not 演算子は、式を $false から $true に、または $true から $false に反転させます。次に、Test-Path が $false であるときにアクションを実行する例を示します。

if ( -not ( Test-Path -Path $path ) )

説明してきたほとんどの演算子には、-not 演算子を使用する必要がないバリエーションがあります。しかし、それでも役に立つ場面があります。

! operator

-not の別名として ! を使用できます。

if ( -not $value ){}
if ( !$value ){}

C# などの別の言語が専門のユーザーは、! をより多用することに気付くかも知れません。私は、スクリプトをすばやく調べるときに見にくいと感じるため、これを文字で入力することを好んでいます。

-and

式を -and 演算子と組み合わせることができます。それを行うときには、式全体が $true になるには、両方の側が $true になる必要があります。

if ( ($age -gt 13) -and ($age -lt 55) )

この例では、$age は左側で 13 以上、右側で 55 未満である必要があります。その例で、より明確にするために私がかっこを余分に追加しましたが、式が単純である限り、これらのかっこは省略可能です。それらがない同じ例を示します。

if ( $age -gt 13 -and $age -lt 55 )

評価は左から右に実行されます。最初の項目が $false に評価された場合は早期に終了し、右側の比較は実行されません。これは、使用する前に値が存在することを確認する必要がある場合に便利です。たとえば、$null パスを指定した場合、Test-Path からエラーがスローされます。

if ( $null -ne $path -and (Test-Path -Path $path) )

-or

-or を使用すると、2 つの式を指定し、その 1 つが $true である場合に $true を返すことができます。

if ( $age -le 13 -or $age -ge 55 )

-and 演算子と同様に、評価は左から右に実行されます。最初の部分が $true である場合は、ステートメント全体が $true になるので、式の残りの部分は処理されません。

これらの演算子の構文がどのように機能するかもメモしておいてください。 2 つの別個の式が必要です。私は、自分のミスに気付かずに、このようなこと ($value -eq 5 -or 6) を実行しようとしたユーザーを見てきました。

-xor (排他的 OR)

これは少し変わっています。 -xor では、1 つの式だけが $true に評価されることができます。そのため、両方の項目が $false か、両方の項目が $true である場合に、式全体が $false になります。式の結果が異なるときにだけ、式が $true になる、というのがこれの別の見方です。

この論理演算子を使用することはめったになく、私はこれを使用する理由について、適切な例を思い付くことができません。

ビットごとの演算子

ビットごとの演算子は、値内のビットに対して演算を実行し、結果として新しい値を生成します。ビットごとの演算子について教えることは、この記事の範囲外ですが、次にそれらのリストを示します。

-band (2 項 AND)
-bor (2 項 OR)
-bxor (2 項排他的 OR)
-bnot (2 項 NOT)
-shl (左シフト)
-shr (右シフト)

PowerShell の式

条件ステートメント内で通常の PowerShell を使用できます。

if ( Test-Path -Path $Path )

Test-Path は、実行されると $true または $false を返します。これは、他の値を返すコマンドにも適用されます。

if ( Get-Process Notepad* )

返されたプロセスがある場合は $true に、何もない場合は $false に評価されます。次のようにパイプライン式やその他の PowerShell ステートメントを使用することは、完全に有効です。

if ( Get-Process | Where Name -eq Notepad )

これらの式は、-and 演算子と -or 演算子を使用して相互に結合できますが、かっこを使用して部分式に分割することが必要な場合があります。

if ( (Get-Process) -and (Get-Service) )

$null の確認

結果がなかったり、if ステートメントで $null 値が $false と評価されます。 $null を特に調べる場合は、左側に $null を配置することがベストプラクティスです。

if ( $null -eq $value )

PowerShell で $null 値を扱う際には、かなり多くの微妙な差異があります。詳細についてお知りになりたい場合は、$null について知りたかったことのすべてに関する記事があります。

条件内の変数代入

Prasoon Karunan V に思い出させてもらうまで、この部分を追加するのをほとんど忘れていました。

if ($process=Get-Process notepad -ErrorAction ignore) {$process} else {$false}

通常、変数に値を代入するときに、値はパイプラインやコンソールに渡されません。部分式で変数の代入を行うと、確かにパイプラインに渡されます。

PS> $first = 1
PS> ($second = 2)
2

$first の代入には出力がなく、$second の代入には出力がある様子を確認してください。 if ステートメントで代入が行われると、上の $second の代入と同様に実行されます。次に、使用方法のはっきりした例を示します。

if ( $process = Get-Process Notepad* )
{
    $process | Stop-Process
}

$process が代入された値を取得すると、ステートメントは $true になり、$process は停止されます。

これは等価性チェックではないため、-eq と混同しないでください。これは、ほとんどの人がこのように動作することを認識していない、わかりにくい機能です。

スクリプトブロックからの変数代入

if ステートメントスクリプトブロックを利用して値を変数に代入することもできます。

$discount = if ( $age -ge 55 )
{
    Get-SeniorDiscount
}
elseif ( $age -le 13 )
{
    Get-ChildDiscount
}
else
{
    0.00
}

各スクリプトブロックは、コマンドまたは値の結果を出力として書き込みます。 if ステートメントの結果を $discount 変数に代入できます。その例では、それらの値を直接、各スクリプトブロック内の $discount 変数に簡単に割り当てることができました。私は、if ステートメントでこれを頻繁に使用しているとは言えませんが、確かにこれを最近使用した例があります。

代替実行パス

if ステートメントを使用すると、ステートメントが $true のときだけでなく、$false のときのためにもアクションを指定できます。ここで else ステートメントが登場します。

else

else ステートメントは、使用されるときには常に if ステートメントの最後の部分です。

if ( Test-Path -Path $Path -PathType Leaf )
{
    Move-Item -Path $Path -Destination $archivePath
}
else
{
    Write-Warning "$path doesn't exist or isn't a file."
}

この例では、$path を調べて、それがファイルであることを確認します。ファイルが見つかった場合は、それを移動します。そうでない場合は、警告を書き出します。この種類の分岐ロジックは非常に一般的です。

入れ子の if

if ステートメントと else ステートメントではスクリプトブロックを取るため、その他の if ステートメントを含め、任意の PowerShell コマンドをブロック内に配置できます。これにより、はるかに複雑なロジックを使用できるようになります。

if ( Test-Path -Path $Path -PathType Leaf )
{
    Move-Item -Path $Path -Destination $archivePath
}
else
{
    if ( Test-Path -Path $Path )
    {
        Write-Warning "A file was required but a directory was found instead."
    }
    else
    {
        Write-Warning "$path could not be found."
    }
}

この例では、まずハッピーパスをテストしてから、それに対してアクションを実行します。失敗した場合は別のチェックを行い、より詳細な情報を、ユーザーに提供します。

elseif

単一の条件付きチェックのみに限定されているわけではありません。 elseif ステートメントを使用してステートメントを入れ子にするのではなく、if ステートメントと else ステートメントをまとめて連結できます。

if ( Test-Path -Path $Path -PathType Leaf )
{
    Move-Item -Path $Path -Destination $archivePath
}
elseif ( Test-Path -Path $Path )
{
    Write-Warning "A file was required but a directory was found instead."
}
else
{
    Write-Warning "$path could not be found."
}

実行は、最上部から最下部へと行われます。最上位の if ステートメントが最初に評価されます。それが $false の場合は、リスト内で次にある elseif または else まで移動します。最後の else は、他のどれからも $true が返されない場合に実行する既定のアクションです。

スイッチ

この時点で、switch ステートメントに触れる必要があります。 1 つの値で複数の比較を行うための代替構文を提供します。 switch を使用して、式を指定し、その結果を異なるいくつかの値と比較します。それらの値のいずれかが一致すると、一致するコードブロックが実行されます。次の例を見てください。

$itemType = 'Role'
switch ( $itemType )
{
    'Component'
    {
        'is a component'
    }
    'Role'
    {
        'is a role'
    }
    'Location'
    {
        'is a location'
    }
}

$itemType と一致する可能性がある候補の値が 3 つあります。この場合は Role と一致します。 switch 演算子に触れる機会となるように、私は単純な例を使用しました。別の記事で、switch ステートメントについて知りたかったことのすべてについて詳しく説明しています。

インライン配列

いくつかのコマンドライン引数を指定して実行可能ファイルを起動する、Invoke-SnowSql という名前の関数があります。ここに、引数の配列を構築する関数からのクリップを示します。

$snowSqlParam = @(
    '--accountname', $Endpoint
    '--username', $Credential.UserName
    '--option', 'exit_on_error=true'
    '--option', 'output_format=csv'
    '--option', 'friendly=false'
    '--option', 'timing=false'
    if ($Debug)
    {
        '--option', 'log_level=DEBUG'
    }
    if ($Path)
    {
        '--filename', $Path
    }
    else
    {
        '--query', $singleLineQuery
    }
)

$Debug 変数と $Path 変数は、エンドユーザーによって指定される、関数に対するパラメーターです。これらは、配列の初期化中にインラインで評価します。 $Debug が true の場合、それらの値は正しい場所の $snowSqlParam に格納されます。 $Path 変数についても、同じことが当てはまります。

複雑な操作を簡略化する

確認する比較が多すぎて If ステートメントが画面右側の遠くの方へスクロールされてしまうという状況を避けることはできません。

$user = Get-ADUser -Identity $UserName
if ( $null -ne $user -and $user.Department -eq 'Finance' -and $user.Title -match 'Senior' -and $user.HomeDrive -notlike '\\server\*' )
{
    # Do Something
}

読むのが難しい場合があり、それが理由でよりミスをしやすくなります。これについては、できることがいくつかあります。

行の連結

PowerShell には、コマンドを次の行にラップするための演算子がいくつかあります。論理演算子 -and および -or は、式を複数行に分割する場合に使うのに適した演算子です。

if ($null -ne $user -and
    $user.Department -eq 'Finance' -and
    $user.Title -match 'Senior' -and
    $user.HomeDrive -notlike '\\server\*'
)
{
    # Do Something
}

それでも続行する作業は多数ありますが、各部分をそれぞれの行に配置することで大きな違いが生じます。私が通常これを使用するのは、2 つ以上の比較を取得する場合や、ロジックを読むために右にスクロールする必要がある場合です。

結果の事前計算

if ステートメントから目的のステートメントを取り出して、結果だけを調べることができます。

$needsSecureHomeDrive = $null -ne $user -and
    $user.Department -eq 'Finance' -and
    $user.Title -match 'Senior' -and
    $user.HomeDrive -notlike '\\server\*'

if ( $needsSecureHomeDrive )
{
    # Do Something
}

これはただ、前の例よりずっとすっきりしているように感じます。また、実際に調べようとしていることが何であるかを説明する変数名を使用できます。これは、不要なコメントを節約する自己文書化コードの例でもあります。

複数の if ステートメント

これを複数のステートメントに分割し、一度に 1 つずつ調べることができます。この場合、結果を結合するためにフラグまたは追跡用の変数を使用します。


$skipUser = $false

if( $null -eq $user )
{
    $skipUser = $true
}

if( $user.Department -ne 'Finance' )
{
    Write-Verbose "isn't in Finance department"
    $skipUser = $true
}

if( $user.Title -match 'Senior' )
{
    Write-Verbose "Doesn't have Senior title"
    $skipUser = $true
}

if( $user.HomeDrive -like '\\server\*' )
{
    Write-Verbose "Home drive already configured"
    $skipUser = $true
}

if ( -not $skipUser )
{
    # do something
}

実際には、フラグロジックが正しく機能するように、ロジックを反転する必要がありました。各評価は、個々の if ステートメントです。この利点は、デバッグ中に、ロジックで何を実行中であるかを正確に知ることができることです。同時に、ずっと役立つ詳細を追加できました。

明らかなマイナス面は、記述するコードがずっと多いことです。コードは、1 行のロジックを取得し、それを 25 行以上に展開するため、より複雑に見えます。

関数の使用

そうした検証ロジックすべてを、1 つの関数に移すこともできます。一目で、これがどれほどすっきりしているかがわかります。

if ( Test-SecureDriveConfiguration -ADUser $user )
{
    # do something
}

まだ、検証を実行する関数を作成する必要はありますが、このコードはずっと扱いやすくなっています。このコードをテストするのも容易になっています。テストでは、Test-ADDriveConfiguration への呼び出しを模倣できるので、この関数に必要なテストは 2 つだけです。 1 つはそこで $true を返し、もう 1 つはそこで $false を返します。その他の関数のテストは、関数が非常に小さいためより簡単です。

その関数の本体は、開始時に使った 1 行バージョンである場合も、最後のセクションで使用した、展開されたロジックと同じである場合もあります。これは、どちらのシナリオでも正しく機能し、後でその実装を簡単に変更できます。

エラー処理

if ステートメントの重要な用途の 1 つは、エラーが発生する前にエラー条件を調べることです。フォルダーが既に存在するかどうかを確認してからフォルダーを作成することが、良い例です。

if ( -not (Test-Path -Path $folder) )
{
    New-Item -Type Directory -Path $folder
}

例外の発生を予期している場合、それは実際には例外ではないとも言えます。そのため、値を確認し、可能な場合は条件を検証します。

実際の例外処理についてもう少し詳しく知りたい場合は、例外について知りたかったことのすべてに関するページを参照してください。

まとめ

if ステートメントはあのように単純なステートメントですが、PowerShell の基本となっている部分です。これは、自分が記述するほとんどすべてのスクリプトで、複数回使用しているのに気付くことになります。以前よりも理解を深めていただけたならば幸いです。

`if` ステートメントについて知りたかったことのすべて

条件付き実行

`if` ステートメント

比較演算子

-eq (等価性)

-ne (等しくない)

-gt -ge -lt -le (より大きい、より小さい)

-like (ワイルドカードの一致)

-match (正規表現)

-is (型)

コレクション演算子

-contains

-in

論理演算子

-not

! operator

-and

-or

-xor (排他的 OR)

ビットごとの演算子

PowerShell の式

$null の確認

条件内の変数代入

スクリプトブロックからの変数代入

代替実行パス

else

入れ子の if

elseif

スイッチ

インライン配列

複雑な操作を簡略化する

行の連結

結果の事前計算

複数の if ステートメント

関数の使用

エラー処理

まとめ

フィードバック

その他のリソース

if ステートメントについて知りたかったことのすべて

条件付き実行

if ステートメント

比較演算子

-eq (等価性)

-ne (等しくない)

-gt -ge -lt -le (より大きい、より小さい)

-like (ワイルドカードの一致)

-match (正規表現)

-is (型)

コレクション演算子

-contains

-in

論理演算子

-not

! operator

-and

-or

-xor (排他的 OR)

ビットごとの演算子

PowerShell の式

$null の確認

条件内の変数代入

スクリプトブロックからの変数代入

代替実行パス

else

入れ子の if

elseif

スイッチ

インライン配列

複雑な操作を簡略化する

行の連結

結果の事前計算

複数の if ステートメント

関数の使用

エラー処理

まとめ

フィードバック

その他のリソース

`if` ステートメントについて知りたかったことのすべて

`if` ステートメント