代码改变世界

[翻译] 使用 .NET Core 3.0 创建一个 Windows 服务

2019-04-01 11:24  Rwing  阅读(3042)  评论(5编辑  收藏  举报

原文: .NET Core Workers as Windows Services

在 .NET Core 3.0 中,我们引入了一种名为 Worker Service 的新型应用程序模板。此模板旨在为您在 .NET Core 中编写长时间运行的服务的提供一个起点。在本演练中,我们将创建一个 worker 并将其作为 Windows 服务运行。

创建一个 Worker

注意:在我们的预览版中,worker 模板与 Web 模板位于同一级菜单中。这将在未来的版本中发生变化。我们打算将 Worker Service 模板直接放在“创建新项目”菜单中。

在 Visual Studio 中创建 Worker

在命令行中创建 Worker

运行 dotnet new worker

作为 Windows 服务运行

为了作为 Windows 服务运行,我们需要我们的 worker 监听来自 ServiceBase 的启动停止信号,该类型将 Windows 服务系统暴露给 .NET 应用程序。要做到这一点,我们希望:

添加 Microsoft.Extensions.Hosting.WindowsServices NuGet 包

在 Program.cs 的 HostBuilder 中添加对 UseServiceBaseLifetime 的调用

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .UseServiceBaseLifetime()
            .ConfigureServices(services =>
            {
                services.AddHostedService<Worker>();
            });
}

这个方法做了两件事。首先,它检查应用程序是否真正的作为 Windows 服务运行,如果不是,那么它什么都不做,这使得这个方法很安全,当本地运行或作为 Windows 服务运行时。您不需要向其添加保护语句,只需在未作为 Windows 服务安装时正常运行应用程序即可。

其次,它将配置 host 使用 ServiceBaseLifetime。 ServiceBaseLifetime 与 ServiceBase 一起使用,以帮助控制作为 Windows 服务运行时应用程序的生命周期。这会覆盖处理 CTRL + C 等信号的默认的 ConsoleLifetime 。

安装 Worker

一旦我们的 worker 使用 ServiceBaseLifetime,我们就需要安装它:

首先,让我们发布应用程序。如果我们立刻安装了 Windows 服务,这意味着只要服务运行,exe 就会被锁定。发布这一步是个很好的方法, 以确保我需要运行服务的所有文件都在一个位置, 并准备好安装。

dotnet publish -o c:\code\workerpub

然后我们就可以在命令行中使用 sc 命令来安装

sc create workertest binPath=c:\code\workerpub\WorkerTest.exe

例如:

安全说明:此命令将服务使用 local system 运行,这通常不是您想要做的事情。相反,您应该创建一个服务帐户并以该帐户运行 Windows 服务。我们不会在这里讨论这个问题,但是有一些文档在这里讨论它: https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/windows-service?view=aspnetcore-2.2

日志

日志记录系统有 Event Log 的提供程序,可以将日志消息直接发送到 Windows 事件日志。安装 Microsoft.Extensions.Logging.EventLog 并修改 Program.cs :

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureLogging(loggerFactory => loggerFactory.AddEventLog())
        .ConfigureServices(services =>
        {
            services.AddHostedService<Worker>();
        });

未来工作

在即将到来的预览版中,我们计划通过以下方式改善使用 Worker 的体验:

  • 将 UseWindowsServiceBaseLifetime 重命名为 UseWindowsService
  • 作为 Windows 服务运行时,自动的集成 Event Log 日志。

结论

我们希望您试用这个新模板,并希望您告诉我们它有什么问题,您可以在此处提出任何错误或建议:
https://github.com/aspnet/AspNetCore/issues/new/choose

译者注

原文作者在评论中提到,下一篇文章将讲解如何在 Linux/Unix 中创建服务