Visual Studio 2008/2010 版本控制宏

在进行软件开发时，程序的版本控制非常重要。我控制版本的方案如下：

版本号一般如下形式：AA.BB.CC.DDDD。其中AA，BB，CC由自己定义，DDDD由我做的版本控制宏自动递增。

• AA代表大版本号，有大的更新和功能增加时改变此号码。此版本升级后，BB、CC清零。
• BB代表小一级版本号，有小的更新和功能增加时改变此号码。此版本升级后，CC清零。
• CC代表更小一级的版本号，用于代表对Bug的修正。每次修正Bug即改变此号码。
• DD代表编译次数，依次累加递增，不做清零。

我编写的宏响应OnBuildBegin，每次编译project时自动增加DDDD的版本号。此宏目前支持C#，VC++，应该也支持VB，不过没有测试过，呵呵。有几点需要说明一下：

1. 对于C# project，只修改AssemblyVersion。删除了AssembleInfo.cs中的FileVersion段。
2. 对于VC project，修改的.rc中的四处版本号。
3. 由于Visual Stdio多语言特性的原因（猜想应该是这个原因），对于VC Project，修改.rc文件后，必须采用unicode编码输出，才能实现对多语言的支持，比如中文。而对于C# project则不需要也不能以unicode编码输出。

代码如下：

EnvironmentEvents中，响应BuildBegin事件

Private Sub BuildEvents_OnBuildBegin(ByVal Scope As EnvDTE.vsBuildScope, ByVal Action As EnvDTE.vsBuildAction) Handles BuildEvents.OnBuildBegin Start() End Sub   

 

Main中如下：

