dotnet core

开发第一个Windows 服务

2019-06-17  本文已影响1人  Jboob

上一篇文章非常简单地介绍了一下Windows 服务的概念,现在来讲讲如何创建一个简单的Windows服务。


环境准备

首先: Vs 安装这里就略过。下载地址可以去微软官网下载 https://visualstudio.microsoft.com/zh-hans/?rr,根据自己需要,下载合适的版本。

步入正题

以 Visual Studio 2017 为例,新建一个项目,如图:

图 1

NET Framework 版本根据安装环境自行选择。点击确定,项目就创建完成了。


图 2

Visual Studio 2017 创建服务项目完成后,默认创建了一个Service1.cs 类,感觉很不爽,创建一个项目名的类也可以啊,这里看名字看自己喜好,改成自己喜欢的名字就好,不改也行。我是有强迫症,不改不舒服,我这边个重命名为 SimpleService。接下来切换到代码视图。

using System.ServiceProcess;

namespace SimpleService
{
    public partial class SimpleService : ServiceBase
    {
        public SimpleService()
        {
            InitializeComponent();
        }

        /// <summary>
        /// 服务启动
        /// </summary>
        /// <param name="args"></param>
        protected override void OnStart(string[] args)
        {
        }

        /// <summary>
        /// 服务停止
        /// </summary>
        protected override void OnStop()
        {
        }
    }
}

SimpleService 继承了ServiceBase,并默认实现了 OnStart 和 OnStop 方法,从方法名可以看出,OnStart 是在服务启动时调用,OnStop 是在服务停止时调用。这里可能有人会思考了,服务不可能只有这两个方法控制它的生命周期吧? 当然不止,我们看看 ServiceBase 源码。

#region 程序集 System.ServiceProcess, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
// C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.5.2\System.ServiceProcess.dll
#endregion

using System.ComponentModel;
using System.Diagnostics;
using System.Runtime.InteropServices;

namespace System.ServiceProcess
{
    //
    // 摘要:
    //     将作为一个服务应用程序的一部分存在的服务提供基类。 System.ServiceProcess.ServiceBase 必须派生自创建新的服务类时。
    [InstallerType(typeof(ServiceProcessInstaller))]
    public class ServiceBase : Component
    {
        //
        // 摘要:
        //     指示服务名称的最大大小。
        public const int MaxNameLength = 80;

        //
        // 摘要:
        //     创建 System.ServiceProcess.ServiceBase 类的新实例。
        public ServiceBase();

