Какво е Windows PowerShell и с какво се храни? Част 4: Работа с обекти, собствени класове

Текстовият изход на командите в прозореца на интерпретатора PowerShell е просто начин за показване на информация в удобен за човешкото възприятие вид. Всъщност, средата е ориентирана към работа с обекти: командлети и функции получават входни данни и връщат на изхода, а наличните в интерактивен режим и в сценарии типове променливи се основават на класовете .NET. В четвъртата статия от цикъла ще разгледаме работата с обектите по-подробно.

Съдържание:

Обектите в PowerShell
Преглед на структурата на обектите
Филтриране на обектите
Сортиране на обектите
Избор на обекти и техните части
ForEach-Object, Group-Object и Measure-Object
Създаване на обекти .NET и COM (New-Object)
Извикване на статични методи
Тип PSCustomObject
Създаване на собствени класове

Обектите в PowerShell

Нека припомним, че обектът е съвкупност от полета с данни (свойства, събития и т.н.) и методи за тяхната обработка. Неговата структура се задава от типа, който обикновено се основава на класовете, използвани в унифицираната платформа .NET Core. Съществува и възможност за работа с обекти COM, CIM (WMI) и ADSI. Свойствата и методите са необходими за извършване на различни действия с данните, освен това в PowerShell обектите могат да се предават като аргументи на функции и командлети, да им се присвояват стойности на променливите, а също и съществува механизъм за композиция на команди (конвейер или pipeline). Всяка команда в конвейера предава своя изход на следващата последователно — обект по обект. За обработка могат да се използват компилирани командлети или да се създават собствени разширени функции, за да се извършват различни манипулации с обектите в конвейера: филтриране, сортиране, групиране и дори изменение на тяхната структура. Предаването на данни по този начин има сериозно предимство: приемната команда не трябва да се занимава със синтактичен анализ на потока от байтове (текст), необходимата информация лесно се извлича чрез достъп до съответните свойства и методи.

Преглед на структурата на обектите

За пример, нека стартираме командлет Get-Process, който позволява получаване на информация за работещите в системата процеси:

Той ще изведе на екран някои форматирани текстови данни, които не дават представа за свойствата на връщаните обекти и техните методи. За внимателно разглеждане на изхода трябва да се научим да изследваме структурата на обектите и на това ще ни помогне командлет Get-Member:

Get-Process | Get-Member

Тук вече виждаме типа и структурата, а с помощта на допълнителни параметри можем, например, да изведем само свойствата на обекта, попаднал на входа:

Get-Process | Get-Member -MemberType Property

Тези знания ще са необходими за решаване на администраторски задачи в интерактивен режим или за написването на собствени скриптове: да кажем, за да получим информация за задържани процеси по свойството Responding.

Филтриране на обектите

PowerShell позволява да предаваме по конвейера обекти, отговарящи на определено условие:

Where-Object { блок сценария }

Резултатът от изпълнението на блока сценария в операторните скобки трябва да е логическа стойност. Ако тя е вярна ($true), обектът, попаднал на входа на командлета Where-Object, ще бъде предаден по конвейера нататък, в противен случай (стойност $false) той ще бъде премахнат. За пример, нека изведем списък на спрените услуги на Windows Server, т.е. такива, при които свойството Status има стойност "Stopped":

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

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

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

Сортиране на обектите

При конвейерна обработка на обекти често възниква необходимост от тяхната сортировка. На командлета Sort-Object се подават имена на свойства (ключове за сортиране), а той връща обектите, подредени по техните стойности. Изходът на активните процеси не е труден за сортиране по изразходвано CPU време (свойство cpu):

Get-Process | Sort-Object –Property cpu

Параметърът -Property при извикване на командлета Sort-Object може да не се указыва, той се използва по подразбиране. За обратна сортировка се използва параметърът -Descending:

Get-Process | Sort-Object cpu -Descending

Избор на обекти и техните части

Командлетът Select-Object позволява да изберем определено количество обекти в началото или в края на конвейера с помощта на параметрите -First или -Last. С него можем да изберем отделни обекти или определени свойства, а също така да създадем нови обекти на тяхна база. Нека разгледаме работата на командлета с прости примери.

