Powershell פונקציונלי עם שיעורים הוא לא אוקסימורון, אני מבטיח את זה

היי הבר! אני מציג לתשומת לבך את התרגום של המאמר "PowerShell פונקציונלי עם שיעורים.
אני מבטיח שזה לא אוקסימורון" מאת כריסטופר קיך.

פרדיגמות תכנות מונחה עצמים ופונקציונליות עשויות להיראות מנוגדות זו לזו, אך שתיהן נתמכות באותה מידה ב- Powershell. כמעט לכל שפות התכנות, פונקציונליות או לא, יש מתקנים לקשירת שם-ערך מורחבת; שיעורים, כמו מבנים ושיאים, הם רק גישה אחת. אם נגביל את השימוש שלנו ב-Class לקשירת שמות וערכים, ונימנע ממושגי תכנות כבדים מונחה עצמים כמו ירושה, פולימורפיזם או שינוי, נוכל לנצל את היתרונות שלהם מבלי לסבך את הקוד שלנו. יתר על כן, על ידי הוספת שיטות המרה מסוגים בלתי ניתנים לשינוי, אנו יכולים להעשיר את הקוד הפונקציונלי שלנו עם Classes.

הקסם של הקסטות

קאסטות הן אחת התכונות החזקות ביותר ב- Powershell. כאשר אתה מטיל ערך, אתה מסתמך על יכולות האתחול והאימות המרומזים שהסביבה מוסיפה ליישום שלך. לדוגמה, פשוט יציקת מחרוזת ב-[xml] תפעיל אותה דרך קוד המנתח ותיצור עץ xml שלם. אנחנו יכולים להשתמש בשיעורים בקוד שלנו לאותה מטרה.

טבלאות hashtables

אם אין לך בנאי, אתה יכול להמשיך בלי אחד על ידי יציקת hashtable לסוג הכיתה שלך. אל תשכח להשתמש בתכונות האימות כדי לנצל את מלוא היתרונות של דפוס זה. יחד עם זאת, אנו יכולים להשתמש במאפיינים המוקלדים של המחלקה כדי להפעיל לוגיקית אתחול ואימות עמוק עוד יותר.

class Cluster {
    [ValidatePattern("^[A-z]+$")]
    [string] $Service
    [ValidateSet("TEST", "STAGE", "CANARY", "PROD")]
    [string] $FlightingRing
    [ValidateSet("EastUS", "WestUS", "NorthEurope")]
    [string] $Region
    [ValidateRange(0, 255)]
    [int] $Index
}

[Cluster]@{
    Service       = "MyService"
    FlightingRing = "PROD"
    Region        = "EastUS"
    Index         = 2
}

בנוסף, הליהוק עוזר לקבל תפוקה נקייה. השווה את הפלט של מערך ה-hashtable של Cluster המועבר ל-Format-Table עם מה שאתה מקבל אם אתה מטיל לראשונה את הטבלאות ה-hashtable האלה למחלקה. המאפיינים של מחלקה מופיעים תמיד בסדר שבו הם מוגדרים שם. אל תשכח להוסיף את מילת המפתח הנסתרת לפני כל אותם מאפיינים שאתה לא רוצה שיוצגו בתוצאות.

יצוק של משמעויות

אם יש לך בנאי עם ארגומנט אחד, יציקת ערך לסוג המחלקה שלך תעביר את הערך לבנאי שלך, שם תוכל לאתחל מופע של המחלקה שלך

class Cluster {
    [ValidatePattern("^[A-z]+$")]
    [string] $Service
    [ValidateSet("TEST", "STAGE", "CANARY", "PROD")]
    [string] $FlightingRing
    [ValidateSet("EastUS", "WestUS", "NorthEurope")]
    [string] $Region
    [ValidateRange(0, 255)]
    [int] $Index

    Cluster([string] $id) {
        $this.Service, $this.FlightingRing, $this.Region, $this.Index = $id -split "-"
    }
}

