C#用Topshelf创建Windows服务的步骤分享

 更新时间:2020年05月17日 14:40:53   作者:缥缈的尘埃  
这篇文章主要给大家介绍了关于C#如何利用Topshelf创建Windows服务的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用C#具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧

一、项目创建

创建一个控制台应用程序,项目右键->管理 NuGet 程序包->Topshelft及Topshelf.Log4Net。

 

   

二、Topshelf配置

    一般来说,服务都会设置每隔多长时间执行一次任务,这里使用System.Threading.Timer来做个简单的日志记录,将日志写入到Debug\Log文件夹下。

    2.1、Log4Net配置

    新建一个log4net.config的配置文件,在其属性的复制到输出目录项下选择始终复制。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
 <configSections>
 <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
 </configSections>
 <log4net>
 <!-- Console部分log输出格式的设定 -->
 <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
  <layout type="log4net.Layout.PatternLayout">
  <conversionPattern value="%date [%thread] %-5level %logger - %message %newline" />
  </layout>
 </appender>
 <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
  <file value="Log\"/>
  <appendToFile value="true"/>
  <maxSizeRollBackups value="10"/>
  <maximumFileSize value="1MB"/>
  <rollingStyle value="Date"/>
  <datePattern value='yyyy-MM-dd".log"' />
  <staticLogFileName value="false"/>
  <!--最小锁定模型以允许多个进程可以写入同一个文件-->
  <param name="lockingModel" type="log4net.Appender.FileAppender+MinimalLock" />
  <layout type="log4net.Layout.PatternLayout">
  <conversionPattern value="%date %-5level %logger - %message %newline"/>
  </layout>
 </appender>
 <root>
  <level value="ALL" />
  <appender-ref ref="ConsoleAppender" />
  <appender-ref ref="RollingLogFileAppender" />
 </root>
 </log4net>
</configuration>

    2.2、TopshelfService

    新建一个TopshelfService类:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Topshelf;
using Topshelf.Logging;

namespace LinkTo.Test.TopshelfService
{
  public class TopshelfService : ServiceControl
  {
    private static readonly LogWriter logger = HostLogger.Get<TopshelfService>();
    private static Timer timerAsync = null;
    private readonly int dueTimeInterval = 1000 * 5; //单位:毫秒
    private readonly int periodInterval = 1000 * 5; //单位:毫秒

    /// <summary>
    /// 构造函数
    /// </summary>
    public TopshelfService()
    {
      timerAsync = new Timer(AutoAsyncCallback, null, Timeout.Infinite, Timeout.Infinite);
    }

    /// <summary>
    /// 启动服务
    /// </summary>
    /// <param name="hostControl"></param>
    /// <returns></returns>
    public bool Start(HostControl hostControl)
    {
      try
      {
        logger.Info("HelloTopshelf Start");
        timerAsync.Change(dueTimeInterval, periodInterval);
      }
      catch (Exception ex)
      {
        logger.Info(ex.Message);
      }
      return true;
    }

    /// <summary>
    /// 停止服务
    /// </summary>
    /// <param name="hostControl"></param>
    /// <returns></returns>
    public bool Stop(HostControl hostControl)
    {
      try
      {
        logger.Info("HelloTopshelf Stop");
        if (timerAsync != null)
        {
          timerAsync.Change(Timeout.Infinite, Timeout.Infinite);
          timerAsync.Dispose();
          timerAsync = null;
        }
      }
      catch (Exception ex)
      {
        logger.Info(ex.Message);
      }
      return true;
    }

    /// <summary>
    /// 回调函数
    /// </summary>
    /// <param name="state"></param>
    private void AutoAsyncCallback(object state)
    {
      try
      {
        timerAsync.Change(Timeout.Infinite, Timeout.Infinite);
        logger.Info("AutoAsyncCallback执行开始");
        Thread.Sleep(1000 * 10);
      }
      catch (Exception ex)
      {
        logger.ErrorFormat("AutoAsyncCallback执行异常:{0}", ex.Message);
      }
      finally
      {
        timerAsync.Change(dueTimeInterval, periodInterval);
        logger.Info("AutoAsyncCallback执行结束");
        logger.Info(Environment.NewLine);
      }
    }
  }
}

    2.3、配置和运行宿主服务

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

