现已推出!阅读 10 月份的新功能和修复。

容器中的 ASP.NET Core

在本指南中,您将学习如何

  • 创建Dockerfile 文件,其中描述了一个简单的 .NET Core 服务容器。
  • 构建、运行和验证服务的正常运行。
  • 调试作为容器运行的服务。

先决条件

创建 .NET Web API 项目

  1. 为项目创建一个文件夹。

  2. 在项目文件夹中打开开发人员命令提示符并初始化项目

    dotnet new webapi --no-https
    

将 Docker 文件添加到项目

  1. 在 VS Code 中打开项目文件夹。

  2. 等待 C# 扩展提示您添加构建和调试所需的资产,然后选择。您也可以打开命令面板(⇧⌘P(Windows、Linux Ctrl+Shift+P)并使用.NET: 生成构建和调试资产命令。

  3. 打开命令面板(⇧⌘P(Windows、Linux Ctrl+Shift+P)并使用Docker: 将 Docker 文件添加到工作区...命令

    Add Dockerfile to a .NET project

  4. 在提示您选择应用程序平台时,使用.NET: ASP.NET Core

  5. 在提示您选择操作系统时,选择WindowsLinux

    只有在您的 Docker 安装配置为使用 Windows 容器时,Windows 才适用。

  6. 系统会询问您是否要添加 Docker Compose 文件。在本教程中,我们不会使用 Docker Compose,因此“是”和“否”答案都可以。

  7. 将应用程序端点的端口更改为5000

  8. Dockerfile.dockerignore 文件已添加到工作区。

    该扩展还会创建一组用于构建和运行容器的VS Code 任务(以调试和发布配置形式,总共四个任务),以及用于以调试模式启动容器的调试配置

构建应用程序

  1. 打开终端提示符(⌃`(Windows、Linux Ctrl+`)。

  2. 发出dotnet build 命令以构建应用程序

    PS C:\source\repos\net> dotnet build
    MSBuild version 17.4.0-preview-22470-08+6521b1591 for .NET
      Determining projects to restore...
      All projects are up-to-date for restore.
      net -> C:\source\repos\net\bin\Debug\net7.0\net.dll
    
    Build succeeded.
        0 Warning(s)
        0 Error(s)
    
    Time Elapsed 00:00:08.96
    

向映像添加环境变量

您可以使用 Docker 扩展编写 Docker 文件。该扩展提供补全和上下文帮助。若要查看这些功能,请按照以下步骤向服务映像添加环境变量

  1. 打开Dockerfile 文件。

  2. 使用ENV 指令将环境变量添加到服务容器映像。该指令应放置在Dockerfilebase 阶段(文件中的第一个阶段)。将ASPNETCORE_URLS 变量设置为http://*:5000

    Add an environment variable to Docker image

    请注意 Docker 扩展如何列出所有可用的 Dockerfile 指令并描述语法。

    Docker 扩展使用Dockerfilebase 阶段为您的服务创建容器映像的调试版本。将ASPNETCORE_URLS 环境变量定义放在base 阶段,以便在容器映像的调试和发布版本中都可以使用此变量。

  3. 保存Dockerfile 文件。

构建映像

  1. 打开命令面板(⇧⌘P(Windows、Linux Ctrl+Shift+P)并发出Docker 映像: 构建映像...命令。

  2. 打开 Docker 资源管理器,验证新映像是否在“映像”树中可见

    Verify Docker image exists

测试服务容器

  1. 右键单击上一步中构建的映像,然后选择运行交互式运行。容器应启动,您应该能够在 Docker 资源管理器的“容器”窗格中看到它

    Running service container

  2. 打开 Web 浏览器并导航到https://127.0.0.1:5000/WeatherForecast。您应该看到类似于以下内容的 JSON 格式的天气数据

    [
        {"date":"2019-11-07T23:31:57.0527092+00:00","temperatureC":4,"temperatureF":39,"summary":"Bracing"},
        {"date":"2019-11-08T23:31:57.0539243+00:00","temperatureC":-19,"temperatureF":-2,"summary":"Freezing"},
        {"date":"2019-11-09T23:31:57.0539269+00:00","temperatureC":2,"temperatureF":35,"summary":"Freezing"},
        {"date":"2019-11-10T23:31:57.0539275+00:00","temperatureC":-4,"temperatureF":25,"summary":"Freezing"},
        {"date":"2019-11-11T23:31:57.053928+00:00","temperatureC":9,"temperatureF":48,"summary":"Bracing"}
     ]
    

    默认情况下,Docker 会将随机选择的主机端口分配给容器公开的端口(容器端口)。在我们的应用程序中,公开的(容器)端口为 5000。当您对映像发出运行命令时,VS Code 会尝试为主机端口和容器端口使用相同的端口号。这使得记住用于与容器通信的端口变得容易,但如果主机端口已在使用中,则不会起作用。

    如果在浏览器中看不到容器中的数据,请确保docker run 命令没有报告任何错误(查看终端窗口中的命令输出)。您也可以通过右键单击 Docker 资源管理器中的容器并选择检查来验证容器使用的是哪个主机端口。这将打开一个 JSON 文档,其中详细描述了容器。搜索PortBindings 元素,例如

    "PortBindings": {
      "5000/tcp": [
        {
          "HostIp": "",
          "HostPort": "5000"
        }
      ]
    },
    
  3. 测试完成后,右键单击 Docker 资源管理器中的容器,然后选择停止

在容器中调试

将 Docker 文件添加到应用程序时,Docker 扩展还添加了VS Code 调试器配置,用于在服务在容器内运行时调试服务。该扩展将自动检测服务使用的协议和端口,并将浏览器指向该服务,但我们需要告诉它使用哪个 URL 路径。

  1. Controllers/WeatherForecastController.cs 文件的Get() 方法的代码开头设置断点。

  2. 打开.vscode/launch.json 文件并找到Docker .NET Core Launch 调试配置。

  3. Docker .NET Core Launch 配置中添加dockerServerReadyAction

    "dockerServerReadyAction": {
        "uriFormat": "%s://127.0.0.1:%s/WeatherForecast"
    }
    
  4. 确保选择该配置作为活动配置

    Selected Docker debug configuration

  5. 启动调试(F5)。

    • 服务容器的调试版本将构建并启动。
    • 浏览器将打开以请求新的天气预报。
    • 将命中WeatherForecastController 中的断点。

您可以通过更改docker-run: debug任务(在.vscode/tasks.json文件中定义)使用的Docker运行选项,在主机上使用特定的端口。例如,如果您想使用相同的端口(5000)来公开服务,则docker-run: debug任务定义将如下所示

 {
    "type": "docker-run",
    "label": "docker-run: debug",
    "dependsOn": [
        "docker-build: debug"
    ],
    "dockerRun": {
        "ports": [
            { "hostPort": 5000, "containerPort": 5000 }
        ]
    },
    "netCore": {
        "appProject": "${workspaceFolder}/netcorerest.csproj",
        "enableDebugging": true
    }

后续步骤

完成了!现在您的容器已准备就绪,您可能想