Следващата команда извежда информация за 10 процеса, консумиращи максимално количество оперативна памет (свойство WS):

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

Можем да изберем само определени свойства на преминаващите през конвейера обекти и да създадем нови на тяхна основа:

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

В резултат на работата на конвейера ще получим нов обект, структурата на който ще се различава от структурата на обектите, връщани от командлета Get-Process. Нека да се уверим в това с помощта на Get-Member:

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

Обърнете внимание, че Select-Object връща единичен обект (-First 1), който има само две полета, посочени от нас: техните стойности бяха копирани от първия предаден в конвейера обект от командлета Get-Process. На използването на Select-Object се основава един от начините за създаване на обекти в PowerShell сценарии:

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

С помощта на Select-Object можете да добавяте изчисляеми свойства на обектите, които трябва да се представят като хеш-таблица. При това стойността на първия ключ съответства на името на свойството, а стойността на втория — на стойността на свойството за текущия елемент в конвейера:

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

Нека да видим структурата на обектите, които преминават през конвейера:

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

ForEach-Object, Group-Object и Measure-Object

За работа с обектите съществуват и други командлети. Например, ще обсъдим три от най-полезните:

ForEach-Object позволява да изпълнявате код на PowerShell за всеки обект в конвейера:

ForEach-Object { блок сценария }

Group-Object групира обектите по стойност на свойството:

Group-Object PropertyName

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

Measure-Object агрегира различни обобщени параметри по стойностите на полетата на обектите в конвейера (изчислява сумата, а също така намира минималната, максималната или средната стойност):

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

Обычно рассмотренные командлеты се използват в интерактивен режим, а в скриптове обикновено се създават функции с блоковете Begin, Process и End.

Създаване на обекти .NET и COM (New-Object)

Има множество софтуерни компоненти с интерфейси .NET Core и COM, които ще бъдат полезни на системните администратори. С помощта на класа System.Diagnostics.EventLog можете да управлявате системните дневници директно от Windows PowerShell. Нека да разгледаме пример за създаване на екземпляр на този клас с помощта на командлета New-Object с параметъра -TypeName:

New-Object -TypeName System.Diagnostics.EventLog

Тъй като не посочихме конкретен журнал на събитията, получената инстанция на класа не съдържа данни. За да променим това, е необходимо по време на създаването му да извикаме специалния метод-конструктор чрез параметъра -ArgumentList. Ако искаме да получим достъп до журнала на приложенията, в конструктора трябва да предадем низ „Application“ като аргумент:

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

Обърнете внимание: изходните данни на командата запазихме в променливата $AppLog. Въпреки че в интерактивен режим обикновено се използват конвейери, писането на сценарии често изисква запазване на връзка с обекта. Освен това основните класове на .NET Core се съдържат в пространството от имена System: PowerShell по подразбиране търси в него посочените типове, така че написването на Diagnostics.EventLog вместо System.Diagnostics.EventLog е напълно коректно.

За работа с журнала може да се обръщате към съответните методи:

$AppLog | Get-Member -MemberType Method

Да предположим, че той се изчиства с метода Clear() при наличие на права за достъп:

$AppLog.Clear()

Командлетът New-Object се прилага и за работа с COM компоненти. Има доста от тях — от доставяните с Windows сценарии до ActiveX приложения, например Internet Explorer. За да създадете COM обект, трябва да зададете параметър -ComObject с програмния идентификатор ProgId на необходимия клас:

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

За създаване на собствени обекти с произволна структура, използването на New-Object изглежда твърде архаично и обемисто; този командлет се използва за работа с външни към PowerShell софтуерни компоненти. В следващите статии този въпрос ще бъде разгледан по-подробно. Освен обектите .NET и COM, ще изучим и обекти CIM (WMI) и ADSI.

Извикване на статични методи

Инстанции на някои класове на .NET Core не могат да бъдат създадени: към тях спада System.Environment и System.Math. Те са статични и съдържат само статични свойства и методи. Всъщност, това са справочни библиотеки, които се използват без създаване на обекти. Можете да се позовете на статичен клас чрез литерал, като поставите името на типа в квадратни скоби. При това, ако погледнете структурата на обекта с помощта на Get-Member, ще видите тип System.RuntimeType вместо System.Environment:

