C#：通過Visual Studio項目預生成命令獲取SVN版本號

     之前有一個winfrom項目，想要通過獲取SVN版本號作為程序的內部編譯版本號。網上也有各種方法，但沒有一篇行得通的方法。於是我經過一系列研究，得出了一些經驗，特總結成一篇博客。

方法一：通過SVN命令獲取版本號

     類似地，我在項目中添加了一個名為"Version_inf.bat"的用於生成版本號的批處理文件,把他放在啟動項目的目錄中。批處理文件中寫下如下腳本：

   svn info>bin\Debug\SVN_Version.dll
   findstr “Revision” bin\Debug\SVN_Version.dll

     這段腳本的意思是通過“svn info”命令獲取“Revision”版本信息到Debug的輸出目錄的“SVN_Version.dll”文件中。(前提是電腦上必須安裝了svn軟件才能正常使用此命令。)

     在程序的Program主入口中，寫上類似的代碼：

    string str_PathResult = null;
    Microsoft.Win32.RegistryKey regKey = null;//表示 Windows 注冊表中的項級節點(注冊表對象?) 
    Microsoft.Win32.RegistryKey regSubKey = null;
    try
    {
        regKey = Microsoft.Win32.Registry.LocalMachine;//讀取HKEY_LOCAL_MACHINE項

        if (regKey != null)
        {
            string keyPath = @"SOFTWARE\TortoiseSVN";
            regSubKey = regKey.OpenSubKey(keyPath, false);
        }
        //得到SVN安裝路徑
        if (regSubKey != null)
        {
            if (regSubKey.GetValue("Directory") != null)
            {
                str_PathResult = regSubKey.GetValue("Directory").ToString();
            }
        }

        //如果存在SVN安裝信息，則通過調用批處理獲取版本號
        if (str_PathResult != null)
        {
            string path = System.Environment.CurrentDirectory;
            ////刪除已經存在的版本信息，避免出現串號
            //if (File.Exists(path + "\\SVN_Version.dll"))
            //{
            //    File.Delete(path + "\\SVN_Version.dll");
            //}

            int pathNum = path.LastIndexOf("\\") - 3;
            ProcessStartInfo psi = new ProcessStartInfo();

            string pathStr = path.Substring(0, pathNum) + "Version_inf.bat";
            //string newPathStr = (pathStr.Substring(0, pathStr.LastIndexOf("."))) + ".bat";

            psi.FileName = pathStr;
            //psi.FileName = path.Substring(0, pathNum) + "Version_inf.bat";
            psi.UseShellExecute = false;
            psi.WorkingDirectory = path.Substring(0, pathNum).Substring(0, path.Substring(0, pathNum).Length - 1);
            psi.CreateNoWindow = true;
            Process.Start(psi);
        }
    }
    catch (Exception ex)
    {
        //MessageBox.Show("檢測SVN信息出錯," + ex.ToString(), "提示信息");
        //LogUtil.WriteException(ex, "Program.Main()");
    }
    finally
    {
        if (regKey != null)
        {
            regKey.Close();
            regKey = null;
        }

        if (regSubKey != null)
        {
            regSubKey.Close();
            regSubKey = null;
        }
    }

        這樣每次程序編譯的時候就會生成一個新的“SVN_Version.dll”文件，里面記錄了最后一次更新的記錄版本號。

        然后在主窗口讀取“SVN_Version.dll”文件中的版本信息顯示到程序的主界面上，代碼如下：

    AssemblyName name = Assembly.GetExecutingAssembly().GetName();
    String version = name.Version.ToString().Substring(0, name.Version.ToString().LastIndexOf("."));
    //SVN版本號文件保存路徑
    String svnVersionPath = System.AppDomain.CurrentDomain.BaseDirectory + "SVN_Version.dll";
    if (File.Exists(svnVersionPath))
    {
        //StreamReader svnSteamReader = new StreamReader(svnVersionPath);
        string[] lines = File.ReadAllLines(svnVersionPath);
        if (lines.Length > 0)
        {
            for (int i = 0; i < lines.Length; i++)
            {
                if (lines[i].Contains("Revision"))
                {
                    String[] temps = lines[i].Split(':');
                    if (temps.Length > 1)
                    {
                        version += String.Format(".{0}", temps[1].Trim());
                        break;
                    }
                }
            }
            tssVersion.Text += version;         
        }
        else
        {
            tssVersion.Text += "獲取出錯";
        }
    }
    else
    {
        tssVersion.Text += "未知的版本";
    }

      這樣就完成了SVN版本號的獲取和內部編譯號的顯示了。如下圖：

      

      但是這種的方法的問題是：

     1）svn命令在程序沒有變化或者沒有獲取最新版本時會無法生成版本號；

     2）只是在主界面顯示了版本號，但是並沒有真正改變項目生成文件的版本號；

     3）如果電腦中沒有安裝svn程序，則極有可能會出現錯誤； 

      所以我又研究了方法二。

 

