使用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组件的更多相关文章

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

    很多时候都在讨论是否需要了解一个组件或者一个语言的底层原理这个问题,其实我个人觉得,对于这个问题,每个人都有自己的看法,个人情况不同,选择的方式也就会不同了.我个人觉得无论学习什么,都应该尝试着去了解 ...

  2. 使用Topshelf组件 一步一步创建 Windows 服务

    我们先来介绍一下使用它的好处,以下论述参考自其他大神. topshelf是创建windows服务的一种方式,相比原生实现ServiceBase.Install.Installer更为简单方便, 我们只 ...

  3. 使用 Topshelf 组件一步一步创建 Windows 服务 (2) 使用Quartz.net 调度

    上一篇说了如何使用 Topshelf 组件快速创建Windows服务,接下来介绍如何使用 Quartz.net 关于Quartz.net的好处,网上搜索都是一大把一大把的,我就不再多介绍. 先介绍需要 ...

  4. 使用Topshelf快速搭建Windows服务

    1.创建控制台程序 2.安装Topshelf组件  Install-Package Topshelf using System; using System.Timers; using Topshelf ...

  5. 【框架学习与探究之宿主服务--Topshelf】

    前言 此文欢迎转载,原始链接地址:http://www.cnblogs.com/DjlNet/p/7603819.html 正文 原先也偶然见过这个关键词,当时只是有个大致了解貌似和WinServic ...

  6. C#/.NET基于Topshelf创建Windows服务程序及服务的安装和卸载(极速,简洁)

    本文首发于:码友网--一个专注.NET/.NET Core开发的编程爱好者社区. 文章目录 C#/.NET基于Topshelf创建Windows服务的系列文章目录: C#/.NET基于Topshelf ...

  7. 通过TopShelf快速开发服务程序

    我之前在文章中介绍过使用NSSM将exe封装为服务,这种方式我个人是比较喜欢的,一来原始文件不受服务的开发约束,二来也可以提供简单的日志系统.线程守护等功能,是我个人比较倾向的行为.但是,有的场景下, ...

  8. Quartz.NET+Topshelf 创建Windows服务

    由于项目开发中经常会有定时任务执行的需求,所以会第一时间就想到 windows 服务 的方式,但是做过开发的同学都知道windows服务不利于调试,安装也麻烦: 并且有开源的作业框架Quartz.NE ...

  9. Topshelf+Quartz在.Net Core框架下的实现

    在我们日常开发工作中,经常会运用到Quartz+Topshelf组件的组合来开发一些定时任务.那么在.Net Core下如何去使用呢?我自己尝试搭建了一个测试项目,过程中遇到了以下一些问题: Quar ...

随机推荐

  1. 【例题 6-17 UVa 10562】Undraw the Trees

    [链接] 我是链接,点我呀:) [题意] 在这里输入题意 [题解] 模拟+递归 [代码] #include <bits/stdc++.h> using namespace std; con ...

  2. sql for xml query sample

    sample 1: declare @x xml select @x='<ArrayOfScheduledTime> <ScheduledTime> <Recurrenc ...

  3. C#中lock

    http://www.cnblogs.com/apsnet/archive/2012/07/08/2581475.html

  4. vue配置路由

    1,首先用vue-cli搭建vue项目.这个我就不细说了,详见以前的博客 2,npm安装vue-router 3.打开router文件加下的index.js 4.导入你想跳转的组件. import z ...

  5. jquery weui日期选择控件添加取消按钮

    如图: 上图是jQuery weui的时间选择控件,红框处本来应该有个“取消”按钮的,可惜偏偏没有,当用户不想选择的时候就不好处理,虽然插件提供了点击其他区域关闭的功能,但过于隐晦,不容易发现,因此本 ...

  6. css3-13 如何改变文本框的轮廓颜色

    css3-13 如何改变文本框的轮廓颜色 一.总结 一句话总结:outline使用和border很像,几乎一模一样,多了一个offset属性 1.轮廓outline如何使用? 使用和border很像, ...

  7. Spring的资源抽象Resource2实体类

    aaarticlea/png;base64,iVBORw0KGgoAAAANSUhEUgAAA0UAAAGkCAIAAABxYhnsAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWX ...

  8. item.imageInsets =

    直接上代码: item.imageInsets = UIEdgeInsetsMake(6, 0, -6, 0);//设置图片居中 阅读全文 本文已收录于下面专栏: wanglixin1999 +关注 ...

  9. signature.html

    原文网址:http://www.youdzone.com/signature.html   阮一峰:http://www.ruanyifeng.com/blog/2011/08/what_is_a_d ...

  10. 使用JQuery将前端form表单数据转换为JSON字符串传递到后台处理

    一般地,我们在处理表单(form表单哦)数据时,传输对象或字符串到后台,Spring MVC或SpringBoot的Controller接收时使用一个对象作为参数就可以被正常接收并封装到对象中.这种方 ...