基于跨项目的代码文件进行构建时代码验证和生成

Question

我正在寻找一种方法，让我可以使用 Visual Studio 2010（非 Express）和 MSBuild 在构建过程中验证代码和生成器代码。

后台验证：

我正在使用 WCF Web Api 编写 RESTful Web 服务。在代表 Web 服务的服务类中，我必须定义一个端点，另外将参数声明为普通测试。当端点声明中的参数名称与 C# 方法的参数不同时，我会收到错误 - 不幸的是，在访问 Web 服务的运行时，而不是在编译时。因此，我认为最好将 Web 服务类作为编译步骤的一部分来分析这样的缺陷，当出现问题时返回错误。

示例：

[WebGet(UriTemplate = "Endpoint/{param1}/{param2}")]
public string MyMethod(string param1, string parameter2) {
    // Accessing the web service now will result in an error,
    // as there's no fitting method-parameter named "param2".
}

我还想强制一些命名规则，例如 GET 方法必须以“Get”一词开头。我相信这将有助于该服务在与多个同事合作时保持更高的可维护性。

后台生成：

我将在其他几个项目中使用此 REST Web 服务，因为我需要编写一个客户端来访问此服务。但我不想为每一个都编写一个客户端，每当服务发生变化时总是进行调整。我希望根据 Web 服务代码文件自动生成客户端。

以前的方法：

到目前为止，我尝试使用使用DTE接口的T4模板来解析代码文件并验证它，或者生成客户端。手动保存时，这在 Visual Studio 中工作得很好，但在构建过程中集成它却不太有效，因为 Visual Studio 主机无法使用 MSBuild。

欢迎任何建议。 :)

Answer 1

您可以使用反射（仅反射上下文）在编译后检查程序集，而不是使用 DTE 或其他方法来解析 C# 代码。使用反射是一种更强大的解决方案，而且可能也更快（特别是如果您使用 Mono.Cecil 进行反射）。

对于 MSBuild 集成，我建议编写一个 自定义 MSBuild 任务 - 这是相当的比编写由 MSBuild 执行的命令行实用程序更简单、更健壮/优雅。

Answer 2

这可能是一个远景，但仍然符合“任何建议”:)

您可以编译代码，然后运行构建后命令，这将是您必须编写的工具，它使用反射来比较解析的 UriTemplate 文本使用方法参数名称，捕获错误并以 MSBuild 拾取的方式输出它们。查看 此链接了解有关如何输出的信息，以便 MSBuild 将错误放入 Visual Studio 错误列表中。如果发现错误，构建后工具可以删除已编译的程序集，从而“模拟”失败的构建。

这是 SO 链接 也引导我访问 MSBuild 博客，仅供参考。

华泰

Answer 3

对于执行方面，自定义 FxCop 规则可能非常适合。

对于客户端代码生成，有很多可能性。如果您喜欢 T4 方法，可能有一种方法可以让它与 MSBuild 一起工作（但您肯定需要提供有关现在不起作用的更多详细信息）。如果您无论如何都想要替代方案，基于反射的构建后工具是另一种选择......

Answer 4

这是一个简短的、极其难看的程序，您可以在一个程序集或一组程序集上运行该程序（只需将 dll 作为参数传递）以执行 WebGet UriTemplate 检查。如果您没有通过任何内容，它会自行运行（并且会适当地失败，因为它是它自己的单元测试）。

该程序将向标准输出打印缺少参数的方法的名称以及缺少参数的名称，如果找到任何参数，将返回非零返回代码（程序失败的标准），使其适合作为构建后事件。如果您的眼睛流血，我不承担任何责任：

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Reflection;
using System.ServiceModel.Web;

namespace ConsoleApplication1
{
    class Program
    {
        static int Main(string[] args)
        {
            var failList = new ConcurrentDictionary<MethodInfo, ISet<String>>();
            var assembliesToRunOn = (args.Length == 0 ? new[] {Assembly.GetExecutingAssembly()} : args.Select(Assembly.LoadFrom)).ToList();
            assembliesToRunOn.AsParallel().ForAll(
                a => Array.ForEach(a.GetTypes(), t => Array.ForEach(t.GetMethods(BindingFlags.Public | BindingFlags.Instance),
                    mi =>
                        {
                            var miParams = mi.GetParameters();
                            var attribs = mi.GetCustomAttributes(typeof (WebGetAttribute), true);
                            if (attribs.Length <= 0) return;
                            var wga = (WebGetAttribute)attribs[0];
                            wga.UriTemplate
                                .Split('/')
                                .ToList()
                                .ForEach(tp =>
                                             {
                                                 if (tp.StartsWith("{") && tp.EndsWith("}"))
                                                 {
                                                     var tpName = tp.Substring(1, tp.Length - 2);
                                                     if (!miParams.Any(pi => pi.Name == tpName))
                                                     {
                                                         failList.AddOrUpdate(mi, new HashSet<string> {tpName}, (miv, l) =>
                                                                                                                    {
                                                                                                                        l.Add(tpName);
                                                                                                                        return l;
                                                                                                                    });
                                                     }
                                                 }
                                             });
                        })));
            if (failList.Count == 0) return 0;
            failList.ToList().ForEach(kvp => Console.Out.WriteLine("Method " + kvp.Key + " in type " + kvp.Key.DeclaringType + " is missing the following expected parameters: " + String.Join(", ", kvp.Value.ToArray())));
            return failList.Count;
        }

        [WebGet(UriTemplate = "Endpoint/{param1}/{param2}")]
        public void WillPass(String param1, String param2) { }

        [WebGet(UriTemplate = "Endpoint/{param1}/{param2}")]
        public void WillFail() { }

        [WebGet(UriTemplate = "Endpoint/{param1}/{param2}")]
        public void WillFail2(String param1) { }
    }
}