Как создать пользовательский тип в PowerShell для использования в моих сценариях? - PullRequest
69 голосов
/ 12 сентября 2008

Я хотел бы иметь возможность определять и использовать пользовательский тип в некоторых моих сценариях PowerShell. Например, давайте представим, что мне нужен объект, который имеет следующую структуру:

Contact
{
    string First
    string Last
    string Phone
}

Как бы я мог создать это, чтобы я мог использовать его в функции, подобной следующей:

function PrintContact
{
    param( [Contact]$contact )
    "Customer Name is " + $contact.First + " " + $contact.Last
    "Customer Phone is " + $contact.Phone 
}

Возможно ли что-то подобное или даже рекомендуется в PowerShell?

Ответы [ 7 ]

103 голосов
/ 16 сентября 2008

До PowerShell 3

Система расширяемых типов PowerShell изначально не позволяла вам создавать конкретные типы, которые можно тестировать в соответствии с тем, как вы это делали в параметре. Если вам не нужен этот тест, вы можете использовать любой из перечисленных выше методов.

Если вам нужен фактический тип, к которому вы можете привести или проверить тип, как в вашем примере скрипта ... это не может быть без написания его на C # или VB.net и компиляции. В PowerShell 2 вы можете использовать команду «Add-Type», чтобы сделать ее достаточно простой:

add-type @"
public struct contact {
   public string First;
   public string Last;
   public string Phone;
}
"@

Историческая справка : в PowerShell 1 это было еще сложнее. Вы должны были вручную использовать CodeDom, на PoshCode.org есть очень старый скрипт функции new-struct , который поможет. Ваш пример становится:

New-Struct Contact @{
    First=[string];
    Last=[string];
    Phone=[string];
}

Использование Add-Type или New-Struct позволит вам фактически протестировать класс в вашем param([Contact]$contact) и создавать новые, используя $contact = new-object Contact и так далее ...

В PowerShell 3

Если вам не нужен «реальный» класс, который вы можете использовать, вам не нужно использовать способ Add-Member, который Стивен и другие продемонстрировали выше.

Начиная с PowerShell 2, вы можете использовать параметр -Property для New-Object:

$Contact = New-Object PSObject -Property @{ First=""; Last=""; Phone="" }

А в PowerShell 3 мы получили возможность использовать ускоритель PSCustomObject для добавления TypeName:

[PSCustomObject]@{
    PSTypeName = "Contact"
    First = $First
    Last = $Last
    Phone = $Phone
}

Вы все еще получаете только один объект, поэтому вы должны сделать функцию New-Contact, чтобы убедиться, что каждый объект получается одинаковым, но теперь вы можете легко проверить параметр "is" одного из этих типов, декорируя параметр с атрибутом PSTypeName:

function PrintContact
{
    param( [PSTypeName("Contact")]$contact )
    "Customer Name is " + $contact.First + " " + $contact.Last
    "Customer Phone is " + $contact.Phone 
}

В PowerShell 5

В PowerShell 5 все меняется, и мы наконец-то получили class и enum в качестве ключевых слов языка для определения типов (нет struct, но это нормально):

class Contact
{
    # Optionally, add attributes to prevent invalid values
    [ValidateNotNullOrEmpty()][string]$First
    [ValidateNotNullOrEmpty()][string]$Last
    [ValidateNotNullOrEmpty()][string]$Phone

    # optionally, have a constructor to 
    # force properties to be set:
    Contact($First, $Last, $Phone) {
       $this.First = $First
       $this.Last = $Last
       $this.Phone = $Phone
    }
}

Мы также получили новый способ создания объектов без использования New-Object: [Contact]::new() - фактически, если вы сохранили свой класс простым и не определяете конструктор, вы можете создавать объекты путем приведения хеш-таблицы (хотя без конструктора невозможно было бы принудительно установить, что все свойства должны быть установлены):

