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

 更新时间:2017年03月23日 08:37:27   作者:彭泽0902  
这篇文章主要为大家详细介绍了使用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服务的方法,在这里只是一个简单的介绍,没有很深入的介绍,如果需要了解更多的东西,可以看源码,毕竟是开源免费的组件,也是一个很不错的组件。

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

相关文章

  • Request.UrlReferrer使用详解

    Request.UrlReferrer使用详解

    Request.UrlReferrer可以获取客户端上次请求的url的有关信息,接下来为大家详细介绍下Request.UrlReferrer使用方法,感兴趣的朋友可以参考下哈,希望对你有所帮助
    2013-04-04
  • asp.net中C#实现手动回收内存的方法

    asp.net中C#实现手动回收内存的方法

    这篇文章主要介绍了asp.net中C#实现手动回收内存的方法,包括System.GC.Collect方法的使用及缓存技术的分析,具有一定的实用价值,需要的朋友可以参考下
    2014-12-12
  • .net core利用orm如何操作mysql数据库详解

    .net core利用orm如何操作mysql数据库详解

    这篇文章主要给大家介绍了关于.net core利用orm如何操作mysql数据库的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-05-05
  • asp.net web大文件上传带进度条实例代码

    asp.net web大文件上传带进度条实例代码

    web 大文件上传 带进度条
    2008-10-10
  • c#生成图片缩略图的类(2种实现思路)

    c#生成图片缩略图的类(2种实现思路)

    4个重载方法,有直接返回Image对象的,有生成缩略图,并且保存到指定目录的,具体祥看下文
    2013-05-05
  • .net core日志结构化

    .net core日志结构化

    如果我们的日志结构化了,那么可以使用elasticsearch 这样的框架进行二次整理,再借助一些分析工具。我们就能做到可视化分析系统的运行情况,做到日志告警、上下文关联、实现追踪系统集成,同样也易于检索相关信息。本文讲解的结构化,借助需要借助serilog工具
    2021-06-06
  • ASP.NET(C#) 读取EXCEL另加解决日期问题的方法分享

    ASP.NET(C#) 读取EXCEL另加解决日期问题的方法分享

    这篇文章介绍了ASP.NET(C#) 读取EXCEL另加解决日期问题的方法,有需要的朋友可以参考一下
    2013-11-11
  • 官网 Ext direct包中.NET版的问题

    官网 Ext direct包中.NET版的问题

    下载了官网的 Ext direct 包进行研究,发现服务器端返回结果存在一点小问题。
    2009-06-06
  • .Net程序防止被注入代码(整站通用)分享

    .Net程序防止被注入代码(整站通用)分享

    防止sql注入,通常一个一个文件修改不仅麻烦而且还有漏掉的危险,下面我说一上如何从整个系统防止注入
    2013-11-11
  • xUnit 编写 ASP.NET Core 单元测试的方法

    xUnit 编写 ASP.NET Core 单元测试的方法

    这篇文章主要介绍了xUnit 编写 ASP.NET Core 单元测试的方法,文中代码非常详细,帮助大家更好的参考和学习,感兴趣的朋友可以了解下
    2020-06-06

最新评论