Topshelf：一款非常好用的 Windows 服務開發框架

背景

多數系統都會涉及到“后台服務”的開發，一般是為了調度一些自動執行的任務或從隊列中消費一些消息，開發 windows service 有一點不爽的是：調試麻煩，當然你還需要知道 windows service 相關的一些開發知識（也不難），本文介紹一個框架，讓你讓 console application 封裝為 windows service，這樣你就非常方便的開發和調試 windows service。

TopShelf

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Timers;

using Topshelf;
using Topshelf.Builders;
using Topshelf.Configurators;
using Topshelf.HostConfigurators;

namespace TopshelfStudy
{
    public sealed class TimeReporter
    {
        private readonly Timer _timer;
        public TimeReporter()
        {
            _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(); }
    }

    class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(x =>
            {
                x.Service<TimeReporter>(s =>
                {
                    s.ConstructUsing(settings => new TimeReporter());
                    s.WhenStarted(tr => tr.Start());
                    s.WhenStopped(tr => tr.Stop());
                });

                x.RunAsLocalSystem();

                x.SetDescription("定時報告時間");
                x.SetDisplayName("時間報告器");
                x.SetServiceName("TimeReporter");
            });
        }
    }
}

備注

TopShelf 提高的 API 非常簡單，也提高了和 Log4Net 的集成，結合 Quartz（后面介紹），可以實現任務調度服務。