使用MSBuild实现完整daily build流程

[Author:Jason Wang]

一、MSBuild

在微软软件开发中，每日构建是最重要的过程之一，被称为微软产品开发的“心跳”。简单来看，每天构建系统将整个产品解决方案完整构建一遍，生成的目标文件和安装文件被放置在一个共享位置。接着，安装文件被自动部署到release server上，随后可以自动运行BVT（build verification test），并将所有结果寄送每个team member的信箱。

微软有一套完善的内部系统来完成整个自动化流程，以及流程管理、reporting等工作，而如果我们没有这套系统，也想实现完整的daily build流程，该怎么做呢？

在VS.NET2003时代，IDE可以控制整个方案的构建，但是所有的构建逻辑被IDE控制，对于开发人员来说，整个构建流程就像一个黑箱，很难修改和管理。当然可以使用PreBuildEvent和PostBuildEvent来控制，但是这些event都写在csproj/vbproj文件中，不便于修改，不适于扩展。而且使用IDE来做每日构建的话，要求构建系统本身装有VS.NET，这会带来额外的成本。另一种办法是使用NAnt，通过XML配置文件，来管理构建流程，这会使得整个流程易于修改，可扩展，并且不要求构建系统安装IDE，只需要有framework即可。问题是使用NAnt必须额外写一堆复杂的XML配置文件，足以让很多developer看了头疼。

VS.NET2005中引入了一套全新的构建系统：MSBuild。简单来讲，MSBuild可以直接读取csproj文件，控制csc/vbc等编译器，生成整个方案。实际上，VS2005的IDE自身就是调用MSBuild来完成编译的，这与VS2003有很大的不同。并且由于VS2005的csproj文件服从MSBuild的配置schema，因此我们可以直接使用csproj，稍稍修改一下，就能组织起完整的构建流程了。

 

二、示例项目的组织

来看一个完整的例子。

我们将建立一个简单的Hello方案，包括一个HelloService（Windows NT Service），一个HelloSite（ASP.NET Web Site），和一个共用组件（class library）。如图所示。

build目录中，将用来存放构建使用的配置文件。private目录中存放解决方案本身。public目录中存放用来完成构建所使用的编译器，例如WiX（用来生成安装包）。先在private目录中新建一个空解决方案，可以命名为“HelloSolution”。然后依次新建SharedComponents、HelloService和HelloSite项目，并建立引用关系：HelloService引用了SharedComponents。最后的文件组织如图所示。

删除Default.aspx第一行的引用，删除Default.aspx.cs，添加一个App_Code目录，在App_Code中新建一个Hello.cs文件，保持初始代码不用修改。

在IDE中编译整个Solution，没问题。可以关闭IDE了。

打开SDK的控制台，输入两条命令：

CD /d C:\Hello\private\HelloSolution

msbuild

很快就能看到构建结果了：

但这并不完全是我想要的。例如我想将所有的项目输出都放在C:\Hello\target目录；我想让HelloSite有一个自己的主目录；我想自动生成MSI安装包，并且也放在target目录下。

三、修改构建流程

首先我们将SharedComponent.csproj和HelloService.csproj文件copy至build目录下，并将扩展名改名为proj。用记事本打开SharedComponents.proj，看到如下内容。

Debug

AnyCPU

8.0.50727

2.0

{FF79BA82-D6CE-4E89-9AFA-C5EF83A62C2D}

Library

Properties

SharedComponents

SharedComponents

true

full

false

bin\Debug\

DEBUG;TRACE

prompt

4

pdbonly

true

bin\Release\

TRACE

prompt

4

观察可以发现，红色的部分是给VS IDE用的，与MSBuild无关，因此可以删除。最后几行中的BeforeBuild和AfterBuild暂时没用，也可以删除。

从第一行开始看：

Debug

AnyCPU

首先看到一个属性组，里面的每一条属性都可以理解成一个环境变量。属性组第一行是说，如果环境变量“Configuration”为空，那么设置属性 “Configuration”为“Debug”。同样，第二行是说，如果环境变量“Platform”为空，那么设置属性“Platform”为“AnyCPU”。这里我不想使用“AnyCPU”，于是将其改成“x86”。

Library

SharedComponents

OutputType指定了输出类型为类库。AssemblyName指定输出文件名，改为Hello.SharedComponents。

true

full

false

bin\Debug\

DEBUG;TRACE

prompt

4

在这一段中，如果Configuration属性并上“|” 并上Platform属性，等于“Debug|AnyCPU”的话，那么定义一个属性组。换句话说，就是为debug、AnyCPU的组合配置一段编译器使用的属性。将第一行的Condition改成“'$(Configuration)' == 'Debug'”（假设我们并不需要在其它platform上进行编译）。以同样的方式修改Release的PropertyGroup。

