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

Здравей, Хабр! Представям ви превода на статията "Функционален PowerShell с класове."
Обещавам, че това не е оксиморон" автора Christopher Kuech.

Обектно-ориентираните и функционалните парадигми на програмиране може да изглеждат неподходящи една за друга, но и двете се поддържат в PowerShell. Практически всички програмни езици, независимо дали функционални или не, разполагат със средства за разширено свързване на имена и стойности; Класовете, подобно на структурата (struct) и записите (record), са само един подход. Ако ограничим използването на класовете до свързването на имена и стойности и избягваме "тежките" обектно-ориентирани концепции, като наследяване, полиморфизъм или изменяемост (mutability), можем да се възползваме от техните предимства, без да усложняваме кода си. След това, добавяйки неизменяеми (immutable) методи за преобразуване на типове, можем да обогатим функционалния си код с класове.

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

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

Каст на стойности

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

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 "Създадохме модел за '$cluster'"

Преобразуване на сериализирани инстанции

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

• Можете да направите dot-sourcing на файла с класовете: . ./my-classes.ps1. Това ще изпълни my-classes.ps1 в текущата ви област на видимост и ще определи всички класове от файла там.

• Можете да създадете PowerShell модул, който експортира всичките ви потребителски API (командлети) и да зададете променливата 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

Източник: habr.com