[System.Environment] | Get-Member

За да видите само статични елементи, трябва да извикате Get-Member с параметъра -Static (обърнете внимание на типа на обекта):

[System.Environment] | Get-Member -Static

За достъп до статични свойства и методи се използват две последователни двоеточия вместо точка след литерала:

[System.Environment]::OSVersion

Или

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

Тип PSCustomObject

Сред многобройните налични типове данни в PowerShell, особено трябва да споменем PSCustomObject, предназначен за съхраняване на обекти с произволна структура. Създаването на такъв обект с помощта на командлета New-Object се счита за класически, но тромав и остарял начин:

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

Нека да разгледаме структурата на обекта:

$object | Get-Member

От PowerShell 3.0 е наличен и друг синтаксис:

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

Достъпът до данните може да се осъществи по един от следните еквивалентни начини:

$object.Name

$object.'Name'

$value = 'Name'
$object.$value

Дайте пример за преобразуване в обект на съществуваща хеш таблица:

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

Един от недостатъците на обектите от този тип е, че редът на техните свойства може да се промени. За да избегнете това, е необходимо да използвате атрибута [ordered]:

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

Има и други варианти за създаване на обект: по-горе разгледахме използването на командлета Select-Object. Остава да разберем добавянето и изтриването на елементи. Да го направим за обекта от предишния пример е доста просто:

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

Командлетът Add-Member позволява добавянето на не само свойства, но и методи към предварително създадения обект $object, чрез използването на конструкцията "-MemberType ScriptMethod":

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

Обърнете внимание: за съхранение на кода на новия метод използвахме променливата $ScriptBlock от тип ScriptBlock.

За изтриване на свойства се използва съответният метод:

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

Създаване на собствени класове

В PowerShell 5.0 се появи възможността за дефиниране на класове с използване на синтаксиса, характерен за обектно-ориентираните програмни езици. За това е предназначена служебната дума Class, след която следва да се зададе името на класа и да се опише неговото тяло в операторни скоби:

class MyClass
{
    # тяло на класа
}

Това е истински тип .NET Core, в тялото на който се описват неговите свойства, методи и други елементи. Нека разгледаме пример за определяне на най-простия клас:

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

За създаване на обект (екземпляр на класа) се използва командлет New-Object, или литералът от тип [MyClass] и псевдостатичният метод new (конструктор по умолчание):

$object = New-Object -TypeName MyClass

или

$object = [MyClass]::new()

Нека анализираме структурата на обекта:

$object | Get-Member

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

След създаването на обекта да запълним свойствата му:

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

Нека отбележим, че в описанието на класа се задават не само типовете на свойствата, но и техните стойности по подразбиране:

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

Описание на метода на класа напомня описанието на функция, но без използването на служебната дума function. Както и при функцията, параметри могат да бъдат предадени на методите при необходимост:

class MyClass 
{
     [string]$Name
     [string]$City
     [string]$Country
     
     #описание на метода
     Smile([bool]$param1)
     {
         If($param1) {
            Write-Host ':)'
         }
     }
}

Сега представителят на нашия клас умее да се усмихва:

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

Методите могат да се претоварват, освен това класът може да има статични свойства и методи, както и конструктори, имената на които съвпадат с името на самия клас. Определеният в скрипта или модула PowerShell клас може да бъде основа за друг — така се реализира наследяване. При това може да се използват съществуващи класове .NET като базови:

class MyClass2 : MyClass
{
      #тяло на новия клас, за който базовият е MyClass
}
[MyClass2]::new().Smile($true)

Нашето описание на работа с обекти в PowerShell трудно може да се нарече изчерпателно. В следващите публикации ще се опитаме да го задълбочим на практическите примери: петата статия от цикъла ще бъде посветена на въпросите за интеграция на PowerShell с външни софтуерни компоненти. Предишните части могат да бъдат намерени на връзките по-долу.

Част 1: основни възможности на Windows PowerShell
Част 2: въведение в езика за програмиране Windows PowerShell
Част 3: предаване на параметри в скриптове и функции, създаване на командлети

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