Jorge Serrano
  • Home

Creando un Servicio Windows con .NET Core 3.1

  • By jorge
  • Mar-2-2020
  • .NET Core 3.1, C#
  • 2 Comments.

Introducción

En esta entrada, voy a explicar cómo crear un Servicio de Windows con .NET Core 3.1.

Para ello, podríamos utilizar una plantilla de Visual Studio 2019 que nos da casi todo hecho, pero voy a hacerlo paso a paso de manera tradicional, a través de una aplicación de consola.

 

Creando la aplicación de consola

La primera acción por lo tanto, será crear una aplicación de consola, que en mi caso utilizaré como base de lo que será nuestro Servicio de Windows.

Quiero volver a reiterar que estoy haciendo el Servicio de Windows así, para demostrar cómo hacerlo y qué partes forman parte de él.
Si quisiéramos utilizar directamente la plantilla de Microsoft, deberíamos usar la plantilla Worker Service.

Pondremos un nombre a nuestra aplicación de consola, que en mi caso es MyFirtsWindowsService.

 

SDK a utilizar por un Servicio Windows

Una particularidad y diferenciación de un Servicio Windows con respecto a una aplicación de consola, es que debe utilizar un SDK especial.
Uno que tenga una referencia explícita a Microsoft.Extensions.Hosting.

Por lo que el proyecto no debería hacer referencia al SDK Microsoft.NET.Sdk de la forma <Project Sdk=»Microsoft.NET.Sdk»>, sino a Microsoft.NET.Sdk.Worker de la forma <Project Sdk=»Microsoft.NET.Sdk.Worker»>.

Así que deberemos hacer un clic sobre el proyecto en Visual Studio 2019, o bien editar el fichero proj de nuestra aplicación de consola para apuntar al SDK correcto.

 

Eliminar en el proyecto la configuración de salida como ejecutable

Aunque se generará un fichero exe a la hora de compilar, la verdad es que no debemos indicar la salida como fichero exe ejecutable, por lo que dentro del fichero de configuración, eliminaremos la línea:

<OutputType>Exe</OutputType>

 

Añadiendo referencia al paquete NuGet de WindowsService

Para poder utilizar nuestra aplicación de consola como si fuera un Servicio Windows, necesitaremos añadir una referencia a un paquete NuGet llamado Microsoft.Extensions.Hosting.WindowsServices.

Encontrarás este paquete en este enlace de NuGet.

Una vez añadida la referencia, será necesario crear el host, algo que haremos devolviendo una interfaz de tipo IHostBuilder.

Pero esto está relacionado también con el worker que define la lógica de nuestro servicio, así que antes de abordar cómo crear el host que hospedará nuestro servicio, vamos a crearlo.

 

Añadiendo un Worker

Cualquier Servicio Windows contendrá un worker, que es la base fundamental del servicio.

Este worker heredará de BackgroundService, que a su vez implementa la interfaz IHostedService.

IHostedService define dos métodos para su gestión dentro del host.
Por un lado, un método para iniciar la lógica de la tarea a ejecutar o inicializar el servicio.
Este método se llama StartAsync.
Por otro lado, un método que se ejecuta al detener el servicio.
Este método se llama StopAsync.

No necesitamos implementar estos dos métodos dentro de nuestro worker, pero conviene saber de su existencia, pues la mayoría de las veces nos vendrá bien ejecutar acciones al comenzar o al detener el servicio dentro del sistema.

Otro método muy importante es BackgroundService.

Este método es llamado cuando IHostedServer es llamado.
Dentro de este método implementaremos el servicio en sí, por lo que debería devolver una tarea o Task.

Esa tarea representa el ciclo de vida de una operación que debe ser ejecutada.
La escucha de un puerto, la entrada de una comunicación, la ejecución de un proceso dentro de un timer o tarea programada, etc.

Así que nuestro worker deberá heredar de BackgroundService quién a su vez, deberá implementar al menos a ExecuteAsync.

Llegados a este punto, vamos a escribir el código de nuestro servicio.

Como queremos ejecutar una tarea que debe ejecutarse todo el tiempo, vamos a hacer un bucle continuo en el tiempo mientras la tarea no sea cancelada.

Crearemos una clase a la que he llamado MyWorker.
Dentro de esta clase, he agregado el siguiente código:

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

namespace MyFirstWindowsService
{
    public class MyWorker : BackgroundService
    {
        private readonly ILogger _logger;

        public MyWorker(ILogger logger)
        {
            _logger = logger;
        }

