C#/.NET基于Topshelf创建Windows服务程序及服务的安装和卸载(极速，简洁)

本文首发于：码友网--一个专注.NET/.NET Core开发的编程爱好者社区。

文章目录

C#/.NET基于Topshelf创建Windows服务的系列文章目录：

1. C#/.NET基于Topshelf创建Windows服务程序及服务的安装和卸载 (1)
2. 在C#/.NET应用程序开发中创建一个基于Topshelf的应用程序守护进程(服务) (2)
3. C#/.NET基于Topshelf创建Windows服务的守护程序作为服务启动的客户端桌面程序不显示UI界面的问题分析和解决方案 (3)

前言

对于使用Windows操作系统的人来说，Windows Service(Windows服务)应该不会陌生。在Windows操作系统中，我们可以在"运行"窗口中运行

service.msc

即可打开一个查看Windows服务的窗口，如图：

Windows服务基本都是一些后台运行的服务进程，没有UI界面，每个服务处理着各自独立的任务并且有专门的启动或者停止策略。所以，Windows服务在很多情况下会被用来者处理一些定时任务或者调度。

那么，对于.NET的开发者来说，可不可以自己创建Windows服务呢，如何使用C#创建Windows服务呢？

本文就为大家分享一种基于Topshelf创建的Windows服务的方法。

创建Topshelf服务项目

首先打开Visual Studio(本文使用的是Visual Studio 2019)，打开新建项目的对话框，选择.NET Framework的控制台应用程序(Console App(.NET Framework))，如图：

点击"下一步"，在项目名称中输入

TopshelfDemoService

安装Topshelf组件

在

TopshelfDemoService

Topshelf

Topshelf

编写Topshelf服务的示例程序代码

Topshelf

首先，创建一个名为

HealthMonitorService.cs

Start()

Stop()

using System;
using System.Timers;

namespace TopshelfDemoService
{
internal class HealthMonitorService
{
private readonly Timer _timer;
public HealthMonitorService()
{
_timer = new Timer(1000) { AutoReset = true };
_timer.Elapsed += (sender, eventArgs) => Console.WriteLine("执行系统健康检查任务，所有指标均正常。执行时间：{0}", DateTime.Now);
}

public void Start()
{
_timer.Start();
}
public void Stop()
{
_timer.Stop();
}
}
}

再创建一个名为

MyServiceConfigure.cs

using System;
using Topshelf;

namespace TopshelfDemoService
{
internal class MyServiceConfigure
{
internal static void Configure()
{
var rc = HostFactory.Run(host =>                                    // 1
{
host.Service<HealthMonitorService>(service =>                   // 2
{
service.ConstructUsing(() => new HealthMonitorService());   // 3
service.WhenStarted(s => s.Start());                        // 4
service.WhenStopped(s => s.Stop());                         // 5
});

host.RunAsLocalSystem();                                        // 6

host.EnableServiceRecovery(service =>                           // 7
{
service.RestartService(3);                                  // 8
});
host.SetDescription("Windows service based on topshelf");       // 9
host.SetDisplayName("Topshelf demo service");                   // 10
host.SetServiceName("TopshelfDemoService");                     // 11
host.StartAutomaticallyDelayed();                               // 12
});

var exitCode = (int)Convert.ChangeType(rc, rc.GetTypeCode());       // 13
Environment.ExitCode = exitCode;
}
}
}

最后，打开

Program.cs

Topshelf

namespace TopshelfDemoService
{
class Program
{
static void Main(string[] args)
{
MyServiceConfigure.Configure();
}
}
}

好了，完成到这里，整个示例程序就写好了，按F5运行示例程序，你将看到如下类似的控制台信息：

可以看到，我们创建的

TopshelfDemoService

这样，我们就成功创建了一个基于

Topshelf

作为Windows服务安装和卸载

我们刚才运行的只是一个控制台应用程序，如果将这个控制台应用程序关掉，定时任务也会被停止了。如果我们希望定时任务可以一直运行，那需要将这个控制台应用程序作为服务安装到Windows服务进程中，如何操作呢？

非常简单的安装和卸载命令。

首先，以管理员身份打开一个命令行工具，进入到控制台应用程序所在目录。

安装

安装服务运行如下命令：

TopshelfDemoService.exe install

打开Windows服务查看窗口(刷新)，可以看到

Topshelf demo service

这时，我们只需要按照Windows服务来操作这个服务即可。

卸载

如果需要卸载服务，则运行如下命令：

TopshelfDemoService.exe uninstall

Topshelf配置参数说明

HostFactory.Run()

Topshelf

HealthMonitorService

new

HealthMonitorService

示例代码托管和下载

本示例代码托管地址可以在原出处找到：示例代码下载地址