C# 开发 Windows 服务程序最简单的方式-Topshelf

栏目: ASP.NET · 发布时间: 5年前

内容简介：一直以来，我都在追求以最简单的方式写程序。这里的最简单是指利用强大的工具。这种想法主要来源于三年前我服务过的一个客户。他们的IT经理就一直在部门内部强调“你所想到的，别人都想已经想到而且做到了，学会寻找比学会创造更加重要。”这种话虽略显极端，但在程序这个领域里却有着重要意义。像很多知名的开源软件，都是无数人智慧的结晶。扯远了~本文写作的目的是，记录一种最简单开发 Windows 服务的方式– Topshelf 。使用前先下载依赖文件： Topshelf.dll

一、概述

一直以来，我都在追求以最简单的方式写程序。这里的最简单是指利用强大的工具。

这种想法主要来源于三年前我服务过的一个客户。他们的IT经理就一直在部门内部强调“你所想到的，别人都想已经想到而且做到了，学会寻找比学会创造更加重要。”这种话虽略显极端，但在程序这个领域里却有着重要意义。像很多知名的开源软件，都是无数人智慧的结晶。扯远了~

本文写作的目的是，记录一种最简单开发 Windows 服务的方式– Topshelf 。使用前先下载依赖文件： Topshelf.dll Topshelf.4.2.0.zip 或者直接通过 Nuget 安装：Install-Package Topshelf

Topshelf 官方网站： http://topshelf-project.com/

Topshelf 文档地址： https://topshelf.readthedocs.io/en/latest/index.html

二、程序实例

C# 直接创建控制台项目，覆盖 Program.cs 文件为如下代码：

using System;
using System.Timers;
using Topshelf;

namespace TopshelfDemo
{
    public class TownCrier
    {
        readonly Timer _timer;
        public TownCrier()
        {
            _timer = new Timer(1000) { AutoReset = true };//1秒执行一次
            _timer.Elapsed += (sender, eventArgs) => Console.WriteLine("It is {0} and all is well", DateTime.Now);
        }
        public void Start() { _timer.Start(); }
        public void Stop() { _timer.Stop(); }
    }

    public class Program
    {
        public static void Main()
        {
            var rc = HostFactory.Run(x =>
            {
                x.Service<TownCrier>(s =>
                {
                    s.ConstructUsing(name => new TownCrier());
                    s.WhenStarted(tc => tc.Start());
                    s.WhenStopped(tc => tc.Stop());
                });
                x.RunAsLocalSystem(); //服务器使用内置账户运行

                x.SetDescription("Sample Topshelf Host");//服务的描述信息
                x.SetDisplayName("Stuff");//服务的显示名称
                x.SetServiceName("Stuff");//服务的名称（最好不要包含空格或者有空格属性的字符）。Windows 服务名称不能重复。
                //x.SetInstanceName("MyService");//实例名称：主要用于命令行部署多实例时进行区分。效果是：Stuff$MyService
            });

            var exitCode = (int)Convert.ChangeType(rc, rc.GetTypeCode());
            Environment.ExitCode = exitCode;
        }
    }
}

这段代码就是 Topshelf 官网文档中的实例代码。

直接启用运行，效果如下。每秒输出一条语句。到这里实现输出的字符串的 Windows 服务程序就开发完成了。