        protected override async Task ExecuteAsync(CancellationToken stoppingToken)
        {
            while (!stoppingToken.IsCancellationRequested)
            {
                _logger.LogInformation($"{nameof(ExecuteAsync)} running at: {DateTimeOffset.Now}");
                await Task.Delay(1000, stoppingToken);
            }
        }
    }
}

 

Crear el Host

Bien, una vez que ya tenemos nuestro worker creado, el cuál se ejecutará cada 1000 ms y agregará en el log una información, el siguiente paso será crear el host.

Dentro de la lógica de nuestro worker, éste escribirá información en el Visor de Eventos de Windows o Event Viewer porque así lo hemos querido.
Algo que no ocurrirá hasta que instanciemos el worker, y ésto sucederá a través del host.

Todo esto lo haremos dentro de la clase Program.

Los pasos generales que haremos a la hora de crear el host serán los de crear la configuración estándar y por defecto del host, configurar el log (en nuestro caso), configurar el servicio junto a nuestro worker, e indicarle que queremos hacerlo como Servicio Windows indicándoselo con UseWindowsService.

El código de nuestro host y de la clase Program completa, quedará de la siguiente forma:

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.EventLog;

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

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
            .ConfigureLogging(options => options.AddFilter(level => level >= LogLevel.Information))
            .ConfigureServices((hostContext, services) =>
            {
                services.AddHostedService()
                .Configure(config =>
                {
                    config.LogName = "MyService";
                    config.SourceName = "My Sample Service";
                });
            }).UseWindowsService();
    }
}

 

Compilar nuestro Servicio Windows

A continuación, pasaremos a compilar nuestro Servicio Windows.
La compilación debería ser correcta y no debería devolver ningún error.

Nota: en este caso, estoy compilando y desplegando nuestro servicio como Debug, aunque lo lógico sería hacerlo como Release.

 

Instalar el Servicio Windows

Para instalar nuestro Servicio Windows, voy a abrir una consola como administrador y voy a ponerme dentro de la ruta en la que se encuentra el fichero ejecutable de nuestro servicio.

Escribiré el siguiente comando:

sc create «MyService» binPath=c:\temp\MyFirstWindowsService\bin\Debug\netcoreapp3.1\MyFirstWindowsService.exe

Deberá aparecer en pantalla algo similar a:

[SC] CreateService SUCCESS

Si vamos a la consola msc de Servicios de Windows, veremos allí nuestro servicio, aunque por defecto, sin iniciarse.

Inicializaremos el servicio, el cuál debería iniciarse sin problemas.

Mientras el servicio esté en funcionamiento, cada 1 sg (1000 ms) deberá estar escribiendo en el visor de eventos de Windows un mensaje.
Como no queremos que esto se convierta en un bucle infinito, pararemos nuestro servicio después de varios segundos.

Iremos al visor de eventos, y veremos dentro del apartado Applications and Services Log información de nuestro servicio dentro del log MyService que así lo hemos llamado.

Finalmente, si queremos eliminar nuestro servicio, deberemos ejecutar el comando:

sc delete «MyService» binPath=c:\temp\MyFirstWindowsService\bin\Debug\netcoreapp3.1\MyFirstWindowsService.exe

Deberá aparecer en pantalla algo similar a:

[SC] DeleteService SUCCESS

Como podemos observar, desarrollar nuestros servicios de Windows en .NET Core 3.1 es realmente sencillo, ya sea utilizando una plantilla de Visual Studio 2019 directamente, o a mano desde una aplicación de consola o desde Visual Studio Code.

Happy Coding!

Comments

2 Responsesso far

  1. Andres dice:
    10 mayo, 2020 a las 7:11 pm

    Parece sencillo, lastima que no funcione..
    Estoy utilizando net core 3.1 y visual studio preview 3
    Para que compile he tendo que cambiar esto:
    services.AddHostedService();
    services.Configure(config =>
    {
    config.LogName = «MyService»;
    config.SourceName = «My Sample Service»;
    });
    Y al ejecutarlo da un error:
    System.InvalidOperationException: ‘Unable to resolve service for type ‘Microsoft.Extensions.Logging.ILogger’ while attempting to activate ‘MyFirstWindowsService.MyWorker’.’

    Un saludo

    Responder
  2. Dani Fernandez dice:
    18 agosto, 2020 a las 11:19 am

    Hola, buenas!.
    Gracias por el aporte. Añadir que necesitaba pasarle a un cliente el servicio y queria que fuera facil de instalar.
    Encontre esta pagina donde explica cómo se hace:

    https://www.3engine.net/wp/2015/10/como-crear-un-servicio-windows-net-autoinstalable/

    Saludos.

    Responder

