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

Posted 2020-09-09 Allyte

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

  如果觉得楼主以上的说法不对，或者有些不妥，还望见谅，因为争论一个观点没有意义，认为对的人自己会去理解，认为不对的，可以忽略。没有这个必要去花费时间和精力取讨论这种事情。

  以上是扯淡，下面切入正题。前面介绍了一个组件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服务的方法，在这里只是一个简单的介绍，没有很深入的介绍，如果需要了解更多的东西，可以看源码，毕竟是开源免费的组件，也是一个很不错的组件。