En la empresa en la que trabajo actualmente han surgido una serie de nuevos proyecto en la que parte de la solución pasa por la creación de Servicios Windows que ejecuten tareas de forma automática y sistemática (sin la intervención de un usuario). Debido a esto me han pedido que cree una proyecto plantilla que sirva como punto de inicio de cada proyecto especifico.

Las premisas de la plantilla eran las siguientes:

  1. Que se pueda depurar haciendo F5 en Visual Studio
  2. Que sea fácil de instalar
  3. Que tenga incorporado un logger para “trazar” la aplicación.
Aunque todas estas premisas son tareas comunes cuando desarrollas un servicio el tema de implementarlas en un servicio base se debe a la necesidad de que todos los servicios que se creen partiendo de esta "Plantilla" tengan esta funcionalidad implementada de la misma forma.

Que se pueda depurar haciendo F5 en Visual Studio

Aunque hay varias formas de depurar un servicio de Windows (tal y como se describe en MSDN) seguro que todo desarrollador agradecería que con un simple F5 se pueda entrar en modo depuración del servicio.

Para resolver este punto, y entendiendo que el código que se quiere depurar es el que se encuentra dentro del método OnStart() del servicio. Podríamos modificar el método Main que te crea la plantilla por defecto que viene con VisualStudio ( al hacer File –> New Project –> Windows Service ) para que acepte un arreglo de string como parámetro y en función del valor del parámetro crear una instancia de la clase del servicio y llamar al metodo OnStart().

using System.ServiceProcess;
using System.Threading;

namespace WindowsService1
{
    static class Program
    {
        /// 
        /// The main entry point for the application.
        /// 
        static void Main(string[] args)
        {
            if (args[0] == "D" || args[0] == "-D")
            {
                var service = new Service1();
                service.OnStart(null);

                do
                {
                    Thread.Sleep(1000);
                } while (true);
            }
            else
            {
                ServiceBase[] ServicesToRun;
                ServicesToRun = new ServiceBase[]
                                    {
                                        new Service1()
                                    };
                ServiceBase.Run(ServicesToRun);
            }
        }
    }
}

En este punto nos encontramos con un problema y es que el método OnStart() es un método protegido por lo que solo se puede llamar desde la clase en la que esta definido o en las que deriven de esta. Así que una solución podría ser pasar el punto de entrada de la aplicación (Método MAIN) a nuestra case Service1 y eliminar el archivo Program.cs. A continuación se muestra como va quedando la clase.

using System.ServiceProcess;
using System.Threading;

namespace WindowsService1
{
    public partial class Service1 : ServiceBase
    {
        public Service1()
        {
            InitializeComponent();
        }

        protected override void OnStart(string[] args)
        {
        }

        protected override void OnStop()
        {
        }

        static void Main(string[] args)
        {
            if (args[0] == "D" || args[0] == "-D")
            {
                var service = new Service1();
                service.OnStart(null);

                do
                {
                    Thread.Sleep(1000);
                } while (true);
            }
            else
            {
                ServiceBase[] ServicesToRun;
                ServicesToRun = new ServiceBase[]
                                    {
                                        new Service1()
                                    };
                ServiceBase.Run(ServicesToRun);
            }
        }
    }
}

En este punto solo nos queda pasarle este parámetro a método Main a presionar la tecla F5 estando en VisualStudio. Esto es realmente sencillo, para ello haremos click derecho –> Propiedades sobre el proyecto de Servicio. y dentro del Tab “Debug” nos vamos a la opción “Start Options” y dentro de esta buscamos la caja de texto “Command line arguments” y escribimos –D

Properties_Debug

y con esto ya podemos depurar pulsando la tecla F5 desde Visual Studio.

Que sea facil de instalar

Para instalar un servicio podemos hacerlo utilizando las herramientas habituales: Proyecto de Instalación de VisualeStudio, herramienta de instalación InstallUtil.exe, InstallShield etc. Pero en esta ocasión y siendo consecuentes con la solución anterior queremos que el servicio se instale y desinstale pasándole parámetros (-I, -U)

Para lograr esto hemos utilizado la plataforma P/Invoke y las APIs para win32.

Una herramienta de mucha utilidad siempre se trabaje con win32 y pinvoke es la wiki desarrollada por redgate (pinvoke.net).

A continuación el código de la clase que utilizamos para instalar y desinstalar el servicio.

using System;
using System.Runtime.InteropServices;

namespace WindowsService
{
    class ServiceInstaller
    {
        [DllImport("advapi32.dll")]
        public static extern IntPtr OpenSCManager(string lpMachineName,string lpScdb, int scParameter);

        [DllImport("Advapi32.dll")]
        public static extern IntPtr CreateService(IntPtr scHandle,string lpSvcName,string lpDisplayName, int dwDesiredAccess,int dwServiceType,int dwStartType,int dwErrorControl,string lpPathName, string lpLoadOrderGroup,int lpdwTagId,string lpDependencies,string lpServiceStartName,string lpPassword);

