Windowsサービスとしての.NETコンソールアプリケーション

コンソールアプリケーションがあり、Windowsサービスとして実行したい。VS2010には、コンソールプロジェクトをアタッチしてWindowsサービスを構築できるプロジェクトテンプレートがあります。個別のサービスプロジェクトを追加せずに、可能であればサービスコードをコンソールアプリケーションに統合して、コンソールアプリケーションを、コンソールアプリケーションとして、またはスイッチを使用してコマンドラインから実行する場合はWindowsサービスとして実行できる1つのプロジェクトとして保持します。

たぶん、誰かがクラスライブラリまたはコードスニペットを提案して、c＃コンソールアプリケーションをすばやく簡単にサービスに変換できるでしょうか？

私は通常、次のテクニックを使用して、コンソールアプリケーションまたはサービスと同じアプリを実行します。

public static class Program
{
    #region Nested classes to support running as service
    public const string ServiceName = "MyService";

    public class Service : ServiceBase
    {
        public Service()
        {
            ServiceName = Program.ServiceName;
        }

        protected override void OnStart(string[] args)
        {
            Program.Start(args);
        }

        protected override void OnStop()
        {
            Program.Stop();
        }
    }
    #endregion

    static void Main(string[] args)
    {
        if (!Environment.UserInteractive)
            // running as service
            using (var service = new Service())
                ServiceBase.Run(service);
        else
        {
            // running as console app
            Start(args);

            Console.WriteLine("Press any key to stop...");
            Console.ReadKey(true);

            Stop();
        }
    }

    private static void Start(string[] args)
    {
        // onstart code here
    }

    private static void Stop()
    {
        // onstop code here
    }
}

Environment.UserInteractive通常、コンソールアプリの場合はtrue、サービスの場合はfalseです。技術的には、ユーザーインタラクティブモードでサービスを実行することができるため、代わりにコマンドラインスイッチを確認できます。

TopShelfで大成功を収めました。

TopShelfは、コンソールアプリまたはWindowsサービスとして実行できる.NET Windowsアプリを簡単に作成できるように設計されたNugetパッケージです。サービスのStartイベントやStopイベントなどのイベントをすばやく接続し、コードを使用して、実行するアカウントを設定したり、他のサービスへの依存関係を構成したり、エラーからの回復方法を構成したりできます。

パッケージマネージャーコンソール（Nuget）から：

インストールパッケージTopshelf

開始するには、コードサンプルを参照してください。

例：

HostFactory.Run(x =>                                 
{
    x.Service<TownCrier>(s =>                        
    {
       s.ConstructUsing(name=> new TownCrier());     
       s.WhenStarted(tc => tc.Start());              
       s.WhenStopped(tc => tc.Stop());               
    });
    x.RunAsLocalSystem();                            

    x.SetDescription("Sample Topshelf Host");        
    x.SetDisplayName("Stuff");                       
    x.SetServiceName("stuff");                       
}); 

TopShelfは、サービスのインストールも処理します。これにより、多くの時間を節約でき、ソリューションから定型コードを削除できます。.exeをサービスとしてインストールするには、コマンドプロンプトから次のコマンドを実行するだけです。

myservice.exe install -servicename "MyService" -displayname "My Service" -description "This is my service."

ServiceInstallerなどを接続する必要はありません-TopShelfがすべてを行います。

だからここに完全なチュートリアルがあります：

1. 新しいコンソールアプリケーションプロジェクト（MyServiceなど）を作成します。
2. 2つのライブラリ参照を追加します：System.ServiceProcessおよびSystem.Configuration.Install
3. 以下に印刷された3つのファイルを追加します
4. プロジェクトをビルドして、「InstallUtil.exe c：\ path \ to \ MyService.exe」を実行します
5. これで、サービスリストにMyServiceが表示されます（services.mscを実行します）。

* InstallUtil.exeは通常、ここにあります：C：\ windows \ Microsoft.NET \ Framework \ v4.0.30319 \ InstallUtil.ex‌ e

Program.cs

using System;
using System.IO;
using System.ServiceProcess;

namespace MyService
{
    class Program
    {
        public const string ServiceName = "MyService";

        static void Main(string[] args)
        {
            if (Environment.UserInteractive)
            {
                // running as console app
                Start(args);

                Console.WriteLine("Press any key to stop...");
                Console.ReadKey(true);

                Stop();
            }
            else
            {
                // running as service
                using (var service = new Service())
                {
                    ServiceBase.Run(service);
                }
            }
        }

