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

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

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

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

Кастовете са едно от най-мощните предимства в 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.

• Можете да направите дотсорсване на файла с класове: . ./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