當(dāng)前位置：首頁(yè) > 编程资源 > 编程问答 >内容正文

编程问答

使用MSBuild实现完整daily build流程 .

發(fā)布時(shí)間：2025/4/5 编程问答 60 豆豆

生活随笔收集整理的這篇文章主要介紹了使用MSBuild实现完整daily build流程 . 小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

一、MSBuild

在微軟軟件開發(fā)中，每日構(gòu)建是最重要的過程之一，被稱為微軟產(chǎn)品開發(fā)的“心跳”。簡(jiǎn)單來看，每天構(gòu)建系統(tǒng)將整個(gè)產(chǎn)品解決方案完整構(gòu)建一遍，生成的目標(biāo)文件和安裝文件被放置在一個(gè)共享位置。接著，安裝文件被自動(dòng)部署到release server上，隨后可以自動(dòng)運(yùn)行BVT（build verification test），并將所有結(jié)果寄送每個(gè)team member的信箱。

微軟有一套完善的內(nèi)部系統(tǒng)來完成整個(gè)自動(dòng)化流程，以及流程管理、reporting等工作，而如果我們沒有這套系統(tǒng)，也想實(shí)現(xiàn)完整的daily build流程，該怎么做呢？

在VS.NET2003時(shí)代，IDE可以控制整個(gè)方案的構(gòu)建，但是所有的構(gòu)建邏輯被IDE控制，對(duì)于開發(fā)人員來說，整個(gè)構(gòu)建流程就像一個(gè)黑箱，很難修改和管理。當(dāng)然可以使用PreBuildEvent和PostBuildEvent來控制，但是這些event都寫在csproj/vbproj文件中，不便于修改，不適于擴(kuò)展。而且使用IDE來做每日構(gòu)建的話，要求構(gòu)建系統(tǒng)本身裝有VS.NET，這會(huì)帶來額外的成本。另一種辦法是使用NAnt，通過XML配置文件，來管理構(gòu)建流程，這會(huì)使得整個(gè)流程易于修改，可擴(kuò)展，并且不要求構(gòu)建系統(tǒng)安裝IDE，只需要有framework即可。問題是使用NAnt必須額外寫一堆復(fù)雜的XML配置文件，足以讓很多developer看了頭疼。

VS.NET2005中引入了一套全新的構(gòu)建系統(tǒng)：MSBuild。簡(jiǎn)單來講，MSBuild可以直接讀取csproj文件，控制csc/vbc等編譯器，生成整個(gè)方案。實(shí)際上，VS2005的IDE自身就是調(diào)用MSBuild來完成編譯的，這與VS2003有很大的不同。并且由于VS2005的csproj文件服從MSBuild的配置schema，因此我們可以直接使用csproj，稍稍修改一下，就能組織起完整的構(gòu)建流程了。

二、示例項(xiàng)目的組織

來看一個(gè)完整的例子。

我們將建立一個(gè)簡(jiǎn)單的Hello方案，包括一個(gè)HelloService（Windows NT Service），一個(gè)HelloSite（ASP.NET Web Site），和一個(gè)共用組件（class library）。如圖所示。

build目錄中，將用來存放構(gòu)建使用的配置文件。private目錄中存放解決方案本身。public目錄中存放用來完成構(gòu)建所使用的編譯器，例如WiX（用來生成安裝包）。先在private目錄中新建一個(gè)空解決方案，可以命名為“HelloSolution”。然后依次新建SharedComponents、HelloService和HelloSite項(xiàng)目，并建立引用關(guān)系：HelloService引用了SharedComponents。最后的文件組織如圖所示。

刪除Default.aspx第一行的引用，刪除Default.aspx.cs，添加一個(gè)App_Code目錄，在App_Code中新建一個(gè)Hello.cs文件，保持初始代碼不用修改。

在IDE中編譯整個(gè)Solution，沒問題。可以關(guān)閉IDE了。

打開SDK的控制臺(tái)，輸入兩條命令：

CD /d C:\Hello\private\HelloSolution

msbuild

很快就能看到構(gòu)建結(jié)果了：

但這并不完全是我想要的。例如我想將所有的項(xiàng)目輸出都放在C:\Hello\target目錄；我想讓HelloSite有一個(gè)自己的主目錄；我想自動(dòng)生成MSI安裝包，并且也放在target目錄下。

三、修改構(gòu)建流程

首先我們將SharedComponent.csproj和HelloService.csproj文件copy至build目錄下，并將擴(kuò)展名改名為proj。用記事本打開SharedComponents.proj，看到如下內(nèi)容。

