dotNet符号文件(pdb)，符号包(snupkg)和SourceLink

最新推荐文章于 2024-04-25 12:18:13 发布
最新推荐文章于 2024-04-25 12:18:13 发布
阅读量41 收藏
点赞数
文章标签： mfc c++
原文链接：https://mp.weixin.qq.com/s?__biz=MzAwNTMxMzg1MA==&mid=2654099148&idx=7&sn=3e67e52ecd856b9b76885083402e84be&chksm=8177421bc7e5af72a4f865742f549b4aec9575606f025c87fcec006b4bd5493a202c2f0da14e&scene=126&sessionid=0
版权

前言

本文的主题是 Visual Studio 调试 NuGet 包,以及符号包的概念，如何去发布一个 NuGet 包，让我们的 NuGet 包支持 SouceLink，这些都是我们开发中比较容易忽视的内容，但是熟悉了以后可以让我们在调试中得心应手，也是开源项目开发的基础篇。

demo 源代码在文末

pdb 符号文件

程序数据库 (.pdb) 文件（也称为符号文件）将项目源代码中的标识符和语句映射到已编译应用中的相应标识符和说明。这些映射文件将调试器链接到源代码，以进行调试。

在 Visual Studio 调试器（C#、C++、Visual Basic、F#）中指定符号 (.pdb) 和源文件[1]

符号文件的工作方式

.pdb 文件保存调试和项目状态信息，使用这些信息可以对应用的调试配置进行增量链接。在调试时，Visual Studio 调试器使用 .pdb 文件来确定两项关键信息：

  • 要在 Visual Studio IDE 中显示的源文件名和行号。

  • 在应用中停止的断点位置。

调试器只会加载与在生成应用时创建的 .pdb 文件完全匹配的 .pdb 文件（即原始 .pdb 文件或副本）。

我们随便找一个自己代码的类库 Build 可以看一下

7aeab20e26843459e194787ff80bbff2.png

简单的讲：我们平时在 Visual Studio中调试代码 编译后的dll 文件在和 VS 内代码文件，断点等各种调试操作都是跟.pdb 文件内记录的信息做的映射。

符号包 (.snupkg)

创建符号包[2]

符号包提供了一些关键信息，例如已编译的代码与源代码之间的关联、局部变量的名称、堆栈跟踪,代码源文件映射等。你可以使用符号包 (.snupkg) 来分发这些符号(.pdb)，并改善 NuGet 包的调试体验。

创建符号包

有两种方式可以创建符号包

  • .csproj 文件添加属性

<PropertyGroup>
    <IncludeSymbols>true</IncludeSymbols>
    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
</PropertyGroup>

  • 打包时指定参数

dotnet pack MyPackage.csproj -p:IncludeSymbols=true -p:SymbolPackageFormat=snupkg

那我们创建一个类库先用第二种命令行打包测试一下看看效果

e45ec83fcb31d582fb1655e22a7e70bb.png

可以看到我们的符号包已经成功创建了。

接下来我们看一下符号包里面有什么东西
这里面用NuGetPackageExplorer本地工具，直接打开本地的包

acabaf061d43e33c3a664b93027b83b7.png

可以看到我们的.pdb 文件已经被打包到符号包中

SourceLink 源链接

源链接将源代码管理元数据添加到程序集和 NuGet 包，这么做的好处是进一步的获得最佳调试体验，把源链接元数据跟符号包中的pdb文件绑定

github sourcelink[3]

从.NET 8 开始，.NET SDK 默认包含对以下来源控制提供商的源链接（Source Link）支持：

  • GitHub[4] 或 GitHub Enterprise[5]

  • Azure Repos git[6] 仓库（之前称为 Visual Studio Team Services）

  • GitLab[7] 12.0+（对于旧版本，请查看 GitLab 设置[8]）

  • Bitbucket[9] 4.7+（对于旧版本，请查看 Bitbucket 设置[10]）

如果您的项目使用.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 那默认可以不用安装任何 SourceLink 的 package

接下来我们继续测试一下在类库中添加对应的属性

先提交一下代码，再打 pack

d28e2fbd72073a02a05e3cd1278616df.png

从这可以看出我们的 pdb 符号文件已经包含了 git 的源代码信息。

推送 Nuget 包

发布 Nuget 包[11]我们这里使用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%

2529175d76417ee25a6a6c1c262bf0c1.png

现在 NuGet 包已经推送上去了第一次推送的包 NuGet 平台需要对其进行索引病毒扫描等 大概需要几分钟

86d42fac98a74eafa4f60c5958ba92bb.png

可以看到我们的符号包以及源代码地址都已经在 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 中开启如下配置

87192185bb676e0887d93b42577a9ad1.png

VS 工具->选项->调试->符号 开启上面符号服务器的选中，可以设置一个本地缓存的文件夹，另外下面选择仅加载指定模块（如果开启上面除了排除的全部加载大项目调试起来有点难受）

VS 设置 SourceLink

VS 工具->选项->调试-常规

577b0ad9ea8e4eedf0c54a5aa48f27ad.png

