VB.net 2010 視頻教程 VB.net 2010 視頻教程 VB.net 2010 視頻教程
SQL Server 2008 視頻教程 c#入門經典教程 Visual Basic從門到精通視頻教程
當前位置:
魔兽世界wow > 編程開發 > c#教程 >
  • C#教程之C#/.NET基于Topshelf創建Windows服務程序及服

  • 2019-04-13 19:25 來源:未知

魔兽世界wow www.geyjm.icu 本文首發于:碼友網--一個專注.NET/.NET Core開發的編程愛好者社區。

前言

對于使用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.設置服務的退出代碼。

示例代碼托管和下載

本示例代碼托管地址可以在原出處找到:示例代碼下載地址

相關教程