Deja un comentario Cancelar respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

← Previous Post Next Post →

Jorge Serrano

MVP Reconnect


¡Subscríbete a mi canal!
YouTube

Donaciones
Donation

Entradas recientes

  • Go – Arrays
  • Go – Operators
  • Go – Constants
  • Go – Tipos de Datos
  • Go – Variables
  • Hello Go-rld!
  • Introducción a Go o Golang
  • JSON Patch en ASP.NET Core 5 Web API
  • Null Checking en C#
  • ¿Porqué mi página web por defecto de ASP.NET Core no se vé en mi Azure Web App y me da un 404?

Categorías

  • .NET 5
  • .NET Core
  • .NET Core 3.0
  • .NET Core 3.1
  • .NET Framework 2.0
  • .NET Framework 3.0
  • .NET Framework 3.5
  • .NET Framework 4.0
  • .NET Framework 4.5
  • .NET Framework 4.6
  • .NET Framework 4.7
  • .NET Framework 4.8
  • .NET Standard 2.0
  • .NET Standard 2.1
  • AMQP
  • Android
  • Angular
  • API REST
  • Apple
  • Apple iOS
  • Apple macOs
  • Arquitectura
  • ASP.NET
  • ASP.NET Core
  • ASP.NET Core 3
  • ASP.NET Core 5
  • AWS
  • Azure App Service
  • Azure Application Insights
  • Azure Cosmos DB
  • Azure Database Migration Service
  • Azure Databricks
  • Azure DevOps
  • Azure Event Grid
  • Azure Functions
  • Azure IoT
  • Azure Portal
  • Azure PowerShell
  • Azure Queue Storage
  • Azure SQL
  • Azure Storage
  • Azure Virtual Datacenter
  • Azure WebApps
  • Big Data
  • Bing
  • Blazor
  • Blog
  • Bots
  • C#
  • C# 7.0
  • C# 7.1
  • C# 7.2
  • C# 7.3
  • C# 8.0
  • C# 9.0
  • Channel 9
  • Codeplex
  • Codespaces
  • Containers
  • Debugging
  • DevOps
  • Docker
  • Electron
  • Entity Framework
  • Entity Framework Core
  • Entity Framework Core 3.0
  • Entity Framework Core 5
  • Eventos
  • F#
  • FaaS
  • FeatureFlags
  • FeatureToggles
  • Feeds
  • Fluent Assertions
  • General
  • GIMP
  • Git
  • GitHub
  • Go
  • Google
  • Google Analytics
  • Gradle
  • gRPC
  • GSA
  • Historia de la Informática
  • HoloLens
  • HtmlAgilityPack
  • IdentityServer4
  • Inkscape
  • Ionic
  • iOS
  • IoT
  • Java
  • JavaScript
  • JDBC
  • JSON
  • Kubernetes
  • Lenguajes de Programación
  • Libros y Cursos
  • LINQ
  • Linux
  • LiteDB
  • Machine Learning
  • macOS
  • Microservices
  • Microsoft
  • Microsoft .NET Framework 4.5
  • Microsoft 365
  • Microsoft Azure
  • Microsoft Build
  • Microsoft Ignite
  • Microsoft Learn
  • Microsoft Orleans
  • Microsoft Surface Go
  • Microsoft Teams
  • ML.NET
  • MQTT
  • MRO
  • MS-DOS
  • MsCoders Madrid
  • MVP
  • NancyFx
  • Node.js
  • NoSQL
  • NuGet
  • NUnit
  • OData
  • ODP.NET Core
  • Office 2007
  • Office 2010
  • Office 2013
  • Office 2016
  • Office 2019
  • Office 365
  • Open Source
  • Open XML SDK
  • Opinión
  • Orchard CMS
  • OT
  • PaaS
  • Patterns
  • PdfSharpCore
  • Performance
  • PHP
  • Postman
  • Power BI
  • PowerShell
  • PowerShell Core
  • Productividad
  • Project Server 2019
  • R
  • Rendimiento
  • Scala
  • Scraper
  • Security
  • Serverless
  • Service Fabric
  • SharePoint Server 2019
  • SignalR
  • Sin categoría
  • Sistemas Distribuidos
  • Skype
  • Skype for Business Server 2019
  • Small Basic Online
  • SQL Server 2005
  • SQL Server 2008
  • SQL Server 2012
  • SQL Server 2014
  • SQL Server 2016
  • SQL Server 2017
  • SQL Server 2019
  • STOMP
  • Swagger
  • Testing
  • TFS 2017
  • TFS 2018
  • Tools
  • TypeScript
  • Unity
  • UWP
  • UX
  • Visio
  • Visual Basic
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013
  • Visual Studio 2015
  • Visual Studio 2017
  • Visual Studio 2017 for Mac
  • Visual Studio 2019
  • Visual Studio 2019 for Mac
  • Visual Studio App Center
  • Visual Studio Code
  • Visual Studio IntelliCode
  • Visual Studio Live Share
  • Visual Studio Live Share Audio
  • Visual Studio Online
  • VS Anywhere
  • Vue.js
  • Web API
  • WebAssembly
  • WinDbg
  • Windows
  • Windows 10
  • Windows Compatibility Pack
  • Windows Phone 10
  • Windows Phone 7
  • Windows Phone 8
  • Windows Server 2008
  • Windows Server 2012
  • Windows Server 2016
  • Windows Server 2019
  • Windows Service
  • WinForms
  • WinUI
  • WPF
  • Xamarin
  • Xbox
  • Xcode
  • Xiaomi Mi Band 2
  • xUnit
  • YAML

