NetCoreDbg 使用教程

1. 项目介绍

NetCoreDbg 是一个用于 .NET Core 运行时的托管代码调试器，支持 GDB/MI 和 VSCode 调试适配器协议。它允许用户在 .NET Core 运行时下进行 .NET 应用程序的调试，并且可以通过命令行（如 GDB）进行调试。NetCoreDbg 由三星公司开发并开源，采用 MIT 许可证。

2. 项目快速启动

2.1 安装

NetCoreDbg 可以通过多种方式安装，以下是几种常见的方法：

2.1.1 通过包管理器安装

• Arch Linux: 使用 AUR 包管理器安装 netcoredbg。
• Gentoo Linux: 使用 dev-dotnet/netcoredbg 包。
• Scoop (Windows): 使用 Scoop 安装 netcoredbg。

2.1.2 从 GitHub 下载二进制文件

可以直接从 GitHub Releases 页面下载预编译的二进制文件。

2.2 编译源码

如果你需要从源码编译 NetCoreDbg，可以按照以下步骤进行：

2.2.1 安装依赖

• Linux: 安装 cmake、clang 和 .NET 运行时。
• Windows: 安装 CMake、Visual Studio 2019 或更新版本、Git。

2.2.2 编译步骤

# 克隆仓库
git clone https://github.com/Samsung/netcoredbg.git
cd netcoredbg

# 创建构建目录
mkdir build
cd build

# 配置构建
cmake ..

# 编译
make

# 安装
make install

2.3 使用示例

以下是一个简单的使用示例，展示如何在命令行中启动 NetCoreDbg 并调试一个 .NET Core 应用程序：

# 启动 NetCoreDbg 并调试指定的 .NET Core 应用程序
./netcoredbg --interpreter=cli -- /path/to/dotnet /path/to/program.dll

3. 应用案例和最佳实践

3.1 在 Neovim 中使用 NetCoreDbg

用户可以在 Neovim 中使用 NetCoreDbg 进行 .NET Core 应用程序的调试。以下是一个简单的配置示例：

-- 配置 nvim-dap 插件
require('dap').adapters.coreclr = {
  type = 'executable',
  command = 'netcoredbg',
  args = { '--interpreter=vscode' }
}

require('dap').configurations.cs = {
  {
    type = 'coreclr',
    name = 'launch - netcoredbg',
    request = 'launch',
    program = function()
      return vim.g.dotnet_get_dll_path()
    end,
    console = 'integratedTerminal'
  }
}

3.2 调试 Web API 项目

在调试 Web API 项目时，可以通过设置环境变量为 Development 来确保调试器能够正确连接到应用程序的端口：

# 设置环境变量并启动应用程序
export ASPNETCORE_ENVIRONMENT=Development
dotnet run

然后使用 NetCoreDbg 附加到运行中的进程：

./netcoredbg --attach <process-id>

4. 典型生态项目

4.1 nvim-dap-cs

nvim-dap-cs 是一个为 Neovim 的 nvim-dap 插件提供的扩展，用于配置和启动 .NET Core 调试器（NetCoreDbg）。它简化了在 Neovim 中调试 .NET Core 应用程序的流程。

4.2 VSCode 调试适配器

NetCoreDbg 支持 VSCode 调试适配器协议，因此可以与 VSCode 集成，提供强大的调试功能。用户可以在 VSCode 中配置调试器，以便在开发环境中进行高效的调试。

通过以上步骤，你可以快速上手并使用 NetCoreDbg 进行 .NET Core 应用程序的调试。