接着是一个ItemGroup，指定了这个项目引用的组件。

然后又是一个ItemGroup，指定了参加编译的源代码文件。

再接下来，引入了一个targets文件：

$(MSBuildBinPath)是一个环境变量，或者是之前定义的属性。Microsoft.CSharp.targets位于C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727目录下，用记事本打开，查找“Name="CoreCompile"”，可以找到真正控制编译器运行的核心配置。其中$(xxx)表示一个之前定义的属性，@(xxx)表示之前定义的ItemGroup。可以发现，先前在SharedComponents.proj中定义的属性和Item，最后实际上都是给这一段CoreCompile用的。由这个target来控制csc编译器执行最终的编译。

在第一个PropertyGroup中添加一个属性：SrcDir，其值为“C:\Hello\private\HelloSolution\Shared\SharedComponents”，表示此项目源代码文件的位置。相应修改Compile项目组的Include属性为：

回到HelloService.proj文件，依上所述，进行类似的修改。

注意ProjectReference这个ItemGroup，这一段将会被用来解析依赖关系，需要对Include属性做些修改。

最后形成的两个文件为：

SharedComponents.proj

C:\Hello\private\HelloSolution\Shared\SharedComponents

Debug

x86

Library

Hello.SharedComponents

true

full

false

bin\Debug\

DEBUG;TRACE

prompt

4

pdbonly

true

bin\Release\

TRACE

prompt

4

HelloService.proj

C:\Hello\private\HelloSolution\Services\HelloService

Debug

x86

WinExe

Hello.HelloService

true

full

false

bin\Debug\

DEBUG;TRACE

prompt

4

pdbonly

true

bin\Release\

TRACE

prompt

4

最后参考上面的两个文件和MSDN上MSBuild的资料，新建HelloSite.proj文件：

/Hello

C:\Hello\private\HelloSolution\Web\HelloSite\

Web

true

false

VirtualPath="$(VirtualPath)"

PhysicalPath="$(PhysicalPath)"

TargetPath="$(TargetPath)"

Force="true"

Debug="$(DebugCompile)"

Updateable="true" />

转到控制台，在C:\Hello\build目录下执行msbuild HelloService.proj，观察执行结果，发现MSBuild成功解析出HelloService引用了SharedComponent组件，并首先编译了被引用的组件，然后才编译目标组件。如图所示：

再执行msbuild HelloSite.proj，构建也成功了。

 

四、进一步完善

在这部分中，我们使用环境变量来替代长路径，把项目输出放到指定位置，将公用的属性配置放在一个引用文件里。由于在MSBuild系统中，系统环境变量和属性是通用的，因此这些目标并不难完成。

在C:\Hello\build目录中新建一个include.cmd文件。

@echo off

@set public=%inetroot%\public

@set private=%inetroot%\private

@set target=%inetroot%\target

@set product=%private%\HelloSolution

@set setup=%product%\Setup

@set wix=%public%\WiX

@set Platform=%PROCESSOR_ARCHITECTURE%

call "C:\Program Files\Microsoft Visual Studio 8\SDK\v2.0\Bin\sdkvars.bat"

在include.cmd中，我们指定了所需的环境变量，并调用了SDK的环境变量设置命令。

新建include.property文件，内容为：

Debug

x86

$(target)\

$(target)\$(Platform)\$(Configuration)\

true

full

false

DEBUG;TRACE

prompt

4

true

pdbonly

true

TRACE

prompt

4

false

修改SharedComponents.proj：

$(product)\Shared\SharedComponents

Library

Hello.SharedComponents

修改HelloService.proj：

$(product)\Services\HelloService

WinExe

Hello.HelloService

修改HelloSite.proj：

/Hello

C:\Hello\private\HelloSolution\Web\HelloSite\

$( OutputPath)\Web

VirtualPath="$(VirtualPath)"

PhysicalPath="$(PhysicalPath)"

TargetPath="$(TargetPath)"

Force="true"

Debug="$(DebugCompile)"

Updateable="true" />

在C:\Hello目录下新建一个build.proj文件：

xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

在C:\Hello目录中新建一个build.cmd文件：

@echo off

@set Configuration=Debug

msbuild build.proj /t:Build

@set Configuration=Release

msbuild build.proj /t:Build

在桌面上新建一个快捷方式，命名为“Hello”，Target设置为：

C:\WINDOWS\system32\cmd.exe /K set inetroot=C:\Hello&"C:\Hello\build\Include.cmd"

Start in设置为C:\Hello，Option中选上“QuickEdit mode”。

退出命令行，双击桌面上的Hello快捷方式，运行build，大约五秒钟后，整个方案就被成功构建了，所有的项目输出都在C:\Hello\target目录下。

五、Installer

