c# - 在 C# 中创建 PowerShell Cmdlet

问题描述

我在 C# 中有一些类，我想在管道中使用它们，我已经看过有关它的文章，但我还不能这样做。

这是我现在使用它的方式：

$suite = [MyProject.SuiteBuilder]::CreateSuite('my house')

$houseSet = $suite.AddSet('doors', 'These represents doors')
$houseSet.AddOption('blue', 'kitchen')
$houseSet.AddOption('black', 'bedreoom')
$houseSet.AddOption('white', 'toilet')

我希望能够像这样在管道中使用它：

$suite = [MyProject.SuiteBuilder]::CreateSuite('my house')

$suite | AddSet('doors', 'These represents doors') `
       | AddOption('blue', 'kitchen') `
       | AddOption('black', 'bedreoom') `
       | AddOption('white', 'toilet')

这是我的 C# 类：

//SuiteBuilder.cs
public static class SuiteBuilder
{
    public static Suite CreateTestSuite(string name)
    {
        return new Suite(name);
    }
}

//Suite.cs
public class Suite : PSCmdlet
{
    public string Name { get; set; }
    public IEnumerable<Set> Sets { get; set; }

    public Suite(string name)
    {
        Name = name;
        Sets = new List<Set>();
    }

    // call this method in pipeline
    public Set AddSet(string type, string description)
    {
        Sets.Add(new Set(type, description));
        return Sets.Last();
    }
}


//Set.cs
public class Set : PSCmdlet
{
    public string Type { get; set; }
    public string Description { get; set; }
    public IEnumerable<Option> Options { get; set; }

    public Set(string type, string description)
    {
        Type = type;
        Description = description;
        Options = new List<Option>();
    }

    // call this method from pipeline
    public Set AddOption(string color, string place)
    {
        Options.Add(new Option(color, place));
        return this;
    }
}


//option.cs
public class Option : PSCmdlet
{
    public string Color { get; set; }
    public string Place { get; set; }

    public Option(string color, string place)
    {
        Color = color;
        Place = place;
    }
}

而且我正在努力使这些功能可以在管道形式中调用。

我还添加了一条评论，就像call this method in pipeline 我需要调用的每条评论之前一样。

标签： c#powershellcmdlet

解决方案

简而言之，您需要：

通过使用从管道接受参数[Parameter(ValueFromPipeline =true)]
WriteObject通过调用过程方法中的方法向管道提供输出

详细的一步一步的答案

在这篇文章中，我将对您的代码进行一些重构，并向您展示如何在 C# 中创建Powershell Cmdlet，以及如何定义参数、接受来自管道的参数并将输出提供给管道。然后你可以很容易地写出类似的东西：

$suite = [MyCmdLets.Suite]::New("suite1")
$suite | Add-Set "type1" "desc1"`
       | Add-Option "color1" "place1"`
       | Add-Option "color2" "place2" | Out-Null

为此，请按照下列步骤操作：

创建一个 C# 类库项目（例如命名它MyCmdlets）
安装包Microsoft.PowerShell.5.ReferenceAssemblies
创建独立于 PowerShell 的模型类。（见帖子底部的代码）
考虑以下注意事项创建 cmdlet：（请参阅帖子底部的代码）
- 每个 cmdlet，创建一个 C# 类
- Cmdlet从类派生
- 使用指定动词和动词后名称的属性来装饰类CmdletAttribute，例如，如果你想拥有Add-Set，请使用[Cmdlet(VerbsCommon.Add, "Set")]。
- 如果您想为管道提供输出，请使用OutputTypeAttribute指定输出类型的属性来装饰类，例如，如果您想Set为管道提供类型的输出，请使用[OutputType(typeof(Set))].
- 根据 cmdlet 的每个输入参数，定义一个 C# 属性。
- 按属性装饰每个参数Parameter属性。
- 如果你想从管道接受一个参数，当用ParameterAttribute属性装饰时，设置ValueFromPipeline为true，例如[Parameter(ValueFromPipeline =true)
- 要向管道提供输出，请覆盖管道处理方法，例如ProcessRecord并使用WriteObjectwrite to output。
构建项目。

打开 PowerShell ISE 并运行以下代码：

Import-Module "PATH TO YOUR BIN DEBUG FOLDER\MyCmdlets.dll"

$suite = [MyCmdLets.Suite]::New("suite1")
$suite | Add-Set "type1" "desc1"`
       | Add-Option "color1" "place1"`
       | Add-Option "color2" "place2" | Out-Null

它将创建一个这样的结构：

Name   Sets           
----   ----           
suite1 {MyCmdlets.Set}


Type  Description Options                             
----  ----------- -------                             
type1 desc1       {MyCmdlets.Option, MyCmdlets.Option}


Color  Place 
-----  ----- 
color1 place1
color2 place2

示例代码

模型类

如上所述，设计独立于 PowerShell 的模型类，如下所示：

using System.Collections.Generic;
namespace MyCmdlets
{
    public class Suite
    {
        public string Name { get; set; }
        public List<Set> Sets { get; } = new List<Set>();
        public Suite(string name) {
            Name = name;
        }
    }
    public class Set
    {
        public string Type { get; set; }
        public string Description { get; set; }
        public List<Option> Options { get; } = new List<Option>();
        public Set(string type, string description) {
            Type = type;
            Description = description;
        }
    }
    public class Option 
    {
        public string Color { get; set; }
        public string Place { get; set; }
        public Option(string color, string place) {
            Color = color;
            Place = place;
        }
    }
}

CmdLet 类

还要根据我上面描述的注释设计 cmdlet 类：

using System.Management.Automation;
namespace MyCmdlets
{
    [Cmdlet(VerbsCommon.Add, "Set"), OutputType(typeof(Set))]
    public class AddSetCmdlet : Cmdlet
    {
        [Parameter(ValueFromPipeline = true, Mandatory = true)]
        public Suite Suite { get; set; }
        [Parameter(Position = 0, Mandatory = true)]
        public string Type { get; set; }
        [Parameter(Position = 1, Mandatory = true)]
        public string Description { get; set; }
        protected override void ProcessRecord() {
            var set = new Set(Type, Description);
            Suite.Sets.Add(set);
            WriteObject(set);
        }
    }

    [Cmdlet(VerbsCommon.Add, "Option"), OutputType(typeof(Option))]
    public class AddOptionCmdlet : Cmdlet
    {
        [Parameter(ValueFromPipeline = true, Mandatory = true)]
        public Set Set { get; set; }
        [Parameter(Position = 0, Mandatory = true)]
        public string Color { get; set; }
        [Parameter(Position = 1, Mandatory = true)]
        public string Place { get; set; }
        protected override void ProcessRecord() {
            var option = new Option(Color, Place);
            Set.Options.Add(option);
            WriteObject(Set);
        }
    }
}

c# - 在 C# 中创建 PowerShell Cmdlet - 管道链接

问题描述

解决方案

详细的一步一步的答案

示例代码

推荐阅读