Visual Studio Package 插件開發(Visual Studio SDK)

背景

　　這段時間公司新做了一個支付系統，里面有N個后台服務，每次有更新修改，拷貝打包發布包“不亦樂乎”。。。於是我想要不要自己定制個打包插件。

　　部分朋友可能會認為，有現成的可以去找一個，干嘛不用持續集成工具啊。

　　1、公司沒用，也不打算用

　　2、自己想折騰下，好奇

　　因此主要是分享這次的學習過程和結果。

涉及知識點

　　大概構想下，選擇需要打包的項目-重新編譯-拷貝生成文件到指定目錄-OK，剩下就是交給測試去做了。

　　1、Visual Studio Package 初步使用

　　2、.Net 執行Dos命令

　　3、MSBuild簡單運用

　　4、File.Copy的使用

下載安裝

　　Visual Studio 2013 SDK包的下載地址：http://www.microsoft.com/en-us/download/details.aspx?id=40758&fa43d42b-25b5-4a42-fe9b-1634f450f5ee=True

　　完畢后，在新建項目-C#-擴展性，可以見到Visual Studio Package模板選項（見下圖）

　　

第一個vs插件程序

 

　　下一步，勾選Menu Command；下一步，修改Command Name；下一步，取消單元測試，Finish。恭喜，您的第一個插件程序就這么誕生了。

　　編譯后，到生成目錄下，執行.vsix文件，安裝完后，重啟VS，點擊[工具]就會見到您的插件工具。同時你也可以在擴展與更新界面進行對您的插件進行卸載。

 

 

項目文件簡介

　　初建項目，有很多文件，有幾個下面是需要了解一下的。

　　1、PackingTools.vsct

　　2、PackingToolsPackage.cs

　　3、source.extension.vsixmanifest

　　PackingTools.vsct

　　　　　vsct是個Xml文件，它用來對插件按鈕進行配置的。

　　　　　Group是組節點，項目初建，它的Parent為IDM_VS_MENU_TOOLS，對於這個我們可以查看  您的vs安裝目錄\Visual Studio2013\VSSDK\VisualStudioIntegration\Common\Inc\vsshlids.h，打開文件，我們可以看到除IDM_VS_MENU_TOOLS以外還有IDM_VS_MENU_ADDINS、IDM_VS_MENU_HELP等等，我們嘗試改成IDM_VS_MENU_HELP。

　　　　  Buttons節點下，可以添加多個Button信息，我們嘗試添加一個Button進去，同時GuidSymbol加多一個IDSymbol進去。修改對應新按鈕的id 和 priority。

　　　　　　

　　　　　　我們啟動F5，調試看看，插件按鈕位置變了，也是我們第一次修改了按鈕布局。

　　　　　　

　　PackingToolsPackage.cs

　　　　　　插件程序的入口，我們細看代碼，發現在Initialize方法里，就對批量打包這個按鈕進行事件綁定，我們嘗試一下，把MenuItemCallback里的邏輯刪了，展示一個wpf窗體出來。

　　　　　　添加新建項-添加wpf窗體后，需要在項目里新引用一個System.Xaml.dll才能編譯通過。

　　　　　　接着，我們在PackingToolsPackage.cs的MenuItemCallback的方法里寫new MainWindow().Show()，F5運行->點擊批量打包，則會彈出下圖。

　　　　　　

　　　　　　主界面就這么出來了，當然，你可以單例一個窗體，不用new。。。　

　　source.extension.vsixmanifest

　　　　　　對Visual Studio 擴展的配置，如：文件模板，項目工程模板，依賴程序集，Visual Studio 工具包logo，VS安裝的版本等等。

 

讀取已打開的項目信息

　　這個其實並沒什么特別難的邏輯，只是開始找資料花了一些時間，直接上代碼。

private void MenuItemCallback(object sender, EventArgs e)
        {
            IVsSolution pSolution = GetService(typeof(SVsSolution)) as IVsSolution;

            if (pSolution != null)
            {
                var projectArray = new string[10];
                uint aa;
                //通過這個方法取到打開解決方案的項目信息
                pSolution.GetProjectFilesInSolution((uint)__VSGETPROJFILESFLAGS.GPFF_SKIPUNLOADEDPROJECTS,
                    (uint)__VSGETPROJFILESFLAGS.GPFF_SKIPUNLOADEDPROJECTS, projectArray, out aa);

                //轉換信息，讓girdView展示
                var projectList =
                    projectArray.ToList()
                        .Where(a => a.Contains(".csproj")).Select(a => new ProjectList
                        {
                            Name = Path.GetFileNameWithoutExtension(a),
                            Path = a
                        }).ToList();

                MainForm.GetInstance(projectList).Show();
            }
        }

　　對於IVsSolution這個接口的命名空間下，還有各種各樣的類，對Visual Studio Package開發有興趣的同學可以去看看。傳送門

MSBuild的使用

　　Microsoft Build Engine 是MSBuild的全稱，是一個獨立的存在生成平台，不需要依賴vs,但是vs的生成、發布等等功能都是基於MSBuild去構建的，它能讀取.sln、.csproj、.pubxml等xml文件里的參數進行生成解決和項目。這里就不做過多的介紹和深入，有需要可以點擊這里進行查看文檔

