使用容器进行 .NET 开发

先决条件

完成 容器化 .NET 应用程序.

概述

在本节中,你将学习如何为你的容器化应用程序设置开发环境。这包括

  • 添加本地数据库并持久化数据
  • 配置 Compose 在你编辑并保存代码时自动更新正在运行的 Compose 服务
  • 创建一个包含 .NET Core SDK 工具和依赖项的开发容器

更新应用程序

本节使用 docker-dotnet-sample 存储库的不同分支,其中包含更新的 .NET 应用程序。更新的应用程序位于你在 容器化 .NET 应用程序 中克隆的存储库的 add-db 分支上。

要获取更新的代码,你需要检出 add-db 分支。对于你在 容器化 .NET 应用程序 中所做的更改,对于本节,你可以将它们隐藏起来。在终端中,在 docker-dotnet-sample 目录中运行以下命令。

  1. 隐藏任何之前的更改。

    $ git stash -u
    
  2. 检出包含更新的应用程序的新分支。

    $ git checkout add-db
    

add-db 分支中,只有 .NET 应用程序已更新。还没有更新任何 Docker 资源。

现在你的 docker-dotnet-sample 目录中应该包含以下内容。

├── docker-dotnet-sample/
│ ├── .git/
│ ├── src/
│ │ ├── Data/
│ │ ├── Models/
│ │ ├── Pages/
│ │ ├── Properties/
│ │ ├── wwwroot/
│ │ ├── appsettings.Development.json
│ │ ├── appsettings.json
│ │ ├── myWebApp.csproj
│ │ └── Program.cs
│ ├── tests/
│ │ ├── tests.csproj
│ │ ├── UnitTest1.cs
│ │ └── Usings.cs
│ ├── .dockerignore
│ ├── .gitignore
│ ├── compose.yaml
│ ├── Dockerfile
│ ├── README.Docker.md
│ └── README.md

添加本地数据库并持久化数据

你可以使用容器来设置本地服务,例如数据库。在本节中,你将更新 compose.yaml 文件以定义一个数据库服务和一个用于持久化数据的卷。

在 IDE 或文本编辑器中打开 compose.yaml 文件。你将注意到它已经包含了有关 PostgreSQL 数据库和卷的注释掉的指令。

在 IDE 或文本编辑器中打开 docker-dotnet-sample/src/appsettings.json。你将注意到包含所有数据库信息的连接字符串。compose.yaml 已经包含了这些信息,但它被注释掉了。取消注释 compose.yaml 文件中的数据库指令。

以下是更新后的 compose.yaml 文件。

services:
  server:
    build:
      context: .
      target: final
    ports:
      - 8080:80
    depends_on:
      db:
        condition: service_healthy
  db:
    image: postgres
    restart: always
    user: postgres
    secrets:
      - db-password
    volumes:
      - db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=example
      - POSTGRES_PASSWORD_FILE=/run/secrets/db-password
    expose:
      - 5432
    healthcheck:
      test: [ "CMD", "pg_isready" ]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  db-data:
secrets:
  db-password:
    file: db/password.txt

注意

要了解有关 Compose 文件中指令的更多信息,请参阅 Compose 文件参考.

在你使用 Compose 运行应用程序之前,请注意,此 Compose 文件使用 secrets 并指定了一个 password.txt 文件来保存数据库的密码。你必须创建此文件,因为它不包含在源存储库中。

docker-dotnet-sample 目录中,创建一个名为 db 的新目录,并在该目录中创建一个名为 password.txt 的文件。在 IDE 或文本编辑器中打开 password.txt 并添加以下密码。密码必须在一行上,文件中没有其他行。

example

保存并关闭 password.txt 文件。

现在你的 docker-dotnet-sample 目录中应该包含以下内容。

├── docker-dotnet-sample/
│ ├── .git/
│ ├── db/
│ │ └── password.txt
│ ├── src/
│ ├── tests/
│ ├── .dockerignore
│ ├── .gitignore
│ ├── compose.yaml
│ ├── Dockerfile
│ ├── README.Docker.md
│ └── README.md

运行以下命令以启动你的应用程序。

$ docker compose up --build

打开浏览器,并在 https://127.0.0.1:8080。你应该看到一个简单的 Web 应用程序,其中显示文本“学生姓名是”。

应用程序没有显示姓名,因为数据库是空的。对于此应用程序,你需要访问数据库,然后添加记录。

向数据库添加记录

对于示例应用程序,你必须直接访问数据库以创建示例记录。

你可以使用 docker exec 命令在数据库容器中运行命令。在运行该命令之前,你必须获取数据库容器的 ID。打开一个新的终端窗口并运行以下命令以列出所有正在运行的容器。

$ docker container ls

你应该看到类似于以下内容的输出。

CONTAINER ID   IMAGE                  COMMAND                  CREATED              STATUS                        PORTS                  NAMES
cb36e310aa7e   docker-dotnet-server   "dotnet myWebApp.dll"    About a minute ago   Up About a minute             0.0.0.0:8080->80/tcp   docker-dotnet-server-1
39fdcf0aff7b   postgres               "docker-entrypoint.s…"   About a minute ago   Up About a minute (healthy)   5432/tcp               docker-dotnet-db-1

在之前的示例中,容器 ID 为 39fdcf0aff7b。运行以下命令连接到容器中的 postgres 数据库。将容器 ID 替换为自己的容器 ID。

$ docker exec -it 39fdcf0aff7b psql -d example -U postgres

最后,向数据库插入一条记录。

