控制檯程式秒變Windows服務(Topshelf)
專案中有些時候需要寫服務，一般我們都是先建立控制檯程式，測試，執行，成功之後再建立windows服務程式，這樣好麻煩啊，有沒有簡單的控制檯程式直接變成Widnows服務，經過查詢，找到了Topshelf。Topshelf是一個託管使用.NET框架編寫的服務的框架，簡化了服務的建立，允許開發人員建立一個簡單的控制檯應用程式，可以使用Topshelf作為服務安裝。
Topshelf介紹
Topshelf是一個託管使用.NET框架編寫的服務的框架。簡化了服務的建立，允許開發人員建立一個簡單的控制檯應用程式，可以使用Topshelf作為服務安裝。原因很簡單：除錯控制檯應用程式比使用服務要容易得多。一旦應用程式經過測試並可以投入生產，Topshelf便可以輕鬆地將應用程式作為服務進行安裝。這是一個開源的專案，專案地址，Nuget上可以搜到響應的庫。
Topshelf使用
1.建立控制檯程式
2.安裝Topshelf，在Nuget上搜下
3.安裝NLog、NLog.Config，目的是為了看日誌，可以清楚的知道服務在執行，可以不要
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"
xsi:schemaLocation="http://www.nlog-project.org/schemas/NLog.xsd NLog.xsd"
autoReload="true"
throwExceptions="false"
internalLogLevel="Off" internalLogFile="c:\temp\nlog-internal.log">
<!-- optional, add some variables
https://github.com/nlog/NLog/wiki/Configuration-file#variables
-->
<variable name="myvar" value="myvalue"/>
<!--
See https://github.com/nlog/nlog/wiki/Configuration-file
for information on customizing logging rules and outputs.
-->
<targets>
<!--
add your targets here
See https://github.com/nlog/NLog/wiki/Targets for possible targets.
See https://github.com/nlog/NLog/wiki/Layout-Renderers for the possible layout renderers.
-->
<!--
Write events to a file with the date in the filename.
-->
<target xsi:type="File" name="f" fileName="${basedir}/logs/${shortdate}.log"
layout="${longdate} ${uppercase:${level}} ${message}" />
</targets>
<rules>
<!-- add your logging rules here -->
<!--
Write all events with minimal level of Debug (So Debug, Info, Warn, Error and Fatal, but not Trace) to "f"
-->
<logger name="*" minlevel="Debug" writeTo="f" />
</rules>
</nlog>4.程式碼實現
class Program
{
private static readonly Logger logger = LogManager.GetLogger("Program");
static void Main(string[] args)
{
logger.Info($"Main主程式{DateTime.Now}");
var rc = HostFactory.Run(x => //1.啟動程式
{
logger.Info($"主程式{DateTime.Now}");
x.Service<TownCrier>(s => //2.設定服務型別
{
s.ConstructUsing(name => new TownCrier()); //3.建立服務例項
s.WhenStarted(tc => tc.Start()); //4.啟動程式
s.WhenStopped(tc => tc.Stop()); //5.停止程式
});
x.RunAsLocalSystem(); //6.本地系統執行
x.SetDescription("超級簡單的windows服務"); //7.windows服務的描述
x.SetDisplayName("SimpleWindowsService 服務"); //8.windows服務的顯示名稱
x.SetServiceName("SimpleWindowsService"); //9.windows服務的服務名稱
});
var exitCode = (int)Convert.ChangeType(rc, rc.GetTypeCode()); //11.退出程式
Environment.ExitCode = exitCode;
}
}
public class TownCrier
{
private static readonly Logger logger = LogManager.GetLogger("logTest");
readonly Timer _timer; //System.Timers不要引用錯誤
public TownCrier()
{
_timer = new Timer(1000) { AutoReset = true };
_timer.Elapsed += (sender, eventArgs) =>
{
Console.WriteLine($"It is {DateTime.Now} and all is well");
logger.Info($"It is {DateTime.Now} and all is well");
};
}
public void Start() { _timer.Start(); }
public void Stop() { _timer.Stop(); }
}必須有啟動方法（Start）和停止方法（Stop）
4. 執行控制檯程式，也可以是除錯，效果如下
5. 程式除錯執行成功，一切ok，現在可以安裝服務了，以管理員身份執行cmd找到對應路徑，開始安裝
安裝：SimpleWindowsService.exe install
檢視服務
啟動：SimpleWindowsService.exe start
服務已經執行，檢視執行情況，日誌
解除安裝：SimpleWindowsService.exe uninstall
可以看到服務已經沒有了
停止：SimpleWindowsService.exe stop
停止之後可以再次啟動，這個功能不介紹了，解除安裝服務的時候會呼叫這個方法。
Topshelf的其他功能
安裝動作之前：Topshelf允許指定在安裝服務之前執行的操作。請注意，只有在安裝服務時才會執行此操作。
HostFactory.New(x =>
{
x.BeforeInstall(settings => { ... });
});
安裝動作後：Topshelf允許指定在安裝服務後執行的操作。請注意，只有在安裝服務時才會執行此操作。
HostFactory.New(x =>
{
x.AfterInstall(settings => { ... });
});
在解除安裝操作之前：Topshelf允許指定在解除安裝服務之前執行的操作。請注意，只有在解除安裝服務時才會執行此操作。
HostFactory.New(x =>
{
x.BeforeUninstall(() => { ... });
});
解除安裝操作後：Topshelf允許指定在解除安裝服務後執行的操作。請注意，只有在解除安裝服務時才會執行此操作。
HostFactory.New(x =>
{
x.AfterUninstall(() => { ... });
});
異常：為服務執行時丟擲的異常提供回撥。此回撥不是處理程式，不會影響Topshelf已提供的預設異常處理。它旨在提供對觸發外部操作，日誌記錄等的丟擲異常的可見性。
HostFactory.New(x =>
{
x.OnException(ex =>
{
// Do something with the exception
});
});
其他的一些功能，如果需要可以檢視英文官網文件
定時任務的服務
一般的服務都沒有這麼簡單，一般都需要定時任務，這裡的定時任務服務用到了FluentScheduler，FluentScheduler定時器介紹 ，這篇文章對FluentScheduler定時器進行了詳細的介紹，這裡不再介紹，只展示使用。
/// <summary>
/// 用MySchedule的任務定時功能
/// </summary>
public class MyJob {
private static readonly Logger logger = LogManager.GetLogger("MyJob");
public MyJob() { }
public void Start()
{
logger.Info($"MySchedule啟動 {DateTime.Now}");
JobManager.Initialize(new MySchedule());
}
public void Stop()
{
logger.Info($"MySchedule停止 {DateTime.Now}");
JobManager.Stop();
}
}
/// <summary>
/// 定時器
/// </summary>
public class MySchedule : Registry
{
private static readonly Logger logger = LogManager.GetLogger("MySchedule");
public MySchedule()
{
SetNewsSchedule();
}
/// <summary>
/// 設定任務
/// </summary>
private void SetNewsSchedule()
{
//獲取連結傳送郵件
Schedule(() =>
{
logger.Info($"MySchedule執行 {DateTime.Now}");
}
).ToRunNow().AndEvery(1000).Milliseconds();
}
}
控制檯程式呼叫
class Program
{
private static readonly Logger logger = LogManager.GetLogger("Program");
static void Main(string[] args)
{
logger.Info($"Main主程式{DateTime.Now}");
var rc = HostFactory.Run(x => //1.啟動程式
{
logger.Info($"主程式{DateTime.Now}");
x.Service<MyJob>(s => //2.設定服務型別
{
s.ConstructUsing(name => new MyJob()); //3.建立服務例項
s.WhenStarted(tc => tc.Start()); //4.啟動程式
s.WhenStopped(tc => tc.Stop()); //5.停止程式
});
x.RunAsLocalSystem(); //6.本地系統執行
x.SetDescription("超級簡單的windows服務"); //7.windows服務的描述
x.SetDisplayName("SimpleWindowsService 服務"); //8.windows服務的顯示名稱
x.SetServiceName("SimpleWindowsService"); //9.windows服務的服務名稱
});
var exitCode = (int)Convert.ChangeType(rc, rc.GetTypeCode()); //11.退出程式
Environment.ExitCode = exitCode;
}
}
服務安裝兩步走，管理員cmd，SimpleWindowsService.exe install， SimpleWindowsService.exe start
總結
1. 寫控制檯程式
2.管理員cmd，SimpleWindowsService.exe install
3.啟動服務SimpleWindowsService.exe start
4.解除安裝服務SimpleWindowsService.exe unins