        public static void Start(string[] args)
        {
            File.AppendAllText(@"c:\temp\MyService.txt", String.Format("{0} started{1}", DateTime.Now, Environment.NewLine));
        }

        public static void Stop()
        {
            File.AppendAllText(@"c:\temp\MyService.txt", String.Format("{0} stopped{1}", DateTime.Now, Environment.NewLine));
        }
    }
}

MyService.cs

using System.ServiceProcess;

namespace MyService
{
    class Service : ServiceBase
    {
        public Service()
        {
            ServiceName = Program.ServiceName;
        }

        protected override void OnStart(string[] args)
        {
            Program.Start(args);
        }

        protected override void OnStop()
        {
            Program.Stop();
        }
    }
}

MyServiceInstaller.cs

using System.ComponentModel;
using System.Configuration.Install;
using System.ServiceProcess;

namespace MyService
{
    [RunInstaller(true)]
    public class MyServiceInstaller : Installer
    {
        public MyServiceInstaller()
        {
            var spi = new ServiceProcessInstaller();
            var si = new ServiceInstaller();

            spi.Account = ServiceAccount.LocalSystem;
            spi.Username = null;
            spi.Password = null;

            si.DisplayName = Program.ServiceName;
            si.ServiceName = Program.ServiceName;
            si.StartType = ServiceStartMode.Automatic;

            Installers.Add(spi);
            Installers.Add(si);
        }
    }
}

1つのアセンブリに繰り返しコードを停止させたいというあなたの意見を聞きましたが、これは最も簡単で、コードの繰り返しを減らし、将来他の方法でコードを再利用しやすくなります。

1. すべての作業を行う1つのライブラリアセンブリ。次に、非常にスリムでシンプルな2つのプロジェクトがあります。
2. コマンドラインであるもの
3. 1つはWindowsサービスです。

最新の.Net Core 3.1に基づいて、コンソールアプリケーションをワーカーサービスとしてWindowsサービスに変換する新しい方法を次に示します。ます。

Visual Studio 2019からワーカーサービスを作成すると、Windowsサービスを作成するために必要なほぼすべてのものが提供されます。これは、コンソールサービスをWindowsサービスに変換するために変更する必要があるものでもあります。

以下に、必要な変更を示します。

次のNuGetパッケージをインストールする

Install-Package Microsoft.Extensions.Hosting.WindowsServices -Version 3.1.0
Install-Package Microsoft.Extensions.Configuration.Abstractions -Version 3.1.0

Program.csを以下のような実装に変更します。

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace ConsoleApp
{
    class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).UseWindowsService().Build().Run();
        }

        private static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureServices((hostContext, services) =>
                {
                    services.AddHostedService<Worker>();
                });
    }
}

サービスオペレーションによって実行されるコードを配置するWorker.csを追加します。

using Microsoft.Extensions.Hosting;
using System.Threading;
using System.Threading.Tasks;

namespace ConsoleApp
{
    public class Worker : BackgroundService
    {
        protected override async Task ExecuteAsync(CancellationToken stoppingToken)
        {
            //do some operation
        }

        public override Task StartAsync(CancellationToken cancellationToken)
        {
            return base.StartAsync(cancellationToken);
        }

        public override Task StopAsync(CancellationToken cancellationToken)
        {
            return base.StopAsync(cancellationToken);
        }
    }
}

すべての準備が整い、アプリケーションが正常にビルドされたら、sc.exeを使用して、次のコマンドでコンソールアプリケーションのexeをWindowsサービスとしてインストールできます。

sc.exe create DemoService binpath= "path/to/your/file.exe"

使用できます

reg add HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run /v ServiceName /d "c:\path\to\service\file\exe"

そして、それはサービスリストに表示されます。それが正しく機能するかどうかはわかりません。サービスは通常、いくつかのイベントをリッスンする必要があります。

ただし、いくつかのサービスラッパーがあり、任意のアプリケーションを実際のサービスとして実行できます。たとえば、Win2003リソースキットの Microsofts SrvAny

まず、コンソールアプリケーションソリューションをWindowsサービスソリューションに埋め込み、参照します。

次に、コンソールアプリケーションのProgramクラスを公開します。

/// <summary>
/// Hybrid service/console application
/// </summary>
public class Program
{
}

次に、コンソールアプリケーション内に2つの関数を作成します

    /// <summary>
    /// Used to start as a service
    /// </summary>
    public void Start()
    {
        Main();
    }

    /// <summary>
    /// Used to stop the service
    /// </summary>
    public void Stop()
    {
       if (Application.MessageLoop)
            Application.Exit();   //windows app
        else
            Environment.Exit(1);  //console app
    }

