使用Topshelf组件构建简单的Windows服务

   不少时候都在讨论是否须要了解一个组件或者一个语言的底层原理这个问题，其实我我的以为，对于这个问题，每一个人都有本身的见解，我的状况不一样，选择的方式也就会不一样了。我我的以为不管学习什么，都应该尝试着去了解对应的原理和源码（这里就不要急着吐槽，容我说完）。对底层的了解不是为了让你写出相似的东西，让你写也不可能写的出来，重写一个就须要以此修改整个底层结构，了解底层知识只是为了让你能够在写业务代码时，选择合适的方式，以此使底层与业务层配合达到效率最佳。任何一种方式有坏有好，须要合适的选择。

  若是以为楼主以上的说法不对，或者有些不妥，还望见谅，由于争论一个观点没有意义，认为对的人本身会去理解，认为不对的，能够忽略。没有这个必要去花费时间和精力取讨论这种事情。

  以上是扯淡，下面切入正题。前面介绍了一个组件Hangfire，用于设置定时任务等等操做，在这里介绍另外一款组件Topshelf。

一.Topshelf组件概述

   Topshelf是.NET平台的Windows服务框架。Topshelf能够轻松建立Windows服务，测试服务，调试服务，并最终将其安装到Windows服务控制管理器（SCM）中。Topshelf经过容许开发人员专一于服务逻辑，而不是与.NET框架中的内置服务支持交互的细节。开发人员不须要了解服务类的复杂细节，经过InstallUtil执行安装，或者了解如何将调试器附加到服务以进行故障排除问题。

   建立Windows服务与建立控制台应用程序相似，控制台应用程序建立后，建立一个具备公共Start和Stop方法的单一服务类。服务操做的方式较多，自动，自动（延迟），手动和禁用启动选项本地系统，本地服务，网络服务，用户名/密码或安装期间提示的服务凭证。服务启动依赖项，包括SQL Server，MSMQ和其余具备不一样服务名称的多实例服务安装服务恢复选项，包括从新启动，从新引导或运行程序。Topshelf与Mono合做，能够将服务部署到Linux。服务安装功能目前仅限Windows。

二.Topshelf用法说明

      介绍完对应的组件背景概述，在这里就要介绍一下如何使用这个组件的使用方法。该组件的使用方法有另个方法，都在HostFactory类中，下面具体的介绍一个使用方式。

   1.配置新的服务主机

      HostFactory.New(x =>
                {
                    // 能够定义不须要接口依赖性的服务，这只是为了
                    //在此示例中显示并未使用。
                    x.Service<SampleSansInterfaceService>(s =>
                        {
                            s.ConstructUsing(() => new SampleSansInterfaceService());
                            s.WhenStarted(v => v.Start());
                            s.WhenStopped(v => v.Stop());
                        });
                });

   2.配置和运行新的服务主机，处理任何异常并将其写入日志

   HostFactory.Run(x =>
                {
                    x.UseLog4Net("log4net.config");
                    x.UseAssemblyInfoForServiceInfo();
                    bool throwOnStart = false;
                    bool throwOnStop = false;
                    bool throwUnhandled = false;
                    x.Service(settings => new SampleService(throwOnStart, throwOnStop, throwUnhandled), s =>
                    {
                        s.BeforeStartingService(_ => Console.WriteLine("BeforeStart"));
                        s.BeforeStoppingService(_ => Console.WriteLine("BeforeStop"));
                    });
                    x.SetStartTimeout(TimeSpan.FromSeconds(10));
                    x.SetStopTimeout(TimeSpan.FromSeconds(10));
                    x.EnableServiceRecovery(r =>
                        {
                            r.RestartService(3);
                            r.RunProgram(7, "ping google.com");
                            r.RestartComputer(5, "message");

                            r.OnCrashOnly();
                            r.SetResetPeriod(2);
                        });
                    x.AddCommandLineSwitch("throwonstart", v => throwOnStart = v);
                    x.AddCommandLineSwitch("throwonstop", v => throwOnStop = v);
                    x.AddCommandLineSwitch("throwunhandled", v => throwUnhandled = v);
                    x.OnException((exception) =>
                    {
                        Console.WriteLine("Exception thrown - " + exception.Message);
                    });
                });

    3.Topshelf配置操做方法

三.Topshelf核心对象解析

     承接上文，介绍完毕相关背景和常规操做，在这里介绍一个核心对象的一些方法。

  1.HostFactory.New()：

public static Host New(Action<HostConfigurator> configureCallback)
        {
            try
            {
                if (configureCallback == null)
                    throw new ArgumentNullException("configureCallback");
                var configurator = new HostConfiguratorImpl();
                Type declaringType = configureCallback.Method.DeclaringType;
                if (declaringType != null)
                {
                    string defaultServiceName = declaringType.Namespace;
                    if (!string.IsNullOrEmpty(defaultServiceName))
                        configurator.SetServiceName(defaultServiceName);
                }
                configureCallback(configurator);
                configurator.ApplyCommandLine();
                ConfigurationResult result = ValidateConfigurationResult.CompileResults(configurator.Validate());
                if (result.Message.Length > 0)
                {
                    HostLogger.Get(typeof(HostFactory))
                              .InfoFormat("Configuration Result:\n{0}", result.Message);
                }
                return configurator.CreateHost();
            }
            catch (Exception ex)
            {
                HostLogger.Get(typeof(HostFactory)).Error("An exception occurred creating the host", ex);
                HostLogger.Shutdown();
                throw;
            }
        }

     该方法用于配置新的服务主机，方法接受一个参数Action<HostConfigurator>配置方法调用，该方法返回Host对象，表示Topshelf服务主机，准备运行。 configureCallback.Method.DeclaringType;用于获取声明该成员的类。declaringType.Namespace;用于获取获取 System.Type 的命名空间。ValidateConfigurationResult.CompileResults(configurator.Validate());用于验证配置结果。

   2.HostFactory.Run()：

public static TopshelfExitCode Run(Action<HostConfigurator> configureCallback)
        {
            try
            {
                return New(configureCallback)
                    .Run();
            }
            catch (Exception ex)
            {
                HostLogger.Get(typeof(HostFactory))
                          .Error("The service terminated abnormally", ex);
                HostLogger.Shutdown();
                
                return TopshelfExitCode.AbnormalExit;
            }
        }

     该方法是一个静态方法，配置和运行新的服务主机，处理任何异常并将其写入日志。该方法接收一个参数Action<HostConfigurator> configureCallback配置方法调用，返回应用程序主方法返回的进程的退出代码。

四.总结

   以上是介绍如何使用Topshelf组件建立简单的Windows服务的方法，在这里只是一个简单的介绍，没有很深刻的介绍，若是须要了解更多的东西，能够看源码，毕竟是开源免费的组件，也是一个很不错的组件。