如何在IIS中部署兼具后台服务与API查询的Health Check应用

一、Windows环境（部署为Windows服务） #

• 适配服务运行：安装Microsoft.Extensions.Hosting.WindowsServices包，在Program.cs中添加builder.Host.UseWindowsService();，让应用支持Windows服务模式。
• 发布应用：执行命令 dotnet publish -c Release -o D:\HealthCheckPublish，生成Release版本的发布包（推荐用--self-contained true参数生成自包含包，避免依赖服务器上的.NET环境）。
• 注册并启动服务：
  1. 以管理员身份打开命令提示符，执行 sc create "HealthCheckBackgroundService" binPath="D:\HealthCheckPublish\YourApp.exe" start=auto 注册服务。
  2. 启动服务：sc start HealthCheckBackgroundService。
• 访问验证：开放服务器防火墙对应端口（如5000），通过http://<服务器IP>:<端口>/自定义API路径和http://<服务器IP>:<端口>/healthz（默认健康检查端点）验证访问。

二、Linux环境（部署为Systemd服务） #

• 适配服务运行：安装Microsoft.Extensions.Hosting.Systemd包，在Program.cs中添加builder.Host.UseSystemd();。
• 发布应用：执行命令 dotnet publish -c Release -o /opt/healthcheck --runtime linux-x64 --self-contained true，生成适配Linux的发布包。
• 配置Systemd服务：
  1. 在/etc/systemd/system/目录下创建healthcheck.service文件，内容如下：

     [Unit]
     Description=Health Check Background Service
     After=network.target
     
     [Service]
     WorkingDirectory=/opt/healthcheck
     ExecStart=/opt/healthcheck/YourApp
     Restart=always
     User=root
     
     [Install]
     WantedBy=multi-user.target
     

  2. 重新加载Systemd配置：sudo systemctl daemon-reload。
  3. 启用并启动服务：sudo systemctl enable --now healthcheck.service。
• 访问验证：用ufw allow 5000开放端口，通过http://<服务器IP>:5000/自定义API路径和健康检查端点验证。

三、容器化部署（Docker） #

• 编写Dockerfile：

  FROM mcr.microsoft.com/dotnet/aspnet:8.0 AS base
  WORKDIR /app
  EXPOSE 80
  
  FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
  WORKDIR /src
  COPY ["YourApp.csproj", "."]
  RUN dotnet restore "./YourApp.csproj"
  COPY . .
  RUN dotnet build "YourApp.csproj" -c Release -o /app/build
  
  FROM build AS publish
  RUN dotnet publish "YourApp.csproj" -c Release -o /app/publish
  
  FROM base AS final
  WORKDIR /app
  COPY --from=publish /app/publish .
  ENTRYPOINT ["dotnet", "YourApp.dll"]
  

• 构建并运行容器：
  1. 构建镜像：docker build -t healthcheck-app .。
  2. 后台运行容器并映射端口：docker run -d -p 5000:80 --name healthcheck-service healthcheck-app。
• 访问验证：通过http://localhost:5000/自定义API路径或服务器IP+端口访问端点；若需长期稳定运行，可搭配Docker Compose或Kubernetes部署，配置自动重启和服务发现。

四、通用配置要点 #

• 端口配置：在appsettings.json中设置ASPNETCORE_URLS为http://*:5000，或部署时通过环境变量指定，确保服务能被外部访问。
• 端点确认：确保Program.cs中已正确映射原生健康检查端点（如app.MapHealthChecks("/healthz");）和自定义API的路由规则。
• 日志配置：配置日志输出到文件、系统日志或专业日志平台（如ELK），方便排查服务运行异常。
• 自动恢复：所有部署方式均配置自动重启机制（Windows服务的故障恢复、Systemd的Restart=always、Docker的--restart always），保障服务可用性。

内容的提问来源于stack exchange，提问作者CodeTruthSeeker