使用.NET Core3.0创建一个Windows服务的方法

时间:2022-01-26 11:26:24

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

创建一个 worker

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

在 visual studio 中创建 worker

使用.NET Core3.0创建一个Windows服务的方法

使用.NET Core3.0创建一个Windows服务的方法

使用.NET Core3.0创建一个Windows服务的方法

在命令行中创建 worker

运行 dotnet new worker

使用.NET Core3.0创建一个Windows服务的方法

作为 windows 服务运行

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

添加 microsoft.extensions.hosting.windowsservices nuget 包

使用.NET Core3.0创建一个Windows服务的方法

在 program.cs 的 hostbuilder 中添加对 useservicebaselifetime 的调用

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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

例如:

使用.NET Core3.0创建一个Windows服务的方法

安全说明:此命令将服务使用 local system 运行,这通常不是您想要做的事情。相反,您应该创建一个服务帐户并以该帐户运行 windows 服务。我们不会在这里讨论这个问题,但是有一些文档在这里讨论它:

日志

日志记录系统有 event log 的提供程序,可以将日志消息直接发送到 windows 事件日志。安装 microsoft.extensions.logging.eventlog 并修改 program.cs :

?
1
2
3
4
5
6
7
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 中创建服务

原文: .net core workers as windows services

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。