在 Ant 或 MSBuild 中编写构建脚本的任何最佳实践

Question

我正在尝试使用 Ant 和 MSBuild 自动化项目（java 和 .net）的构建过程。我已经阅读过它们并知道如何在 Ant 和 MSBuild 中编写构建脚本。但我想知道，是否有任何编写构建脚本的指南或最佳实践？这是我发现的两个，但我想听到其他开发人员的更多信息。

• 在编写构建脚本时，只需依赖位于 源代码管理并可在工作文件夹中使用 检查来源。不要编写以下构建脚本 依赖于未保留在源代码控制中的项目。
• 如果一个项目包含一组子系统，并且每个子系统都有 它自己的构建脚本，项目的构建文件应该只调用 子系统的构建脚本。此外，这些文件应该导入一个通用的构建文件，其中包含编译、测试、打包等目标。

我见过 这篇文章也是如此，但它详细介绍了编写任务的方式。如上所述，我需要更高级别的指导方针。

以下是我从答案中收集的指南：

1. 在干净的环境中运行每个构建。这意味着每个构建脚本都需要一个 clean 目标。
2. 构建脚本通常应包含 compile、package 和 test 目标。
3. 如果一个产品有不同的开发线（例如 dev 、release）， 它们都应该具有相同的构建脚本。但是，不同 应将参数传递给这些脚本。
4. 在开发线上执行的构建通常包含编译、 打包、部署和安装步骤。但建立在发布的基础上 行包括进一步的步骤，例如标记产品和 生成变更日志/发行说明。
5. 构建脚本也应该保留在源代码控制中。
6. 尝试将所有构建信息保留在构建脚本中，而不是 持续集成服务器（Bamboo、TeamCity 等）
7. 如果您的构建使用的参数将来可能会更改（例如 复制构建结果的网络地址），不要将其硬编码到 你的构建脚本。相反，使用构建参数来更多地控制它 容易地。

Answer 1

如果您正在构建 VisualStudio 应用程序，那么最好使用 msbuild 而不是 Ant。 msbuild 命令将使用开发人员创建的解决方案文件进行构建，并基本上模拟他们所做的相同构建。

如果您确实想自动化一切，请查看 Jenkins。它有一个可以执行 msbuild 的插件，并且每次有人进行更改时都会自动触发构建。我将 msbuild 和 Ant 与 Jenkins 结合使用。我使用 msbuild 进行构建，然后使用 Ant 收集并压缩所有构建的工件。然后，人们可以直接从 Jenkins 下载构建的工件。

现在，对于 Java 应用程序，您必须使用 Ant。我使用以下准则

• 每个构建脚本都需要一个 clean 目标。此目标会删除构建过程中添加的所有文件，将工作目录返回到发生clean之前的状态。
• 我遵循 Maven 在使用目标名称时所做的操作，因此我的目标是诸如 clean、compile 和 package 之类的名称。
• 同样遵循 Maven 指南，我的所有构建文件都放置在 target 目录中。这样，我的 clean 命令可以简单地执行
• 如果我有子项目，则每个子项目项目有自己的 build.xml 文件。我的主 build.xml 文件只是调用所有子项目的 build.xml 文件。
• 使用Ivy 易于设置且易于使用，您不再有在源代码中存储 jar 文件的问题。 不幸的是，大多数
• 较旧的项目mavenize都比它的价值要困难。
• 使用 Jenkins 进行构建作为持续构建而且，离开部门的所有构建（UAT、QA 和保护构建）都必须是 Jenkins 构建。
• 事实上，Jenkins 可以执行单元测试并在其构建页面上显示其结果。
• 使用其他工具，例如 checkstyle、PMD、CPD、Findbugs 和其他代码验证产品。当然，Jenkins 可以运行其中的每一个并显示漂亮的图表，这些图表可用于向您的经理展示您的工作有多努力。

Answer 2

只是对您上面提到的第二个要点的评论：

如果一个项目包含一组子系统，并且每个子系统都有自己的
自己的构建脚本，项目的构建文件应该只调用
构建子系统的脚本。

每个子系统都应该有自己的构建文件，但该文件应该导入一个公共构建文件。通用构建文件将包含编译、测试、打包等目标。

http://ant .apache.org/manual/Tasks/import.html

子系统构建文件非常简单，不包含重复内容，仅包含特定于该子系统的信息（例如compile.classpath）。

Answer 3

在 MSBuild 中，目标应尽可能指定输入和输出（以启用依赖项计算）。如有必要，请使用 Returns 属性来指定返回与用于依赖性计算的项目不同的项目的目标。

给定目标的输入和输出项应使用项转换（对于简单的基于路径的转换）或另一个目标（对于更复杂的转换）生成。

对于 MSBuild 4.x 之前的版本，对于您在 .targets 文件中定义的目标，请考虑使用以下模式使使用者能够在您定义的目标之前注入自己的目标：

<PropertyGroup>
  <MyTargetDependsOn>
    Target1;
    Target2;
    SomeOtherTarget
  </MyTargetDependsOn>
</PropertyGroup>
<Target
  Name="MyTarget"
  DependsOnTargets="$(MyTargetDependsOn)">

</Target>

这使使用者能够在指定的目标之前注入自己的目标只需修改 MyTargetsDependsOn 属性的值：

<PropertyGroup>
  <MyTargetDependsOn>
    $(MyTargetDependsOn);
    YetAnotherTarget
  </MyTargetDependsOn>
</PropertyGroup>
<Target
  Name="YetAnotherTarget">

</Target>

在 MSBuild 4.x 中，您可以简单地使用 BeforeTargets 和 AfterTargets 属性。