Mis on Windows PowerShell ja millega seda kasutatakse? Osa 4: Töö objektidega, oma klassid

Käskude tekstiline väljund PowerShelli tõlgendaja aknas on lihtsalt teabe kuvamise viis, mis on inimsõbralik. Tegelikult on keskkond on suunatud objektide töötlemiseks: cmdlet'id ja funktsioonid saavad neid sisendina ja tagastavad väljundina, samas kui interaktiivses režiimis ja skriptides saadaval olevad muutuja tüübid põhinevad .NET-i klassidel. Selle artikli neljandas osas uurime objektide töötamist põhjalikumalt.

Sisukord:

Objektid PowerShellis
Objektide struktuuri vaatamine
Objektide filtreerimine
Objektide sorteerimine
Objektide ja nende osade esiletoomine
ForEach-Object, Group-Object ja Measure-Object
Objektide loomine .NET ja COM (New-Object)
Statiliste meetodite kutsumine
Tüüp PSCustomObject
Oma klasside loomine

Objektid PowerShellis

Tuletame meelde, et objekt on andmeväljade (omaduste, sündmuste jne) kogum ja nende töötlemise meetodid. Selle struktuuri määrab tüüp, mis põhineb tavaliselt .NET Core'i standardiseeritud klassidel. Samuti on võimalik töötada COM, CIM (WMI) ja ADSI objektidega. Omadused ja meetodid on vajalikud erinevate toimingute täitmiseks andmetega; PowerShellis saavad objektid olla argumentideks funktsioonides ja käskudes, nende väärtusi saab määrata muutujatele, ja samuti on olemas käskude kompositsiooni mehhanism (toru ehk pipeline). Iga käsk torus edastab oma väljundi järgmiseks järjestikku — objekt objekti järel. Töötlemiseks saab kasutada kompileeritud käsklusi või luua oma laiendatud funktsioonid, et objekti töötlemiseks voos erinevaid manipulatsioone: filtreerimine, sorteerimine, rühmitamine ja isegi nende struktuuri muutmine. Andmete edastamine sellisel kujul on märkimisväärne eelis: vastuvõtv meeskond ei pea tegelema baitide (teksti) süntaktilise analüüsiga, kogu vajalik teave on lihtsasti ekstraheeritav, kui pöörduda vastavate omaduste ja meetodite poole.

Objektide struktuuri vaatamine

Näiteks käivitame Get-Process käskluse, mis annab teavet süsteemis töötavate protsesside kohta:

See väljastab ekraanile mõned vormindatud tekstilised andmed, mis ei anna ülevaadet tagastatud objektide omadustest ja nende meetoditest. Väljundi peeneks analüüsimiseks tuleb õppida uurima objektide struktuuri, ja siin aitab meid käsklus Get-Member:

Get-Process | Get-Member

Siin näeme juba tüüpi ja struktuuri, ja täiendavate parameetrite abil saame näiteks väljastada ainult sisenenud objekti omadused:

Get-Process | Get-Member -MemberType Property

Need to know this to handle administration tasks interactively or to write custom scripts, for instance, to retrieve information about hanging processes based on the Responding property.

Objektide filtreerimine

PowerShell allows for passing objects through the pipeline that meet certain conditions:

Where-Object { script block }

The result of executing the script block within the parentheses must be a boolean value. If it is true ($true), the object passing into the Where-Object cmdlet will be sent further down the pipeline; otherwise (the value $false), it will be removed. For example, let’s list the stopped Windows Server services, i.e., those whose Status property is ‘Stopped’:

Get-Service | Where-Object {$_.Status -eq "Stopped"}

Here, we again see a textual representation, but it's easy to understand the type and internal structure of the objects passing through the pipeline if desired:

Get-Service | Where-Object {$_.Status -eq "Stopped"} | Get-Member

Objektide sorteerimine

Objektide konveieritöötlemisel esineb sageli vajadus nende sorteerimiseks. Cmdletile Sort-Object edastatakse sorteerimisvõtmete nimed ja see tagastab objektid, mis on järjekorda seatud nende väärtuste põhjal. Käimasolevaid protsesse ei ole keeruline sorteerida nende kulutatud protsessori aja (cpu omaduse) alusel:

