Windows VSCode .NET Core WebAPI Debug配置

在现代的开发流程中，Visual Studio Code（简称VSCode）凭借其轻量、跨平台的特性，成为了广受开发者喜爱的编辑器。尤其对于**.NET Core WebAPI**的开发，VSCode 提供了一个极好的调试环境，支持通过配置与调试器进行高效的开发、调试工作。

本文将详细讲解如何在 Windows 上配置和调试 .NET Core WebAPI 应用程序，包括从安装 VSCode 到调试配置的全过程。通过一些具体的场景和实例，帮助开发者理解如何在实际项目中使用 VSCode 进行调试工作。

目录

1. 前言
2. 环境准备
   • 安装 .NET Core SDK
   • 安装 Visual Studio Code
   • 安装 C# 插件
3. 创建 .NET Core WebAPI 项目
   • 创建 WebAPI 项目
   • 运行默认的 WebAPI 示例
4. 配置 VSCode 调试
   • 配置 launch.json
   • 配置 tasks.json
5. 调试流程
   • 断点调试
   • 输出调试信息
   • 调试 HTTP 请求
6. 常见问题与解决方案
   • 无法启动调试会话
   • 调试过程中出现异常
7. 总结

前言

在 Windows 上开发 .NET Core WebAPI 时，Visual Studio Code 是一种非常优秀的选择。VSCode 是一个开源的、功能强大的轻量级编辑器，通过安装插件，用户能够轻松实现对 .NET Core 项目的开发与调试。

然而，如何在 VSCode 中调试 .NET Core WebAPI 应用程序，尤其是如何配置调试器和调试环境，是很多开发者可能不太熟悉的问题。本文将通过一步步的说明，帮助你在 Windows 上配置 VSCode 进行 .NET Core WebAPI 项目的调试。

环境准备

安装 .NET Core SDK

在开始使用 VSCode 调试 .NET Core WebAPI 之前，你需要安装 .NET Core SDK。请按照以下步骤进行安装：

1. 访问 .NET 下载页面。
2. 选择适合你操作系统的版本，并下载最新的 .NET SDK。
3. 运行安装包并按照提示完成安装。

安装完成后，可以在命令行中输入以下命令检查安装是否成功：

bashCopy Code
dotnet --version

如果输出了 .NET 的版本号，说明安装成功。

安装 Visual Studio Code

接下来，需要安装 Visual Studio Code，它是一个轻量级的编辑器，适合各种语言的开发。

1. 访问 Visual Studio Code 官方网站。
2. 根据操作系统选择下载对应的版本。
3. 运行安装程序，并按照提示完成安装。

安装 C# 插件

为了支持 .NET Core 开发和调试，你需要在 VSCode 中安装 C# 插件。步骤如下：

1. 打开 VSCode。
2. 点击左侧的扩展图标（或者使用快捷键 Ctrl+Shift+X）。
3. 在搜索框中输入 C#，找到并安装 C# 插件，作者为 Microsoft。
4. 安装完成后，VSCode 将自动启用 C# 支持。

安装完成后，你就可以开始开发和调试 .NET Core 项目了。

创建 .NET Core WebAPI 项目

创建 WebAPI 项目

创建 .NET Core WebAPI 项目的步骤如下：

1. 打开命令行（或者使用 VSCode 内置的终端）。

2. 使用以下命令创建一个新的 WebAPI 项目：

   bashCopy Code
   dotnet new webapi -n MyWebApi
   

   这会在当前目录下创建一个名为 MyWebApi 的文件夹，里面包含一个基本的 WebAPI 项目结构。

3. 进入项目目录：

   bashCopy Code
   cd MyWebApi
   

4. 运行项目，确保一切正常：

   bashCopy Code
   dotnet run
   

   运行后，默认情况下，WebAPI 会监听 http://localhost:5000，你可以通过浏览器或 Postman 来访问该接口。

运行默认的 WebAPI 示例

