c# - 将数组传递给自定义 MSBuild 任务

Question

我以为这会很简单，但后来意识到我无法在任何地方找到任何关于它的信息。

我有一个这样的自定义任务:

public class MyCustomTask : Task
{
    [Required]
    public string[] SomeStrings {get;set;}

    public override bool Execute()
    {
        // Do something with strings...
    }
}

匹配的MSBuild东西基本是这样的:

<UsingTask TaskName="MyCustomTask" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildBinPath)\Microsoft.Build.Tasks.v4.0.dll">
    <ParameterGroup>
      <SomeStrings ParameterType="System.String[]" Required="true" />
    </ParameterGroup>
    <Task>
    ... 
    </Task>
</UsingTask>

<Target Name="DoSomething">
    <MyCustomTask SomeStrings="????" />
</Target>

不知道要在 SomeStrings 参数中放入什么，我想如果我输入“xxx,xxx,xxx”它可能会理解，所以任何人都可以对此有所了解。基本场景很像标记化，所以我需要一个字符串列表，然后是一些比较字符串，所以我需要传入 2 个列表/数组，但只是被难住了。

Answer 1

@BrianKretzler 非常喜欢使用 ITaskItem，因为它是 MSBuild 在您声明 <ItemGroup> 时使用的东西.

我只是想用一个完整的工作示例来说明答案，因为我在尝试完成同样的事情时发现了这篇文章，它帮助了我。 (很难搜索这些问题，因为关键字在不同的上下文中使用，所以希望这会帮助其他人)。

<UsingTask TaskName="MyCustomTask" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll">
    <ParameterGroup>
        <SomeStrings ParameterType="Microsoft.Build.Framework.ITaskItem[]" Required="true" />
    </ParameterGroup>
    <Task>
        <Code Type="Class" Language="cs"><![CDATA[
            using System;
            using Microsoft.Build.Framework;
            using Microsoft.Build.Utilities;

            public class MyCustomTask : Task
            {  
                public ITaskItem[] SomeStrings { get; set; }

                public override bool Execute()
                {
                    foreach (var item in SomeStrings)
                    {
                        Log.LogMessage(MessageImportance.High, 
                                       "Got item {0}",
                                       item.ItemSpec);
                        Log.LogMessage(" -> {0} -> {1}", 
                                       item.GetMetadata("Comparison"),
                                       item.GetMetadata("MoreDetail"));
                    }
                    return true;
                }
            }
        ]]></Code>
    </Task>
</UsingTask>

现在您可以调用此任务:

<Target Name="DoSomething">
    <ItemGroup>
       <SomeStrings Include="first string">
          <Comparison>first</Comparison>
       </SomeStrings>
       <SomeStrings Include="second string">
          <Comparison>2nd</Comparison>
          <MoreDetail>this is optional</MoreDetail>
       </SomeStrings>
    </ItemGroup>
    <MyCustomTask SomeStrings="@(SomeStrings)" />
</Target>

输出是:

Microsoft (R) Build Engine Version 4.0.30319.1
[Microsoft .NET Framework, Version 4.0.30319.269]
Copyright (C) Microsoft Corporation 2007. All rights reserved.

Build started 2012-10-19 5:41:22 PM.
Got first string
 -> first -> 
Got second string
 -> 2nd -> this is optional

Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:00.12

当然你也可以使用像<ItemGroup><SomeStrings Include="**\*.txt" /></ItemGroup>这样的东西你会得到匹配的文件名列表，当然你可以使用 GetMetadata()访问 well-known file metadata