Get-Process | Sort-Object –Property cpu

Cmdleti Sort-Object käsu kutsumise puhul ei ole parameetrit -Property tingimata määrata — see on vaikimisi kasutusel. Tagurpidi sorteerimiseks kasutatakse parameetrit -Descending:

Get-Process | Sort-Object cpu -Descending

Objektide ja nende osade esiletoomine

Cmdlet Select-Object võimaldab valida teatud arvu objekte konveieri alguses või lõpus parameetrite -First või -Last abil. Selle abil on võimalik valida üksikobjekte või spetsiifilisi omadusi ning luua nende põhjal uusi objekte. Vaadakem cmdleti tööd lihtsate näidete kaudu.

Järgmine käsk näitab teavet 10 kõige rohkem mälu tarbiva protsessi (WS omadus) kohta:

Get-Process | Sort-Object WS -Descending | Select-Object -First 10

Saate valida ainult teatud omadused konveieris liikuvate objektide seast ja luua nende põhjal uusi:

Get-Process | Select-Object ProcessName, Id -First 1

Tulemusena saame uue objekti, mille struktuur erineb Get-Process'i käivitatud struktuurist. Vaadake seda Get-Member'i abil:

Get-Process | Select-Object ProcessName, Id -First 1 | Get-Member

Pange tähele, et Select-Object tagastab ühe objekti (-First 1), millel on ainult kaks meie määratud väljad: nende väärtused on kopeeritud esimesest objektist, mille Get-Process käivitas. Select-Object'i kasutamise põhjal on PowerShellis objekti loomise üks meetoditest:

$obj = Get-Process | Select-Object ProcessName, Id -First 1
$obj.GetType()

Select-Object'i abil saab objektidele lisada arvutuslikke omadusi, mida tuleks esitada hõlbustus. Sellisel juhul vastab esimese võtme väärtus omaduse nimele ning teise võtme väärtus on omaduse väärtus antud toru praeguse elemendi jaoks:

Get-Process | Select-Object -Property ProcessName, @{Name="StartTime"; Expression = {$_.StartTime.Minute}}

Vaadakem torust läbi minevate objektide struktuuri:

Get-Process | Select-Object -Property ProcessName, @{Name="StartTime"; Expression = {$_.StartTime.Minute}} | Get-Member

ForEach-Object, Group-Object ja Measure-Object

Objektidega töötamiseks on olemas ka teisi käsurealt. Näiteks räägime kolmest kõige kasulikumast:

ForEach-Object kui see võimaldab täita PowerShelli keeles koodi iga toruga edastatud objekti jaoks:

ForEach-Object { skripti plokk }

Group-Object grupeerib objekte põhijoonte väärtuse järgi:

Group-Object PropertyName

Kui käivitada see parameetriga -NoElement, saab teada rühmades olevate elementide arvu.

Measure-Object kondenseerib erinevaid kokkuvõtlikke parameetreid objektide väljade väärtuste põhjal (arvutab summa, samuti leiab minimaalset, maksimaalset või keskmist väärtust):

Measure-Object -Property PropertyName -Minimum -Maximum -Average -Sum

Kasutatud käsuread töötavad tavaliselt interaktiivses režiimis, samas kui skripte luuakse sagedamini funktsioonid Begin, Process ja End plokkidega.

Objektide loomine .NET ja COM (New-Object)

On palju tarkvarakomponente, millel on .NET Core ja COM liidesed, mis on süsteemiadministraatoritele kasulikud. Klassiga System.Diagnostics.EventLog saab hallata süsteemi logisid otse Windows PowerShellist. Vaatame näidet, kuidas seda klassi luua käsurea New-Object abil parameetriga -TypeName:

New-Object -TypeName System.Diagnostics.EventLog

Kuna me ei määratlenud konkreetset sündmuste ajakirja, ei sisalda saadud klassi eksemplar andmeid. Selle muutmiseks tuleks selle loomise ajal kutsuda konstruktorimeetod koos parameetriga -ArgumentList. Kui soovime pääseda rakenduse ajakirja, tuleb konstruktorisse edastada string "Application" argumendina:

$AppLog = New-Object -TypeName System.Diagnostics.EventLog -ArgumentList Application
$AppLog