        [DllImport("advapi32.dll")]
        public static extern IntPtr CloseServiceHandle(IntPtr schandle);

        [DllImport("advapi32.dll")]
        public static extern IntPtr StartService(IntPtr svhandle, int dwNumServiceArgs, string lpServiceArgVectors);
  
        [DllImport("advapi32.dll",SetLastError=true)]
        public static extern IntPtr OpenService(IntPtr schandle,string lpSvcName,int dwNumServiceArgs);

        [DllImport("advapi32.dll")]
        public static extern IntPtr DeleteService(IntPtr svhandle);
 
        [DllImport("kernel32.dll")]
        public static extern int GetLastError();
  
        public void Install(string servicePath, string serviceName, string serviceDisplayName)
        {
            int SC_MANAGER_CREATE_SERVICE = 0x0002;
            int SERVICE_WIN32_OWN_PROCESS = 0x00000010;
            //int SERVICE_AUTO_START                = 0x00000002;
            int SERVICE_DEMAND_START = 0x00000003;
            int SERVICE_ERROR_NORMAL = 0x00000001;

            int STANDARD_RIGHTS_REQUIRED = 0xF0000;
            int SERVICE_QUERY_CONFIG = 0x0001;
            int SERVICE_CHANGE_CONFIG = 0x0002;
            int SERVICE_QUERY_STATUS = 0x0004;
            int SERVICE_ENUMERATE_DEPENDENTS = 0x0008;
            int SERVICE_START = 0x0010;
            int SERVICE_STOP = 0x0020;
            int SERVICE_PAUSE_CONTINUE = 0x0040;
            int SERVICE_INTERROGATE = 0x0080;
            int SERVICE_USER_DEFINED_CONTROL = 0x0100;

            int SERVICE_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED |
                SERVICE_QUERY_CONFIG |
                SERVICE_CHANGE_CONFIG |
                SERVICE_QUERY_STATUS |
                SERVICE_ENUMERATE_DEPENDENTS |
                SERVICE_START |
                SERVICE_STOP |
                SERVICE_PAUSE_CONTINUE |
                SERVICE_INTERROGATE |
                SERVICE_USER_DEFINED_CONTROL);

            IntPtr iptSCMHandle = OpenSCManager(null, null, SC_MANAGER_CREATE_SERVICE);

            if (iptSCMHandle == IntPtr.Zero)
            {
                throw new CustomServiceException(GetLastError());
            }

            IntPtr iptSVCHandle = CreateService(iptSCMHandle,
                                                serviceName,
                                                serviceDisplayName,
                                                SERVICE_ALL_ACCESS,
                                                SERVICE_WIN32_OWN_PROCESS,
                                                SERVICE_DEMAND_START,
                                                SERVICE_ERROR_NORMAL,
                                                servicePath,
                                                null, 0, null,
                                                null, null);

            if (iptSVCHandle == IntPtr.Zero)
            {
                throw new CustomServiceException(GetLastError());
            }

            if (CloseServiceHandle(iptSVCHandle) == IntPtr.Zero)
            {
                throw new CustomServiceException(GetLastError());
            }
        }

        public void Uninstall(string serviceName)
        {
            int GENERIC_WRITE = 0x40000000;
            int DELETE = 0x10000;
            IntPtr iptSCMHandle;
            IntPtr iptSVCHandle;

            iptSCMHandle = OpenSCManager(null, null, GENERIC_WRITE);

            if (iptSCMHandle == IntPtr.Zero)
            {
                throw new CustomServiceException(GetLastError());
            }

            iptSVCHandle = OpenService(iptSCMHandle, serviceName, DELETE);
            if (iptSVCHandle == IntPtr.Zero)
            {
                throw new CustomServiceException(GetLastError());
            }

            if (DeleteService(iptSVCHandle) == IntPtr.Zero)
            {
                throw new CustomServiceException(GetLastError());
            }

            if (CloseServiceHandle(iptSCMHandle) == IntPtr.Zero)
            {
                throw new CustomServiceException(GetLastError());
            }
        }
        
    }
}

Con esto logramos instalar y desinstalar el servicio por líneas de comando.

Command Prompt

Que tenga incorporado un logger para “trazar” la aplicación.

Debido a la amplia variedad de productos que existen para implementar trazas en una aplicación. A continuación enumero algunas de las que he utilizado y creo son las mas populares.

  1. Log4net
  2. NLog
  3. Enterprise Libraries

y debido al hecho de que este es un servicio plantilla. La implementación del sistema de trazas no debería estar acoplado al servicio. Para esto hemos creado un contrato (interface ILogger) la cual provee al servicio de una capa de abstracción de la implementación real, con el objetivo de poder cambiarla cada vez que se desee. En este caso en particular y debido al amplio uso de las Enterprise Libraries  dentro de mi empresa, la implementación concreta del logger esta basada en este producto.

Aquí dejo el código fuente completo del Servicio .


 |