首页 > 解决方案 > 注入由 MSBuild 任务创建的 EmbeddedResource

问题描述

我有一个自定义 MSBuild 任务,它根据没有构建操作的文件生成一个文件。生成的文件需要嵌入到最终程序集中。任务看起来像这样:

public class MyTask : Task
{
    public string OutputDirectory { get; set; }

    public string[] NoneIncluded { get; set; }

    private IEnumerable<ITaskItem> _generatedFiles;
    [Output]
    public ITaskItem[] GeneratedFiles => _generatedFiles.ToArray();

    public override bool Execute()
    {
        _generatedCssFiles = new List<ITaskItem>();
        foreach(var item in NoneIncluded)
        {
            if(someCondition)
            {
                var contents = DoFoo(item);
                var outputPath = Path.Combine(OutputDirectory, $"{item}.txt");
                File.WriteAllText(outputPath, contents);
                _generatedFiles.Add(new TaskItem(ProjectCollection.Escape(outputFile)));
            }
        }
    }
}

在我的目标文件中,我定义了一个目标,如下所示:

<PropertyGroup>
    <CoreCompileDependsOn>MyTarget;$(CoreCompileDependsOn);</CoreCompileDependsOn>
</PropertyGroup>

<Target Name="MyTarget"
        BeforeTargets="CoreCompile;Build">

  <MyTask OutputDirectory="$(IntermediateOutputPath)"
          NoneIncluded="@(None)">
    <Output ItemName="FilesWrite"
            TaskParameter="GeneratedFiles"/>
    <Output ItemName="EmbeddedResource" 
            TaskParameter="GeneratedFiles" />
  </MyTask>

</Target>

我最终遇到了两个我似乎无法解决的问题:

  1. 尽管文件是在编译任务之前生成的,但它并没有嵌入到程序集中,除非我在不清理输出的情况下重建项目。在随后的构建中,该文件被嵌入。
  2. 如果我在 中生成文件IntermediateOutputPath,则嵌入的资源 ID 包含该路径。所以不是MyProject.SomeResource.txt我得到MyProject.obj.netstandard2._0.SomeResource.txt

注意: - 如果我在项目中替换Path.Combine并简单地生成输出文件,它会解决资源 id 的问题,但不是第一个问题,因为它没有嵌入到第一次编译中。

如何确保我生成的文件嵌入在第一次编译中,并且我可以在 IntermediateOutputPath 中生成它们,而不是在项目目录中生成它们,就像它在项目中一样。

标签: msbuildmsbuild-task

解决方案


您的第二个问题可以通过简单地将 LogicalName 元数据设置为创建的任务项来解决。

TaskItem taskItem = new TaskItem(ProjectCollection.Escape(outputFile));   
taskItem.SetMetadata("LogicalName", $"{AssemblyName}.{item}.txt");
_generatedFiles.Add(taskItem);

现在要访问任务中的程序集名称,只需将AssemblyName字符串属性添加MyTaskAssemblyName="$(AssemblyName)"目标。这应该会产生预期的结果。


推荐阅读