Hosting .NET Core Applications as Windows Services

.NET Core is a powerful, cross-platform framework that enables developers to build high-performance applications. While .NET Core applications are typically executed in development environments or as console applications, you may want to run your application as a Windows Service for production environments. Running an application as a Windows Service provides several advantages, such as automatic startup, background execution, and easier management.

Prerequisites

1. Windows Operating System - The steps below are specifically for Windows environments.
2. .NET Core SDK - Download and install the .NET Core SDK if you haven't already.
3. Visual Studio or Visual Studio Code - You'll need an IDE to write and run your application.
4. Administrator Privileges - Setting up and managing Windows Services requires administrator access.

Step 1: Create a New .NET Core Worker Service

1. dotnet new worker -n MyWindowsService
   <span class="hljs-built_in">cd</span> MyWindowsService
   

Step 2: Modify the Worker Service

Worker

 class, you’ll find an example 

ExecuteAsync

 method that runs in the background when the service starts. You can modify this method to include the logic of your application.

ExecuteAsync

 method as follows:

csharp
Copy code
<span class="hljs-keyword">public</span> <span class="hljs-keyword">class</span> <span class="hljs-title">Worker</span> : <span class="hljs-title">BackgroundService</span>
{
    <span class="hljs-keyword">private</span> <span class="hljs-keyword">readonly</span> ILogger&lt;Worker&gt; _logger;

    <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">Worker</span>(<span class="hljs-params">ILogger&lt;Worker&gt; logger</span>)</span>
    {
        _logger = logger;
    }

    <span class="hljs-function"><span class="hljs-keyword">protected</span> <span class="hljs-keyword">override</span> <span class="hljs-keyword">async</span> Task <span class="hljs-title">ExecuteAsync</span>(<span class="hljs-params">CancellationToken stoppingToken</span>)</span>
    {
        <span class="hljs-keyword">while</span> (!stoppingToken.IsCancellationRequested)
        {
            _logger.LogInformation(<span class="hljs-string">"Worker running at: {time}"</span>, DateTimeOffset.Now);
            <span class="hljs-keyword">await</span> Task.Delay(<span class="hljs-number">1000</span>, stoppingToken);
        }
    }
}

Step 3: Add the Windows Service Hosting

Program.cs

 file to include the 

UseWindowsService

 method. This will configure the worker to run as a Windows Service when deployed to a Windows machine.

Program.cs

 as follows:

csharp
Copy code
<span class="hljs-keyword">using</span> Microsoft.Extensions.DependencyInjection;
<span class="hljs-keyword">using</span> Microsoft.Extensions.Hosting;

<span class="hljs-keyword">namespace</span> <span class="hljs-title">MyWindowsService</span>
{
    <span class="hljs-keyword">public</span> <span class="hljs-keyword">class</span> <span class="hljs-title">Program</span>
    {
        <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">Main</span>(<span class="hljs-params"><span class="hljs-built_in">string</span>[] args</span>)</span>
        {
            CreateHostBuilder(args).Build().Run();
        }

        <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> IHostBuilder <span class="hljs-title">CreateHostBuilder</span>(<span class="hljs-params"><span class="hljs-built_in">string</span>[] args</span>)</span> =&gt;
            Host.CreateDefaultBuilder(args)
                .ConfigureServices((hostContext, services) =&gt;
                {
                    services.AddHostedService&lt;Worker&gt;();
                })
                .UseWindowsService(); <span class="hljs-comment">// Add this line to run as a Windows Service</span>
    }
}

Step 4: Publish the Application

bash
Copy code
dotnet publish -c Release -r win-x64 --self-contained

Step 5: Install and Run the Service

sc

 command or create a service configuration script using PowerShell.

sc

 command:

2. bash
   Copy code
   sc create MyWindowsService binPath= <span class="hljs-string">"C:\path\to\your\published\app\MyWindowsService.exe"</span>
   

   "C:\path\to\your\published\app\MyWindowsService.exe"

    with the actual path to your published application.

3. bash
   Copy code
   sc start MyWindowsService
   

4. bash
   Copy code
   sc stop MyWindowsService
   

5. bash
   Copy code
   sc delete MyWindowsService
   

Step 6: Verify Service Operation

sc query

 command:

bash
Copy code
sc query MyWindowsService

ILogger

 service.

Conclusion