以Windows服務方式執行.NET Core程式

摘要： 在之前一篇部落格《 以Windows服務方式執行ASP.NET Core程式 》中我講述瞭如何把ASP.NET Core程式作為Windows服務執行的方法，而今，我們又遇到了新的問題，那就是：我們的控制檯程式，也就是普通的.NET Core程式(而不是ASP.NET Core程式)如何以服...

在之前一篇部落格《 ofollow,noindex">以Windows服務方式執行ASP.NET Core程式 》中我講述瞭如何把ASP.NET Core程式作為Windows服務執行的方法，而今，我們又遇到了新的問題，那就是：我們的控制檯程式，也就是普通的.NET Core程式(而不是ASP.NET Core程式)如何以服務的方式執行呢？

這個問題我們在.NET Core之前早就遇到過，那是是.NET Framework的時代(其實距今也沒多遠啦)，我們是用一個第三方的元件——Topshelf，來解決這個問題的，Topshelf的官網是： http://topshelf-project.com/ ，它的使用很簡單，官網上有具體的描述，對於一個普通的控制檯程式而言(通常是一個不需要圖形介面的服務)，開發和除錯的時候，把它當做一個普通的控制檯程式來使用，十分方便；而實際部署的時候，通過傳入不同的命令列引數，可以使它有了新的行為：安裝Windows服務、執行Windows服務、停止/重啟Windows服務或者解除安裝Windows服務。進入跨平臺的.NET Core時代之後，Topshelf自然有了支援.NET Core的版本，使用方法與之前的類似，具體在此不表了，因為接下來我們根本不打算使用它！

現在我想要的是：不要引入任何元件，不要對現在控制檯程式進行任何修改(ASP.NET Core程式也是控制檯程式)，開發除錯時候不要進行任何複雜的引數配置，一切照舊，僅僅是在部署階段，把程式當做Windows服務去執行。——你嘚講吼不吼？

要達到這個目標，就要藉助一個神器了，此神器為NSSM，Non-Sucking Service Manager，名字有點拗口，翻譯成中文就是：不嗝屁服務管理器。

NSSM的官網是： https://nssm.cc/ ，十分簡陋，但程式功能可是非常強大和全面的，下面我來一步步演示它如何使用。

1，先構建一個簡單的服務程式

構建一個簡單的服務程式，程式功能描述：程式沒有圖形介面，僅僅是定時記錄一些日誌(5秒鐘寫一下日誌)，在使用者按下<Ctrl>+<C>的時候，程式退出。功能明確，Okay，let's get down to work.

1. 建立一個.NET Core Application，叫MyService

2. Nuget引入Quartz和NLog.Extensions.Logging，一個用來做定時任務，另一個用來log

3. 另外，程式使用了依賴注入，還需要用Nuget引入Microsoft.Extensions.DependencyInjection

4. 給專案增加NLog.Config配置檔案，內容是

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
autoReload="true"
throwExceptions="false"
internalLogLevel="Off">
<variable name="theLayout" value="${date:format=HH\:mm\:ss.fff} [${level}][${logger}] ${callsite:className=False:fileName=True:methodName=False} ${message} ${onexception:${newline}}${exception:format=Message,ShortType,StackTrace:innerFormat=Message,ShortType,StackTrace:separator=\r\n:innerExceptionSeparator=\r\n---Inner---\r\n:maxInnerExceptionLevel=5}"/>
<targets>
<target name="asyncFile" xsi:type="AsyncWrapper">
<target name="logfile" xsi:type="File" fileName="${basedir}/log/${shortdate}.log" layout="${theLayout}" encoding="UTF-8" />
</target>
<target name="debugger" xsi:type="Debugger" layout="${theLayout}" />
<target name="console" xsi:type="Console" layout="${theLayout}" />
<target name="void" xsi:type="Null" formatMessage="false" />
</targets>
<rules>
<logger name="Quartz.*" minlevel="Trace" maxlevel="Info" writeTo="void" final="true" />
<logger name="*" minlevel="Debug" writeTo="asyncFile" />
<logger name="*" minlevel="Trace" writeTo="debugger"/>
<logger name="*" minlevel="Trace" writeTo="console"/>
</rules>
</nlog>

還要注意的是這個檔案必須複製到生成目錄去以便程式執行時候能夠載入到。

5. 增加MyServiceJobFactory.cs

using Quartz;
using Quartz.Spi;
using System;
namespace MyService {
class MyServiceJobFactory : IJobFactory {
protected readonly IServiceProvider _container;
public MyServiceJobFactory(IServiceProvider container) {
_container = container;
}
public IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler) {
return _container.GetService(bundle.JobDetail.JobType) as IJob;
}
public void ReturnJob(IJob job) {
}
}
}

6. 增加PeriodLoggingJob.cs

using Microsoft.Extensions.Logging;
using Quartz;
using System;
using System.Threading.Tasks;
namespace MyService {
class PeriodLoggingJob: IJob {
private readonly ILogger<PeriodLoggingJob> _logger;
public PeriodLoggingJob(ILogger<PeriodLoggingJob> logger, IServiceProvider serviceProvider) {
_logger = logger;
}
private void DoLoggingJob() {
_logger.LogInformation("logging...");
}
public Task Execute(IJobExecutionContext context) {
try {
DoLoggingJob();
}
catch (Exception ex) { //必須妥善處理好定時任務中發生的異常
_logger.LogError(ex, "執行定時任務發生意外錯誤");
}
returnTask.CompletedTask;
}
}
}

