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

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

# Topshelf  # Windows  # asp.net基于windows服务实现定时发送邮件的方法  # .NET实现可交互的WINDOWS服务的实例代码  # 用.NET创建Windows服务的方法  # 在这里  # 让你  # 都在  # 应用程序  # 不需要  # 这个问题  # 开发人员  # 自己的  # 的人  # 是一个  # 就会  # 在此  # 要去  # 将其  # 并将其  # 很不错  # 较多  # 这只  # 重写  # 管理器 

相关文章： 如何用wdcp快速搭建高效网站？  网站制作知乎推荐,想做自己的网站用什么工具比较好？  开源网站制作软件,开源网站什么意思？  网站制作多少钱一个,建一个论坛网站大约需要多少钱？  较简单的网站制作软件有哪些,手机版网页制作用什么软件？  合肥制作网站的公司有哪些,合肥聚美网络科技有限公司介绍？  如何快速生成可下载的建站源码工具？  如何选择服务器才能高效搭建专属网站？  如何通过智能用户系统一键生成高效建站方案？  婚礼视频制作网站,学习*后期制作的网站有哪些？  制作营销网站公司,淘特是干什么用的？  建站之星后台密码遗忘？如何快速找回？  教育培训网站制作流程,请问edu教育网站的域名怎么申请？  如何制作新型网站程序文件,新型止水鱼鳞网要拆除吗？  如何在云服务器上快速搭建个人网站？  攀枝花网站建设,攀枝花营业执照网上怎么年审？  建站主机解析：虚拟主机配置与服务器选择指南  山东云建站价格为何差异显著？  网站制作模板下载什么软件,ppt模板免费下载网站？  制作表格网站有哪些,线上表格怎么弄？  如何配置WinSCP新建站点的密钥验证步骤？  学校免费自助建站系统：智能生成+拖拽设计+多端适配  如何在建站之星网店版论坛获取技术支持？  网站制作软件有哪些,制图软件有哪些？    零基础网站服务器架设实战：轻量应用与域名解析配置指南  盐城做公司网站,江苏电子版退休证办理流程？  如何快速配置高效服务器建站软件？  如何在万网ECS上快速搭建专属网站？  建站之星手机一键生成：多端自适应+小程序开发快速建站指南  宁波免费建站如何选择可靠模板与平台？  如何选择适配移动端的WAP自助建站平台？  如何生成腾讯云建站专用兑换码？  香港网站服务器数量如何影响SEO优化效果？  网站网页制作电话怎么打,怎样安装和使用钉钉软件免费打电话？  南阳网站制作公司推荐,小学电子版试卷去哪里找资源好？  网站制作的软件有哪些,制作微信公众号除了秀米还有哪些比较好用的平台？  手机钓鱼网站怎么制作视频,怎样拦截钓鱼网站。怎么办？  怎么用手机制作网站链接,dw怎么把手机适应页面变成网页？  如何选择香港主机高效搭建外贸独立站？  如何选择高性价比服务器搭建个人网站？  定制建站是什么？如何实现个性化需求？  建站之星如何实现五合一智能建站与营销推广？  建站之星ASP如何实现CMS高效搭建与安全管理？  如何通过二级域名建站提升品牌影响力？  深圳网站制作公司好吗,在深圳找工作哪个网站最好啊？  如何通过虚拟机搭建网站？详细步骤解析  如何快速生成ASP一键建站模板并优化安全性？  如何通过商城免费建站系统源码自定义网站主题？  已有域名和空间如何搭建网站？