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，.NET Framework 選擇4.6.2，其中選項根據本身狀況填寫便可，最後點擊"建立"按鈕。

安裝Topshelf組件

在TopshelfDemoService項目中，打開Nuget包管理工具，搜索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的服務配置類，這個類主要用來配置Topshelf服務的各類運行參數，代碼以下：

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服務安裝和卸載

咱們剛纔運行的只是一個控制檯應用程序，若是將這個控制檯應用程序關掉，定時任務也會被中止了。若是咱們但願定時任務能夠一直運行，那須要將這個控制檯應用程序做爲服務安裝到Windows服務進程中，如何操做呢？

很是簡單的安裝和卸載命令。

首先，以管理員身份打開一個命令行工具，進入到控制檯應用程序所在目錄。

安裝

安裝服務運行以下命令：

TopshelfDemoService.exe install

打開Windows服務查看窗口(刷新)，能夠看到Topshelf demo service已經在服務列表中了，如圖：

這時，咱們只須要按照Windows服務來操做這個服務便可。

卸載

若是須要卸載服務，則運行以下命令：

TopshelfDemoService.exe uninstall

Topshelf配置參數說明

1.設置服務主機使用HostFactory.Run()來建立並運行一個Topshelft服務。 2.設置Topshelf使用類型HealthMonitorService做爲服務類。 3.配置如何建立一個服務的實例，這裏採用的是使用關鍵字new來實例化一個HealthMonitorService對象，你也可使用IoCp容器來實例化服務對象。 4.設置當服務啓動時執行的操做。 5.設置當服務中止時執行的操做。 6.設置將服務以本地系統身份運行。 7.啓動恢復服務模式(當服務意外中止後自動恢復)。 8.設置第一次自動恢復服務的延遲時間爲3分鐘。 9.設置Topshelf服務在Windows服務中的描述信息。 10.設置Topshelf服務在Windows服務中的顯示名稱。 11.設置Topshelf服務在Windows服務中的服務名稱。 12.設置Topshelf服務隨Windows啓動時自動運行(延遲)。 13.設置服務的退出代碼。

示例代碼託管和下載

本示例代碼託管地址能夠在原出處找到：示例代碼下載地址

原文出處：https://www.cnblogs.com/bobositlife/p/create-windows-service-with-topshelf-in-csharp-console-application.html