Как экспортировать класс в модуль PowerShell v5

Согласно здесь и здесь, вы можете использовать классы, определенные в вашем модуле, выполнив следующие действия в PowerShell 5 :

using module holidays

PSA: существует известная проблема, связанная с сохранением старых копий классов в памяти. Это действительно сбивает с толку работу с классами, если вы об этом не знаете. Вы можете прочитать об этом здесь.

using подвержен ловушкам

Ключевое слово using подвержено различным ошибкам, а именно:

• Оператор using не работает для модулей, не входящих в PSModulePath, если вы не укажете полный путь к модулю в операторе using. Это довольно удивительно, потому что, хотя модуль доступен через Get-Module, оператор using может не работать в зависимости от того, как модуль был загружен.
• Оператор using может использоваться только в самом начале «сценария». Никакая комбинация [scriptblock]::Create() или New-Module, похоже, не преодолеет это. Строка, переданная в Invoke-Expression, похоже, действует как своего рода автономный скрипт; using оператор в начале такого рода строк работает. То есть Invoke-Expression "using module $path" может быть успешным, но объем, в котором становится доступным содержимое модуля, кажется довольно непостижимым. Например, если Invoke-Expression "using module $path" используется внутри блока сценария Pester, классы внутри модуля недоступны из одного и того же блока сценария Pester.

Приведенные выше утверждения основаны на . Насколько я могу судить, использование ScriptsToProcess похоже на определение класса вне модуля следующим образом:

#  this is like defining c in class.ps1 and referring to it in ScriptsToProcess
class c {
    [string] priv () { return priv }
    [string] pub  () { return pub  }
}

# this is like defining priv and pub in module.psm1 and referring to it in RootModule
New-Module {
    function priv { 'private function' }
    function pub  { 'public function' }
    Export-ModuleMember 'pub'
} | Import-Module

[c]::new().pub()  # succeeds
[c]::new().priv() # fails

public function
priv : The term 'priv' is not recognized ...
+         [string] priv () { return priv } ...

New-Module 'ModuleName' { class c {$p = 'some value'} } |
    Import-Module

PS C:\> $c = & (Get-Module 'ModuleName').NewBoundScriptBlock({[c]::new()})
PS C:\> $c.p
some value

& (Get-Module 'ModuleName').NewBoundScriptBlock({[c]::new()})
& (Get-Module 'ModuleName') {[c]::new()}}

Я нашел способ загружать классы без использования модуля. В вашем файле MyModule.psd1 используйте строку:

ScriptsToProcess = @('Class.ps1')

А затем поместите свои классы в файл Class.ps1:

class MyClass {}

Обновление: хотя вам не нужно использовать модуль MyModule с этим методом, вам все равно необходимо:

• Запускаем с помощью модуля MyModule
• Или запустите Import-Module MyModule
• Или вызовите любую функцию в своем модуле (чтобы он автоматически импортировал ваш модуль по пути)

Update2: это загрузит класс в текущую область, поэтому, если вы импортируете модуль из функции, например, класс не будет доступен за пределами функции. К сожалению, единственный надежный метод, который я вижу, - это написать свой класс на C # и загрузить его с помощью Add-Type -Language CSharp -TypeDefinition 'MyClass...'.

с использованием - это правильный путь, если он работает для вас. В противном случае это тоже работает.

class abc{
    $testprop = 'It Worked!'
    [int]testMethod($num){return $num * 5}
}

function new-abc(){
    return [abc]::new()
}

Export-ModuleMember -Function new-abc

Import-Module path\to\testclass.psm1
$testclass = new-abc
$testclass.testProp        # Returns 'It Worked!'
$testclass.testMethod(500) # Returns 2500


$testclass | gm


Name        MemberType Definition
----        ---------- ----------
Equals      Method     bool Equals(System.Object obj)
GetHashCode Method     int GetHashCode()
GetType     Method     type GetType()
testMethod  Method     int testMethod(System.Object num)
ToString    Method     string ToString()
testprop    Property   System.Object testprop {get;set;}

Это определенно не работает так, как ожидалось.
Идея PowerShell 5 заключается в том, что вы можете определить свой класс в отдельном файле с расширением .psm1.
Затем вы можете загрузить определение с помощью команды (например):

using module C:\classes\whatever\path\to\file.psm1

Это должна быть первая строка в вашем скрипте (после комментариев).

Так много боли вызывает то, что даже если определения классов вызываются из сценария, модули загружаются для всего сеанса. В этом можно убедиться, запустив:

Get-Module

Вы увидите имя загруженного файла. Если вы снова запустите сценарий, он не перезагрузит определения классов! (Он даже не читает файл psm1.) Это вызывает сильное скрежетание зубов.

Иногда - иногда - вы можете запустить эту команду перед запуском скрипта, который перезагрузит модуль с обновленными определениями классов:

Remove-Module  file

где файл - это имя без пути и расширения. Однако, чтобы сохранить ваше здравомыслие, я рекомендую перезапустить сеанс PowerShell. Это явно громоздко; Microsoft нужно как-то это исправить.

Вы почти не можете. Согласно about_Classes справке:

Ключевое слово класса

Определяет новый класс. Это настоящий тип .NET Framework. Члены класса являются общедоступными, но только в пределах области действия модуля. Вы не можете ссылаться на имя типа как на строку (например, New-Object не работает), и в этом выпуске вы не можете использовать литерал типа (например, [MyClass]) вне скрипта / файл модуля, в котором определен класс.

Это означает, что если вы хотите получить себе экземпляр data_block или использовать функции, которые управляют этими классами, создайте функцию, скажем, New-DataBlock и заставьте ее возвращать новый экземпляр data_block, который затем можно использовать для получения методов и свойств класса (вероятно, включая статические).

Я также столкнулся с множеством проблем с классами PowerShell в версии 5.

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

Add-Type -Language CSharp -TypeDefinition @"
namespace My.Custom.Namespace {
    public class Example
    {
        public string Name { get; set; }
        public System.Management.Automation.PSCredential Credential { get; set; }
        // ...
    }
}
"@

Преимущество состоит в том, что вам не нужна настраиваемая сборка для добавления определения типа. Вы можете добавить определение класса в свои сценарии или модули PowerShell.

Единственным недостатком является то, что вам нужно будет создать новую среду выполнения для перезагрузки определения класса после того, как оно было загружено в первый раз (точно так же, как загрузка сборок в домене C # /. NET).

Способ, которым я работал над этой проблемой, заключается в том, чтобы переместить определение вашего пользовательского класса в пустой файл .ps1 с тем же именем (как в Java / C #), а затем загрузить его как в определение модуля, так и в зависимый код с помощью точечный поиск. Я знаю, что это не очень хорошо, но для меня это лучше, чем поддерживать несколько определений одного и того же класса в нескольких файлах ...

Чтобы обновить определения классов во время разработки, выберите код для класса и нажмите F8, чтобы запустить выбранный код. Это не так чисто, как параметр -Force в команде Import-Module.

Видя, что using Module не имеет этой опции и Remove-Module в лучшем случае носит спорадический характер. Я нашел лучший способ разработать класс и увидеть результаты, не закрывая PowerShell ISE и снова запустите его.