Функционалният Powershell с класове не е оксиморон, гарантирам го

Хей Хабр! Представям на вашето внимание превода на статията „Функционален PowerShell с класове.
Обещавам, че не е оксиморон" от Кристофър Куех.

Парадигмите на обектно-ориентираното и функционалното програмиране може да изглеждат в противоречие една с друга, но и двете се поддържат еднакво в Powershell. Почти всички езици за програмиране, функционални или не, имат възможности за разширено свързване на име-стойност; Класовете, като структурите и записите, са само един подход. Ако ограничим използването на класове до обвързването на имена и стойности и избягваме тежки концепции за обектно-ориентирано програмиране като наследяване, полиморфизъм или променливост, можем да се възползваме от тях, без да усложняваме нашия код. Освен това, чрез добавяне на неизменни методи за преобразуване на типове, можем да обогатим нашия функционален код с класове.

Магията на кастите

Кастите са една от най-мощните функции в Powershell. Когато прехвърляте стойност, вие разчитате на неявните възможности за инициализация и валидиране, които средата добавя към вашето приложение. Например, простото прехвърляне на низ в [xml] ще го прекара през кода на анализатора и ще генерира пълно xml дърво. Можем да използваме класове в нашия код за същата цел.

Предаване на хеш-таблици

Ако нямате конструктор, можете да продължите без такъв, като прехвърлите хеш-таблица към вашия тип клас. Не забравяйте да използвате атрибутите за валидиране, за да се възползвате напълно от този модел. В същото време можем да използваме въведените свойства на класа, за да изпълняваме още по-дълбока логика за инициализация и валидиране.

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
}

В допълнение, кастингът помага да се получи чист резултат. Сравнете изхода на масива от хеш-таблици на Cluster, предадени на Format-Table, с това, което получавате, ако първо прехвърлите тези хеш-таблици в клас. Свойствата на даден клас винаги са изброени в реда, в който са дефинирани там. Не забравяйте да добавите скритата ключова дума преди всички тези свойства, които не искате да се виждат в резултатите.

Състав на значенията

Ако имате конструктор с един аргумент, прехвърлянето на стойност към вашия тип клас ще предаде стойността към вашия конструктор, където можете да инициализирате екземпляр на вашия клас

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 позволява безопасна десериализация. Примерите по-долу ще бъдат неуспешни, ако данните не отговарят на нашата спецификация в 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 се изпълнява всеки път, когато се прехвърля Data, и това ни дава възможност да избегнем писането на голямо количество код. В резултат на това нашият конвейер се фокусира върху декларативни заявки за данни и агрегиране, докато нашите класове се грижат за анализирането и валидирането на данни.

# Пример комбинирования классов с конвейерами для 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 (кратки команди) и да зададете променливата ScriptsToProcess = "./my-classes.ps1" в манифеста на вашия модул със същия резултат: ./my-classes.ps1 ще се изпълни в вашата среда.

Която и опция да изберете, имайте предвид, че системата за типове на Powershell не може да разреши типове с едно и също име, заредени от различни места.
Дори ако сте заредили два идентични класа с еднакви свойства от различни места, рискувате да попаднете на проблеми.

Пътят напред

Най-добрият начин да избегнете проблеми с разрешаването на типове е никога да не излагате вашите класове на потребителите. Вместо да очаквате потребителят да импортира тип, дефиниран от клас, експортирайте функция от вашия модул, която елиминира необходимостта от директен достъп до класа. За клъстер можем да експортираме функция New-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