本
PowerShell
第5章. 良いコーディングの実践
リファクタリング

PowerShell:
リファクタリング

方法

PowerShellには専用のリファクタリングツールは組み込まれていませんが、読みやすさやパフォーマンスのためにコードを整理することはできます。多くの処理を行っている関数を考え、それを明確にリファクタリングする方法を検討してみましょう：

function Get-InventoryData {
    # データ取得とフォーマットを組み合わせた元の関数
    $data = Get-Content -Path 'C:\inventory-list.txt'
    $inventoryData = $data | ForEach-Object {
        $fields = $_ -split ','
        [PSCustomObject]@{
            ItemID = $fields[0]
            Name   = $fields[1]
            Count  = $fields[2]
            Price  = $fields[3]
        }
    }
    $inventoryData | Format-Table -AutoSize
}

# 関数を分割してリファクタリング
function Import-InventoryData {
    param($Path)
    Get-Content -Path $Path | ForEach-Object {
        $fields = $_ -split ','
        [PSCustomObject]@{
            ItemID = $fields[0]
            Name   = $fields[1]
            Count  = $fields[2]
            Price  = $fields[3]
        }
    }
}

function Format-InventoryData {
    param($Data)
    $Data | Format-Table -AutoSize
}

# 使用例
$inventory = Import-InventoryData -Path 'C:\inventory-list.txt'
Format-InventoryData -Data $inventory

サンプル出力：

ItemID Name            Count Price
------ ----            ----- -----
1001   Widget Type A   50    9.99
1002   Gadget Type B   20    14.99

掘り下げ

プログラミングにおけるリファクタリングは、ソフトウェア開発の最初の日から根付いていますが、1990年代に一般的な実践として形式化されました。マーチン・ファウラーの著書「Refactoring: Improving the Design of Existing Code」は、クリーンなコードを達成するためにリファクタリングの重要性を強調した基本的な作品の一つです。

PowerShellには、他の言語のいくつかの統合開発環境（IDE）（EclipseやVisual Studioなど）のような特定のリファクタリングツールが付属していませんが、手動で良いリファクタリングの原則を実践することはできます。リファクタリングは単にコードを変更することではなく、コードの構造とデザインを向上させるための意図的で、振る舞いを保持する変更を行うことであることを覚えておくことが重要です。

PowerShellでの手動リファクタリングに代わるものには、言語をサポートするIDE（例えば、PowerShell拡張機能を備えたVisual Studio Code）を使用することが含まれます。これは、コードのフォーマットや基本的なリファクタリング機能のような特徴を提供します。より大規模なリファクタリングには、変更が機能に影響を与えないことを確認するためにPesterテストを活用することを検討するかもしれません。

また、リファクタリングの実装には、コードを再利用可能なモジュールまたは関数に分割するような、よりシステム的な変更が含まれることがあります。これはDRY（Don’t Repeat Yourself）の原則の遵守を改善します。その他の一般的なリファクタリングの技法には、明確性のための名前変更、重複コードの削除、条件ロジックの複雑さの削減が含まれます。

参照

さらに深く掘り下げるために、以下のリソースをご覧ください：

コードを関数に整理する