本文的主題是 Visual Studio
調(diào)試 NuGet
包,以及符號包的概念,如何去發(fā)布一個 NuGet
包,讓我們的 NuGet
包支持 SouceLink
,這些都是我們開發(fā)中比較容易忽視的內(nèi)容,但是熟悉了以后可以讓我們在調(diào)試中得心應(yīng)手,也是開源項目開發(fā)的基礎(chǔ)篇。
demo 源代碼在文末
程序數(shù)據(jù)庫 (
.pdb
) 文件(也稱為符號文件)將項目源代碼中的標(biāo)識符和語句映射到已編譯應(yīng)用中的相應(yīng)標(biāo)識符和說明。這些映射文件將調(diào)試器鏈接到源代碼,以進(jìn)行調(diào)試。
在 Visual Studio 調(diào)試器(C#、C++、Visual Basic、F#)中指定符號 (.pdb) 和源文件[1]
.pdb
文件保存調(diào)試和項目狀態(tài)信息,使用這些信息可以對應(yīng)用的調(diào)試配置進(jìn)行增量鏈接。在調(diào)試時,Visual Studio
調(diào)試器使用 .pdb
文件來確定兩項關(guān)鍵信息:
Visual Studio IDE
中顯示的源文件名和行號。調(diào)試器只會加載與在生成應(yīng)用時創(chuàng)建的 .pdb
文件完全匹配的 .pdb
文件(即原始 .pdb
文件或副本)。
我們隨便找一個自己代碼的類庫 Build 可以看一下
簡單的講:我們平時在 Visual Studio
中調(diào)試代碼 編譯后的dll
文件在和 VS
內(nèi)代碼文件,斷點等各種調(diào)試操作都是跟.pdb
文件內(nèi)記錄的信息做的映射。
創(chuàng)建符號包[2]
符號包提供了一些關(guān)鍵信息,例如已編譯的代碼與源代碼之間的關(guān)聯(lián)、局部變量的名稱、堆棧跟蹤,代碼源文件映射等。你可以使用符號包 (
.snupkg
) 來分發(fā)這些符號(.pdb
),并改善NuGet
包的調(diào)試體驗。
有兩種方式可以創(chuàng)建符號包
.csproj
文件添加屬性<PropertyGroup>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
</PropertyGroup>
dotnet pack MyPackage.csproj -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg
那我們創(chuàng)建一個類庫先用第二種命令行打包測試一下看看效果
可以看到我們的符號包已經(jīng)成功創(chuàng)建了。
接下來我們看一下符號包里面有什么東西
這里面用NuGetPackageExplorer
本地工具,直接打開本地的包
可以看到我們的.pdb
文件已經(jīng)被打包到符號包中
源鏈接將源代碼管理元數(shù)據(jù)添加到程序集和 NuGet
包,這么做的好處是進(jìn)一步的獲得最佳調(diào)試體驗,把源鏈接元數(shù)據(jù)跟符號包中的pdb
文件綁定
github sourcelink[3]
從.NET 8
開始,.NET SDK
默認(rèn)包含對以下來源控制提供商的源鏈接(Source Link
)支持:
如果您的項目使用.NET SDK 8+
并托管在上述提供商中,則無需引用任何 Source Link
包或設(shè)置任何構(gòu)建屬性,Source Link
已默認(rèn)啟用。
否則,您可以通過設(shè)置幾個屬性并添加適用于提供商的 Source Link
包的 PackageReference
來啟用項目中的 Source Link
體驗,這樣可以實現(xiàn)在指定的來源控制環(huán)境中進(jìn)行無縫調(diào)試和源代碼導(dǎo)航。配置如下
<Project>
<PropertyGroup>
<!-- Optional: Publish the repository URL in the built .nupkg (in the NuSpec <Repository> element) -->
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<!-- Optional: Embed source files that are not tracked by the source control manager in the PDB -->
<EmbedUntrackedSources>true</EmbedUntrackedSources>
</PropertyGroup>
<ItemGroup>
<!-- Add PackageReference specific for your source control provider (see below) -->
</ItemGroup>
</Project>
如果你在 dotNet 8+
的環(huán)境中引用任何的源代碼管理包比如github.com
and GitHub Enterprise
<ItemGroup>
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All"/>
</ItemGroup>
會禁用.NET SDK
中包含的 Source Link
功能。
本文的所有案例默認(rèn)都是用 dotNet8
開發(fā)的 那按照說明如果代碼在 github
那默認(rèn)可以不用安裝任何 SourceLink
的 package
接下來我們繼續(xù)測試一下在類庫中添加對應(yīng)的屬性
先提交一下代碼,再打 pack
從這可以看出我們的 pdb
符號文件已經(jīng)包含了 git
的源代碼信息。
發(fā)布 Nuget 包[11]我們這里使用dotnet cli
推送 用命令行推送.nupkg
包同名的.snupkg
符號包默認(rèn)也會被推送到 nuget.org
dotnet nuget push dotNetParadise-SourceLink.1.0.1.nupkg -s https://api.nuget.org/v3/index.json --api-key %nugetApiKey%
現(xiàn)在 NuGet
包已經(jīng)推送上去了第一次推送的包 NuGet
平臺需要對其進(jìn)行索引病毒掃描等 大概需要幾分鐘
可以看到我們的符號包以及源代碼地址都已經(jīng)在 NuGet
平臺顯示了。
前面做的部分實際上都是為了我們在給用戶用的時候方便調(diào)試,那我們來調(diào)試一下看看這個過程。創(chuàng)建新項目->NuGet
安裝剛才上傳的包
dotnet add package dotNetParadise-SourceLink --version 1.0.1
項目文件夾。
在 DLL 或可執(zhí)行 (.exe) 文件中指定的位置。
與 DLL 或 .exe 文件相同的文件夾。
在調(diào)試器選項中為符號文件指定的任何位置。
任何本地符號緩存文件夾。
指定的網(wǎng)絡(luò)、Internet 或本地符號服務(wù)器和位置,例如 Microsoft 符號服務(wù)器(如果選擇)。Visual Studio 可從實現(xiàn) symsrv 協(xié)議的符號服務(wù)器下載調(diào)試符號文件。Visual Studio Team Foundation Server 和 Windows 調(diào)試工具是可使用符號服務(wù)器的兩個工具。
可能會用到的符號服務(wù)器包括:
公共 Microsoft 符號服務(wù)器:要調(diào)試在調(diào)用系統(tǒng) DLL 或第三方庫時出 現(xiàn)的故障,通常需要系統(tǒng) .pdb 文件。系統(tǒng) .pdb 文件包含 Windows DL、.exe 文件和設(shè)備驅(qū)動程序的符號 。你可以從公共 Microsoft 符號服務(wù)器獲取 Windows 操作系統(tǒng)、MDAC、IIS、ISA 和 .NET 的符號。
內(nèi)部網(wǎng)絡(luò)或本地計算機(jī)上的符號服務(wù)器:你的團(tuán)隊或公司可為你自己的產(chǎn)品創(chuàng)建符號服務(wù)器,并作為外部源符號的緩存。你自己的計算機(jī)上可能具有符號服務(wù)器。
第三方符號服務(wù)器:Windows 應(yīng)用程序和庫的第三方提供程序可提供對 Internet 上的符號服務(wù)器的訪問。
了解了這部分信息之后,我們的符號包是在 Nuget.org 中所以,需要在 Vs 中開啟如下配置
VS 工具->選項->調(diào)試->符號 開啟上面符號服務(wù)器的選中,可以設(shè)置一個本地緩存的文件夾,另外下面選擇僅加載指定模塊(如果開啟上面除了排除的全部加載大項目調(diào)試起來有點難受)
VS 工具->選項->調(diào)試-常規(guī)
第一步要禁用啟用僅我的代碼
第二部 啟用源服務(wù)器的支持
到這兒基本上配置已經(jīng)全部完成了
實戰(zhàn)測試一下 我們的類庫實際上是封裝了一個 MinimalApis
的自動注冊功能,感興趣的朋友可以去讀一下我之前的文章
public class TodoApi : IEndPoint
{
public void MapEndPoints(IEndpointRouteBuilder app)
{
var group = app.MapGroupWithTags("Todo");
group.MapGet("sayhello", (string name) => $"hello {name}");
}
}
創(chuàng)建一個 api
在 program
調(diào)用類庫方法注冊一下
app.RegisterEndPoints();
可以看到很對 NuGet
類庫 源碼的調(diào)試就舒服多了,可以加斷點修改代碼,加類庫調(diào)試。
簡要摘要:
本文介紹了在 Visual Studio
中調(diào)試 NuGet
包的相關(guān)概念,包括 PDB
符號文件、符號包、Source Link
功能以及發(fā)布支持 Source Link
的 NuGet
包。通過配置符號包和 Source Link
,開發(fā)者可以更輕松地調(diào)試外部依賴項的源代碼,提高調(diào)試效率。
總結(jié):
PDB
符號文件和符號包在調(diào)試中起著關(guān)鍵作用,幫助將源代碼映射到編譯后的應(yīng)用程序,提供更詳細(xì)的調(diào)試信息。Source Link
通過在程序集和 NuGet
包中添加源代碼管理元數(shù)據(jù),實現(xiàn)了方便調(diào)試外部依賴項的功能。Source Link
選項可以使 Visual Studio
更好地支持調(diào)試 NuGet
包的源代碼。本文Demo 源代碼[12]
希望本文能對你有幫助!
在 Visual Studio 調(diào)試器(C#、C++、Visual Basic、F#)中指定符號 (.pdb) 和源文件: https://learn.microsoft.com/zh-cn/visualstudio/debugger/specify-symbol-dot-pdb-and-source-files-in-the-visual-studio-debugger?view=vs-2022
[2]創(chuàng)建符號包: https://learn.microsoft.com/zh-cn/nuget/create-packages/symbol-packages-snupkg
[3]github sourcelink: https://github.com/dotnet/sourcelink
[4]GitHub: http://github.com/
[5]GitHub Enterprise: https://enterprise.github.com/home
[6]Azure Repos git: https://azure.microsoft.com/en-us/services/devops/repos
[7]GitLab: https://azure.microsoft.com/en-us/services/devops/repos
[8]GitLab 設(shè)置: https://gitlab.com/
[9]Bitbucket: https://gitlab.com/
[10]Bitbucket 設(shè)置: https://github.com/dotnet/sourcelink#bitbucket
[11]發(fā)布 Nuget 包: https://learn.microsoft.com/zh-cn/nuget/nuget-org/publish-a-package
[12]Demo 源代碼: https://github.com/Dong-Ruipeng/dotNetParadise-SourceLink.git