第一步要禁用启用仅我的代码

第二部 启用源服务器的支持

到这儿基本上配置已经全部完成了

实战测试一下 我们的类库实际上是封装了一个 MinimalApis 的自动注册功能，感兴趣的朋友可以去读一下我之前的文章

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

创建一个 api 在 program 调用类库方法注册一下

app.RegisterEndPoints();

50ea1c02088423c284791dcebef60842.png

可以看到很对 NuGet 类库 源码的调试就舒服多了，可以加断点修改代码，加类库调试。

最后

简要摘要：

本文介绍了在 Visual Studio中调试 NuGet 包的相关概念，包括 PDB 符号文件、符号包、Source Link 功能以及发布支持 Source Link 的 NuGet 包。通过配置符号包和 Source Link，开发者可以更轻松地调试外部依赖项的源代码，提高调试效率。

总结：

  • PDB 符号文件和符号包在调试中起着关键作用，帮助将源代码映射到编译后的应用程序，提供更详细的调试信息。

  • Source Link 通过在程序集和 NuGet 包中添加源代码管理元数据，实现了方便调试外部依赖项的功能。

  • 配置符号服务器路径和 Source Link 选项可以使 Visual Studio 更好地支持调试 NuGet 包的源代码。

本文Demo 源代码[12]

希望本文能对你有帮助！

参考资料

[1]

在 Visual Studio 调试器（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]

创建符号包: 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 设置: https://gitlab.com/

[9]

Bitbucket: https://gitlab.com/

[10]

Bitbucket 设置: https://github.com/dotnet/sourcelink#bitbucket

[11]

发布 Nuget 包: https://learn.microsoft.com/zh-cn/nuget/nuget-org/publish-a-package

[12]

Demo 源代码: https://github.com/Dong-Ruipeng/dotNetParadise-SourceLink.git

