PowerShell スクリプト ベストプラクティス ガイド

概要

本記事では、PowerShellスクリプトのベストプラクティスについて、コード構造、出力フォーマット、エラーハンドリング、パフォーマンス最適化、セキュリティ対策を中心に解説します。

なぜ重要か

PowerShellスクリプトのベストプラクティスを遵守することで、可読性・保守性・セキュリティ・パフォーマンスが向上します。これにより、技術的負債を減らし、チームでの協業や本番環境でのリスクを最小限に抑えることができます。

実践方法

ツールとコントローラーの設計

「ツール」か「コントローラー」かを判断する

  • ツール：再利用可能な関数やモジュール。
  • コントローラー：特定のタスクを自動化するスクリプト（再利用を想定しない）。

コードをモジュール化する

  • 関数やスクリプトモジュールを活用し、再利用性を高める。

標準の命名規則を使用する

  • PowerShellの承認済み動詞（Get-Verb）を使った動詞-名詞形式を守る。

パラメーター名を統一する

  • $ComputerNameのような標準的な名前を使用する。

ツールは生データを出力する

  • 柔軟性を保つため、最低限の加工データを出力。

コントローラーは整形済みデータを出力する

  • ユーザー向けの見やすいレポート形式にする。

例

function Get-DiskInfo {
    param ([string]$ComputerName)
    Get-WmiObject Win32_LogicalDisk -ComputerName $ComputerName
}

車輪の再発明を避ける

独自のping関数を作らず、Test-Connectionのような組み込みコマンドレットを利用する。

# 推奨
Test-Connection $ComputerName -Quiet

パラメーターブロックの書き方

常にヘルプを記述する

.SYNOPSIS、.DESCRIPTION、.EXAMPLEを含むコメントベースのヘルプを追加する。

function Test-Help {
    <#
        .SYNOPSIS
            適切なヘルプドキュメントの例。
        .EXAMPLE
            Test-Help -MandatoryParameter "Example"
            必須パラメーターでTest-Helpを実行。
    #>
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [Alias("MP")]
        [String]$MandatoryParameter
    )
}

[CmdletBinding()] を使用する

-Verbose や -Debug などの共通パラメーターを有効化。

-WhatIf と -Confirm をサポートする

状態変更を伴う処理には SupportsShouldProcess を使用。

[CmdletBinding(SupportsShouldProcess, ConfirmImpact = "Medium")]
param ([switch]$Force)

パラメーターは強く型指定する

バリデーションと可読性向上のため、型指定を行う。

param (
    [string]$Name,
    [int]$Count
)

[switch] の正しい使い方

  • デフォルトは $false。
  • ブール値として扱い、三値論理のように使わない。

出力フォーマット

不要な Write-Host の使用を避ける

状況に応じて Write-Verbose、Write-Debug、Write-Output を使い分ける。

進捗表示には Write-Progress を使う

Write-Progress -Activity "処理中" -Status "50% 完了" -PercentComplete 50

カスタムオブジェクトの整形はフォーマットファイルを使う

.format.ps1xml を定義する。

出力は常に単一の型にする

[OutputType()] を活用し、型の混在を避ける。

エラーハンドリングのベストプラクティス

コマンドレットには -ErrorAction Stop を使用する

try-catchで適切にエラー処理を行う。

try {
    Get-Item "C:\InvalidPath" -ErrorAction Stop
} catch {
    Write-Warning "対象が見つかりません。"
}

非コマンドレットには $ErrorActionPreference を使用

リスクのある処理の前後で設定する。

フラグや $? に頼らない

構造化された try-catch を使う。

catch 内で $Error[0] や $_ をすぐコピーする

catch {
    $errorDetails = $_
    Write-Error "エラー発生: $($errorDetails.Exception.Message)"
}

パフォーマンス最適化

PERF-01 パフォーマンスは必要な時だけ測定する

Measure-Command を使って検証する。

Measure-Command {
    foreach ($item in $data) { Process-Item $item }
}

PERF-02 可読性とパフォーマンスのバランスを取る

  • 小規模データなら可読性重視。
  • 大規模データならストリーミングや.NETを検討。

可読性重視：

$content = Get-Content -Path file.txt
foreach ($line in $content) {
    Do-Something -Input $line
}

パフォーマンス重視：

Get-Content -Path file.txt | ForEach-Object {
    Do-Something -Input $_
}

さらに高速な.NET使用例：

$sr = New-Object System.IO.StreamReader "file.txt"
while ($sr.Peek() -ge 0) {
    $line = $sr.ReadLine()
    Do-Something -Input $line
}

PERF-03 言語機能を優先する

  • foreach > .NETメソッド > スクリプト > コマンドレット/パイプライン
  • 早すぎる最適化は避け、必ず測定すること。

セキュリティのベストプラクティス

資格情報は必ず PSCredential を使う

平文パスワードは避け、[Credential()] で受け取る。

param (
    [System.Management.Automation.PSCredential]
    [System.Management.Automation.Credential()]
    $Credential
)

APIに渡す場合：

$Insecure.SetPassword($Credential.GetNetworkCredential().Password)

機密データには SecureString を使う

安全にプロンプトし、暗号化して保存。

$Secure = Read-Host -Prompt "機密データを入力" -AsSecureString

復号化する場合：

$BSTR = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($Secure)
$PlainText = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto($BSTR)
[System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($BSTR)

資格情報の安全な保存

Export-CliXml を使用する。

Get-Credential | Export-CliXml -Path C:\secure\cred.xml
$Credential = Import-CliXml -Path C:\secure\cred.xml

暗号化文字列の保存

ConvertFrom-SecureString -SecureString $Secure | Out-File -Path "${Env:AppData}\secure.bin"
$Secure = Get-Content -Path "${Env:AppData}\secure.bin" | ConvertTo-SecureString

結論

設計・ドキュメント・出力処理・エラーハンドリング・パフォーマンス・セキュリティの各観点でベストプラクティスを守ることで、堅牢で保守性の高い効率的なPowerShellスクリプトを作成できます。可読性・パフォーマンス・セキュリティのバランスを意識し、高品質な自動化ソリューションを提供しましょう。

タイトルとURLをコピーしました