Pange tähele: käsu väljund salvestati muutujasse $AppLog. Kuigi interaktiivses režiimis kasutatakse tavaliselt torustikke, nõuab skriptimine sageli objekti viite salvestamist. Lisaks sisaldavad .NET Core põhiklassid nimede ruumis System: PowerShell otsib vaikimisi seal määratud tüüpe, seega on Diagnostics.EventLog kirjutamine täiesti korrektne.

Ajakirjaga töötamiseks võib pöörduda vastavate meetodite poole:

$AppLog | Get-Member -MemberType Method

Ütleme, et seda kustutatakse meetodi Clear() abil, kui on juurdepääsuõigused:

$AppLog.Clear()

Cmdlet New-Object kasutatakse ka COM-komponentidega töötamiseks. Neid on päris palju — Windowsi serveriga kaasas olevatest skripti raamatukogudest kuni ActiveX rakendusteni, nagu näiteks Internet Explorer. COM-objekti loomiseks tuleb määrata -ComObject parameeter koos vajaliku klassi ProgId programmidentifikaatoriga:

New-Object -ComObject WScript.Shell
New-Object -ComObject WScript.Network
New-Object -ComObject Scripting.Dictionary
New-Object -ComObject Scripting.FileSystemObject

Oma struktuuriga objektide loomiseks tundub New-Object kasutamine liiga arhailine ja kohmakas; seda cmdletit kasutatakse väliste PowerShelli programmikomponentidega töötamiseks. Järgmistes artiklites käsitleme seda teemat põhjalikumalt. Peale .NET ja COM objektide uurime ka CIM (WMI) ja ADSI objekte.

Statiliste meetodite kutsumine

Mõnede .NET Core klasside eksemplaride loomine on võimatu: nende hulka kuuluvad System.Environment ja System.Math. Need on staatilised ja sisaldavad ainult staatilisi omadusi ja meetodeid. Tegelikult on need viidete teegid, mida kasutatakse ilma objektide loomata. Viidates staatilisele klassile, saab kasutada literali, pannes tüübi nime nurksulgudesse. Samuti, kui vaadata objekti struktuuri Get-Member abil, näeme tüüpi System.RuntimeType, mitte System.Environment:

[System.Environment] | Get-Member

Ainult staatiliste elementide vaatamiseks tuleb kutsuda Get-Member koos parameetriga -Static (pange tähele objekti tüüpi):

[System.Environment] | Get-Member -Static

Staatiliste omaduste ja meetodite juurde pääsemiseks kasutatakse kahte järjestikust koolonit punkti asemel pärast literali:

[System.Environment]::OSVersion

Või

$test=[System.Math]::Sqrt(25) 
$test
$test.GetType()

Tüüp PSCustomObject

Paljude PowerShell'i andmetüüpide seas väärib eraldi mainimist PSCustomObject, mis on mõeldud juhusliku struktuuriga objektide hoidmiseks. Sellise objekti loomine New-Object käsu kaudu on klassikaline, kuid kohmakas ja vananenud meetod:

$object = New-Object –TypeName PSCustomObject -Property @{Name = 'Ivan Danko'; 
                                          City = 'Moscow';
                                          Country = 'Russia'}

Vaadakem objekti struktuuri:

$object | Get-Member

Alates PowerShell 3.0 on saadaval ka teine süntaks:

$object = [PSCustomObject]@{Name = 'Ivan Danko'; 
                                          City = 'Moskva';
                                          Country = 'Venemaa'
}

Andmetele on võimalik juurde pääseda mõne ekvivalentse viisi kaudu:

$object.Name

$object.'Name'

$value = 'Name'
$object.$value

Toome näite olemasoleva hashtabeli teisendamisest objektiks:

$hash = @{'Name'='Ivan Danko'; 'City'='Moskva'; 'Country'='Venemaa'}
$hash.GetType()
$object = [pscustomobject]$hash
$object.GetType()

Üks selle tüüpi objektide miinus on see, et nende omaduste järjekord võib muutuda. Selle vältimiseks tuleb kasutada atribuuti [ordered]:

$object = [PSCustomObject][ordered]@{Name = 'Ivan Danko'; 
                                          City = 'Moskva';
                                          Country = 'Venemaa'
}