默认情况下，dotnet new webapi 命令会生成一个简单的 API，通常会包含一个 WeatherForecastController 控制器，它提供一个 GET 请求示例接口。你可以访问 http://localhost:5000/weatherforecast 来查看返回的 JSON 数据。

配置 VSCode 调试

调试配置是让 VSCode 与 .NET Core 项目能够正确交互的关键部分。下面将介绍如何配置 launch.json 和 tasks.json 来支持调试。

配置 launch.json

launch.json 文件用于配置调试器的启动行为。VSCode 会根据该配置来启动应用程序并附加调试器。

1. 在 VSCode 中打开项目。

2. 按下 Ctrl+Shift+D，打开调试面板。

3. 点击上方的 "create a launch.json file"（或者点击齿轮图标）创建一个新的调试配置文件。

4. 选择 .NET Core，VSCode 将自动为你生成一个 launch.json 文件。该文件包含如下配置：

   jsonCopy Code
   {
     "version": "0.2.0",
     "configurations": [
       {
         "name": ".NET Core Launch (web)",
         "type": "coreclr",
         "request": "launch",
         "preLaunchTask": "build",
         "program": "${workspaceFolder}/bin/Debug/netcoreapp3.1/MyWebApi.dll",
         "args": [],
         "cwd": "${workspaceFolder}",
         "stopAtEntry": false,
         "serverReadyAction": {
           "action": "openExternally",
           "pattern": "\\bNow listening on:\\s+(https?://\\S+)"
         },
         "env": {
           "ASPNETCORE_ENVIRONMENT": "Development"
         },
         "sourceFileMap": {
           "/Views": "${workspaceFolder}/Views"
         }
       }
     ]
   }
   

   其中，program 字段指定了启动的 WebAPI 项目文件路径，args 中可以传递启动参数，stopAtEntry 是否在程序入口处停止等。

配置 tasks.json

tasks.json 用于配置构建任务，可以确保每次调试之前都执行构建。为了确保项目在调试前已编译，添加一个构建任务：

1. 在 .vscode 目录下创建 tasks.json 文件，内容如下：

   jsonCopy Code
   {
     "version": "2.0.0",
     "tasks": [
       {
         "label": "build",
         "type": "shell",
         "command": "dotnet build",
         "group": {
           "kind": "build",
           "isDefault": true
         },
         "problemMatcher": "$msCompile"
       }
     ]
   }
   

   这样每次启动调试时，VSCode 会首先执行 dotnet build 命令，确保代码是最新的。

调试流程

断点调试

在 VSCode 中，调试 .NET Core WebAPI 和调试其他应用程序一样，支持在代码中设置断点。

1. 打开你要调试的代码文件，比如 Controllers/WeatherForecastController.cs。
2. 在你想要调试的行点击左边的灰色区域设置断点（点击后会变成红点）。
3. 按 F5 启动调试器，程序会启动并附加调试器到运行中的进程。
4. 当程序执行到断点处时，调试器会暂停，并允许你查看变量、调用栈等信息。

输出调试信息

为了方便调试，你可以在代码中添加日志信息，以便在调试时查看：

csharpCopy Code
private readonly ILogger<WeatherForecastController> _logger;

public WeatherForecastController(ILogger<WeatherForecastController> logger)
{
    _logger = logger;
}

[HttpGet]
public IEnumerable<WeatherForecast> Get()
{
    _logger.LogInformation("Getting weather forecast...");
    var rng = new Random();
    return Enumerable.Range(1, 5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = rng.Next(-20, 55),
        Summary = Summaries[rng.Next(Summaries.Length)]
    })
    .ToArray();
}

这些日志信息会在调试时输出到 Debug Console 中。

调试 HTTP 请求

在调试 WebAPI 时，你可以使用浏览器或工具如 Postman 来发送 HTTP 请求。当请求到达时，调试器会触发断点，允许你逐步检查请求处理的每一个环节。

1. 在 Postman 中