推荐一款将控制台程序部署到Windows服务的组件

光明布业

在日常开发中，有时候需要将我们的程序随着操作系统一起运行，并且无需人工干预。要实现这种效果，有很多种方法，比如：如果是桌面程序，可以设置到程序的启动项；如果是Web程序，还可以托管到IIS中，而对于控制台程序，最常见在做法是将程序部署成Windows服务，并设置成自动运行，这样当操作系统开机时，就会自动启动。在.NET程序中，如何将控制台程序，部署成Windows服务中呢？本文以一个简单的小例，简述如何利用一款第三方插件（Topshelf）将控制台程序部署成Windows服务的相关方法及步骤。
 
什么是Topshelf?

 
Topshelf是一款开源的用于托管.NET编写的应用程序到Windows服务的框架，通过Topshelf，可以非常方便的将普通控制台应用程序，转换成Winodw服务，并注册到Windows服务控制管理器（SCM）中。
 
示例说明

 
Windows服务一般都是周期性重复运行的，并不会停止。在本示例中，主要是为了演示创建Windows服务的方法及功能框架，实现功能是每隔一秒钟，输入一段话到日志文件中，以便于查看。
 
创建控制台应用程序

 
首先创建一个控制台应用程序，以及一个普通的类（AppService），此类包含Start和Stop方法，以及Work方法，具备一个服务的基本功能。如下所示：

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
4. using System.Text;
5. using System.Threading.Tasks;
7. namespace DemoWinService
8. {
9.     /// <summary>
10.     /// 程序运行主体
11.     /// </summary>
12.     internal class AppService
13.     {
14.         private CancellationTokenSource cts;
15.         private CancellationToken token;
16.         private Task bgtask;
18.         public AppService()
19.         {
20.             this.cts = new CancellationTokenSource();
21.             this.token = cts.Token;
22.         }
24.         /// <summary>
25.         /// 开始
26.         /// </summary>
27.         public void Start()
28.         {
29.             Logger.Info("DemoWinService程序开始运行");
30.             this.bgtask = Task.Run(() =>
31.             {
32.                 while (!this.token.IsCancellationRequested)
33.                 {
34.                     try
35.                     {
36.                         this.Work();
37.                     }
38.                     catch (Exception ex)
39.                     {
41.                     }
42.                     finally
43.                     {
44.                         Sleep(1000);
45.                     }
46.                 }
48.             });
49.         }
51.         /// <summary>
52.         /// 运行
53.         /// </summary>
54.         public void Work()
55.         {
56.             Logger.Info($"{DateTime.Now.ToString("当前时间为：yyyy-MM-dd HH:mm:ss")}程序正在运行...");
57.         }
59.         /// <summary>
60.         /// 停止
61.         /// </summary>
62.         public void Stop()
63.         {
64.             cts.Cancel();
65.             if(this.bgtask != null)
66.             {
67.                 this.bgtask.Wait(1000);
68.             }
69.             Logger.Info("DemoWinService程序结束运行");
70.         }
72.         /// <summary>
73.         /// 线程等待
74.         /// </summary>
75.         /// <param name="milliseconds"></param>
76.         private void Sleep(int milliseconds)
77.         {
78.             int times = 10;
79.             if (milliseconds <= 1000)
80.             {
81.                 times = 10;
82.             }
83.             else if (milliseconds > 1000 && milliseconds <= 10000)
84.             {
85.                 times = 20;
86.             }
87.             else if (milliseconds > 10000 && milliseconds <= 100000)
88.             {
89.                 times = 40;
90.             }
91.             else
92.             {
93.                 times = 60;
94.             }
95.             for (int i = 0; i < times; i++)
96.             {
97.                 if (token.IsCancellationRequested)
98.                 {
99.                     return;
100.                 }
101.                 Thread.Sleep(milliseconds / times);
102.             }
103.         }
104.     }
105. }

复制代码

 其中服务名称和描述信息，在配置文件（App.config）中，方便修改。

1. using System;
2. using System.Collections.Generic;
3. using System.Configuration;
4. using System.Linq;
5. using System.Text;
6. using System.Threading.Tasks;
7. using Topshelf;
9. namespace DemoWinService
10. {
11.     internal class Program
12.     {
13.         public static void Main(string[] args)
14.         {
15.             var rc = HostFactory.Run(x =>
16.             {
17.                 x.Service<AppService>(s =>
18.                 {
19.                     s.ConstructUsing(name => new AppService());
20.                     s.WhenStarted(tc => tc.Start());
21.                     s.WhenStopped(tc => tc.Stop());
22.                 });
23.                 x.RunAsLocalSystem();
24.                 x.StartAutomatically();
25.                 x.SetDescription(ConfigurationManager.AppSettings["Description"]);
27.                 x.SetDisplayName(ConfigurationManager.AppSettings["DisplayName"]);
28.                 x.SetServiceName(ConfigurationManager.AppSettings["ServiceName"]);
29.             });
31.             var exitCode = (int)Convert.ChangeType(rc, rc.GetTypeCode());
33.             Environment.ExitCode = exitCode;
34.         }
35.     }
36. }

复制代码

 
服务安装

 
当程序开发完成后，将编译后的程序放置在服务器上指定的目录，然后【以管理员运行】打开命令行窗口，找到程序目录，通过以下命令进行安装：

1. <?xml version="1.0" encoding="utf-8" ?>
2. <configuration>
3.         <appSettings>
4.                 <add key="Description" value="测试Windows服务"/>
5.                 <add key="ServiceName" value="DemoWinService"/>
6.                 <add key="DisplayName" value="DemoWinService"/>
7.         </appSettings>
8. </configuration>

复制代码

 示例如下所示：

 
启动停止服务

 
安装成功后，即可在Windows服务管理器中，进行启动或者停止 ，如下所示：
 

 
程序输出日志，表示服务正常运行：
 

 
服务卸载

 
当服务不再使用时，可以通过如下命令卸载服务：

1. 可执行程序.exe install

复制代码

 
示例如下所示：

 
Topshelf源码

 
Topshelf是一款开源框架，其源码是托管到Github中，如下所示：GitHub源码：https://github.com/Topshelf/Topshelf

 
以上就是【推荐一款将控制台程序部署到Windows服务的组件】的全部内容，希望可以抛砖引玉，一起学习，共同进步。

来源:https://www.cnblogs.com/hsiang/p/18317307
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！