dotNet符號文件(pdb),符號包(snupkg)和SourceLink

来源:https://www.cnblogs.com/ruipeng/p/18093758
-Advertisement-
Play Games

前言 本文的主題是 Visual Studio 調試 NuGet 包,以及符號包的概念,如何去發佈一個 NuGet 包,讓我們的 NuGet 包支持 SouceLink,這些都是我們開發中比較容易忽視的內容,但是熟悉了以後可以讓我們在調試中得心應手,也是開源項目開發的基礎篇。 demo 源代碼在文末 ...


前言

本文的主題是 Visual Studio 調試 NuGet 包,以及符號包的概念,如何去發佈一個 NuGet 包,讓我們的 NuGet 包支持 SouceLink,這些都是我們開發中比較容易忽視的內容,但是熟悉了以後可以讓我們在調試中得心應手,也是開源項目開發的基礎篇。

demo 源代碼在文末

pdb 符號文件

程式資料庫 (.pdb) 文件(也稱為符號文件)將項目源代碼中的標識符和語句映射到已編譯應用中的相應標識符和說明。 這些映射文件將調試器鏈接到源代碼,以進行調試。

在 Visual Studio 調試器(C#、C++、Visual Basic、F#)中指定符號 (.pdb) 和源文件

符號文件的工作方式

.pdb 文件保存調試和項目狀態信息,使用這些信息可以對應用的調試配置進行增量鏈接。 在調試時,Visual Studio 調試器使用 .pdb 文件來確定兩項關鍵信息:

  • 要在 Visual Studio IDE 中顯示的源文件名和行號。
  • 在應用中停止的斷點位置。

調試器只會載入與在生成應用時創建的 .pdb 文件完全匹配的 .pdb 文件(即原始 .pdb 文件或副本)。

我們隨便找一個自己代碼的類庫 Build 可以看一下
image

簡單的講:我們平時在 Visual Studio 中調試代碼 編譯後的dll 文件在和 VS 內代碼文件,斷點等各種調試操作都是跟.pdb 文件內記錄的信息做的映射。

符號包 (.snupkg)

創建符號包

符號包提供了一些關鍵信息,例如已編譯的代碼與源代碼之間的關聯、局部變數的名稱、堆棧跟蹤,代碼源文件映射等。 你可以使用符號包 (.snupkg) 來分發這些符號(.pdb),並改善 NuGet 包的調試體驗。

創建符號包

有兩種方式可以創建符號包

  • .csproj 文件添加屬性
<PropertyGroup>
    <IncludeSymbols>true</IncludeSymbols>
    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
</PropertyGroup>
  • 打包時指定參數
dotnet pack MyPackage.csproj -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg

那我們創建一個類庫先用第二種命令行打包測試一下看看效果

image

可以看到我們的符號包已經成功創建了。

接下來我們看一下符號包裡面有什麼東西
這裡面用NuGetPackageExplorer本地工具,直接打開本地的包
image

可以看到我們的.pdb 文件已經被打包到符號包中

源鏈接將源代碼管理元數據添加到程式集和 NuGet 包,這麼做的好處是進一步的獲得最佳調試體驗,把源鏈接元數據跟符號包中的pdb文件綁定

github sourcelink

.NET 8 開始,.NET SDK 預設包含對以下來源控制提供商的源鏈接(Source Link)支持:

如果您的項目使用.NET SDK 8+並托管在上述提供商中,則無需引用任何 Source Link 包或設置任何構建屬性,Source Link 已預設啟用。

否則,您可以通過設置幾個屬性並添加適用於提供商的 Source Link 包的 PackageReference 來啟用項目中的 Source Link 體驗,這樣可以實現在指定的來源控制環境中進行無縫調試和源代碼導航。
配置如下

<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+ 的環境中引用任何的源代碼管理包比如
github.com and GitHub Enterprise

<ItemGroup>
  <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All"/>
</ItemGroup>

會禁用.NET SDK 中包含的 Source Link 功能。

本文的所有案例預設都是用 dotNet8 開發的 那按照說明如果代碼在 github 那預設可以不用安裝任何 SourceLinkpackage

接下來我們繼續測試一下在類庫中添加對應的屬性

先提交一下代碼,再打 pack
image

從這可以看出我們的 pdb 符號文件已經包含了 git 的源代碼信息。

推送 Nuget 包

發佈 Nuget 包
我們這裡使用dotnet cli推送
用命令行推送.nupkg包同名的.snupkg符號包預設也會被推送到 nuget.org

 dotnet nuget push dotNetParadise-SourceLink.1.0.1.nupkg -s https://api.nuget.org/v3/index.json --api-key %nugetApiKey%

image

現在 NuGet 包已經推送上去了第一次推送的包 NuGet 平臺需要對其進行索引病毒掃描等 大概需要幾分鐘

image

可以看到我們的符號包以及源代碼地址都已經在 NuGet 平臺顯示了。

VS 調試部分

前面做的部分實際上都是為了我們在給用戶用的時候方便調試,那我們來調試一下看看這個過程。
創建新項目->NuGet 安裝剛纔上傳的包

dotnet add package dotNetParadise-SourceLink --version 1.0.1

調試器查找符號文件的位置

  • 項目文件夾。

  • 在 DLL 或可執行 (.exe) 文件中指定的位置。

    • 預設情況下,如果你在電腦上已生成 DLL 或 .exe 文件,則鏈接器會將關聯的 .pdb 文件的完整路徑和文件名放入 DLL 或 .exe 文件中 。 調試器會檢查該位置是否存在符號文件。
  • 與 DLL 或 .exe 文件相同的文件夾。

  • 在調試器選項中為符號文件指定的任何位置。

    • 任何本地符號緩存文件夾。

    • 指定的網路、Internet 或本地符號伺服器和位置,例如 Microsoft 符號伺服器(如果選擇)。 Visual Studio 可從實現 symsrv 協議的符號伺服器下載調試符號文件。 Visual Studio Team Foundation Server 和 Windows 調試工具是可使用符號伺服器的兩個工具。

  • 可能會用到的符號伺服器包括:

    • 公共 Microsoft 符號伺服器:要調試在調用系統 DLL 或第三方庫時出 現的故障,通常需要系統 .pdb 文件。 系統 .pdb 文件包含 Windows DL、.exe 文件和設備驅動程式的符號 。 你可以從公共 Microsoft 符號伺服器獲取 Windows 操作系統、MDAC、IIS、ISA 和 .NET 的符號。

    • 內部網路或本地電腦上的符號伺服器:你的團隊或公司可為你自己的產品創建符號伺服器,並作為外部源符號的緩存。 你自己的電腦上可能具有符號伺服器。

    • 第三方符號伺服器:Windows 應用程式和庫的第三方提供程式可提供對 Internet 上的符號伺服器的訪問。

瞭解了這部分信息之後,我們的符號包是在 Nuget.org 中所以,需要在 Vs 中開啟如下配置
image

VS 工具->選項->調試->符號 開啟上面符號伺服器的選中,可以設置一個本地緩存的文件夾,另外下麵選擇僅載入指定模塊(如果開啟上面除了排除的全部載入大項目調試起來有點難受)

VS 工具->選項->調試-常規
image

第一步要禁用啟用僅我的代碼

第二部 啟用源伺服器的支持

到這兒基本上配置已經全部完成了

實戰測試一下
我們的類庫實際上是封裝了一個 MinimalApis 的自動註冊功能,感興趣的朋友可以去讀一下我之前的文章

public class TodoApi : IEndPoint
{
    public void MapEndPoints(IEndpointRouteBuilder app)
    {
        var group = app.MapGroupWithTags("Todo");
        group.MapGet("sayhello", (string name) => $"hello {name}");
    }
}

創建一個 apiprogram 調用類庫方法註冊一下

app.RegisterEndPoints();

image

可以看到很對 NuGet 類庫 源碼的調試就舒服多了,可以加斷點修改代碼,加類庫調試。

最後

簡要摘要:

本文介紹了在 Visual Studio中調試 NuGet 包的相關概念,包括 PDB 符號文件、符號包、Source Link 功能以及發佈支持 Source LinkNuGet 包。通過配置符號包和 Source Link,開發者可以更輕鬆地調試外部依賴項的源代碼,提高調試效率。

總結:

  • PDB 符號文件和符號包在調試中起著關鍵作用,幫助將源代碼映射到編譯後的應用程式,提供更詳細的調試信息。
  • Source Link 通過在程式集和 NuGet 包中添加源代碼管理元數據,實現了方便調試外部依賴項的功能。
  • 配置符號伺服器路徑和 Source Link 選項可以使 Visual Studio 更好地支持調試 NuGet 包的源代碼。

本文Demo 源代碼

希望本文能對你有幫助!

本文來自博客園,作者:董瑞鵬,轉載請註明原文鏈接:https://www.cnblogs.com/ruipeng/p/18093758


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 完美收官,本文是爬蟲實戰的最後一章了,所以儘管本文著重呈現爬蟲實戰,但其中有一大部分內容專註於數據分析。爬蟲只是整個過程的起點,其主要目的之一就是為後續數據分析等工作做好準備。通過對爬取的數據進行精確的清洗和分析,可以揭示其中隱藏的規律和趨勢,為決策提供有力支持。因此,爬蟲實戰並不僅僅是技術的展示,... ...
  • 前言 去年又重新刷了路遙的《平凡的世界》,最近也在朋友推薦下,來看了路遙的另一部成名作《人生》。 故事中的主人公高加林,雖生在農村,面朝黃土背朝天,卻不甘心像父輩一樣或者,一心想著擺脫民語的束縛,追求他的理想生活。 然而命運多舛,在他所想象的理想生活中,一次次跌倒,最終不得不承認自己的平凡,生活總得 ...
  • 1 定義 一個數據集是分散式的數據集合。Spark 1.6增加新介面Dataset,提供 RDD的優點:強類型、能夠使用強大lambda函數 Spark SQL優化執行引擎的優點 可從JVM對象構造Dataset,然後函數式轉換(map、flatMap、filter等)操作。Dataset API在 ...
  • 一、前言 隨著網路的發展,企業對於信息系統數據的保密工作愈發重視,不同身份、角色對於數據的訪問許可權都應該大相徑庭。 列如 1、不同登錄人員對一個數據列表的可見度是不一樣的,如數據列、數據行、數據按鈕等都可能不太一樣。 2、表單的靈活設計及呈現。 3、流程的靈活設計及呈現。 4、介面的調用信息者及性能 ...
  • 概述:WPF支持綁定到對象的屬性而不是欄位,主要因為屬性提供了更多控制和擴展性。屬性包含get和set方法,支持數據驗證和通知屬性更改,而欄位通常被認為是內部實現。使用屬性使WPF能夠更靈活、可控地與數據交互,提高代碼的可讀性和可維護性。 WPF(Windows Presentation Found ...
  • 概述:上述C#示例演示瞭如何在同步方法中調用非同步方法。通過使用`async`和`await`關鍵字,實現了同步方法對非同步方法的調用。建議使用`await`而不是`Result`來避免潛在的死鎖問題。這種模式在處理非同步任務時能夠提高代碼的可讀性和性能。 在C#中,從同步方法調用非同步方法的過程涉及到使用 ...
  • 一:背景 1. 講故事 前些天有一位朋友在公眾號上找到我,說他們的WinForm程式部署在20多台機器上,只有兩台機器上的程式會出現崩潰的情況,自己找了好久也沒分析出來,讓我幫忙看下怎麼回事,就喜歡這些有點調試基礎的,dump也不需要我指導怎麼去抓,接下來我們就上windbg開始分析吧。 二:Win ...
  • 構建類型是動態代碼生成過程中的關鍵一環,通過靈活運用 TypeBuilder 和相關工具,我們可以實現各種複雜類型的動態生成,為程式的靈活性和可擴展性提供有力支持。總的來說,本章節通過演示如何使用 Emit 來動態創建類型,包括定義欄位、方法、屬性和事件等, 幫助讀者理解如何在運行時生成和操作類型信... ...
一周排行
    -Advertisement-
    Play Games
  • PasteSpider是什麼? 一款使用.net編寫的開源的Linux容器部署助手,支持一鍵發佈,平滑升級,自動伸縮, Key-Value配置,項目網關,環境隔離,運行報表,差量升級,私有倉庫,集群部署,版本管理等! 30分鐘上手,讓開發也可以很容易的學會在linux上部署你得項目! [從需求角度介 ...
  • SQLSugar是什麼 **1. 輕量級ORM框架,專為.NET CORE開發人員設計,它提供了簡單、高效的方式來處理資料庫操作,使開發人員能夠更輕鬆地與資料庫進行交互 2. 簡化資料庫操作和數據訪問,允許開發人員在C#代碼中直接操作資料庫,而不需要編寫複雜的SQL語句 3. 支持多種資料庫,包括但 ...
  • 在C#中,經常會有一些耗時較長的CPU密集型運算,因為如果直接在UI線程執行這樣的運算就會出現UI不響應的問題。解決這類問題的主要途徑是使用多線程,啟動一個後臺線程,把運算操作放在這個後臺線程中完成。但是原生介面的線程操作有一些難度,如果要更進一步的去完成線程間的通訊就會難上加難。 因此,.NET類 ...
  • 一:背景 1. 講故事 前些天有位朋友在微信上丟了一個崩潰的dump給我,讓我幫忙看下為什麼出現了崩潰,在 Windows 的事件查看器上顯示的是經典的 訪問違例 ,即 c0000005 錯誤碼,不管怎麼說有dump就可以上windbg開幹了。 二:WinDbg 分析 1. 程式為誰崩潰了 在 Wi ...
  • CSharpe中的IO+NPOI+序列化 文件文件夾操作 學習一下常見的文件、文件夾的操作。 什麼是IO流? I:就是input O:就是output,故稱:輸入輸出流 將數據讀入記憶體或者記憶體輸出的過程。 常見的IO流操作,一般說的是[記憶體]與[磁碟]之間的輸入輸出。 作用 持久化數據,保證數據不再 ...
  • C#.NET與JAVA互通之MD5哈希V2024 配套視頻: 要點: 1.計算MD5時,SDK自帶的計算哈希(ComputeHash)方法,輸入輸出參數都是byte數組。就涉及到字元串轉byte數組轉換時,編碼選擇的問題。 2.輸入參數,字元串轉byte數組時,編碼雙方要統一,一般為:UTF-8。 ...
  • CodeWF.EventBus,一款靈活的事件匯流排庫,實現模塊間解耦通信。支持多種.NET項目類型,如WPF、WinForms、ASP.NET Core等。採用簡潔設計,輕鬆實現事件的發佈與訂閱。通過有序的消息處理,確保事件得到妥善處理。簡化您的代碼,提升系統可維護性。 ...
  • 一、基本的.NET框架概念 .NET框架是一個由微軟開發的軟體開發平臺,它提供了一個運行時環境(CLR - Common Language Runtime)和一套豐富的類庫(FCL - Framework Class Library)。CLR負責管理代碼的執行,而FCL則提供了大量預先編寫好的代碼, ...
  • 本章將和大家分享在ASP.NET Core中如何使用高級客戶端NEST來操作我們的Elasticsearch。 NEST是一個高級別的Elasticsearch .NET客戶端,它仍然非常接近原始Elasticsearch API的映射。所有的請求和響應都是通過類型來暴露的,這使得它非常適合快速上手 ...
  • 參考delphi的代碼更改為C# Delphi 檢測密碼強度 規則(仿 google) 仿 google 評分規則 一、密碼長度: 5 分: 小於等於 4 個字元 10 分: 5 到 7 字元 25 分: 大於等於 8 個字元 二、字母: 0 分: 沒有字母 10 分: 全都是小(大)寫字母 20 ...