Topshelf 整合 Topshelf.Linux 實現 Mono 跨平台 Windows 服務

背景

Topshelf 是 .NET 建立 Windows 服務的首選庫，但原生不支援 Mono/Linux。GitHub 社群專案 Topshelf.Linux 填補此缺口，讓同一代碼庫在 Windows 跑原生服務，在 Linux 跑 Mono 服務。

整合步驟

1. NuGet 安裝套件

Install-Package Topshelf.Linux

2. 程式碼加入一行：UseLinuxIfAvailable()

class Program {
    static void Main(string[] args) {
        System.IO.Directory.SetCurrentDirectory(AppDomain.CurrentDomain.BaseDirectory);
        log4net.Config.XmlConfigurator.ConfigureAndWatch(new FileInfo("log4net.config"));

        var host = HostFactory.New(x => {
            x.Service<SampleService>(s => {
                s.ConstructUsing(() => new SampleService());
                s.WhenStarted(v => v.Start());
                s.WhenStopped(v => v.Stop());
            });

            x.UseLinuxIfAvailable(); // ★ 關鍵：啟用 Linux/Mono 支援
            x.RunAsLocalSystem();
            x.UseLog4Net();
            x.SetDescription("SampleService Description");
            x.SetDisplayName("SampleService");
            x.SetServiceName("SampleService");
        });

        host.Run();
    }
}

運作原理

• Windows 環境：UseLinuxIfAvailable 偵測非 Linux，啟動標準 Topshelf ServiceControlManager 主機。
• Linux/Mono 環境：偵測到 Mono 執行時，改用 Topshelf.Linux.LinuxHost，以主控台應用程式模式運行，支援 start/stop 命令列參數，配合 rc.d/systemd 腳本管理生命週期。

限制與注意事項

部署建議

1. 開發環境：Windows + VS + Topshelf 開發除錯。
2. 建置輸出：dotnet publish -c Release -r linux-x64 (或 MSBuild 輸出)。
3. Linux 部署：複製發布資料夾至 /opt/myservice/。
4. systemd 服務檔 /etc/systemd/system/myservice.service：

[Unit]
Description=My Topshelf Service
After=network.target

[Service]
Type=simple
WorkingDirectory=/opt/myservice
ExecStart=/usr/bin/mono /opt/myservice/MyService.exe
Restart=on-failure
User=www-data

[Install]
WantedBy=multi-user.target

5. systemctl daemon-reload && systemctl enable myservice && systemctl start myservice

總結

僅需安裝 Topshelf.Linux 並加入 x.UseLinuxIfAvailable()，即可讓既有 Topshelf 服務零成本支援 Mono/Linux 部署，適合漸進式跨平台遷移專案。