<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>

<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>

<OutputType>Library</OutputType>

<AppDesignerFolder>Properties</AppDesignerFolder>

<RootNamespace>SharedComponents</RootNamespace>

<AssemblyName>SharedComponents</AssemblyName>

</PropertyGroup>

<Optimize>false</Optimize>

<OutputPath>bin\Debug\</OutputPath>

<DefineConstants>DEBUG;TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

</PropertyGroup>

<DebugType>pdbonly</DebugType>

<OutputPath>bin\Release\</OutputPath>

<DefineConstants>TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

</PropertyGroup>

</ItemGroup>

</ItemGroup>

<!-- To modify your build process, add your task inside one of the targets below and uncomment it.

Other similar extension points exist, see Microsoft.Common.targets.

</Target>

</Target>

-->

</Project>

觀察可以發(fā)現(xiàn)，紅色的部分是給VS IDE用的，與MSBuild無關(guān)，因此可以刪除。最后幾行中的BeforeBuild和AfterBuild暫時(shí)沒用，也可以刪除。

從第一行開始看：

<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>

<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>

首先看到一個(gè)屬性組，里面的每一條屬性都可以理解成一個(gè)環(huán)境變量。屬性組第一行是說，如果環(huán)境變量“Configuration”為空，那么設(shè)置屬性 “Configuration”為“Debug”。同樣，第二行是說，如果環(huán)境變量“Platform”為空，那么設(shè)置屬性“Platform”為“AnyCPU”。這里我不想使用“AnyCPU”，于是將其改成“x86”。

<OutputType>Library</OutputType>

<AssemblyName>SharedComponents</AssemblyName>

</PropertyGroup>

OutputType指定了輸出類型為類庫(kù)。AssemblyName指定輸出文件名，改為Hello.SharedComponents。

<Optimize>false</Optimize>

<OutputPath>bin\Debug\</OutputPath>

<DefineConstants>DEBUG;TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

</PropertyGroup>

在這一段中，如果Configuration屬性并上“|” 并上Platform屬性，等于“Debug|AnyCPU”的話，那么定義一個(gè)屬性組。換句話說，就是為debug、AnyCPU的組合配置一段編譯器使用的屬性。將第一行的Condition改成“'$(Configuration)' == 'Debug'”（假設(shè)我們并不需要在其它platform上進(jìn)行編譯）。以同樣的方式修改Release的PropertyGroup。

接著是一個(gè)ItemGroup，指定了這個(gè)項(xiàng)目引用的組件。

</ItemGroup>

然后又是一個(gè)ItemGroup，指定了參加編譯的源代碼文件。

</ItemGroup>

再接下來，引入了一個(gè)targets文件：

$(MSBuildBinPath)是一個(gè)環(huán)境變量，或者是之前定義的屬性。Microsoft.CSharp.targets位于C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727目錄下，用記事本打開，查找“Name="CoreCompile"”，可以找到真正控制編譯器運(yùn)行的核心配置。其中$(xxx)表示一個(gè)之前定義的屬性，@(xxx)表示之前定義的ItemGroup。可以發(fā)現(xiàn)，先前在SharedComponents.proj中定義的屬性和Item，最后實(shí)際上都是給這一段CoreCompile用的。由這個(gè)target來控制csc編譯器執(zhí)行最終的編譯。

在第一個(gè)PropertyGroup中添加一個(gè)屬性：SrcDir，其值為“C:\Hello\private\HelloSolution\Shared\SharedComponents”，表示此項(xiàng)目源代碼文件的位置。相應(yīng)修改Compile項(xiàng)目組的Include屬性為：

</ItemGroup>

回到HelloService.proj文件，依上所述，進(jìn)行類似的修改。

注意ProjectReference這個(gè)ItemGroup，這一段將會(huì)被用來解析依賴關(guān)系，需要對(duì)Include屬性做些修改。

最后形成的兩個(gè)文件為：

SharedComponents.proj

<SrcDir>C:\Hello\private\HelloSolution\Shared\SharedComponents</SrcDir>

<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>

<OutputType>Library</OutputType>

<AssemblyName>Hello.SharedComponents</AssemblyName>

</PropertyGroup>

<Optimize>false</Optimize>

<OutputPath>bin\Debug\</OutputPath>

<DefineConstants>DEBUG;TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

</PropertyGroup>

<DebugType>pdbonly</DebugType>

<OutputPath>bin\Release\</OutputPath>

