Функционалниот 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 предадена во Формат-табела со она што го добивате ако прво ги фрлите овие хаштабли во класа. Својствата на класата секогаш се наведени по редоследот по кој се дефинирани таму. Не заборавајте да го додадете скриениот клучен збор пред сите оние својства што не сакате да бидат видливи во резултатите.

Листа на значења

Ако имате конструктор со еден аргумент, ставањето вредност на типот на вашата класа ќе ја пренесе вредноста на вашиот конструктор, каде што можете да иницијализирате примерок од вашата класа

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'"

Фрлајте серијализирани случаи

Листата овозможува сигурна десериализација. Примерите подолу нема да успеат ако податоците не ги исполнуваат нашите спецификација во Кластерот

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

[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.

Во примерот подолу, конструкторот на јазол се извршува секој пат кога се фрлаат податоци, и тоа ни дава можност да избегнеме пишување прилично количество код. Како резултат на тоа, нашиот гасовод се фокусира на декларативно барање и собирање податоци, додека нашите класи се грижат за парсирање и валидација на податоците.

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

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

Патот напред

Најдобар начин да избегнете проблеми со резолуцијата на типот е никогаш да не ги изложувате вашите часови на корисниците. Наместо да очекувате корисникот да увезе тип дефиниран од класа, извезете функција од вашиот модул што ја елиминира потребата за директен пристап до класата. За Кластер, можеме да извеземе функција Ново-Кластер што ќе поддржува сетови на параметри погодни за корисникот и ќе врати Кластер.

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