Criar serviços Windows pode ser uma tarefa complicada. Depurar problemas pode ser difícil e o deploy costuma ser uma dor de cabeça. Topshelf simplifica todas essas atividades.

Por que criar um serviço Windows?

Quando desejamos que nossa aplicação seja executada em background, de maneira contínua, sem se preocupar com qual usuário está logado ou mesmo correr o risco de alguém acidentalmente fechá-la, uma boa solução é criar essa aplicação como um serviço do windows.

Serviços Windows podem iniciar automaticamente no boot da máquina. Além disso, é possível definir políticas de recuperação caso ocorram problemas.

O que é o Topshelf?

Topshelf é um framework opensource que facilita o desenvolvimento de serviços Windows.

Com o Topshelf, podemos desenvolver e depurar serviços Windows com a mesma facilidade com que desenvolvemos e depuramos uma Console Application. Além disso, ele também simplifica o deploy.

Sem o Topshelp, precisaríamos nos preocupar com a utilização de utilitários para instalar serviços e fazer attachment do debugger para fazer depuração.

Passo-a-passo para criação de um serviço windows com Topshelf

Criação

A maneira mais fácil de criar um serviço Windows, usando Topshelf, é começar criando uma Console Application. Em seguida, basta adicionar o pacote Topshelf como referência Nuget.

Abaixo indicamos como modificar o programa para, usando o Topshelf, configurar nosso serviço.

static void Main(string[] args)
{
    HostFactory.Run(config =>
    {
        config.Service<Bootstrap>(service =>
        {
            service.ConstructUsing(s => new Bootstrap());
            service.WhenStarted(s => s.Start());
            service.WhenStopped(s => s.Stop());
        });
        config.RunAsLocalSystem();
        config.SetServiceName("MyService");
        config.SetDisplayName("My Service");
        config.SetDescription("Example of service develped using Topshelf");
        config.StartAutomatically();
    });
}

No código acima, verificamos a configuração básica do serviço Windows que estamos desenvolvendo. Especificamos um nome e uma descrição para o serviço. Também indicamos que o serviço deve iniciar automaticamente (junto com o sistema operacional). Finalmente, indicamos que rotinas devem ser executadas em nosso serviço quando o mesmo for iniciado e encerrado.

A documentação oficial é bem escrita e fácil de entender. Recomendamos fortemente que, utilizando o Topshelf, estude um pouco como o mesmo funciona.

Abaixo, compartilhamos a classe de configuração (Bootstrap) que estamos usando nesse exemplo. Como pode ver, nesse exemplo, não estamos iniciando quaisquer operações.

class Bootstrap
{
    public void Start()
    {
        //do something...
    }

    public void Stop()
    {
        //dispose...
    }
}

Depuração

O debugging funciona exatamente como em uma Console Application normal. Ou seja, basta adicionar os breakpoints que desejamos verificar e rodar a aplicação.

Distribuição (Deploy)

Para que a aplicação funcione como um serviço, é necessário que esta seja instalada no Windows Service Control Manager.

Aplicações desenvolvidas com Topshelf são instaladas facilmente, via linha de comando, com permissões adequadas (por padrão, você precisará ter permissões de administração), passando o parâmetro install para a aplicação.

> SeuServico.exe install

Topshelf irá se responsabilizar por fazer todos os ajustes necessários.

Conclusão

A criação de um Windows Service pode ser uma boa solução para serviços que precisam funcionar de maneira ininterrupta, como por exemplo um servidor de aplicação, um serviço de FTP, um conversor de arquivos, etc.

O Topshelf pode diminuir consideravelmente a complexidade de criação e manutenção de um serviço Windows, o que é muito bom. Afinal, complexidade é custo!