Host An ASP.NET Core Application As A Windows Service

Introduction

 

An ASP.NET Core application can be hosted using various methods including IIS and HTTP.sys servers. This article is about hosting ASP.NET Core applications as a Windows Service. Windows Service feature is available only on Windows platform. This is one of the ways to host ASP.NET Core applications on Windows platform without using IIS.

 

Implementation of hosting an ASP.NET Core application as Windows services is not relevant to .NET Core. When an application is hosted as Windows Service, it can start/stop automatically if the service status is start/stop.

 

When ASP.NET Core applications host as a Windows service, the application must run on the .NET Framework, so we need to specify appropriate values for TargetFramework in csproj file. To demonstrate the example, I have run my application on .NET Framework 4.6.1.

<PropertyGroup>
  <TargetFramework>net461</TargetFramework>
</PropertyGroup>

The first step is to install Microsoft.AspNetCore.Hosting.WindowsServices package from nuGet. This package can be installed either by using NuGet Package Manager or by using .NET Core CLI.

 

Using nuget Package Manager

PM > Install-Package Microsoft.AspNetCore.Hosting.WindowsServices

Using .NET Core CLI 

> dotnet add package Microsoft.AspNetCore.Hosting.WindowsServices

This package contains the extension method named "RunAsService" for IWebHost. This extension method runs the specified web application as a Windows Service and port is blocked until the service is stopped. Here, we want to run our application as a service, so we need to call IWebHost.RunAsService() method instead of IWebHost.Run() in the main method of program.cs file. Also, we need to specify the path for content root directory to publish the location.

 

Program.cs

using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Hosting.WindowsServices;
using System.Diagnostics;
using System.IO;

namespace TestApp
{
    public class Program
    {
        public static void Main(string[] args)
        {
            var pathToExe = Process.GetCurrentProcess().MainModule.FileName;
            var pathToContentRoot = Path.GetDirectoryName(pathToExe);

            var host = WebHost.CreateDefaultBuilder(args)
                .UseContentRoot(pathToContentRoot)
                .UseStartup<Startup>()
                .Build();

            host.RunAsService();
        }
    }
}

The next step is to publish this application and register as a Windows Service. To register a Windows service, open a command shell with administrative privileges and use sc.exe command-line tool to create and start a service. In the following command, binPath is an executable of the application.

>sc create TestService binPath="D:\PubTest\TestApp.exe"
>sc start TestService

 

When the above command executes successfully and Windows service has started, we can browse the same path as when running without the service (i.e. default url is http://localhost:5000).

 

 

Provide a way to host application outside of a service

 

When running and hosting the application as a Windows service, it is very difficult to debug. So we can add a condition so that the application does not run as service.

public static void Main(string[] args)
{
    var pathToExe = Process.GetCurrentProcess().MainModule.FileName;
    var pathToContentRoot = Path.GetDirectoryName(pathToExe);

    IWebHost host;

    if (Debugger.IsAttached || args.Contains("console"))
    {
        Debugger.Launch();
        host = WebHost.CreateDefaultBuilder()
                .UseContentRoot(Directory.GetCurrentDirectory())
                .UseStartup<Startup>()
                .Build();
        host.Run();
    }
    else
    {
        host = WebHost.CreateDefaultBuilder(args)
                .UseContentRoot(pathToContentRoot)
                .UseStartup<Startup>()
                .Build();
        host.RunAsService();
    }
}

Now, I am running my application using dotnet run commad and passing "console" string as an argument, so .NET framework hosts our application on a port configured in launchSettings.json.

> dotnet run console

Handle starting and stopping events of Windows service

To handle OnStarting, OnStarted, and OnStopping events, we need to register our own WebHostService class that has these methods. Following are the steps for such events:

 

Create web host service class which derives from WebHostService class.

public class MyWebHostService : WebHostService
{
    public MyWebHostService(IWebHost host) : base(host)
    {
    }

    protected override void OnStarting(string[] args)
    {
        System.Diagnostics.Debugger.Launch();
        base.OnStarting(args);
    }

    protected override void OnStarted()
    {
        base.OnStarted();
    }

    protected override void OnStopping()
    {
        base.OnStopping();
    }
}

Next step is to create an extension method for IWebHost that registers our custom WebHostService and passes to ServiceBase.Run method.

public static class WebHostServiceExtensions
{
    public static void RunAsCustomService(this IWebHost host)
    {
        var webHostService = new MyWebHostService(host);
        ServiceBase.Run(webHostService);
    }
}

Now, we need to call a new extension method RunAsCustomService instead of RunAsService in Program.Main method.

public static void Main(string[] args)
{
    var pathToExe = Process.GetCurrentProcess().MainModule.FileName;
    var pathToContentRoot = Path.GetDirectoryName(pathToExe);

    var host = WebHost.CreateDefaultBuilder(args)
        .UseContentRoot(pathToContentRoot)
        .UseStartup<Startup>()
        .Build();

    host.RunAsCustomService();
}

If we want any service that is required in our custom service from dependency injection, such as a logger, that can be obtained from IWebHost.Services property using GetRequiredService method.

public class MyWebHostService : WebHostService
{
    private ILogger _logger;

    public MyWebHostService(IWebHost host) : base(host)
    {
        _logger = host.Services.GetRequiredService<ILogger<MyWebHostService>>();
    }

    ...
    ...
}

Summary

 

This article explained about hosting ASP.NET Core applications as a Windows service. This is one of the recommended ways to host an ASP.NET Core app on Windows without using IIS.

 

You can view or download the source code from the following GitHub link.