dotNET跨平台
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
dotnet如何将文件删除到回收站
08-26
主要给大家介绍了关于dotnet如何将文件删除到回收站的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用dotnet具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
用于VS2022的dotnet framework 4.0~4.5目标包
11-27
用于VS2022的dotnet framework 4.0~4.5资源包。 解压到C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework 目录下，可用VS2022开发 .Net Framework 4.0~4.5的程序。
BaGet：轻量级的NuGet和符号服务器
01-28
百得 :baguette_bread: 轻量级的和服务器。 入门 安装 下载并提取 用dotnet BaGet.dll启动服务 在浏览器中浏览http://localhost:5000/ 有关更多信息，请参阅。 特征 跨平台 可以索引整个nuget.org。 请参阅 即将推出：支持 和更多！ 敬请期待，更多功能正在计划中！ 发展 安装和 运行git clone https://github.com/loic-sharma/BaGet.git 导航到.\BaGet\src\BaGet.UI 使用npm install前端的依赖项 导航到..\BaGet 使用dotnet run启动服务 在浏览器中打开URL http://localhost:5000/v3/index.json
DependenSee:Dotnet项目和程序包依赖项可视化工具
05-12
依赖查看 Dotnet项目和程序包依赖项可视化工具。 安装 需要.NET 5或更高版本 dotnet tool install DependenSee --global 在上 卸载 dotnet tool uninstall DependenSee --global 怎么跑 DependenSee root/of/projects path/to/output.html 样本输出（HTML） 为什么要DependenSee查看'X' 当前流行的选择是使用NDepend，VS Architecture Explorer或Code Map。 尽管这些选项功能丰富，但它们也需要支付许可费用。 如果您只想查看依赖关系图，而仅此而已，那么可能很难证明许可成本的合理性。 那么DependenSee适合您。 如果您需要查看类型结构，则您的方法或类型.etc之间的关系。 那么您应该改用上述选项之
Latex常用数学公式
李宏宗的博客
08-30 974
[LaTeX数学公式大全] 感谢大佬
dotnet6.0.hosting文件和sdk文件，IIS环境部署安装包
05-19
因为官网下载网址无法打开，所以难下载。
共享单车（二）：项目日志
学习记录
04-24 986
学习记录
mfc140.dll丢失如何修复，分享多种有效的修复方法
weixin_57940283的博客
04-21 977
在日常操作和使用电脑的过程中，我们可能会遇到一种较为常见的问题，即在尝试启动或运行某个应用程序时，系统突然弹出一个错误提示窗口，明确指出“mfc140.dll文件丢失”。这个mfc140.dll实际上是一个动态链接库文件（DLL），它是Microsoft Visual C++ Redistributable的一部分，对于许多基于此开发环境构建的应用程序来说是至关重要的组件。当系统无法找到或者该文件遭到损坏时，就可能导致相关软件无法正常打开或执行其全部功能。
C++教学——从入门到精通 10.循环
QIPABOSHI的博客
04-24 371
一些事嘛，需要重复做，这就是循环在开始学之前我提一个事，最好先学Python再学C++，不然就会像我和piaojunhe_0825一样有C++后遗症，在Python里写了一个for(int i=0;i
【C】 初识C语言
努力学习C/C++
04-21 770
从本篇开始，带你从不会C语言到精通C语言。这篇是让大家对C语言有个初步的了解。下面的内容会拆分不同篇幅单独进行详细讲叙。数据类型变量、常量字符串转义字符注释选择语句循环语句函数数组操作符常见关键字define定义常量和宏指针结构体1.什么是C语言？C语言是一门面向过程的计算机编程语言，与C++、C#、Java等面向对象编程语言有所不同。C语言的设计目标是提供一种能以简易的方式编译、处理低级存储器、仅产生少量的机器码以及不需要任何运行环境支持便能运行的编程语言。
C++ WebServer的细节理解
我的博客
04-22 623
在非阻塞模式下，如果 I/O 操作不能立即完成（例如，因为没有数据可读 或 写缓冲区满），系统不会让调用进程阻塞等待，而是立即返回一个错误（通常为 EAGAIN 或 EWOULDBLOCK）。先查询文件描述符 fd 当前的标志，然后将 O_NONBLOCK 标志加入其中，并通过 F_SETFL 来更新文件描述符，最终实现将该文件描述符切换为非阻塞模式。这意味着，如果没有待处理的连接请求（即没有客户端尝试连接到服务器），accept() 会一直阻塞，直到有新的连接请求到达或发生其他特定条件（如超时）为止。
笨蛋学C++【C++基础第六弹】
YSL_Monet的博客
04-24 822
定义类需要用到关键字 class，然后指定类的名称，类的主体是包含在一对花括号中，主体包含类的成员变量和成员函数class 类名{访问修饰符（public/protected/private）:成员变量;成员函数();
C语言如何⽤指针为函数传递数组？
最新发布
PAP
04-25 206
C语言如何⽤指针为函数传递数组？
【C++风云录】精益求精：探索C++开发中的性能优化艺术
记录我的学习历程
04-21 1113
本文将介绍几个在C++开发中常用的性能分析工具和性能优化工具集，包括PerfTools、gperftools、Valgrind、Intel VTune、PAPI以及Boost.Profile。通过深入了解这些工具的功能和用途，读者可以更好地理解如何利用它们来提高代码的执行效率和资源利用率。
C++——初识模板
qq_74245477的博客
04-22 911
之前实现的数据结构，比如栈，我们为了便于修改存储的数据类型，通常使用typedef来重定义数据类型，但是这样有一个缺陷，会导致我们定义的栈存储的都是一种数据，如果同时需要两个栈，一个存储int，一个存储自定义类型，那么typedef就不管用了。比如：当用int类型使用函数模板时，编译器通过对实参类型的推演，将T确定为int类型，然后产生一份专门处理int类型的代码，对于字符类型也是如此。概念：函数模板代表了一个函数家族，该函数模板与类型无关，在使用时被参数化，根据实参类型产生函数的特定类型的版本。
理解C语言中的位操作和整数类型：一个温度传感器读取问题的解析
qq_61637982的博客
04-24 237
当我们编写嵌入式系统的代码时，我们经常需要使用位操作来处理硬件设备的数据。然而，如果我们对C语言的位操作和整数类型不完全理解，可能会遇到一些难以理解的问题。在这篇博客中，我将通过一个实际的例子来解释这些概念，并提供一个解决方案。
C++中的抽象类
hh121386的博客
04-23 200
C++中的抽象类
掉落回弹问题（C语言）
m0_67184754的博客
04-22 364
【代码】掉落回弹问题（C语言）
dotnet source ref
11-06
dotnet source ref是.NET框架中的一项功能，用于支持在.NET应用程序中引用源代码文件。在之前的.NET版本中，当我们使用类库或框架的时候，只能通过查看文档或者反编译来了解其内部实现。但是，在.NET 5引入的新功能dotnet source ref下，我们可以直接引用相关源代码文件，以便更深入地了解和调试代码。 使用dotnet source ref功能的前提是，目标代码（类库或框架）需要提供源代码文件的托管。这些源代码文件通常包括类、方法、属性等的实现细节。通过在我们的应用项目中添加源代码的引用，我们可以方便地查看代码的实现逻辑，以及调试内部细节。 在实际使用中，我们可以通过几个步骤使用dotnet source ref功能。首先，在我们的应用程序项目中，需要添加对目标代码的引用。这可以通过NuGet包管理器或手动添加源代码文件来实现。然后，在需要查看或调试源代码的地方，我们可以直接使用dotnet source ref命令或类似的工具来导航到相关代码文件，以获取详细的代码实现。 使用dotnet source ref功能有助于我们更好地理解和调试使用的类库或框架的内部工作原理。这对于开发者来说是非常有用的，尤其是在遇到问题或需要进行深入分析时。通过查看源代码，我们可以更好地理解其设计理念、算法和逻辑，从而更好地应用和扩展这些类库或框架。 总的来说，dotnet source ref功能是.NET框架中一个有用的工具，它允许我们在应用程序中引用源代码文件，以便更深入地了解和调试代码。通过使用这个功能，我们可以更好地理解和使用使用的类库或框架，从而提高开发效率和代码质量。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值