Archivos

  • enero 2021
  • diciembre 2020
  • noviembre 2020
  • octubre 2020
  • septiembre 2020
  • agosto 2020
  • julio 2020
  • junio 2020
  • mayo 2020
  • abril 2020
  • marzo 2020
  • febrero 2020
  • enero 2020
  • diciembre 2019
  • noviembre 2019
  • octubre 2019
  • septiembre 2019
  • agosto 2019
  • julio 2019
  • junio 2019
  • mayo 2019
  • abril 2019
  • marzo 2019
  • febrero 2019
  • enero 2019
  • diciembre 2018
  • noviembre 2018
  • octubre 2018
  • septiembre 2018
  • agosto 2018
  • julio 2018
  • junio 2018
  • mayo 2018
  • abril 2018
  • marzo 2018
  • febrero 2018
  • enero 2018
  • diciembre 2017
  • noviembre 2017
  • octubre 2017
  • septiembre 2017
  • agosto 2017
  • julio 2017
  • junio 2017
  • febrero 2015
  • octubre 2014
  • junio 2014
  • marzo 2014
  • febrero 2014
  • enero 2014
  • diciembre 2013
  • septiembre 2013
  • agosto 2013
  • julio 2013
  • junio 2013
  • abril 2013
  • febrero 2013
  • enero 2013
  • diciembre 2012
  • noviembre 2012
  • septiembre 2012
  • agosto 2012
  • junio 2012
  • mayo 2012
  • abril 2012
  • marzo 2012
  • febrero 2012
  • enero 2012
  • diciembre 2011
  • noviembre 2011
  • octubre 2011
  • septiembre 2011
  • agosto 2011
  • julio 2011
  • junio 2011
  • mayo 2011
  • abril 2011
  • marzo 2011
  • enero 2011
  • diciembre 2010
  • noviembre 2010
  • octubre 2010
  • septiembre 2010
  • agosto 2010
  • julio 2010
  • junio 2010
  • mayo 2010
  • abril 2010
  • marzo 2010
  • febrero 2010
  • enero 2010
  • diciembre 2009
  • noviembre 2009
  • octubre 2009
  • septiembre 2009
  • agosto 2009
  • julio 2009
  • junio 2009
  • mayo 2009
  • abril 2009
  • marzo 2009
  • febrero 2009
  • enero 2009
  • diciembre 2008
  • noviembre 2008
  • octubre 2008
  • septiembre 2008
  • agosto 2008
  • julio 2008
  • junio 2008
  • mayo 2008
  • abril 2008
  • marzo 2008
  • febrero 2008
  • enero 2008
  • diciembre 2007
  • noviembre 2007
  • octubre 2007
  • septiembre 2007
  • agosto 2007
  • julio 2007
  • junio 2007
  • mayo 2007
  • abril 2007
  • marzo 2007
  • febrero 2007
  • enero 2007
  • diciembre 2006
  • noviembre 2006
  • octubre 2006
  • septiembre 2006
  • agosto 2006
  • julio 2006
  • junio 2006
  • mayo 2006
About This Site

A cras tincidunt, ut tellus et. Gravida scel ipsum sed iaculis, nunc non nam. Placerat sed phase llus, purus purus elit.

Archives Widget
  • January 2010
  • December 2009
  • November 2009
  • October 2009
Categories
  • Entertainment
  • Technology
  • Sports & Recreation
  • Jobs & Lifestyle
Search
  • twitter

Powered by WordPress  |  Business Directory by InkThemes.

This site uses cookies: Find out more.