次に、Windowsサービス自体の中でプログラムをインスタンス化し、OnStartおよびOnStop内に追加されたStartおよびStop関数を呼び出します。下記参照

class WinService : ServiceBase
{
    readonly Program _application = new Program();

    /// <summary>
    /// The main entry point for the application.
    /// </summary>
    static void Main()
    {
        ServiceBase[] servicesToRun = { new WinService() };
        Run(servicesToRun);
    }

    /// <summary>
    /// Set things in motion so your service can do its work.
    /// </summary>
    protected override void OnStart(string[] args)
    {
        Thread thread = new Thread(() => _application.Start());
        thread.Start();
    }

    /// <summary>
    /// Stop this service.
    /// </summary>
    protected override void OnStop()
    {
        Thread thread = new Thread(() => _application.Stop());
        thread.Start();
    }
}

このアプローチは、WindowsアプリケーションとWindowsサービスのハイブリッドにも使用できます。

おそらく、私が知る限り、必要なものを定義する必要があります。アプリをコマンドラインでコンソールまたはサービスとして同時に実行することはできません。サービスがインストールされ、サービスマネージャーで開始する必要があることに注意してください。サービスを開始するか、コンソールアプリを実行する新しいプロセスを開始する新しいアプリケーションを作成できます。しかし、あなたが書いたように

「コンソールアプリケーションを1つのプロジェクトとして保持する」

かつて、私はあなたの立場にいて、コンソールアプリケーションをサービスに変えました。VS Express Editionを使用している場合は、最初にテンプレートが必要です。最初のステップを実行できるリンクは次のとおりです。C＃Windowsサービス。これは私にとって非常に役に立ちました。次に、そのテンプレートを使用して、サービスの目的のイベントにコードを追加します。

サービスを改善するためにできることは他にもありますが、これは迅速かつ/または簡単ではなく、appdomainsを使用し、ロード/アンロードするDLLを作成します。1つはコンソールアプリで新しいプロセスを開始する方法で、もう1つはサービスで実行する必要のある機能をDLLに追加する方法です。

幸運を。

機能を1つまたは複数のクラスに分離し、2つのスタブのいずれかを介してそれを起動する必要があります。コンソールスタブまたはサービススタブ。

わかりやすいように、ウィンドウを実行しているとき、インフラストラクチャを構成する無数のサービスは、ユーザーにコンソールウィンドウを表示しません（直接表示することもできません）。サービスは、非グラフィカルな方法でユーザーと通信する必要があります。SCMを介して。イベントログ、ログファイルなどに記録されます。サービスはSCMを介してWindowsと通信する必要もあり、そうでない場合はシャットダウンされます。

サービスと通信できるコンソールアプリがあれば十分ですが、サービスはGUIの対話を必要とせずに独立して実行する必要があります。

コンソールスタブは、サービスの動作のデバッグに非常に役立ちますが、結局のところ、サービスを作成する目的である「本稼働」環境では使用しないでください。

私はそれを完全には読んでいませんが、この記事は正しい方向に向かっているようです。

私は、で規定された標準パターンに従うサービスクラスを使用し、ServiceBaseF5デバッグを容易にするヘルパーを追加しています。これにより、サービス内で定義されたサービスデータが保持されるため、データを見つけやすくなり、ライフタイムを簡単に管理できます。

私は通常、以下の構造を持つWindowsアプリケーションを作成します。コンソールアプリケーションは作成しません。そうすれば、アプリを実行するたびに大きなブラックボックスが顔に飛び出さなくなります。私はすべてのアクションがあるデバッガーにとどまります。私が使うDebug.WriteLineメッセージを出力ウィンドウに送るためします。出力ウィンドウはうまくドッキングし、アプリが終了しても表示されたままになります。

私は通常、わざわざ停止するためのデバッグコードを追加しません。代わりにデバッガを使用します。停止をデバッグする必要がある場合は、プロジェクトをコンソールアプリにして、Stopフォワーダーメソッドを追加し、への呼び出し後に呼び出しますConsole.ReadKey。

public class Service : ServiceBase
{
    protected override void OnStart(string[] args)
    {
        // Start logic here.
    }

    protected override void OnStop()
    {
        // Stop logic here.
    }

    static void Main(string[] args)
    {
        using (var service = new Service()) {
            if (Environment.UserInteractive) {
                service.Start();
                Thread.Sleep(Timeout.Infinite);
            } else
                Run(service);
        }
    }
    public void Start() => OnStart(null);
}