7. Program.cs的完整內容如下

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using NLog.Extensions.Logging;
using Quartz;
using Quartz.Impl;
using Quartz.Spi;
using System;
using System.Collections.Specialized;
using System.IO;
using System.Threading;
namespace MyService {
class Program {
//註冊各種服務
static void RegisterServices(IServiceCollection services) {
//日誌相關
services.AddSingleton<ILoggerFactory, LoggerFactory>();
services.AddSingleton(typeof(ILogger<>), typeof(Logger<>));
services.AddLogging(builder => builder.SetMinimumLevel(LogLevel.Trace));
//定時任務相關
services.AddSingleton<IJobFactory, MyServiceJobFactory>();
services.AddSingleton<PeriodLoggingJob>();
}
static void Main(string[] args) {
//註冊退出事件處理(響應<Ctrl>+<C>)
ManualResetEvent exitEvent = new ManualResetEvent(false);
Console.CancelKeyPress += delegate (object sender, ConsoleCancelEventArgs e) {
e.Cancel = true;
exitEvent.Set();
};
//處理其它程式關閉事件(如kill)，使得程式可以優雅地關閉
AppDomain.CurrentDomain.ProcessExit += (sender, e) => { exitEvent.Set(); };
//容器生成
ServiceCollection services = new ServiceCollection();
RegisterServices(services);
using (ServiceProvider container = services.BuildServiceProvider()) {
//日誌初始化
var loggerFactory = container.GetRequiredService<ILoggerFactory>();
loggerFactory.AddNLog(new NLogProviderOptions {
CaptureMessageTemplates = true,
CaptureMessageProperties = true
});
string nlogConfigFile = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "NLog.config");
NLog.LogManager.LoadConfiguration(nlogConfigFile);
//記錄啟動日誌
ILogger<Program> logger = container.GetService<ILogger<Program>>();
logger.LogInformation("MyService啟動.");
//定時任務配置
NameValueCollection props = new NameValueCollection { { "quartz.serializer.type", "binary" } };
StdSchedulerFactory schedulerFactory = new StdSchedulerFactory(props);
IScheduler scheduler = schedulerFactory.GetScheduler().Result;
scheduler.JobFactory = container.GetService<IJobFactory>();

//每天1:00執行APP狀態更新任務
ITrigger periodLoggingJobTrigger = TriggerBuilder.Create().WithIdentity("PeriodLoggingJobTrigger")
.StartNow().WithSimpleSchedule(x=>x.WithIntervalInSeconds(5).RepeatForever()).Build();
IJobDetail checkPasswordOutOfDateJob = JobBuilder.Create<PeriodLoggingJob>().WithIdentity("PeriodLoggingJob").Build();
scheduler.ScheduleJob(checkPasswordOutOfDateJob, periodLoggingJobTrigger);

//開啟定時服務
scheduler.Start();
//----------------------------------------↑↑↑ 程式開始 ↑↑↑----------------------------------------
exitEvent.WaitOne();
//----------------------------------------↓↓↓ 程式結束 ↓↓↓----------------------------------------
//定時任務結束
scheduler.Shutdown();
//記錄結束日誌
logger.LogInformation("MyService停止.");
}
}
}
}

這就是整個服務程式的完整內容，本來我可以提供一個更簡單的程式，這裡囉裡囉嗦寫了這麼一大堆，目的還是讓初學者更加清楚.NET Core的程式結構和執行方式。其中內容包括：NLog的使用、Quartz的使用、容器及依賴注入的入門例子、如何處理程式關閉事件等，也許你想問“為什麼要引入Quartz，搞這麼複雜，弄個Timer不行嗎？”當然行，但Quartz更強大，而且更適合給大家演示容器與依賴注入的使用。

8. 試執行程式

執行這個程式，輸出幾條日誌資訊後，以<Ctrl>+<C>來結束程式的執行，這樣會在程式目錄下產生log目錄及日誌檔案，檔案的內容大致如下：

19:03:37.117 [Info][MyService.Program] (d:\work\MyService\MyService\Program.cs:55) MyService啟動.
19:03:37.637 [Info][MyService.PeriodLoggingJob] (d:\work\MyService\MyService\PeriodLoggingJob.cs:15) logging...
19:03:42.536 [Info][MyService.PeriodLoggingJob] (d:\work\MyService\MyService\PeriodLoggingJob.cs:15) logging...
19:03:47.535 [Info][MyService.PeriodLoggingJob] (d:\work\MyService\MyService\PeriodLoggingJob.cs:15) logging...
19:03:49.293 [Info][MyService.Program] (d:\work\MyService\MyService\Program.cs:80) MyService停止.

9. 釋出程式

選擇publish，在publish的目標目錄下產生一堆檔案，將這些檔案複製到D:\Service\MyService目錄下，一會兒我們要用到這個目錄。