Я хотел бы иметь возможность определять и использовать настраиваемый тип в некоторых моих сценариях 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?

До 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 Contact @{
    First=[string];
    Last=[string];
    Phone=[string];
}

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

В PowerShell 3

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

Начиная с 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функцию, чтобы убедиться, что все объекты выглядят одинаково, но теперь вы можете легко проверить, что параметр «является» одним из этих типов, украсив параметр 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"
}

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

• Именование настраиваемых объектов
• Определение свойств по умолчанию для настраиваемых объектов

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

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

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
}

Это метод быстрого доступа:

$myPerson = "" | Select-Object First,Last,Phone

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

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
}

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

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

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

Есть концепция 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 для непосредственного использования.

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

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

$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

Вот еще один вариант, в котором используется идея, аналогичная решению PSTypeName, упомянутому Джайкулом (и, следовательно, также требуется PSv3 или выше).

пример

1. Создайте файл TypeName .Types.ps1xml, определяющий ваш тип. Например Person.Types.ps1xml:

<?xml version="1.0" encoding="utf-8" ?>
<Types>
  <Type>
    <Name>StackOverflow.Example.Person</Name>
    <Members>
      <ScriptMethod>
        <Name>Initialize</Name>
        <Script>
            Param (
                [Parameter(Mandatory = $true)]
                [string]$GivenName
                ,
                [Parameter(Mandatory = $true)]
                [string]$Surname
            )
            $this | Add-Member -MemberType 'NoteProperty' -Name 'GivenName' -Value $GivenName
            $this | Add-Member -MemberType 'NoteProperty' -Name 'Surname' -Value $Surname
        </Script>
      </ScriptMethod>
      <ScriptMethod>
        <Name>SetGivenName</Name>
        <Script>
            Param (
                [Parameter(Mandatory = $true)]
                [string]$GivenName
            )
            $this | Add-Member -MemberType 'NoteProperty' -Name 'GivenName' -Value $GivenName -Force
        </Script>
      </ScriptMethod>
      <ScriptProperty>
        <Name>FullName</Name>
        <GetScriptBlock>'{0} {1}' -f $this.GivenName, $this.Surname</GetScriptBlock>
      </ScriptProperty>
      <!-- include properties under here if we don't want them to be visible by default
      <MemberSet>
        <Name>PSStandardMembers</Name>
        <Members>
        </Members>
      </MemberSet>
      -->
    </Members>
  </Type>
</Types>

2. Импортируйте свой тип: Update-TypeData -AppendPath .\Person.Types.ps1xml
3. Создайте объект вашего нестандартного типа: $p = [PSCustomType]@{PSTypeName='StackOverflow.Example.Person'}
4. Инициализируйте свой тип, используя метод сценария, который вы определили в XML: $p.Initialize('Anne', 'Droid')
5. Посмотри на это; вы увидите все определенные свойства:$p | Format-Table -AutoSize
6. Введите вызов мутатора для обновления значения свойства: $p.SetGivenName('Dan')
7. Посмотрите на него еще раз, чтобы увидеть обновленное значение: $p | Format-Table -AutoSize

Объяснение

• Файл PS1XML позволяет определять настраиваемые свойства типов.
• Это не ограничивается типами .net, как следует из документации; так что вы можете поместить то, что вам нравится, в '/ Types / Type / Name', любой объект, созданный с соответствующим 'PSTypeName', унаследует члены, определенные для этого типа.
• Члены добавлены через PS1XMLили Add-Memberограничены NoteProperty, AliasProperty, ScriptProperty, CodeProperty, ScriptMethod, и CodeMethod(или PropertySet/ MemberSet; хотя те могут быть теми же ограничениями). Все эти свойства доступны только для чтения.
• Определив a, ScriptMethodмы можем обмануть указанное выше ограничение. Например, мы можем определить метод (например Initialize), который создает новые свойства, устанавливая их значения для нас; таким образом гарантируя, что наш объект имеет все свойства, необходимые для работы других наших скриптов.
• Мы можем использовать тот же прием, чтобы позволить обновлять свойства (хотя и с помощью метода, а не прямого назначения), как показано в примере SetGivenName.

Этот подход не идеален для всех сценариев; но полезен для добавления классового поведения к пользовательским типам / может использоваться в сочетании с другими методами, упомянутыми в других ответах. Например, в реальном мире я бы, вероятно, только определил FullNameсвойство в PS1XML, а затем использовал бы функцию для создания объекта с необходимыми значениями, например:

Больше информации

Взгляните на документацию или файл типа OOTB Get-Content $PSHome\types.ps1xmlдля вдохновения.

# have something like this defined in my script so we only try to import the definition once.
# the surrounding if statement may be useful if we're dot sourcing the script in an existing 
# session / running in ISE / something like that
if (!(Get-TypeData 'StackOverflow.Example.Person')) {
    Update-TypeData '.\Person.Types.ps1xml'
}

# have a function to create my objects with all required parameters
# creating them from the hash table means they're PROPERties; i.e. updatable without calling a 
# setter method (note: recall I said above that in this scenario I'd remove their definition 
# from the PS1XML)
function New-SOPerson {
    [CmdletBinding()]
    [OutputType('StackOverflow.Example.Person')]
    Param (
        [Parameter(Mandatory)]
        [string]$GivenName
        ,
        [Parameter(Mandatory)]
        [string]$Surname
    )
    ([PSCustomObject][Ordered]@{
        PSTypeName = 'StackOverflow.Example.Person'
        GivenName = $GivenName
        Surname = $Surname
    })
}

# then use my new function to generate the new object
$p = New-SOPerson -GivenName 'Simon' -Surname 'Borg'

# and thanks to the type magic... FullName exists :)
Write-Information "$($p.FullName) was created successfully!" -InformationAction Continue