<DefineConstants>TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

</PropertyGroup>

</ItemGroup>

</ItemGroup>

</Project>

HelloService.proj

<SrcDir>C:\Hello\private\HelloSolution\Services\HelloService</SrcDir>

<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>

<OutputType>WinExe</OutputType>

<AssemblyName>Hello.HelloService</AssemblyName>

</PropertyGroup>

<Optimize>false</Optimize>

<OutputPath>bin\Debug\</OutputPath>

<DefineConstants>DEBUG;TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

</PropertyGroup>

<DebugType>pdbonly</DebugType>

<OutputPath>bin\Release\</OutputPath>

<DefineConstants>TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

</PropertyGroup>

</ItemGroup>

</ItemGroup>

</ItemGroup>

</Project>

最后參考上面的兩個(gè)文件和MSDN上MSBuild的資料，新建HelloSite.proj文件：

<VirtualPath>/Hello</VirtualPath>

<PhysicalPath>C:\Hello\private\HelloSolution\Web\HelloSite\</PhysicalPath>

</PropertyGroup>

</PropertyGroup>

<DebugCompile>false</DebugCompile>

</PropertyGroup>

<AspNetCompiler

VirtualPath="$(VirtualPath)"

PhysicalPath="$(PhysicalPath)"

TargetPath="$(TargetPath)"

Force="true"

Debug="$(DebugCompile)"

Updateable="true" />

</Target>

</Project>

轉(zhuǎn)到控制臺(tái)，在C:\Hello\build目錄下執(zhí)行msbuild HelloService.proj，觀察執(zhí)行結(jié)果，發(fā)現(xiàn)MSBuild成功解析出HelloService引用了SharedComponent組件，并首先編譯了被引用的組件，然后才編譯目標(biāo)組件。如圖所示：

再執(zhí)行msbuild HelloSite.proj，構(gòu)建也成功了。

四、進(jìn)一步完善

在這部分中，我們使用環(huán)境變量來替代長(zhǎng)路徑，把項(xiàng)目輸出放到指定位置，將公用的屬性配置放在一個(gè)引用文件里。由于在MSBuild系統(tǒng)中，系統(tǒng)環(huán)境變量和屬性是通用的，因此這些目標(biāo)并不難完成。

在C:\Hello\build目錄中新建一個(gè)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中，我們指定了所需的環(huán)境變量，并調(diào)用了SDK的環(huán)境變量設(shè)置命令。

新建include.property文件，內(nèi)容為：

<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>

<BaseIntermediateOutputPath>$(target)\</BaseIntermediateOutputPath>

<OutputPath>$(target)\$(Platform)\$(Configuration)\</OutputPath>

</PropertyGroup>

<Optimize>false</Optimize>

<DefineConstants>DEBUG;TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

</PropertyGroup>

<DebugType>pdbonly</DebugType>

<DefineConstants>TRACE</DefineConstants>

<ErrorReport>prompt</ErrorReport>

<DebugCompile>false</DebugCompile>

</PropertyGroup>

</Project>

修改SharedComponents.proj：

<SrcDir>$(product)\Shared\SharedComponents</SrcDir>

<OutputType>Library</OutputType>

<AssemblyName>Hello.SharedComponents</AssemblyName>

</PropertyGroup>

</ItemGroup>

</ItemGroup>

</Project>

修改HelloService.proj：

<SrcDir>$(product)\Services\HelloService</SrcDir>

<OutputType>WinExe</OutputType>

<AssemblyName>Hello.HelloService</AssemblyName>

</PropertyGroup>

</ItemGroup>

</ItemGroup>

</ItemGroup>

</Project>

修改HelloSite.proj：

<VirtualPath>/Hello</VirtualPath>

<PhysicalPath>C:\Hello\private\HelloSolution\Web\HelloSite\</PhysicalPath>

<TargetPath>$( OutputPath)\Web</TargetPath>

</PropertyGroup>

<AspNetCompiler

VirtualPath="$(VirtualPath)"

PhysicalPath="$(PhysicalPath)"

TargetPath="$(TargetPath)"

Force="true"

Debug="$(DebugCompile)"

Updateable="true" />

</Target>

</Project>

在C:\Hello目錄下新建一個(gè)build.proj文件：

<Project DefaultTargets="Compile"

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

</Target>

</Project>

在C:\Hello目錄中新建一個(gè)build.cmd文件：

@echo off

@set Configuration=Debug

msbuild build.proj /t:Build

@set Configuration=Release