方法二：通過項目預處理事件獲取SVN版本號

      先在項目的Properties目錄下新建一個“AssemblyInfo.template.cs”的模板類文件，並把“AssemblyInfo.cs”文件從SVN版本號中忽略。在模板文件中寫下類似的代碼：

using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

// 有關程序集的常規信息通過以下
// 特性集控制。更改這些特性值可修改
// 與程序集關聯的信息。
[assembly: AssemblyTitle("程序名")]
[assembly: AssemblyDescription("更新時間：$WCDATE$")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("程序名")]
[assembly: AssemblyCopyright("Copyright © 2013")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]

// 將 ComVisible 設置為 false 使此程序集中的類型
// 對 COM 組件不可見。如果需要從 COM 訪問此程序集中的類型，
// 則將該類型上的 ComVisible 特性設置為 true。
[assembly: ComVisible(false)]

// 如果此項目向 COM 公開，則下列 GUID 用於類型庫的 ID
[assembly: Guid("18501865-f051-43be-ab03-59a2d9e76fcf")]

// 程序集的版本信息由下面四個值組成:
//
//      主版本
//      次版本 
//      內部版本號
//      修訂號
//
// 可以指定所有這些值，也可以使用“內部版本號”和“修訂號”的默認值，
// 方法是按如下所示使用“*”:
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("1.1.1.$WCREV$")]
[assembly: AssemblyFileVersion("1.1.1.$WCREV$")]

      然后在項目屬性的生成事件中編寫如下預先生成事件執行的命令：

$(SolutionDir)Lib\SubWCRev.exe $(SolutionDir) $(ProjectDir)Properties\AssemblyInfo.template.cs $(ProjectDir)Properties\AssemblyInfo.cs -f

   這段話的意思就是找到SVN的SubWCRev.exe文件，獲取到版本信息后通過模板將數據寫入到“AssemblyInfo.cs”文件中。

   這樣每次生成之后版本號就寫入到了項目輸出的文件中。將每個項目都按照如上方法添加模板和預生成事件，那么程序文件就會都帶有版本信息。

   實際效果如下圖所示：

   

   程序在顯示的時候，可以通過封裝一個公共屬性讓其他人可以調用到版本號信息：

  /// <summary>
  /// 版本號
  /// </summary>
  public static string AppVersion
   {
        set { AppDomain.CurrentDomain.SetData("AppVersion", value); }
        get { return AppDomain.CurrentDomain.GetData("AppVersion") == null ? "" : AppDomain.CurrentDomain.GetData("AppVersion").ToString(); }
   }

  這樣就大功告成啦！！！

  當然如果想獲取項目生成的文件或者想獲取某個指定文件的版本號屬性，可以使用如下方法：

/// <summary>
/// 獲取文件的版本號
/// </summary>
/// <param name="filePath">文件的完整路徑</param>
/// <returns>文件的版本號</returns>
public static string GetFileVersion(string filePath)
{
    string FileVersions = "";

    try
    {
        System.Diagnostics.FileVersionInfo file1 = System.Diagnostics.FileVersionInfo.GetVersionInfo(filePath);
        FileVersions = file1.FileVersion;
        if (FileVersions != "")
        {
            string[] strVer = FileVersions.Split('.');
            if (strVer.Length == 2)
            {
                FileVersions = strVer[0] + ".00.0000";
            }

        }
    }
    catch (Exception ex)
    {
        FileVersions = "";
    }
    return FileVersions;
}

        特別說明：本文章為本人Healer007 原創！ 署名：小蘿卜  轉載請注明出處，謝謝！