Topshelf一個用於使用.NET構建Windows服務框架

南榮相如談程式設計發表於2021-04-03

1 Topshelf是什麼？

Topshelf是用於託管使用.NET框架編寫的Windows服務的框架。服務的建立得到簡化，從而使開發人員可以建立一個簡單的控制檯應用程式，可以使用Topshelf將其作為服務安裝。原因很簡單：除錯控制檯應用程式比服務容易得多。一旦對應用程式進行了測試並準備投入生產，Topshelf便可以輕鬆地將應用程式即服務安裝。

2 使用

2.1 建立應用程式

首先，建立一個新的控制檯應用程式並從nuget獲取Topshelf軟體包

Topshelf

當您使用Topshelf時，我還建議裝一下日誌庫，我們可以選擇日誌框架Serilog。

Topshelf.Serilog
Serilog.Sinks.Console

2.2 建立服務類

然後，建立服務類。我將其命名為MyService。在這裡放置將在Windows服務的特定生命週期事件中呼叫的方法。至少，新增一些用於啟動和停止服務的方法。

public class MyService
{
    readonly ILogger log = Log.ForContext(MethodBase.GetCurrentMethod().DeclaringType);
    public void Start()
    {
        log.Information("Starting MyService...");
    }

    public void Stop()
    {
        log.Information("Stopping MyService...");
    }
}

2.3 在Topshelf中註冊服務

接著，在Topshelf中註冊我們的服務類。跳轉到Program.cs並新增：

class Program
{
    static void Main(string[] args)
    {
        Log.Logger = new LoggerConfiguration()
            .WriteTo.Console()
            .MinimumLevel.Debug()
            .CreateLogger();

        var rc = HostFactory.Run(x =>
        {
            x.UseSerilog(); // HostLogger改為使用Serilog。
            x.SetDisplayName("我的服務");  // 我們設定要在Windows服務監視器中使用的winservice的顯示名稱。
            x.SetDescription("我的服務詳細描述"); // 我們設定了在Windows服務監視器中使用的winservice的描述。
            x.SetServiceName("MyService"); // 我們設定要在Windows服務監視器中使用的winservice的服務名稱。
            x.Service<MyService>(s =>
            {
                s.ConstructUsing(name => new MyService()); // 構建服務例項。
                s.WhenStarted(tc => tc.Start()); // 啟動服務
                s.WhenStopped(tc => tc.Stop()); // 停止服務
            });
            x.RunAsLocalSystem(); // 設定“登入為”並選擇了“本地系統”。
            x.StartAutomatically(); // 設定“啟動型別”並選擇了“自動”。
        });

        var exitCode = (int)Convert.ChangeType(rc, rc.GetTypeCode()); // 我們轉換並返回服務退出程式碼。
        Environment.ExitCode = exitCode;
    }
}