VS.NET中可以新建一个安装项目，用来编译生成安装包，但是这种生成方式类似用IDE来build项目一样，不适于扩展，而且很难通过命令行来执行编译。

替代的方法是使用WiX toolset。WiX是Windows Installer XML的缩写，是微软的第一个开源项目，可以在SourceForge上下载。

在C:\Hello\private\HelloSolution目录下新建一个Setup目录。新建一个HelloService.wxs文件：

Description='Hello Service Windows Installer package'

Manufacturer='Hello Corporation' InstallerVersion='200' Compressed='yes' />

Privileged

VersionNT = 502

其中的YOURGUID需要用一个自己生成的guid来代替，可以用C:\Program Files\Microsoft Visual Studio 8\Common7\Tools\guidgen.exe来生成guid。

新建HelloSite.wxs文件：

Description='Hello Site Windows Installer package'

Manufacturer='Hello Corporation' InstallerVersion='200' Compressed='yes' />

Privileged

VersionNT = 502

注意HelloSite将在把Site程序安装在WebSite下，因此不要在你的关键机器上安装这个示例，并且安装HelloSite前要备份你的IIS设置。

修改build.cmd文件：

@echo off

@set Configuration=Debug

msbuild build.proj /t:Build

if not exist "%target%\%Platform%\%Configuration%\Setup" (mkdir "%target%\%Platform%\%Configuration%\Setup") ELSE (del "%target%\%Platform%\%Configuration%\Setup\*.*" /q)

%wix%\candle %setup%\HelloService.wxs -out "%target%\%Platform%\%Configuration%\Setup\\"

%wix%\light "%target%\%Platform%\%Configuration%\Setup\HelloService.wixobj" /out "%target%\%Platform%\%Configuration%\Setup\HelloService.msi"

%wix%\candle %setup%\HelloSite.wxs -out "%target%\%Platform%\%Configuration%\Setup\\"

%wix%\light "%target%\%Platform%\%Configuration%\Setup\HelloSite.wixobj" "%wix%\ca\sca.wixlib" /out "%target%\%Platform%\%Configuration%\Setup\HelloSite.msi"

@set Configuration=Release

msbuild build.proj /t:Build

if not exist "%target%\%Platform%\%Configuration%\Setup" (mkdir "%target%\%Platform%\%Configuration%\Setup") ELSE (del "%target%\%Platform%\%Configuration%\Setup\*.*" /q)

%wix%\candle %setup%\HelloService.wxs -out "%target%\%Platform%\%Configuration%\Setup\\"

%wix%\light "%target%\%Platform%\%Configuration%\Setup\HelloService.wixobj" /out "%target%\%Platform%\%Configuration%\Setup\HelloService.msi"

%wix%\candle %setup%\HelloSite.wxs -out "%target%\%Platform%\%Configuration%\Setup\\"

%wix%\light "%target%\%Platform%\%Configuration%\Setup\HelloSite.wixobj" "%wix%\ca\sca.wixlib" /out "%target%\%Platform%\%Configuration%\Setup\HelloSite.msi"

运行build，构建完成后，发现target目录中，MSI installer也被生成了。接下去运行

msiexec /i %target%\%Platform%\%Configuration%\Setup\HelloService.msi

C:\Program Files\Hello\Service目录中出现了安装好的文件。打开services.msc，找到“Hello Service”，试着运行一下。

运行msiexec /x %target%\%Platform%\%Configuration%\Setup\HelloService.msi卸载。

运行msiexec /i %target%\%Platform%\%Configuration%\Setup\HelloSite.msi安装Web程序。

运行msiexec /x %target%\%Platform%\%Configuration%\Setup\HelloSite.msi卸载。

 

六、自动化

最后一个任务就是实现自动化，每日定时构建。

在C:\Hello目录中新建一个DailyBuild.bat文件：

@echo off

@set inetroot=C:\Hello

call C:\Hello\build\Include.cmd

call C:\Hello\build.cmd

在Services.msc中enable “Task Scheduler”服务。在控制面板的“Scheduled Tasks”中，新建一个任务：Build Hello，指定其每天03:00AM运行C:\DailyBuild.bat。

右键点击这个task，选择运行，可以先看一下结果。

就这样，daily build的任务完全实现自动化了。

 

七、扩展

在示例方案中，由于MSI安装包都已经自动生成了，接下去能做的就更多了，例如实现自动部署，自动测试（BVT），自动report结果，等等。这些工作需要与tester合作，本文不再展开。

自动化流程是保持项目良好运作的关键，在微软公司，这一流程受到高度的重视，通常由developer manager直接负责。如果哪天出现了build break，那么developer在开始一天的coding之前，必须先找到昨天的build哪里出现了问题，先去修复，重新build，直到build成功为止，没有例外。

转载于:https://www.cnblogs.com/zoti/archive/2007/07/14/817846.html