Objekti loomise jaoks on ka teisi võimalusi: eelnevalt vaatasime üle käsu Select-Object. Jäänud on arutada elementide lisamist ja eemaldamist. Seda on eelmise näite objekti puhul üsna lihtne teha:

$object | Add-Member –MemberType NoteProperty –Name Age  –Value 33
$object | Get-Member

Käsk Add-Member võimaldab lisada juba loodud objektile $object mitte ainult omadusi, vaid ka meetodeid, kasutades konstruktsiooni "-MemberType ScriptMethod":

$ScriptBlock = {
    # kood 
}
$object | Add-Member -Name "MyMethod" -MemberType ScriptMethod -Value $ScriptBlock
$object | Get-Member

Pange tähele: uue meetodi koodi salvestamiseks kasutasime $ScriptBlock tüüpi ScriptBlock muutujat.

Atribuutide eemaldamiseks kasutatakse vastavat meetodit:

$object.psobject.properties.remove('Name')

Oma klasside loomine

PowerShell 5.0-st alates on võimalik määrata klasse kasutades objektorienteeritud programmeerimisele iseloomulikku süntaksit. Selleks on ettenähtud märksõna Class, millele järgneb klassi nimi ja selle keha kirjeldamine sulgudes:

class MyClass
{
    # klassi keha
}

See on tõeline .NET Core tüüp, mille sees kirjeldatakse selle omadusi, meetodeid ja muid elemente. Vaatame näitena lihtsama klassi määratlemist:

class MyClass 
{
     [string]$Name
     [string]$City
     [string]$Country
}

Märksõna New-Object, või tüübi literal [MyClass] ja pseudo-staatiline meetod new (vaikerakendus):

$object = New-Object -TypeName MyClass

või

$object = [MyClass]::new()

Analüüsime objekti struktuuri:

$object | Get-Member

Ärge unustage nähtavust: tüübi nime ei saa stringina viidata ega kasutada tüübi literali väljaspool skripti või moodulit, kusklass on määratletud. Samuti võivad funktsioonid tagastada klassi eksemplare (objekte), mis on kergesti kättesaadavad väljaspool moodulit või skripti.

Pärast objekti loomist täidame selle omadused:

$object.Name = 'Ivan Danko'
$object.City = 'Moscow'
$object.Country = 'Russia'
$object

Oluline on märkida, et klassi kirjelduse juures määratakse mitte ainult omaduste tüübid, vaid ka nende vaikimisi väärtused:

class Example
{
     [string]$Name = 'John Doe'
}

Klassi meetodi kirjeldus sarnaneb funktsiooni kirjeldamisele, kuid ilma võtmesõna function kasutamata. Nagu funktsiooni puhul, edastatakse meetoditele vajadusel argumendid:

class MyClass 
{
     [string]$Name
     [string]$City
     [string]$Country
     
     #meetodi kirjeldus
     Smile([bool]$param1)
     {
         If($param1) {
            Write-Host ':)'
         }
     }
}

Nüüd oskab meie klassi esindaja naeratada:

$object = [MyClass]::new()
$object.Smile($true)

Meetodeid saab üle koormata, peale selle on klassil staatilisi omadusi ja meetodeid, samuti konstruktorid, mille nimed kattuvad selle klassi nimega. PowerShellis määratletud skripti või mooduli klass võib olla aluseks teisele – nii teostatakse pärandamine. Aluseks võib kasutada ka olemasolevaid .NET klasse:

class MyClass2 : MyClass
{
      # uue klasse keha, mille aluseks on MyClass
}
[MyClass2]::new().Smile($true)

Meie kirjeldus PowerShelli objektide töötamisest on raske peab ammendavaks. Järgmistes postitustes püüame seda süvendada praktiliste näidete abil: viies artikkel tsüklis käsitletakse PowerShelli integreerimist kolmandate osapoolte tarkvarakomponentidega. Eelmised osad leiate allpool olevatest linkidest.

Osa 1: Windows PowerShelli põhifunktsioonid
Osa 2: sissejuhatus Windows PowerShelli programmeerimiskeelde
Osa 3: parameetrite edastamine skriptidesse ja funktsioonidesse, cmdletide loomine

Allikas: habr.com