        //
        // 摘要:
        //     获取可用于写入应用程序事件日志服务命令调用,如启动和停止通知事件日志。
        //
        // 返回结果:
        //     System.Diagnostics.EventLog 其源注册到应用程序日志的实例。
        [Browsable(false)]
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
        public virtual EventLog EventLog { get; }
        //
        // 摘要:
        //     获取或设置一个值,指示它启动后是否可以停止服务。
        //
        // 返回结果:
        //     true 如果可以停止服务和 System.ServiceProcess.ServiceBase.OnStop 方法调用; 否则为 false。
        //
        // 异常:
        //   T:System.InvalidOperationException:
        //     服务已启动。 System.ServiceProcess.ServiceBase.CanStop 服务启动后无法更改属性。
        [DefaultValue(true)]
        public bool CanStop { get; set; }
        //
        // 摘要:
        //     获取或设置一个值,该值在系统关闭时是否应通知服务。
        //
        // 返回结果:
        //     true 如果系统正在关闭; 时,应通知服务否则为 false。 默认值为 false。
        //
        // 异常:
        //   T:System.InvalidOperationException:
        //     服务已启动。 System.ServiceProcess.ServiceBase.CanShutdown 服务启动后无法更改属性。
        [DefaultValue(false)]
        public bool CanShutdown { get; set; }
        //
        // 摘要:
        //     获取或设置一个值,该值指示是否可以暂停和恢复该服务。
        //
        // 返回结果:
        //     true 如果可以暂停服务;否则为 false。
        //
        // 异常:
        //   T:System.InvalidOperationException:
        //     服务已启动。 System.ServiceProcess.ServiceBase.CanPauseAndContinue 服务启动后无法更改属性。
        [DefaultValue(false)]
        public bool CanPauseAndContinue { get; set; }
        //
        // 摘要:
        //     获取或设置一个值,指示服务是否可以处理会话从终端服务器会话接收到的更改事件。
        //
        // 返回结果:
        //     true 如果该服务可以处理终端服务器会话更改事件;,否则为 false。
        //
        // 异常:
        //   T:System.InvalidOperationException:
        //     服务已启动后,修改此属性。
        [ComVisible(false)]
        [DefaultValue(false)]
        public bool CanHandleSessionChangeEvent { get; set; }
        //
        // 摘要:
        //     获取或设置一个值,该值指示服务是否可以处理计算机电源状态更改的通知。
        //
        // 返回结果:
        //     true 如果该服务将处理计算机电源状态更改中所示 System.ServiceProcess.PowerBroadcastStatus 类,否则为 false。
        //
        // 异常:
        //   T:System.InvalidOperationException:
        //     服务已启动后,修改此属性。
        [DefaultValue(false)]
        public bool CanHandlePowerEvent { get; set; }
        //
        // 摘要:
        //     获取或设置该服务的退出代码。
        //
        // 返回结果:
        //     该服务退出代码。
        [ComVisible(false)]
        public int ExitCode { get; set; }
        //
        // 摘要:
        //     指示是否报表在事件日志中的启动、 停止、 暂停和继续命令。
        //
        // 返回结果:
        //     true 在事件日志中; 中的报告信息否则为 false。
        [DefaultValue(true)]
        [ServiceProcessDescription("SBAutoLog")]
        public bool AutoLog { get; set; }
        //
        // 摘要:
        //     获取或设置用于标识服务对系统的短名称。
        //
        // 返回结果:
        //     服务的名称。
        //
        // 异常:
        //   T:System.InvalidOperationException:
        //     服务已启动。 System.ServiceProcess.ServiceBase.ServiceName 服务启动后无法更改属性。
        //
        //   T:System.ArgumentException:
        //     指定的名称是一个零长度字符串或者长度超过 System.ServiceProcess.ServiceBase.MaxNameLength, ,或指定的名称包含正斜杠或反斜杠字符。
        [ServiceProcessDescription("SBServiceName")]
        [TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
        public string ServiceName { get; set; }
        //
        // 摘要:
        //     获取服务的服务控制句柄。
        //
        // 返回结果:
        //     System.IntPtr 结构,其中包含该服务的服务控制句柄。
        [EditorBrowsable(EditorBrowsableState.Advanced)]
        protected IntPtr ServiceHandle { get; }

        //
        // 摘要:
        //     与服务控制管理器 (SCM) 注册服务的可执行文件。
        //
        // 参数:
        //   service:
        //     一个 System.ServiceProcess.ServiceBase 指示要启动的服务。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     service 为 null。
        public static void Run(ServiceBase service);
        //
        // 摘要:
        //     注册多个服务的可执行文件与服务控制管理器 (SCM)。
        //
        // 参数:
        //   services:
        //     指示服务与要启动的 ServiceBase 实例的数组。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     未提供要启动的服务。 该数组可能为 null 或为空。
        public static void Run(ServiceBase[] services);
        //
        // 摘要:
        //     挂起的操作的请求更多时间。
        //
        // 参数:
        //   milliseconds:
        //     请求的时间,以毫秒为单位。
        //
        // 异常:
        //   T:System.InvalidOperationException:
        //     该服务未处于挂起状态中。
        [ComVisible(false)]
        public void RequestAdditionalTime(int milliseconds);
        //
        // 摘要:
        //     注册命令处理程序,然后启动该服务。
        //
        // 参数:
        //   argCount:
        //     参数数组中的参数的数目。
        //
        //   argPointer:
        //     System.IntPtr 指向参数的数组的结构。
        [ComVisible(false)]
        [EditorBrowsable(EditorBrowsableState.Never)]
        public void ServiceMainCallback(int argCount, IntPtr argPointer);
        //
        // 摘要:
        //     停止正在执行的服务。
        public void Stop();
        //
        // 摘要:
        //     处置由 System.ServiceProcess.ServiceBase 占用的资源(内存除外)。
        //
        // 参数:
        //   disposing:
        //     若要释放托管资源和非托管资源,则为 true;若仅释放非托管资源,则为 false。
        protected override void Dispose(bool disposing);
        //
        // 摘要:
        //     在派生类中实现时 System.ServiceProcess.ServiceBase.OnContinue 时继续命令发送到服务的服务控制管理器 (SCM)
        //     运行。 指定当某个服务后继续正常工作正在暂停时要执行的操作。
        protected virtual void OnContinue();
        //
        // 摘要:
        //     在派生类中实现时 System.ServiceProcess.ServiceBase.OnCustomCommand(System.Int32) 服务控制管理器
        //     (SCM) 向服务传递自定义命令时执行。 指定具有指定的参数值的命令发生时要采取的操作。
        //
        // 参数:
        //   command:
        //     发送到服务的命令消息。
        protected virtual void OnCustomCommand(int command);
        //
        // 摘要:
        //     派生类中实现时,暂停命令发送到服务的服务控制管理器 (SCM) 时执行。 指定当服务就会暂停时要执行的操作。
        protected virtual void OnPause();
        //
        // 摘要:
        //     派生类中实现时,在计算机的电源状态已发生更改时执行。 这适用于便携式计算机,当他们进入挂起模式,这不是系统关闭相同。
        //
        // 参数:
        //   powerStatus:
        //     一个 System.ServiceProcess.PowerBroadcastStatus ,该值指示系统有关电源状态的通知。
        //
        // 返回结果:
        //     派生类中实现时,应用程序需要确定要返回的值。 例如,如果 QuerySuspend 广播的状态一起传递,则可能会导致您的应用程序通过返回拒绝查询 false。
        protected virtual bool OnPowerEvent(PowerBroadcastStatus powerStatus);
        //
        // 摘要:
        //     在终端服务器会话中接收的更改事件时执行。
        //
        // 参数:
        //   changeDescription:
        //     标识更改类型的结构。
        protected virtual void OnSessionChange(SessionChangeDescription changeDescription);
        //
        // 摘要:
        //     派生类中实现时,在系统关闭时执行。 指定在系统关闭之前应该发生什么。
        protected virtual void OnShutdown();
        //
        // 摘要:
        //     派生类中实现时,在由服务控制管理器 (SCM) 或在操作系统启动时 (对于自动启动的服务) 时,将启动命令发送到服务时执行。 指定当服务启动时要执行的操作。
        //
        // 参数:
        //   args:
        //     启动命令所传递的数据。
        protected virtual void OnStart(string[] args);
        //
        // 摘要:
        //     派生类中实现时,停止命令发送到服务的服务控制管理器 (SCM) 时执行。 指定当服务停止运行时要执行的操作。
        protected virtual void OnStop();
    }
}

从源码中我们可以看到,还有 OnPause 、 OnContinue、Dispose 等方法,这些方法具体含义我这就不扯了,源码里的注释很详细,而且注释还是中文的,很容易理解。
我写的服务在哪调用的呢?
答案请看 Program.cs 类,这是Windows 服务控制台程序的主入口。

using System;
using System.Collections.Generic;
using System.Linq;
using System.ServiceProcess;
using System.Text;
using System.Threading.Tasks;

namespace SimpleService
{
   static class Program
   {
       /// <summary>
       /// 应用程序的主入口点。
       /// </summary>
       static void Main()
       {
           ServiceBase[] ServicesToRun;
           ServicesToRun = new ServiceBase[]
           {
               new SimpleService()
           };
           ServiceBase.Run(ServicesToRun);
       }
   }
}

安装服务前准备

项目建好了,如何调试服务呢?
我们可以使用 .NET Framework 的 installutil.exe 工具本地安装和卸载服务。
首先添加安装程序:


图 3

点击添加安装程序,进入安装程序配置,我们简单配置如下:


图 4
设置Account 为LocalSystem。 图 5

选中项目,右键生成,这是会在项目的debug 目录下生成一个名为SimpleService.exe 文件,这个文件不可以直接运行。

安装服务

在我的电脑中找到此目录 C:\Windows\Microsoft.NET\Framework64\v4.0.30319 ,打开控制台 cd 到此目录下,如图:


图 6

利用InstallUtil.exe 安装生成的服务。


图 7
至此,服务一安装完成。
图 8

我们再来检查下 是否真的安装完成,打开windows 服务管理,找到刚才安装的服务。如图,“一个非常简单的Windows Service ” 确实安装成功了。


图 9

卸载服务

image.png

简单吧, /u 卸载。

如何在其他电脑上也安装此服务呢?

嗯,我想干点坏事,我写了一个服务,我要时刻监控我女朋友每天打开电脑都在干嘛。哈哈,开个玩笑,别这么玩。
把我们写的服务打包成exe 可执行文件,在其它电脑上安装就可以了。
我们在当前解决方案下新建一个Setup Project。


图 10

添加SimpleService 为项目主输出。


图 11

选中 SimpleServiceSetup 项目,右键生成,在SimpleServiceSetup 项目下会生成一个SimpleServiceSetup.msi 应用程序,双击就可以在电脑上安装了。


图 12

最后留下几点思考

  1. Windows 服务优点在哪?
  2. Windows 服务可以应用于哪些场景?
    接下来准备写一篇关于 SignalR 基于Windows 服务的实现。
    在这里非常简单的介绍了如何创建一个Windows Service ,有很多地方只是一笔带过,详细写起来也不是文字能够描述完的,还得大家动手亲自实践,才会印象更加深刻。感谢读者浪费你宝贵的时间阅读到此,有什么毛病请在下方评论区大胆批评作者,有点喜欢的点个赞,鼓励下作者,让他下次写的好一点。
上一篇下一篇

猜你喜欢

热点阅读