Visual Studio - 生成后事件 - 引发错误

Question

我有一个很好的 power-shell 驱动的构建后脚本，它可以执行一些神奇的操作，在编译后将所有插件拉到正确的位置，并整理出与解决方案的主项目的依赖关系。

我的问题是，偶尔当我做了一些愚蠢的事情时，我最终可能会陷入脚本无法正确执行其操作的状态，并在 powershell 中抛出异常，并包含错误的详细信息。

有没有办法将这些异常拉到 Visual Studio 错误窗口，以便当我的构建后失败时，vstudio 会收到失败通知，并在窗口中将其与所有其他警告/错误一起很好地格式化？

编辑：这是对我理想的寻找内容的澄清。

删除了无效的 ImageShack 链接

注意：< em> 如果您来到这里寻找如何在 Visual Studio 中显示自定义错误消息（当您可以控制错误消息时），您可以看到 Roy Tinker 的回答，了解如何定制要显示的消息。如果您有兴趣捕获无法控制的意外错误，或寻找更完整的解决方案，请参阅已接受的答案。

Answer 1

要创建将出现在“错误列表”窗口中的错误、警告或消息，只需从由构建前或构建后事件启动的脚本以以下格式将消息记录到 stdout 或 stderr 即可。如果有官方规范，请评论或编辑；这只是我通过反复试验和观察 MSBuild 的输出得出的结论。方括号表示“可选”：

FilePath[(LineNumber[,ColumnNumber])]: MessageType[ MessageCode]: Description

例如：

E:\Projects\SampleProject\Program.cs(18,5): error CS1519: Invalid token '}' in class, struct, or interface member declaration

有关更多示例，请参阅“输出”窗口，了解在 Visual Studio 中运行生成时可能出现的任何错误/警告/消息。

Answer 2

以下是在 PowerShell 脚本出错时中断构建的两种方法。

使用 exit() 终止 PowerShell 进程

要从脚本返回状态代码（如果非零，将显示在错误列表中），请使用以下命令：

exit(45) # or any other non-zero number, for that matter.

这并不能精确获取错误文本到您的错误列表中，但它确实会终止脚本并在错误列表中获取一些内容以指示哪个构建前或构建后命令失败。

使用自定义 MSBuild 任务执行 PowerShell 脚本

我花了一点时间研究在 MSBuild 任务中执行 PowerShell 脚本的详细信息。我的博客上有包含示例代码的完整文章。请务必查看它，因为它包含更多讨论以及有关如何处理示例项目的一些解释。它可能不是一个完整或完美的解决方案，但我用一个非常简单的脚本在我的机器上工作^TM。

此方法在报告 PowerShell 错误时提供行和列精度，甚至支持我们在 Visual Studio 中习惯的双击“获取文件”行为。如果缺少，我相信您能够扩展它以满足您的需求。此外，根据您的 Visual Studio 版本，您可能需要处理程序集参考版本等详细信息。

首先，在类库项目中构建自定义 MSBuild 任务。该库应引用以下程序集以进行 MSBuild 和 PowerShell 集成。 （请注意，此示例需要 PowerShell 2.0。）

• Microsoft.Build.Framework (GAC)
• Microsoft.Build.Utilities.v3.5 (GAC)
• System.Management.Automation（来自 C:\Program Files\Reference Assemblies\Microsoft\WindowsPowerShell\ v1.0)

构建一个任务类，并公开一个属性来指定 PowerShell 脚本的路径，如下所示：

using System.IO;
using System.Management.Automation;
using System.Management.Automation.Runspaces;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;

public class PsBuildTask : Task
{
    [Required]
    public string ScriptPath { get; set; }

    public override bool Execute()
    {
        // ...
    }
}

在 Execute() 方法中，启动 PowerShell 运行时，执行脚本，然后收集错误。使用Log 属性来记录错误。完成后，关闭运行空间，如果脚本没有记录任何错误，则返回 true。

// create Powershell runspace
Runspace runspace = RunspaceFactory.CreateRunspace();
runspace.Open();

// create a pipeline and feed it the script text
Pipeline pipeline = runspace.CreatePipeline();
pipeline.Commands.AddScript(". " + ScriptPath);

// execute the script and extract errors
pipeline.Invoke();
var errors = pipeline.Error;

// log an MSBuild error for each error.
foreach (PSObject error in errors.Read(errors.Count))
{
    var invocationInfo = ((ErrorRecord)(error.BaseObject)).InvocationInfo;
    Log.LogError(
        "Script",
        string.Empty,
        string.Empty,
        new FileInfo(ScriptPath).FullName,
        invocationInfo.ScriptLineNumber,
        invocationInfo.OffsetInLine,
        0,
        0,
        error.ToString());
}

// close the runspace
runspace.Close();

return !Log.HasLoggedErrors;

就是这样。有了这个程序集，我们就可以配置另一个项目来使用 MSBuild 任务。

例如，考虑一个基于 C# 的类库项目 (.csproj)。将任务集成到构建后事件中只需要做一些事情。

首先，在 .csproj 文件的 节点内注册任务，如下所示：

<UsingTask TaskName="PsBuildTask"
           AssemblyFile="..\Noc.PsBuild\bin\Debug\Noc.PsBuild.dll" />

TaskName 应该是任务类的名称，尽管命名空间似乎不是必需的。 AssemblyFile 是自定义 MSBuild 任务程序集的绝对路径，或相对于 .csproj 文件的相对路径。对于 GAC 中的程序集，您可以改用 AssemblyName 属性。

注册后，该任务可以在构建前和构建后事件中使用。在 .csproj 文件的 元素中配置构建事件，如下所示：

<Target Name="AfterBuild">
    <PsBuildTask ScriptPath=".\script.ps1" />
</Target>

就是这样。当 Visual Studio 编译项目时，它会加载自定义程序集和任务对象并执行任务。检索并报告管道引发的错误。