msbuild build.proj /t:Build

在桌面上新建一個(gè)快捷方式，命名為“Hello”，Target設(shè)置為：

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

Start in設(shè)置為C:\Hello，Option中選上“QuickEdit mode”。

退出命令行，雙擊桌面上的Hello快捷方式，運(yùn)行build，大約五秒鐘后，整個(gè)方案就被成功構(gòu)建了，所有的項(xiàng)目輸出都在C:\Hello\target目錄下。

五、Installer

VS.NET中可以新建一個(gè)安裝項(xiàng)目，用來編譯生成安裝包，但是這種生成方式類似用IDE來build項(xiàng)目一樣，不適于擴(kuò)展，而且很難通過命令行來執(zhí)行編譯。

替代的方法是使用WiX toolset。WiX是Windows Installer XML的縮寫，是微軟的第一個(gè)開源項(xiàng)目，可以在SourceForge上下載。

在C:\Hello\private\HelloSolution目錄下新建一個(gè)Setup目錄。新建一個(gè)HelloService.wxs文件：

<Package Id="YOURGUID"

Description='Hello Service Windows Installer package'

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

Privileged

</Condition>

VersionNT = 502

</Condition>

</Component>

</Component>

</Directory>

</Feature>

</Product>

</Wix>

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

新建HelloSite.wxs文件：

<Package Id="YOURGUID"

Description='Hello Site Windows Installer package'

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

Privileged

</Condition>

VersionNT = 502

</Condition>

</Component>

</Component>

</Directory>

</WebSite>

</Component>

</Directory>

</Feature>

</Product>

</Wix>

注意HelloSite將在把Site程序安裝在WebSite下，因此不要在你的關(guān)鍵機(jī)器上安裝這個(gè)示例，并且安裝HelloSite前要備份你的IIS設(shè)置。

修改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"

運(yùn)行build，構(gòu)建完成后，發(fā)現(xiàn)target目錄中，MSI installer也被生成了。接下去運(yùn)行

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

C:\Program Files\Hello\Service目錄中出現(xiàn)了安裝好的文件。打開services.msc，找到“Hello Service”，試著運(yùn)行一下。

運(yùn)行msiexec /x %target%\%Platform%\%Configuration%\Setup\HelloService.msi卸載。

運(yùn)行msiexec /i %target%\%Platform%\%Configuration%\Setup\HelloSite.msi安裝Web程序。

運(yùn)行msiexec /x %target%\%Platform%\%Configuration%\Setup\HelloSite.msi卸載。

六、自動(dòng)化

最后一個(gè)任務(wù)就是實(shí)現(xiàn)自動(dòng)化，每日定時(shí)構(gòu)建。

在C:\Hello目錄中新建一個(gè)DailyBuild.bat文件：

@echo off

@set inetroot=C:\Hello

call C:\Hello\build\Include.cmd

call C:\Hello\build.cmd

在Services.msc中enable “Task Scheduler”服務(wù)。在控制面板的“Scheduled Tasks”中，新建一個(gè)任務(wù)：Build Hello，指定其每天03:00AM運(yùn)行C:\DailyBuild.bat。

右鍵點(diǎn)擊這個(gè)task，選擇運(yùn)行，可以先看一下結(jié)果。

就這樣，daily build的任務(wù)完全實(shí)現(xiàn)自動(dòng)化了。

七、擴(kuò)展

在示例方案中，由于MSI安裝包都已經(jīng)自動(dòng)生成了，接下去能做的就更多了，例如實(shí)現(xiàn)自動(dòng)部署，自動(dòng)測(cè)試（BVT），自動(dòng)report結(jié)果，等等。這些工作需要與tester合作，本文不再展開。

自動(dòng)化流程是保持項(xiàng)目良好運(yùn)作的關(guān)鍵，在微軟公司，這一流程受到高度的重視，通常由developer manager直接負(fù)責(zé)。如果哪天出現(xiàn)了build break，那么developer在開始一天的coding之前，必須先找到昨天的build哪里出現(xiàn)了問題，先去修復(fù)，重新build，直到build成功為止，沒有例外。

轉(zhuǎn)自：http://blog.csdn.net/dz45693/article/details/6752653

轉(zhuǎn)載于:https://www.cnblogs.com/xgcblog/archive/2011/09/17/2179507.html

總結(jié)

以上是生活随笔為你收集整理的使用MSBuild实现完整daily build流程 .的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇： VMware View 5.0 Read
下一篇： Mylyn 2.0，第 2 部分: 自动