[Cluster]"MyService-PROD-EastUS-2"

יצוק לקו

אתה יכול גם לעקוף את שיטת המחלקה [string] ToString() כדי להגדיר את ההיגיון מאחורי ייצוג המחרוזת של האובייקט, כגון שימוש באינטרפולציה של מחרוזת.

class Cluster {
    [ValidatePattern("^[A-z]+$")]
    [string] $Service
    [ValidateSet("TEST", "STAGE", "CANARY", "PROD")]
    [string] $FlightingRing
    [ValidateSet("EastUS", "WestUS", "NorthEurope")]
    [string] $Region
    [ValidateRange(0, 255)]
    [int] $Index

    [string] ToString() {
        return $this.Service, $this.FlightingRing, $this.Region, $this.Index -join "-"
    }
}

$cluster = [Cluster]@{
    Service       = "MyService"
    FlightingRing = "PROD"
    Region        = "EastUS"
    Index         = 2
}

Write-Host "We just created a model for '$cluster'"

Cast מופעים בסידרה

Cast מאפשר דה-סריאליזציה בטוחה. הדוגמאות שלהלן ייכשלו אם הנתונים לא עומדים במפרט שלנו ב-Cluster

# Валидация сериализованных данных

[Cluster]$cluster = Get-Content "./my-cluster.json" | ConvertFrom-Json
[Cluster[]]$clusters = Import-Csv "./my-clusters.csv"

מטיל את הקוד הפונקציונלי שלך

תוכניות פונקציונליות מגדירות תחילה מבני נתונים, ולאחר מכן מיישמות את התוכנית כרצף של טרנספורמציות על פני מבני נתונים בלתי ניתנים לשינוי. למרות הרושם הסותר, שיעורים באמת עוזרים לך לכתוב קוד פונקציונלי הודות לשיטות המרה מסוג.

האם ה- Powershell שאני כותב פונקציונלי?

הרבה אנשים שמגיעים מרקע C# או דומה כותבים Powershell, שדומה ל-C#. על ידי כך, אתה מתרחק משימוש במושגי תכנות פונקציונליים וסביר להניח שתפיק תועלת מצלילה רבה לתכנות מונחה עצמים ב- Powershell או ללמוד עוד על תכנות פונקציונלי.

אם אתה מסתמך במידה רבה על המרת נתונים בלתי ניתנים לשינוי באמצעות צינורות (|), Where-Object, ForEach-Object, Select-Object, Group-Object, Sort-Object וכו' - יש לך סגנון פונקציונלי יותר ותרוויח מהשימוש ב- Powershell שיעורים בסגנון פונקציונלי.

שימוש פונקציונלי בשיעורים

קאסטות, למרות שהן משתמשות בתחביר חלופי, הן רק מיפוי בין שני תחומים. בצינור, אתה יכול למפות מערך של ערכים באמצעות ForEach-Object.

בדוגמה למטה, בנאי ה-Node מבוצע בכל פעם ש-Datum מוטל, וזה נותן לנו את ההזדמנות לא לכתוב כמות נכבדת של קוד. כתוצאה מכך, הצינור שלנו מתמקד בשאילתות וצבירה של נתונים הצהרתיים, בעוד שהשיעורים שלנו דואגים לניתוח ואימות נתונים.

# Пример комбинирования классов с конвейерами для separation of concerns в конвейерах

class Node {
    [ValidateLength(3, 7)]
    [string] $Name
    [ValidateSet("INT", "PPE", "PROD")]
    [string] $FlightingRing
    [ValidateSet("EastUS", "WestUS", "NorthEurope", "WestEurope")]
    [string] $Region
    Node([string] $Name) {
        $Name -match "([a-z]+)(INT|PPE|PROD)([a-z]+)"
        $_, $this.Service, $this.FlightingRing, $this.Region = $Matches
        $this.Name = $Name
    }
}

