VS 遠端偵錯 Azure Web App

2020-06-16 17:14:15

如果能夠遠端偵錯部署在 Azure 上的 Web App，將會極大的提高我們修復 bug 的效率。Visual Studio 一貫以功能強大、好用著稱，當然可以通吃基於 Azure 應用的建立、發布和偵錯。接下來就讓我們一起看看如何使用 Visual Studio 遠端偵錯部署在 Azure 上的 Web App，以及一些常見的注意事項。

注意工具的版本

在開始正文前讓我們先檢查一下使用的 Azure SDK 版本和 Visual Studio 的版本。根據 MSDN 的介紹，Azure 的遠端偵錯功能是在 Azure SDK 2.2 中加入的，所以請確保您的機器上安裝了 2.2 或者是更新的 Azure SDK。
關於 Visual Studio 的版本問題，MSDN 上的描述也很有趣。大意是使用 Visual Studio 2012 已經可以遠端偵錯 Azure 上的 Website 了，但是 Visual Studio 2013 又對此做了很多的提升。個人理解最好使用 VS2013，或者更新的版本。
筆者在寫本文時的實驗環境是 VS2015 update3 和 Azure SDK 2.9。

原理簡介

如果我們要使用執行在機器A上的 Visual Studio 偵錯另外一台機器B上執行的一個程式 myapp (機器B上沒有安裝 visual studio)，我們不僅要把附帶 pdb 檔案的 myapp 程式部署到機器B上，還要在機器B上執行一個偵錯輔助程式 msvsmon.exe。執行 msvsmon.exe 後，Visual Studio 就能夠 attach 住 myapp 並使用其 pdb 檔案進行偵錯。這就是 Visual Studio 的遠端偵錯功能。而 msvsmon.exe 程式必須與特定版本的 Visual Studio 相匹配才能工作，所以它被整合在 Visual Studio 的安裝包中，用時去 Visual Studio 的安裝目錄中搜尋就能找到。

遠端偵錯 Azure Web App 和上面的過程是一樣的。只不過我們需要通過雲端的設定來指定 msvsmon.exe 對應的 Visual Studio 版本，並告訴雲端開啟一些偵錯所需的埠。

下面就讓我們一步步的踏上 VS 遠端偵錯 Azure App 之路。

設定 Deployment credentials

這個不需要過多的解釋，當我們部署網站時就需要建立這個賬號。當然這個賬號既可以用來部署又可以用來遠端偵錯。

下載發布用的 publishing profile

Publishing profile 是用於進行發佈操作的組態檔。當我們要發布一個網站或者是一個 web 應用時，需要很多的基本資訊，比如伺服器在哪裡？使用者名稱是什麼？密碼是什麼？等等…這些資訊統統儲存在 publishing profile 檔案中，有興趣的朋友可以開啟這個檔案看看裡面的詳細資訊。
無論偵錯與否，我們都要把應用發布到 Azure 上去，下載 publishing profile 先：

允許遠端偵錯 Web App

設定 Application settings 中的遠端偵錯為允許狀態，並指定用於遠端偵錯的 Visual Studio 版本。相關內容已經在原理部分講過，這裡說些需要注意的內容：
這兩項設定是有期限的，在 48 小時之後預設會被關掉！
原因主要是效能和安全。所以建議大家在偵錯完成後立即關閉遠端偵錯功能。

發布偵錯版本的 Web App

Visual Studio 的偵錯功能依賴於編譯過程中產生的 pdb 檔案。下面的設定就是讓 Web App 在發布時編譯為 debug 版本並產生對應的 pdb 檔案。現在的 Visual Studio 已經可以智慧的去找 pdb 檔案了，所以這裡我們不用關心 pdb 檔案是被發布到了雲端還是儲存在本地(簡單就好)！
先匯入剛才下載的 publishing profile 檔案：