Pular para o conteúdo principal

Hangfire - processamento em background fácil no .NET

A necessidade de realizar uma tarefa em segundo plano é muito comum, seja para gravar um arquivo, enviar um e-mail, executar um processo de banco pesado, enfim, qualquer coisa que não deve "bloquear" o usuário no thread principal, e é aí que o Hangfire entra, ele recebe tarefas e as trata em filas realizando a execução em background e mais:

  • As tarefas entram em uma fila e a execução ocorre na sequência;
  • Uma execução só é considerada "falha" quando as tentativas já se esgotaram (por padrão são 10);
  • Dá para criar uma tarefa simplesmente a colocando na fila;
  • Dá para criar um fluxo de execução de tarefas constante dentro de um intervalo;
  • Dá para agendar a execução de tarefas;
  • Dá para condicionar a execução de tarefas após o sucesso de outra tarefa;
  • Todo o fluxo é tratado em tabelas do próprio Hangfire, podendo ser gerido em vários bancos de dados (relacionais ou não);
  • Os registros referentes as tarefas possuem um tempo limitado de vida, depois de concluidos são apagados (por padrão 1 dia);
  • É disponibilizado um dashboard para acompanhar as tarefas;

Instalação

Para esse post será criada uma aplicação web, uma API padrão sem funcionalidades, e o Hangfire vai usar o SqlServer para suas tabelas, então para nosso caso precisaremos dos seguintes pacotes:

Configuração

Em resumo precisamos apenas alterar o Startup, configurando, adicionando e usando o HangFire:

Em "ConfigureServices":

            services.ConfigureHangfire(HostingEnvironment, Configuration);

            services.AddHangfireServer();

Em "Configure":

            app.UseHangfireDashboard();

            new HangfireExamples().StartExamples();

Execução única (assim que possível)

Esse recurso permite que uma tarefa seja incluida na fila sendo executada assim que possível, se a fila estiver vazia ela é executada de imediato, no exemplo abaixo executaremos o método "FireAnfForgetExample":

BackgroundJob.Enqueue(() => FireAnfForgetExample(null));

Execução recorrente

Aqui temos a capacidade de programar uma tarefa para ser executada de tempos em tempos, no exemplo abaixo executaremos o método "RecurringJobExample" de minuto em minuto:

RecurringJob.AddOrUpdate(() => RecurringJobExample(null), Cron.Minutely);

Execução agendada

Caso a necessidade seja a de agendar uma execução futura podemos fazer com o exemplo abaixo, onde o método "DelayedJobExample" é executado em uma semana:

BackgroundJob.Schedule(() => DelayedJobExample(null), TimeSpan.FromDays(7));

Execução contínua

Esse último recurso nos permite condicionar a execução de uma terefa ao sucesso de uma outra, para isso primeiro precisamos pegar o ID da tarefa "principal" e informa-lo para a tarefa "condicional", no exemplo abaixo executamos o método "ContinuationTaskFirst" e caso ele seja concluido com sucesso o método "ContinuationTaskSecond" será executado:

var jobId = BackgroundJob.Enqueue(() => ContinuationTaskFirst(null));

BackgroundJob.ContinueJobWith(jobId, () => ContinuationTaskSecond(null));

Dashboard

Como mencionado o Hangfire fornece uma aplicação web que nos permite acompanhar toda movimentação, basta acessar "url_site/hangfire":

  • Painel de monitoramento com gráficos em tempo real e histórico:
  • Página de Tarefas para consultar "Enfileiradas", "Agendadas", "Processando", "Concluido", "Em falha", "Removidas" e "Aguardando";
  • Página de Retentativas para ver o que ainda não deu certo de ser executado;
  • Página de Tarefas recorrentes para ver o que está configurado como "recorrente";
  • Página de Servidores para ver onde o Hangfire esta rodando;

Conclusão

O Hangfire é uma forma bem poderosa e simples de se trabalhar com filas de execução em segundo plano, fornecendo inclusive uma série de ferramentas para acompanhamento desse trabalho, é sem dúvidas uma das maneiras mais simples de tratar essa questão.

Projeto de exemplo

Fonte

Marcadores:

Comentários

Postar um comentário

Obrigado por Participar do programero, fique a vontade para agradecer, retificar, perguntar ou sugerir.

Mais visitadas

Aplicação Flask usando Nginx e Gunicorn

Aplicação Flask usando Nginx e Gunicorn Se você já desenvolveu uma aplicação Flask básica, sabe que o servidor de desenvolvimento embutido não é ideal para produção. Ele não é projetado para lidar com altos volumes de tráfego ou conexões simultâneas. Para tornar sua aplicação Flask mais robusta e pronta para produção, podemos usar o Gunicorn como servidor de aplicação e o Nginx como proxy reverso. Neste artigo, vamos adaptar o exemplo anterior ( Criando uma Aplicação CRUD com Flask, PostgreSQL e Docker ) para incluir o Nginx e o Gunicorn. O que são Nginx e Gunicorn? Gunicorn O Gunicorn (Green Unicorn) é um servidor de aplicação WSGI que roda aplicações Python como o Flask. Ele é eficiente e simples de configurar, lidando com múltiplas requisições ao mesmo tempo, algo que o servidor embutido do Flask não faz bem. Nginx O Nginx é um servidor web que atua como um proxy reverso. Ele recebe requisições HTTP e as encaminha ao Gunicorn. Além disso, o Nginx pode: Servir arquivos ...
Postar um comentário
Leia mais

Criando uma Aplicação CRUD com Flask, PostgreSQL e Docker

Criando uma Aplicação CRUD com Flask, PostgreSQL e Docker Neste guia, vamos criar uma aplicação básica que acessa um banco de dados PostgreSQL e realiza operações CRUD (Create, Read, Update, Delete). Vamos usar Flask e executar tudo com Docker. Sem estilos ou extras, apenas o essencial. Estrutura do Projeto crud-app/ |-- app/ | |-- app.py | |-- templates/ | | |-- index.html | | |-- edit.html |-- Dockerfile |-- requirements.txt |-- docker-compose.yml Passo 1: Dependências Crie um arquivo requirements.txt com as seguintes linhas: Flask==2.2.2 Flask-SQLAlchemy==3.0.2 psycopg2-binary==2.9.3 Werkzeug==2.2.2 Passo 2: Aplicação Flask Arquivo app/app.py : from flask import Flask, render_template, request, redirect, url_for from flask_sqlalchemy import SQLAlchemy app = Flask(__name__) # Configuração do banco de dados app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:password@db:5432/crud_db' app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False db...
Postar um comentário
Leia mais

Criando sua Primeira Aplicação Web com Python e Docker

  Criando sua Primeira Aplicação Web com Python e Docker Hoje vamos fazer algo prático: criar uma aplicação web simples em Python usando Flask e executá-la dentro de um contêiner Docker. Se você não sabe exatamente o que é Docker ou Flask, não se preocupe! Vou explicar tudo de forma simples para que você consiga acompanhar sem problemas. O que é Docker? Docker é uma ferramenta que permite empacotar aplicações e suas dependências em contêineres, garantindo que elas funcionem da mesma forma em qualquer ambiente. Em outras palavras, com o Docker, você cria um ambiente isolado e padronizado para rodar suas aplicações. Como instalar o Docker Acesse o site oficial do Docker . Baixe e instale a versão apropriada para o seu sistema operacional (Windows, macOS ou Linux). Após a instalação, verifique se está tudo funcionando abrindo um terminal e executando: docker --version Se o Docker estiver instalado corretamente, ele vai exibir a versão instalada. O que é Flask? Flask é um m...
Postar um comentário
Leia mais