Cookbooks
PowerShell
Kapitel 5. Gute Programmierpraktiken
Refactoring

PowerShell:
Refactoring

Wie:

PowerShell bietet kein eigenes, dediziertes Refactoring-Tool, aber Sie können trotzdem Ihren Code bereinigen, um Lesbarkeit und Leistung zu verbessern. Betrachten Sie eine Funktion, die zu viel macht, und wie wir sie für mehr Klarheit refactorn könnten:

function Get-InventoryData {
    # Ursprüngliche Funktion, die Datenabruf und Formatierung kombiniert
    $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
}

# Refaktoriert in separate Funktionen
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
}

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

Beispielausgabe:

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

Vertiefung

Refactoring in der Programmierung hat seine Wurzeln, die bis in die frühesten Tage der Softwareentwicklung zurückreichen, obwohl es in den 1990er Jahren als Praxis formalisiert wurde. Martin Fowlers Buch “Refactoring: Improving the Design of Existing Code” ist eines der grundlegenden Werke zum Thema und betont die Bedeutung des Refactorings, um sauberen Code zu erreichen.

Obwohl PowerShell nicht mit spezifischen Refactoring-Tools wie einige Integrierte Entwicklungsumgebungen (IDEs) für andere Sprachen (denken Sie an Eclipse oder Visual Studio) ausgestattet ist, können Sie trotzdem gute Refactoring-Prinzipien manuell praktizieren. Das Wichtigste, an das Sie sich erinnern sollten, ist, dass Refactoring nicht nur darum geht, Code um des Änderns willen zu ändern, sondern um intentionale, verhaltensbewahrende Modifikationen vorzunehmen, die die Struktur und das Design des Codes verbessern.

Alternativen zum manuellen Refactoring in PowerShell umfassen die Verwendung von IDEs, die die Sprache unterstützen, wie Visual Studio Code mit der PowerShell-Erweiterung, die Funktionen wie Codeformatierung und grundlegende Refactoring-Fähigkeiten bietet. Für umfangreicheres Refactoring könnten Sie in Betracht ziehen, Pester-Tests zu nutzen, um sicherzustellen, dass Änderungen die Funktionalität nicht verändern.

Darüber hinaus kann die Implementierung von Refactoring systemischere Änderungen wie Modularisierung umfassen, bei der Code in wiederverwendbare Module oder Funktionen aufgeteilt wird, was die Einhaltung des DRY-Prinzips (Don’t Repeat Yourself) verbessert. Andere übliche Refactoring-Techniken umfassen die Umbenennung zur Klärung, das Entfernen von doppeltem Code und die Reduzierung der Komplexität von bedingter Logik.

Siehe auch

Für eine tiefergehende Betrachtung finden Sie hier einige Ressourcen:

Code in Funktionen organisieren