Open Closed

Hangfire enqueue into custom Hangfire server queue #431


User avatar
0
joe@tronactive.com created
  • ABP Framework version: v3.10
  • UI type: Angular
  • Tiered (MVC) or Identity Server Seperated (Angular): yes

I have been trying to figure out with ABPs Background system how to enqueue to a custom hangfire queue. WIth using just the basic hangfire api I just put an attribute above the method I am calling in the enqueue method [Queue("CustomQueue")] but that does not work with ABPs hangfire version. Is there anyway to get it to enqueue to my custom queue besides the default queue?


8 Answer(s)
  • User Avatar
    0
    liangshiwei created
    Support Team Fullstack Developer

    Hi,

    First , create a filter:

    public class MyJobFilterAttribute : JobFilterAttribute, IElectStateFilter
    {
        public void OnStateElection(ElectStateContext context)
        {
            if (context.CandidateState is EnqueuedState enqueuedState)
            {
                enqueuedState.Queue = "myqueue";
            }
        }
    }
    

    Add the following configuration to your module:

    Configure<AbpHangfireOptions>(options =>
    {
        options.ServerOptions = new BackgroundJobServerOptions()
        {
            Queues = new[] {"default", "myqueue"}
        };
    });
    
    
    context.Services.AddHangfire(options =>
    {
        //options.UseMemoryStorage();
        options.UseFilter(new MyJobFilterAttribute());
    });
    

    Now, your all job will enqueue to the myqueue queue and you can custom if you need.

  • User Avatar
    0
    joe@tronactive.com created

    Thank you for the help. What method would this attribute go above then? Would it be the one that does the work? or above the Execute method in the below job class?

    ` public class RenderChartJob : BackgroundJob

        public RenderChartJob(IChartsAppService chartsAppService)
        {
            _chartsAppService = chartsAppService;
        }
    
        public override void Execute(RenderChartsJobArgs args)
        {
            args.Subject = "Job Scheduled to Render Chart to PDF";
            args.Body = $"Job rendering chart successful. ";
    
    
            try
            {
                //Pass in Render chart input and render chart to PDF
               _chartsAppService.RenderChartToPdf(args.RenderChartInput);
                
                //We will not be rescheduling this since it is a one time execution
                args.Body = $"{DateTime.UtcNow}: {args.Body}";
                emailSender.Send(args.FromEmail, args.ToEmail, args.Subject, args.Body);
    
            }
            catch (Exception e)
            {
                throw new Exception(e.StackTrace);
            }
        }
    }`
    
  • User Avatar
    0
    liangshiwei created
    Support Team Fullstack Developer

    The filter will work on global. you don't need add attribute to method.

  • User Avatar
    0
    joe@tronactive.com created

    Sorry I should have explained it better. I want to create multiple Queues. This only works with just one.

  • User Avatar
    0
    liangshiwei created
    Support Team Fullstack Developer

    Hi, you can custom the code if you need.

    public class MyJobFilterAttribute : JobFilterAttribute, IElectStateFilter
    {
        public void OnStateElection(ElectStateContext context)
        {
            if (context.CandidateState is EnqueuedState enqueuedState)
            {
                // you can custom if iyou need.
                enqueuedState.Queue = "myqueue";
            }
        }
    }
    
  • User Avatar
    0
    joe@tronactive.com created

    I understand I can, I guess I am just having a hard time how to. Thanks though

  • User Avatar
    0
    liangshiwei created
    Support Team Fullstack Developer

    Okey, I will give you a usable example

  • User Avatar
    0
    liangshiwei created
    Support Team Fullstack Developer

    See https://github.com/realLiangshiwei/AbpQa431

    In the way, you can customize the queue of all jobs

Made with ❤️ on ABP v9.0.0-preview. Updated on October 07, 2024, 08:52