　　MSBuild.exe在C:\Windows\Microsoft.NET\Framework\v4.0.30319 這個路徑下，值得注意的是Framework 的位數和版本，這個影響選擇MSBuild.exe的路徑。

　　嘗試一下，打開cmd，輸入-> C:\Windows\Microsoft.NET\Framework\v4.0.30319 "您的項目文件路徑" /t:Rebuild /p:Configuration=Release /p:VisualStudioVersion=12.0

　　

　　這句話指，用msbuild重新生成Release版本，注意項目路徑是有雙引號的。

　　然而，我們需要在.net程序里使用這段dos指令，因此我們寫編寫一個dos指令幫助類

#region Dos指令幫助類
    /// <summary>
    /// Dos指令幫助類
    /// </summary>
    public class DosCommanHelper
    {
        #region 執行指令
        /// <summary>
        /// 執行指令
        /// </summary>
        /// <param name="command">指令</param>
        /// <param name="seconds">最長等待時間（秒）</param>
        /// <returns></returns>
        public static string ExeCommand(string command, int seconds = 3)
        {
            var output = "";
            if (string.IsNullOrWhiteSpace(command))
                return output;

            var process = new Process(); //創建進程對象
            var startInfo = new ProcessStartInfo
            {
                FileName = "cmd.exe", //設定需要執行的命令
                Arguments = "/C " + command, //“/C”表示執行完命令后馬上退出
                UseShellExecute = false, //不使用系統外殼程序啟動
                RedirectStandardInput = false, //不重定向輸入
                RedirectStandardOutput = true, //重定向輸出
                CreateNoWindow = true //不創建窗口
            };

            process.StartInfo = startInfo;
            try
            {
                if (process.Start())
                {
                    if (seconds == 0)
                    {
                        process.WaitForExit();
                    }
                    else
                    {
                        process.WaitForExit(seconds * 1000);
                    }
                    output = process.StandardOutput.ReadToEnd();
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
            finally
            {
                process.Close();
            }
            return output;
        }
        #endregion
    }
    #endregion

 

拷貝生成文件

　　從上面我們已經讀取到了解決方案對應的項目信息，包括路徑，新建的項目默認生成到.csproj文件目錄下的bin/Release里。

　　我們利用Path.GetDirectoryName和Path.Combine方法，獲取對應路徑，再自己編寫文件操作幫助類，對應Release里的文件復制到指定位置。

#region 文件操作幫助類
    /// <summary>
    /// 文件操作幫助類
    /// </summary>
    public static class FilesHelper
    {
        #region 復制文件
        /// <summary>
        /// 復制文件
        /// </summary>
        /// <param name="fromPath">原路徑</param>
        /// <param name="toPath">新路徑</param>
        /// <returns></returns>
        public static bool CopyFiles(string fromPath, string toPath)
        {
            try
            {
                if (!Directory.Exists(fromPath))
                    throw new Exception("no fromPath");

                if (Directory.Exists(toPath))
                    Directory.Delete(toPath, true);

                Directory.CreateDirectory(toPath);

                var fromfiles = Directory.GetFiles(fromPath).ToList();
                fromfiles.ForEach(file =>
                {
                    var newFile = Path.Combine(new[] { toPath, Path.GetFileName(file) });
                    File.Copy(file, newFile, true);
                });

                var fromFolders = Directory.GetDirectories(fromPath).ToList();
                fromFolders.ForEach(folder =>
                {
                    var destDir = Path.Combine(new[] { toPath, Path.GetFileName(folder) });
                    CopyFiles(folder, destDir);
                });

                return true;
            }
            catch
            {
                return false;
            }
        }
        #endregion
    }
    #endregion

 

　　最后我們只需要完善發布按鈕事件，獲取列表選擇項->獲取打包到的指定路徑->遍歷列表項數據->執行MSBuild指令->復制文件到指定路徑->完畢

 private void Button_Click_1(object sender, RoutedEventArgs e)
        {
            var list = MyListView.SelectedItems.Cast<ProjectList>().ToList();

            var fromPath = PathLabel.Content;

            list.ForEach(item =>
            {
                DosCommanHelper.ExeCommand(string.Format(@"C:\Windows\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe {0} /t:Rebuild /p:Configuration=Release /p:VisualStudioVersion=12.0", item.Path));

                var theFileOfDirectoryName = Path.GetDirectoryName(item.Path);
                var toPath = Path.Combine(theFileOfDirectoryName, @"bin\Release");
                FilesHelper.CopyFiles(fromPath.ToString(), Path.Combine(toPath, item.Name));
            });
        }

 

完畢

　　源碼我這里沒有提供，還是希望讀了這篇文章感興趣的小伙伴動手折騰下，Visual Studio Package還可以做模版開發等等，我也沒太多的去深入了解，感興趣的可以去google一下關鍵字Visual Studio Package、vssdk、vsix、插件開發。

　　以上純屬自己初步折騰的結果，為了寫文章弄出來的簡單demo，還有很多可優化的地方，例如各種驗證判斷，插件按鈕的動態顯示、讀取項目的類型過濾、web項目的發布，文件過濾復制等等。。。。

　　本篇文章有什么寫錯的或者更好的建議麻煩大家在評論寫給我，我會一一補充修改。如果對大家有幫助，還希望推薦一下，謝謝。