namespace LinkTo.Test.TopshelfService
{
  class Program
  {
    static void Main(string[] args)
    {
      HostFactory.Run(x =>
      {
        x.UseLog4Net("log4net.config");
        x.RunAsLocalSystem();
        x.Service(settings => new TopshelfService());
        //服务的描述
        x.SetDescription("你好,Topshelf!");
        //服务的显示名称
        x.SetDisplayName("Hello Topshelf Service");
        //服务名称
        x.SetServiceName("HelloTopshelf");
      });
    }
  }
}

    三、安装与卸载

    3.1、安装服务

    在Debug文件夹下面,创建一个"安装服务.bat"的批处理文件:

@echo on

rem 设置DOS窗口的背景颜色及字体颜色
color 2f

rem 设置DOS窗口大小 
mode con: cols=80 lines=25

@echo off
echo 请按任意键开始安装LinkTo.Test.TopshelfService服务

rem 输出空行
echo.
pause

LinkTo.Test.TopshelfService install
net start HelloTopShelf

pause

    3.2、卸载服务

    在Debug文件夹下面,创建一个"卸载服务.bat"的批处理文件:

@echo on

rem 设置DOS窗口的背景颜色及字体颜色
color 2f

rem 设置DOS窗口大小 
mode con: cols=80 lines=25

@echo off
echo 请按任意键开始卸载LinkTo.Test.TopshelfService服务

rem 输出空行
echo.
pause

net stop HelloTopShelf
LinkTo.Test.TopshelfService uninstall

pause

    3.3、查看服务

    在运行中输入"services.msc"进入服务,即可看到新建的HelloTopshelf服务:

    四、添加管理员权限要求

    项目右键->添加->新建项->应用程序清单文件。

 

    将requestedExecutionLevel节点的level设置为"requireAdministrator"。

<requestedExecutionLevel level="requireAdministrator" uiAccess="false" />

总结

到此这篇关于C#用Topshelf创建Windows服务的文章就介绍到这了,更多相关C#用Topshelf创建Windows服务内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • C#实现的优酷真实视频地址解析功能(2014新算法)

    C#实现的优酷真实视频地址解析功能(2014新算法)

    这篇文章主要介绍了C#实现的优酷真实视频地址解析功能(2014新算法),本文在当前环境下是有效的,因为优酷之前更新了算法,需要的朋友可以参考下
    2014-10-10
  • c#在程序中定义和使用自定义事件方法总结

    c#在程序中定义和使用自定义事件方法总结

    在本篇文章中小编给大家整理了关于c#在程序中定义和使用自定义事件方法总结相关知识点,需要的朋友们学习下。
    2019-03-03
  • C#面向对象特征的具体实现及作用详解

    C#面向对象特征的具体实现及作用详解

    所有的面相对象思想,归根结底是为了简化代码,减少代码量,构建更符合现实生活逻辑的程序代码,从而减轻程序员的负担。不能一味地或者说刻意地去使用面相对象的思想而忽略了程序所实现的功能或者框架,要根据实际情况
    2013-10-10
  • C#中对象状态模式教程示例

    C#中对象状态模式教程示例

    这篇文章主要为大家介绍了C#中对象状态模式的教程示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • C# 中的IComparable和IComparer的使用及区别

    C# 中的IComparable和IComparer的使用及区别

    这篇文章主要介绍了C# 中的IComparable和IComparer的使用及区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01
  • C#使用AnimateWindow()实现动画窗体的方法

    C#使用AnimateWindow()实现动画窗体的方法

    用API函数AnimateWindow函数来实现窗体的动画效果,在C#中,你可以使用P/Invoke技术调用Windows API中的AnimateWindow函数来实现动画窗体,本文就给大家介绍了C#使用AnimateWindow()实现动画窗体的方法,感兴趣的朋友可以参考下
    2024-04-04
  • 基于WPF实现验证码控件

    基于WPF实现验证码控件

    这篇文章主要介绍了如何利用WPF实现一个简单的验证码控件,文中的示例代码讲解详细,对我们学习或工作有一定帮助,需要的可以参考一下
    2022-08-08
  • C#基础知识之new关键字介绍

    C#基础知识之new关键字介绍

    在 C# 中,new 关键字可用作运算符、修饰符或约束,本文主要介绍这三种用法。
    2016-04-04
  • C#中计算时间差中的小数问题解决

    C#中计算时间差中的小数问题解决

    C#中计算时间差中的小数问题解决需要的朋友可以参考一下
    2013-03-03
  • C++实现日期类的示例详解

    C++实现日期类的示例详解

    这篇文章主要为大家详细介绍了四个C++常用的日期类的实现,文中的示例代码讲解详细,对我们学习C++有一定的帮助,需要的可以参考一下
    2023-02-02

最新评论