example=# INSERT INTO "Students" ("ID", "LastName", "FirstMidName", "EnrollmentDate") VALUES (DEFAULT, 'Whale', 'Moby', '2013-03-20');

你应该看到类似于以下内容的输出。

INSERT 0 1

运行 exit 关闭数据库连接并退出容器 shell。

example=# exit

验证数据是否持久化到数据库

打开浏览器,并在 https://127.0.0.1:8080。你应该看到一个简单的 Web 应用程序,其中显示文本“学生姓名是鲸鱼莫比”。

在终端中按 ctrl+c 停止你的应用程序。

在终端中,运行 docker compose rm 删除你的容器,然后运行 docker compose up 再次运行你的应用程序。

$ docker compose rm
$ docker compose up --build

刷新浏览器中的 https://127.0.0.1:8080 并验证学生姓名是否持久化,即使容器已删除并再次运行。

在终端中按 ctrl+c 停止你的应用程序。

自动更新服务

使用 Compose Watch 在你编辑并保存代码时自动更新正在运行的 Compose 服务。有关 Compose Watch 的更多详细信息,请参阅 使用 Compose Watch.

在 IDE 或文本编辑器中打开你的 compose.yaml 文件,然后添加 Compose Watch 指令。以下是更新后的 compose.yaml 文件。

services:
  server:
    build:
      context: .
      target: final
    ports:
      - 8080:80
    depends_on:
      db:
        condition: service_healthy
    develop:
      watch:
        - action: rebuild
          path: .
  db:
    image: postgres
    restart: always
    user: postgres
    secrets:
      - db-password
    volumes:
      - db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=example
      - POSTGRES_PASSWORD_FILE=/run/secrets/db-password
    expose:
      - 5432
    healthcheck:
      test: [ "CMD", "pg_isready" ]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  db-data:
secrets:
  db-password:
    file: db/password.txt

运行以下命令使用 Compose Watch 运行你的应用程序。

$ docker compose watch

打开浏览器并验证应用程序是否在 https://127.0.0.1:8080 运行。

对本地机器上的应用程序源文件的任何更改现在都将立即反映在正在运行的容器中。

在 IDE 或文本编辑器中打开 docker-dotnet-sample/src/Pages/Index.cshtml,并将第 13 行上的学生姓名文本从 Student name is 更新为 Student name:

-    <p>Student Name is @Model.StudentName</p>
+    <p>Student name: @Model.StudentName</p>

保存对 Index.cshmtl 的更改,然后等待几秒钟让应用程序重新构建。刷新浏览器中的 https://127.0.0.1:8080 并验证更新后的文本是否出现。

在终端中按 ctrl+c 停止你的应用程序。

创建开发容器

此时,当你运行你的容器化应用程序时,它正在使用 .NET 运行时镜像。虽然这个小镜像对于生产来说很好,但它缺少你在开发时可能需要的 SDK 工具和依赖项。此外,在开发过程中,你可能不需要运行 dotnet publish。你可以使用多阶段构建在同一个 Dockerfile 中构建开发和生产的阶段。有关更多详细信息,请参阅 多阶段构建.

向你的 Dockerfile 添加一个新的开发阶段,并更新你的 compose.yaml 文件以使用此阶段进行本地开发。

以下是更新后的 Dockerfile。

# syntax=docker/dockerfile:1

FROM --platform=$BUILDPLATFORM mcr.microsoft.com/dotnet/sdk:6.0-alpine AS build
ARG TARGETARCH
COPY . /source
WORKDIR /source/src
RUN --mount=type=cache,id=nuget,target=/root/.nuget/packages \
    dotnet publish -a ${TARGETARCH/amd64/x64} --use-current-runtime --self-contained false -o /app

FROM mcr.microsoft.com/dotnet/sdk:6.0-alpine AS development
COPY . /source
WORKDIR /source/src
CMD dotnet run --no-launch-profile

FROM mcr.microsoft.com/dotnet/aspnet:6.0-alpine AS final
WORKDIR /app
COPY --from=build /app .
ARG UID=10001
RUN adduser \
    --disabled-password \
    --gecos "" \
    --home "/nonexistent" \
    --shell "/sbin/nologin" \
    --no-create-home \
    --uid "${UID}" \
    appuser
USER appuser
ENTRYPOINT ["dotnet", "myWebApp.dll"]

以下是更新后的 compose.yaml 文件。

services:
  server:
    build:
      context: .
      target: development
    ports:
      - 8080:80
    depends_on:
      db:
        condition: service_healthy
    develop:
      watch:
        - action: rebuild
          path: .
    environment:
       - ASPNETCORE_ENVIRONMENT=Development
       - ASPNETCORE_URLS=http://+:80'
  db:
    image: postgres
    restart: always
    user: postgres
    secrets:
      - db-password
    volumes:
      - db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=example
      - POSTGRES_PASSWORD_FILE=/run/secrets/db-password
    expose:
      - 5432
    healthcheck:
      test: [ "CMD", "pg_isready" ]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  db-data:
secrets:
  db-password:
    file: db/password.txt

您的容器化应用程序现在将使用 `mcr.microsoft.com/dotnet/sdk:6.0-alpine` 镜像,其中包含 `dotnet test` 等开发工具。继续下一节,了解如何运行 `dotnet test`。

总结

在本节中,您了解了如何设置 Compose 文件以添加本地数据库并持久化数据。您还学习了如何使用 Compose Watch 在您更新代码时自动重建和运行容器。最后,您学习了如何创建包含开发所需 SDK 工具和依赖项的开发容器。

相关信息

下一步

在下一节中,您将学习如何使用 Docker 运行单元测试。