class Contact
{
    # Optionally, add attributes to prevent invalid values
    [ValidateNotNullOrEmpty()][string]$First
    [ValidateNotNullOrEmpty()][string]$Last
    [ValidateNotNullOrEmpty()][string]$Phone
}

$C = [Contact]@{
   First = "Joel"
   Last = "Bennett"
}
57 голосов
/ 13 сентября 2008

Создание пользовательских типов можно выполнить в PowerShell.
У Кирка Мунро на самом деле есть два замечательных поста, которые подробно описывают процесс.

Книга Windows PowerShell в действии Мэннинга также содержит пример кода для создания языка, специфичного для домена, для создания пользовательских типов. Книга отличная, поэтому я очень рекомендую ее.

Если вы просто ищете быстрый способ сделать это, вы можете создать функцию для создания пользовательского объекта, например

function New-Person()
{
  param ($FirstName, $LastName, $Phone)

  $person = new-object PSObject

  $person | add-member -type NoteProperty -Name First -Value $FirstName
  $person | add-member -type NoteProperty -Name Last -Value $LastName
  $person | add-member -type NoteProperty -Name Phone -Value $Phone

  return $person
}
16 голосов
/ 14 сентября 2008

Это быстрый способ:

$myPerson = "" | Select-Object First,Last,Phone
9 голосов
/ 12 января 2011

Ответ Стивена Муравски великолепен, однако мне нравится более короткий (или, скорее, более аккуратный объект выбора вместо использования синтаксиса add-member):

function New-Person() {
  param ($FirstName, $LastName, $Phone)

  $person = new-object PSObject | select-object First, Last, Phone

  $person.First = $FirstName
  $person.Last = $LastName
  $person.Phone = $Phone

  return $person
}
5 голосов
/ 10 сентября 2015

Удивило, что никто не упомянул эту простую опцию (против 3 или более поздней) для создания пользовательских объектов:

[PSCustomObject]@{
    First = $First
    Last = $Last
    Phone = $Phone
}

Типом будет PSCustomObject, но не фактический пользовательский тип. Но это, вероятно, самый простой способ создать пользовательский объект.

4 голосов
/ 13 сентября 2008

Существует концепция PSObject и Add-Member, которую вы можете использовать.

$contact = New-Object PSObject

$contact | Add-Member -memberType NoteProperty -name "First" -value "John"
$contact | Add-Member -memberType NoteProperty -name "Last" -value "Doe"
$contact | Add-Member -memberType NoteProperty -name "Phone" -value "123-4567"

Это выводит как:

[8] » $contact

First                                       Last                                       Phone
-----                                       ----                                       -----
John                                        Doe                                        123-4567

Другой альтернативой (о которой я знаю) является определение типа в C # / VB.NET и загрузка этой сборки в PowerShell для непосредственного использования.

Такое поведение определенно поощряется, потому что оно позволяет другим сценариям или разделам вашего сценария работать с реальным объектом.

3 голосов
/ 15 декабря 2014

Вот сложный путь для создания пользовательских типов и сохранения их в коллекции.

$Collection = @()

$Object = New-Object -TypeName PSObject
$Object.PsObject.TypeNames.Add('MyCustomType.Contact.Detail')
Add-Member -InputObject $Object -memberType NoteProperty -name "First" -value "John"
Add-Member -InputObject $Object -memberType NoteProperty -name "Last" -value "Doe"
Add-Member -InputObject $Object -memberType NoteProperty -name "Phone" -value "123-4567"
$Collection += $Object

$Object = New-Object -TypeName PSObject
$Object.PsObject.TypeNames.Add('MyCustomType.Contact.Detail')
Add-Member -InputObject $Object -memberType NoteProperty -name "First" -value "Jeanne"
Add-Member -InputObject $Object -memberType NoteProperty -name "Last" -value "Doe"
Add-Member -InputObject $Object -memberType NoteProperty -name "Phone" -value "765-4321"
$Collection += $Object

Write-Ouput -InputObject $Collection
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...