在仅有runtime的Docker镜像中使用dotnet global tool的方法
Docker镜像中使用dotnet global tool
△ 背景和问题概述
.NET Core 自2.1版本起便支持了Global tool特性。通过这一特性，用户能够借助命令行轻松实现众多功能，而微软提供的dotnet诊断工具系列也均以global tool形式呈现，使得使用过程更为便捷。然而，global tool的安装通常需要SDK环境，这在仅包含runtime的Docker镜像中并不适用。那么，如何在这样的环境下充分利用global tool呢？接下来，我们将深入探讨这一问题。
△ Global tool特性与运行时环境
dotnet global tool是框架依赖型发布项，其运行依赖于特定的运行时环境。当运行时无法找到时，它将尝试使用更高版本的runtime，并遵循前滚(roll-forward)规则进行选择。这一规则允许应用程序前滚至指定主要版本和次要版本的最新修补程序版本。若主要版本和次要版本均无匹配的运行时，则会选用下一个较高的次要版本。值得注意的是，前滚规则不适用于runtime的预览版，也不适用于预览版与正式版之间的转换。因此，使用预览版创建的.NET global tool需要作者重新生成、发布并安装。
在以下两种常见场景中，roll-forward行为将有所限制：
当仅有低版本运行时可用时，roll-forward仅会选择之后的版本，而不会选择低版本。
若仅有更高主要版本的运行时可用，且两者间存在不兼容的API变更风险时，roll-forward默认不会跨越主要版本界限进行选择。
若无法找到合适的runtime版本，全球工具将无法运行并会抛出错误信息。我们可以通过执行dotnet --info或dotnet --list-runtimes来查看当前可用的runtime信息。
要安装dotnet global tool，可以使用命令dotnet tool install --global dotnet-dump来安装dotnet-dump这个global tool。但请注意，尽管安装global tool需要SDK环境，但global tool在运行时仅依赖于runtime。这似乎产生了一个矛盾：我们实际上只需要runtime就能运行global tool，但安装时却需要SDK。这一现象在GitHub上引发了讨论。
△ Docker多阶段构建策略
为了解决这一问题，我们可以采取两种策略：一是直接在环境中安装SDK或使用带有SDK的环境；二是先在SDK环境下安装global tool，然后再将其拷贝到仅包含runtime的环境中。
在Docker环境中，我们可以利用其多阶段构建功能来在构建镜像时安装dotnet global tool。具体来说，可以在Dockerfile中指定一个包含SDK的镜像作为基础镜像，并在构建过程中安装所需的global tool。最终，在拷贝发布内容时，同时也将global tool拷贝到镜像中。这样，即使在只有runtime的环境中，我们也能够充分利用dotnet global tool的功能。以下是一个示例Dockerfile：
```Dockerfile
FROM mcr.microsoft.com/dotnet/sdk:5.0-alpine AS build-env
WORKDIR /app
在此处添加安装global tool的命令和拷贝操作的指令
install dotnet tool
RUN dotnet tool install --global dotnet-dump
COPY SparkTodo.Shared/SparkTodo.Shared.csproj SparkTodo.Shared/
COPY SparkTodo.API/SparkTodo.API.csproj SparkTodo.API/
RUN dotnet restore SparkTodo.API/SparkTodo.API.csproj
copy everything and build
COPY . .
WORKDIR /app/SparkTodo.API
RUN dotnet publish -c Release -o out
build runtime image
FROM mcr.microsoft.com/dotnet/aspnet:5.0-alpine AS runtime
LABEL Maintainer="WeihanLi"
WORKDIR /app
copy dotnet tools from build stage
COPY --from=build-env /root/.dotnet/tools /root/.dotnet/tools
ENV PATH="/root/.dotnet/tools:${PATH}"
EXPOSE 80
ENTRYPOINT
["dotnet", "SparkTodo.API.dll"]
通过多阶段构建，我们能够有效地避免直接使用庞大且不必要的SDK镜像。采用这种方式，安装dotnet tool只会额外增加几十兆的镜像大小，例如，仅安装一个dotnet-dump工具（具体大小取决于dotnet tool的实际大小）。
通过这种方式，我们能够在Docker容器中充分利用dotnet global tool，而无需担心runtime版本的问题。可以通过执行docker run --rm --name sparktodo sparktodo-api命令，来启动一个名为sparktodo的容器，进入该容器的内部进行工具的测试和使用。