Ein Array bleibt ein Array – Typsicherheit durch PowerShell Klassen

Schütze deine PowerShell-Skripte vor Fehlkonfigurationen. Hier findest du eine typsichere Methode zum Importieren externer Informationen in deine Skripte. 

Füge mit PowerShell-Klassen Typsicherheit hinzu

Im letzten Schritt unserer Miniserie fügen wir dem Lesen von Daten aus *.psd1 Robustheit und Widerstandsfähigkeit hinzu: Das Skript, das die *.psd1-Datei liest, wendet eine einfache, aber leistungsstarke Typüberprüfung an. Keine böswillige Person (oder ein unerfahrener Auszubildender) kann unerlaubte Schlüssel hinzufügen, Tippfehler lösen sofort eine Warnung aus, und erhalte Typsicherheit: Daten, die als Array (Liste) gedacht sind, bleiben ein Array, auch wenn die *.psd1-Datei nur einen (oder keinen) Wert für diesen Schlüssel definiert.

Wir versuchen, das noch zu verbessern. Hier ist wieder die *.psd1-Datei. Diesmal habe ich das Präfix "data" aus den Schlüsseln entfernt, da dieses Präfix nicht mehr benötigt wird, wenn alle Informationen in einem Objekt gespeichert sind, und die Datei als data_new.psd1 gespeichert:

@{

   # Pfade zu wichtigen Ordnern

   InPath = 'c:\data1', '\\server2\public\data'

   OutPath = '\\server99\public\results'

   LogPath = 'f:\local\log'



   # AD-Gruppen 

   Groups = 'Technicians', 'Testers', 'Auditors'



   # Diverse Einstellungen

   TimeoutSeconds = 5400

   LogLevel = 4

} 

Hier siehst du, wie wir zuvor die *.psd1-Datei geladen und ihre Informationen in ein Objekt umgewandelt haben (stelle sicher, dass sich beide Dateien im selben Ordner befinden):

# data.psd1 muss sich im gleichen Ordner befinden

$dataPath = Join-Path -Path $PSScriptRoot -ChildPath data_new.psd1



# Hash-Tabellenschlüssel in Variablen umwandeln

$hashObject = [PSCustomObject](Import-PowerShellDataFile -Path $dataPath)

Das funktionierte gut, aber es gab keine strikte Typdeklaration, die die importierten Daten schützte und sicherstellte, dass sie tatsächlich auf die richtige Weise strukturiert waren.

Dank der (in Windows PowerShell 5 hinzugefügten) Klassen ist das Hinzufügen sehr einfach: Füge deinem Skript eine Klasse hinzu, die die Reihenfolge und den Datentyp der Objekteigenschaften festlegt, und übertrage das Objekt dann auf diese Klasse.

Zusatztipp: Verwende für numerische Listen wie "LogLevel" entweder den Datentyp [int], oder füge besser noch eine Aufzählung mit freundlichen Namen hinzu, die die zulässigen numerischen Werte auf eine feste Liste beschränkt (siehe unten):

enum LogLevel

{

   Information = 1

   Verbose = 2

   Debug = 3

   All = 4

}



# Definieren die Struktur deiner Eingabedaten 

class configDataScript1

{

   # Pfade 

   [string[]]$InPath

   [string[]]$OutPath

   [string]$LogPath



   # AD-Gruppen 

   [string[]]$Groups



   # Diverse Einstellungen

   [int]$ZeitüberschreitungSekunden

   [LogLevel]$LogLevel

}



# data.psd1 muss sich im gleichen Ordner befinden

$dataPath = Join-Path -Path $PSScriptRoot -ChildPath data_new.psd1



# sicheres Lesen der psd1-Datei (Achtung: unsichere Lesevorgänge können Code innerhalb der psd1-Datei ausführen)

[configDataScript1]$externalData = [PSCustomObject](Import-PowerShellDataFile -Path $dataPath)


$externalData

$externalData.GetType().FullName 

Das Ergebnis kann sich sehen lassen: mit minimalem Aufwand hast du *.psd1-Dateien in eine leistungsfähige und typsichere Möglichkeit verwandelt, externe Informationen in deine Skripte zu importieren.

Extra-Tipp: Das Casting von Objekten in selbst erstellte Klassendefinitionen funktioniert mit einer Vielzahl von Daten. Du kannst die gleiche Technik zum Beispiel auf importierte CSV-Dateien anwenden. Vergewissere dich nur, dass die Klassendefinition genau mit den Namen deiner Eigenschaften übereinstimmt und dass jeder Eigenschaftswert tatsächlich in den Datentyp konvertiert werden kann, den die Klasse erfordert.

Alle vier Tipps rund um das Thema 'Externe Konfigurationsdaten nutzen': 

Jeder Tipp baut schrittweise darauf auf, eine verwaltbarere, effizientere und sicherere Methode zur Handhabung von Konfigurationsdaten in PowerShell-Skripten zu schaffen, wobei von einfachen Hash-Tabellen zu fortgeschritteneren typsicheren Objekten übergegangen wird.

• Grundlegende externe Konfigurationen mit Hash-Tabellen
  Schluss mit Hardcoding von Pfaden und Einstellungen! Erfahre hier, wie du deine PowerShell-Skripte vereinfachen kannst, indem du Konfigurationsdaten separat mit Hash-Tabellen in *.psd1-Dateien speicherst.
  
  
• Konvertiere Hash-Tabellen in PowerShell Variablen
  Müde vom Suchen in Hash-Tabellen? Hier kommt der Trick, wie du Konfigurationseinstellungen direkt als Variablen nutzt und deine Skripte so leicht lesbar machst.
  
  
• Erhöhe die Benutzerfreundlichkeit mit Objekt-Konvertierung
  Mach deine Konfigurationsdaten smarter! Konvertiere Hash-Tabellen in Objekte für intuitiven Zugriff und Code, der sich praktisch von selbst schreibt.
  
  
• Erhöhe die Typsicherheit mit PowerShell-Klassen
  Schütze deine PowerShell-Skripte vor Fehlkonfigurationen. Benutzerdefinierte Klassen bieten Struktur, Kontrolle und Typsicherheit für robuste, fehlerfreie Skripte.

Weiterführende Links 

• ScriptRunner ActionPacks  helfen dir, Aufgaben zu automatisieren
• Teste ScriptRunner!
• Erlebe ScriptRunner in Aktion – Buche jetzt eine Demo