class Datum {
    [string] $Name
    [int] $Value
    [Node] $Computer
    [int] Severity() {
        $this.Name -match "[0-9]+$"
        return $Matches[0]
    }
}

Write-Host "Urgent Security Audit Issues:"
Import-Csv "./audit-results.csv" `
    | ForEach-Object {[Datum]$_} `
    | Where-Object Value -gt 0 `
    | Group-Object {$_.Severity()} `
    | Where-Object Name -lt 2 `
    | ForEach-Object Group `
    | ForEach-Object Computer `
    | Where-Object FlightingRing -eq "PROD" `
    | Sort-Object Name, Region -Unique

כיתת אריזה לשימוש חוזר

שום דבר לא טוב כמו שזה נראה

למרבה הצער, לא ניתן לייצא מחלקות על ידי מודולים באותו אופן כמו פונקציות או משתנים; אבל יש כמה טריקים. נניח שהשיעורים שלך מוגדרים בקובץ ./my-classes.ps1

• אתה יכול dotsource קובץ עם מחלקות:. ./my-classes.ps1. זה יפעיל את my-classes.ps1 בהיקף הנוכחי שלך ויגדיר את כל המחלקות מהקובץ שם.

• אתה יכול ליצור מודול Powershell שמייצא את כל ממשקי ה-API המותאמים אישית שלך (cmdlets) ולהגדיר את המשתנה ScriptsToProcess = "./my-classes.ps1" במניפסט המודול שלך, עם אותה תוצאה: ./my-classes.ps1 יבוצע ב- הסביבה שלך.

לא משנה באיזו אפשרות תבחר, זכור שמערכת הסוג של Powershell לא יכולה לפתור סוגים בעלי אותו שם שנטענים ממקומות שונים.
גם אם טענת שתי מחלקות זהות עם אותם מאפיינים ממקומות שונים, אתה עלול להיתקל בבעיות.

הדרך קדימה

הדרך הטובה ביותר להימנע מבעיות ברזולוציה של סוגים היא לעולם לא לחשוף את השיעורים שלך למשתמשים. במקום לצפות מהמשתמש לייבא סוג מוגדר בכיתה, ייצא פונקציה מהמודול שלך שמבטלת את הצורך לגשת ישירות למחלקה. עבור Cluster, נוכל לייצא פונקציית New-Cluster שתתמוך בערכות פרמטרים ידידותיות למשתמש ותחזיר Cluster.

class Cluster {
    [ValidatePattern("^[A-z]+$")]
    [string] $Service
    [ValidateSet("TEST", "STAGE", "CANARY", "PROD")]
    [string] $FlightingRing
    [ValidateSet("EastUS", "WestUS", "NorthEurope")]
    [string] $Region
    [ValidateRange(0, 255)]
    [int] $Index
}

function New-Cluster {
    [OutputType([Cluster])]
    Param(
        [Parameter(Mandatory, ParameterSetName = "Id", Position = 0)]
        [ValidateNotNullOrEmpty()]
        [string] $Id,
        [Parameter(Mandatory, ParameterSetName = "Components")]
        [string] $Service,
        [Parameter(Mandatory, ParameterSetName = "Components")]
        [string] $FlightingRing,
        [Parameter(Mandatory, ParameterSetName = "Components")]
        [string] $Region,
        [Parameter(Mandatory, ParameterSetName = "Components")]
        [int] $Index
    )

    if ($Id) {
        $Service, $FlightingRing, $Region, $Index = $Id -split "-"
    }

    [Cluster]@{
        Service       = $Service
        FlightingRing = $FlightingRing
        Region        = $Region
        Index         = $Index
    }
}

Export-ModuleMember New-Cluster

מה עוד לקרוא

לגבי שיעורים
PowerShell הגנתי
תכנות פונקציונלי ב- PowerShell

מקור: www.habr.com