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

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

Съдържание:

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

Обекти в PowerShell

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

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

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

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

Get-Process | Get-Member

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

Get-Process | Get-Member -MemberType Property

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

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

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

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

Резултатът от изпълнението на скриптовия блок в скобите трябва да бъде булева стойност. Ако е true ($true), обектът, който е въведен в cmdlet 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 получава имената на свойствата (ключове за сортиране) и връща обекти, подредени по техните стойности. Лесно е да сортирате изхода от работещи процеси по изразходвано време на процесора (свойство на процесора):

Get-Process | Sort-Object –Property cpu

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

Get-Process | Sort-Object cpu -Descending

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

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

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

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

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

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

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

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

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

$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

Има и други командлети за работа с обекти. Като пример, нека поговорим за трите най-полезни:

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

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

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

Group-Object PropertyName

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

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

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

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

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

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

New-Object -TypeName System.Diagnostics.EventLog

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

$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 изглежда твърде архаично и тромаво; този cmdlet се използва за работа със софтуерни компоненти, външни за 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, предназначен за съхраняване на обекти с произволна структура. Създаването на такъв обект с помощта на cmdlet 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'
}

Има и други опции за създаване на обект: по-горе разгледахме използването на cmdlet Изберете 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
}

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

$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'
}

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

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: предаване на параметри към скриптове и функции, създаване на кратки команди

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