I encountered Hangfire a while ago, and tried it out sometimes a year ago, but was not having time or need to properly address some job capabilities.
If you are reading me, it’s because your either looking at understanding what is Hangfire or how to address some of your needs.
Hangfire is about running some portion of your code as jobs away from your main (server/web) process. It also adds the capability to run this code as recurring (very convenient to put in place simple update/cleaning/reminder/mailing jobs).
The most important part you have to get when willing to run Hangfire job, is that you code has to be cable to give itself a proper context:
- no HttpContext.Current or similar objects: only what you give to your object at method calling time matters (this is what get serialized as Json on the Hangfire back-end).
- no complex object graph: if the class/service you are willing to instantiate has many dependencies (other objects inits or similar), please make sure everything is in proper order from the call you initiate with Hangfire OR let your object initialize itself properly.
- Bottom-line, be context friendly! if you have keys or ids to identify data you want to manipulate, pass on these values for serialization: simple to serialize and easier to maintain.
When digging into implementing Hangfire, you’ll see by yourself going over the documentation that almost all you need has been thought through.
As per writing some code using Hangfire, here a re a few hints:
- You can only add Hangfire.Core Nuget package to a given project if you only intend to add jobs from it (less is better)
- When willing to use an IOC container, make sure your use the proper Enqueue prototype; if you don’t, Hangfire will simply store the actual type (not the interface) that was used at Job enqueuing time, which might work at first, but won’t switch to your new type if you change your interface implementation in your ioc container:
BackgroundJob.Enqueue(x => x.MyInerfaceMethod(param1, param2, param3));
- If you are planning to run the Hangfire server part in an ASP.NET app, don’t forget to have it running all the time! Hangfire does not auto-start the web app because it’s there 🙂
- As you can access multiple queues when building with Hangfire, don’t forget to assign Hangfire processing servers to different queues.
Thanks for reading, happy coding!