Imports System Imports EnvDTE Imports EnvDTE80 Imports System.Diagnostics Imports System.IO Imports System.Text.RegularExpressions Public Module Main ' Path to file AssemblyInfo.cs, relative to path of the project ReadOnly m_sAssemblyInfoFilePath As String = "Properties/AssemblyInfo.cs" Dim m_OutputWindowPane As OutputWindowPane ' Regular expression to match the version string ReadOnly m_sVersion As String = "AssemblyVersion/(" & Chr(34) & "([0-9]+)/.([0-9]+)/.([0-9]+)/.([0-9/.]+)" & Chr(34) & "/)" ReadOnly m_sFileVersion As String = "FILEVERSION ([0-9]+)/,([0-9]+)/,([0-9]+)/,([0-9/.]+)" ReadOnly m_sProductVersion As String = "PRODUCTVERSION ([0-9]+)/,([0-9]+)/,([0-9]+)/,([0-9/.]+)" ReadOnly m_sFileVersion2 As String = "VALUE " + Chr(34) + "FileVersion" + Chr(34) + ", " + Chr(34) + "([0-9]+)/.([0-9]+)/.([0-9]+)/.([0-9/.]+)" + Chr(34) ReadOnly m_sProductVersion2 As String = "VALUE " + Chr(34) + "ProductVersion" + Chr(34) + ", " + Chr(34) + "([0-9]+)/.([0-9]+)/.([0-9]+)/.([0-9/.]+)" + Chr(34) Function GetOutputWindowPane(ByVal sName As String, Optional ByVal show As Boolean = True) As OutputWindowPane Dim win As Window = DTE.Windows.Item(EnvDTE.Constants.vsWindowKindOutput) If show Then win.Visible = True Dim outputWindow As OutputWindow = win.Object Dim outputWindowPane As OutputWindowPane Try outputWindowPane = outputWindow.OutputWindowPanes.Item(sName) Catch e As System.Exception outputWindowPane = outputWindow.OutputWindowPanes.Add(sName) End Try If show Then outputWindowPane.Activate() Return outputWindowPane End Function Sub Start() Dim project As Project m_OutputWindowPane = GetOutputWindowPane("Build", False) project = CType(DTE.ActiveSolutionProjects().GetValue(0), EnvDTE.Project) If project.ConfigurationManager.ActiveConfiguration.ConfigurationName = "Release" Then m_OutputWindowPane.OutputString("[DSVerCtrl]: Release build, skip the version control." & Microsoft.VisualBasic.Constants.vbCrLf) Exit Sub End If If project.CodeModel.Language = CodeModelLanguageConstants.vsCMLanguageCSharp Or project.CodeModel.Language = CodeModelLanguageConstants.vsCMLanguageVB Then 'm_OutputWindowPane.OutputString("[DSVerCtrl]: The project is not C# project, pass the version control." & Microsoft.VisualBasic.Constants.vbCrLf) UpdateCSharpVersion(project) Exit Sub ElseIf project.CodeModel.Language = CodeModelLanguageConstants.vsCMLanguageVC Then 'm_OutputWindowPane.OutputString("[DSVerCtrl]: The project is VC project, pass the version control." & Microsoft.VisualBasic.Constants.vbCrLf) UpdateVCVersion(project) Exit Sub Else m_OutputWindowPane.OutputString("[DSVerCtrl]: The project is not C#, VB or VC project, pass the version control." & Microsoft.VisualBasic.Constants.vbCrLf) End If End Sub Private Sub UpdateCSharpVersion(ByVal project As Project) Dim vsProject As VSLangProj.VSProject Dim sProjectPath As String Dim sAssemblyInfoFile As String Dim sContent As String Dim verStrRegEx As Regex Dim match As Match Dim nVer As Integer Dim sNewVer As String vsProject = CType(project.Object(), VSLangProj.VSProject) sProjectPath = vsProject.Project.Properties.Item("FullPath").Value sAssemblyInfoFile = sProjectPath & m_sAssemblyInfoFilePath 'outputWindowPane.OutputString("[DSVerCtrl]: Changing the version of """ + project.FullName + """..." + Microsoft.VisualBasic.Constants.vbCrLf) 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Changing the version of """ + sProjectPath + """..." + Microsoft.VisualBasic.Constants.vbCrLf) m_OutputWindowPane.OutputString("[DSVerCtrl]: Modifying the version of """ & project.Name & """..." & Microsoft.VisualBasic.Constants.vbCrLf) 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Assembly info file name is """ + sAssemblyInfoFile + """." + Microsoft.VisualBasic.Constants.vbCrLf) sContent = ReadFileContent(sAssemblyInfoFile) 'm_OutputWindowPane.OutputString("[DSVerCtrl]: File content is """ + sContent + "" + Microsoft.VisualBasic.Constants.vbCrLf) verStrRegEx = New Regex(m_sVersion) match = verStrRegEx.Match(sContent) If match.Success Then 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Found match string." + Microsoft.VisualBasic.Constants.vbCrLf) nVer = Convert.ToInt32(match.Groups.Item(4).Value) nVer = nVer + 1 sContent = sContent.Remove(match.Groups.Item(4).Index, match.Groups.Item(4).Length) sContent = sContent.Insert(match.Groups.Item(4).Index, nVer.ToString()) Else m_OutputWindowPane.OutputString("[DSVerCtrl]: Can not find the version string." & Microsoft.VisualBasic.Constants.vbCrLf) End If sNewVer = match.Groups.Item(1).Value & "." & match.Groups.Item(2).Value & "." & match.Groups.Item(3).Value & "." & nVer.ToString() m_OutputWindowPane.OutputString("[DSVerCtrl]: Modified the version to """ & sNewVer & """." & Microsoft.VisualBasic.Constants.vbCrLf) 'm_OutputWindowPane.OutputString("[DSVerCtrl]: File content after modify is """ + sContent + "" + Microsoft.VisualBasic.Constants.vbCrLf) WriteFileContent(sAssemblyInfoFile, sContent, False) End Sub Private Sub UpdateVCVersion(ByVal project As Project) Dim vsProject As VSLangProj.VSProject Dim sProjectPath As String Dim sAssemblyInfoFile As String Dim sContent As String Dim verStrRegEx As Regex Dim match As Match Dim nVer As Integer Dim sNewVer As String vsProject = CType(project.Object(), VSLangProj.VSProject) sProjectPath = vsProject.Project.Properties.Item("ProjectDirectory").Value 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Changing the version of """ + sProjectPath + """..." + Microsoft.VisualBasic.Constants.vbCrLf) sAssemblyInfoFile = sProjectPath + project.Name + ".rc" 'outputWindowPane.OutputString("[DSVerCtrl]: Changing the version of """ + project.FullName + """..." + Microsoft.VisualBasic.Constants.vbCrLf) m_OutputWindowPane.OutputString("[DSVerCtrl]: Modifying the version of """ & project.Name & """..." & Microsoft.VisualBasic.Constants.vbCrLf) 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Recourse file name is """ + sAssemblyInfoFile + """." + Microsoft.VisualBasic.Constants.vbCrLf) sContent = ReadFileContent(sAssemblyInfoFile) 'm_OutputWindowPane.OutputString("[DSVerCtrl]: File content is """ + sContent + "" + Microsoft.VisualBasic.Constants.vbCrLf) verStrRegEx = New Regex(m_sFileVersion) match = verStrRegEx.Match(sContent) If match.Success Then 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Found match string." + Microsoft.VisualBasic.Constants.vbCrLf) nVer = Convert.ToInt32(match.Groups.Item(4).Value) nVer = nVer + 1 sContent = sContent.Remove(match.Groups.Item(4).Index, match.Groups.Item(4).Length) sContent = sContent.Insert(match.Groups.Item(4).Index, nVer.ToString()) Else m_OutputWindowPane.OutputString("[DSVerCtrl]: Can not find the FILEVERSION version string." & Microsoft.VisualBasic.Constants.vbCrLf) End If verStrRegEx = New Regex(m_sProductVersion) match = verStrRegEx.Match(sContent) If match.Success Then 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Found match string." + Microsoft.VisualBasic.Constants.vbCrLf) sContent = sContent.Remove(match.Groups.Item(4).Index, match.Groups.Item(4).Length) sContent = sContent.Insert(match.Groups.Item(4).Index, nVer.ToString()) Else m_OutputWindowPane.OutputString("[DSVerCtrl]: Can not find the PRODUCTVERSION version string." & Microsoft.VisualBasic.Constants.vbCrLf) End If verStrRegEx = New Regex(m_sFileVersion2) match = verStrRegEx.Match(sContent) If match.Success Then 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Found match string." + Microsoft.VisualBasic.Constants.vbCrLf) sContent = sContent.Remove(match.Groups.Item(4).Index, match.Groups.Item(4).Length) sContent = sContent.Insert(match.Groups.Item(4).Index, nVer.ToString()) Else m_OutputWindowPane.OutputString("[DSVerCtrl]: Can not find the FileVersion version string." & Microsoft.VisualBasic.Constants.vbCrLf) End If verStrRegEx = New Regex(m_sProductVersion2) match = verStrRegEx.Match(sContent) If match.Success Then 'm_OutputWindowPane.OutputString("[DSVerCtrl]: Found match string." + Microsoft.VisualBasic.Constants.vbCrLf) sContent = sContent.Remove(match.Groups.Item(4).Index, match.Groups.Item(4).Length) sContent = sContent.Insert(match.Groups.Item(4).Index, nVer.ToString()) Else m_OutputWindowPane.OutputString("[DSVerCtrl]: Can not find the ProductVersion version string." & Microsoft.VisualBasic.Constants.vbCrLf) End If sNewVer = match.Groups.Item(1).Value & "." & match.Groups.Item(2).Value & "." & match.Groups.Item(3).Value & "." & nVer.ToString() m_OutputWindowPane.OutputString("[DSVerCtrl]: Modified the version to """ & sNewVer & """." & Microsoft.VisualBasic.Constants.vbCrLf) 'm_OutputWindowPane.OutputString("[DSVerCtrl]: File content after modify is """ + sContent + "" + Microsoft.VisualBasic.Constants.vbCrLf) WriteFileContent(sAssemblyInfoFile, sContent, True) End Sub ' Read file content to a string Private Function ReadFileContent(ByVal sFileName As String) As String Dim readerStream As StreamReader Dim sFileContent As String Try readerStream = New StreamReader(sFileName, True) Catch e As FileNotFoundException m_OutputWindowPane.OutputString("[DSVerCtrl] - ERROR: Can not find the file """ & sFileName & """." & Microsoft.VisualBasic.Constants.vbCrLf) Exit Function Catch e As Exception m_OutputWindowPane.OutputString("[DSVerCtrl] - ERROR: Open file """ & sFileName & """ failed: " & e.Message & Microsoft.VisualBasic.Constants.vbCrLf) Exit Function End Try sFileContent = readerStream.ReadToEnd() readerStream.Close() Return sFileContent End Function ' Write the modified file content back Private Sub WriteFileContent(ByVal sFileName As String, ByVal sContent As String, ByVal bVCProject As Boolean) Dim writerStream As StreamWriter Try If (bVCProject) Then writerStream = New StreamWriter(sFileName, False, System.Text.Encoding.Unicode) Else writerStream = New StreamWriter(sFileName, False) End If Catch e As FileNotFoundException m_OutputWindowPane.OutputString("[DSVerCtrl] - ERROR: Can not find the file """ & sFileName & """." & Microsoft.VisualBasic.Constants.vbCrLf) Exit Sub Catch e As Exception m_OutputWindowPane.OutputString("[DSVerCtrl] - ERROR: Write file """ & sFileName & """ failed: " & e.Message & Microsoft.VisualBasic.Constants.vbCrLf) Exit Sub End Try writerStream.Write(sContent) writerStream.Flush() writerStream.Close() End Sub End Module