Building a Background Task Scheduler in ASP.NET Core: Step-by-Step Guide

-

Introduction:

In many web applications, there arises a need to perform certain tasks in the background at regular intervals, such as sending emails, updating caches, or fetching data from external sources. ASP.NET Core provides a easy way to achieve this through hosted services. In this blog, will walk through the process of creating a simple background task scheduler using ASP.NET Core's hosted services feature.

Step 1: Creating a New ASP.NET Core Web Application

Launch Visual Studio. Click on "Create a new project". In the "Create a new project" window, select "ASP.NET Core Web Application" and click Next. Project Name: Enter SampleBackgroundService. Location: Choose a location to save your project. Click Next.

Step 2: Creating the Background Service

Create a new class named MyBackgroundService.cs in your project and implement the background task logic. This class should inherit from BackgroundService and override the ExecuteAsync method.

namespace SampleBackgroundService.BackgroundTaskExample
{
    public class MyBackgroundService : BackgroundService
    {
        private readonly ILogger<MyBackgroundService> _logger;

        public MyBackgroundService(ILogger<MyBackgroundService> logger)
        {
            _logger = logger;
        }

        protected override async Task ExecuteAsync(CancellationToken stoppingToken)
        {
            while (!stoppingToken.IsCancellationRequested)
            {
                _logger.LogInformation("Background task is running at: {time}", DateTimeOffset.Now);
                await Task.Delay(TimeSpan.FromSeconds(10), stoppingToken); // Change the delay as needed
            }
        }
    }
}

Step 3: Configuring the Background Service

In the Program.cs file, add the background service to the service container by calling AddHostedService<MyBackgroundService>() in the ConfigureServices method.

builder.Services.AddHostedService<MyBackgroundService>();

Step 5: Running the Application

Finally, run your ASP.NET Core application. You should see the log messages from the background task appearing in the console at regular intervals.

Conclusion:

In this tutorial, you've learned how to create a simple background task scheduler in ASP.NET Core using hosted services. This approach provides a easy and efficient way to run background tasks in web applications, ensuring that critical processes can be executed asynchronously without affecting the responsiveness of the application. With the knowledge gained from this guide, you can extend the functionality of your ASP.NET Core applications by incorporating various background tasks tailored to your specific requirements.

Comments

Post a Comment

Popular posts from this blog

Entity Framework Core (EF) with SQL Server LocalDB

-
Image
This blog is going to illustrate how to implement Entity Framework (EF) Core with SQL Server LocalDB. The Entity Framework Core enables access to data from the database. This allows developers to avoid having to write most of the data access code. And the SQL Server LocalDB works similarly to the SQL SERVER with few features. You can get the LocalDB when you install visual studio or visual studio express. You can find the .mdf and _log.ldf files in the C:/Users/{user} directory. Let see how to create a SQL Server LocalDB and implement Entity Framework Core Step 1: The first step is to add a connection. In the menu -> click Tools and select Connect to Database It will display the Add Connection window. Enter (localdb)\mssqllocaldb in the server name textbox. Then in the Select or enter a database, select master and click ok Now in the server explorer, you can find the master DB containing Tables, Views, Stored...
Read more

SignalR with JavaScript in ASP.NET Core MVC

-
Image
This blog is going to explain what is SignalR and how to implement it in ASP.NET Core. SignalR is a real time application framework for ASP.NET Core. Using SignalR you can provide updated information without refreshing the page, for example poll results, game score, chat etc. Let's see how to achieve it in ASP.NET Core MVC. Step 1: First step I added the SignalR client library. To add a SignalR client library, Right click on the project in Solution Explorer and Add -> Client-Side Library. Select the provider as unpkg as shown in the image below. Enter the latest version of SignalR into the library. And selected signalr.js and signalr.min.js files. Finally clicked the install button to install the client library. Step 2: At this step I have created a VoteHub.cs class inside the Hubs folder(create a new folder called Hubs). This class inherits from the Hub class which is a base class of SignalR hub. The SendMessage method will be called by the connected client. ...
Read more

Localization in ASP.NET Core MVC with Example

-
Image
Using Query Strings for Request Culture and Simplifying Localization with IStringLocalizer Interface Let’s see how to implement Localization in ASP.NET Core MVC. In the first example, I am going to use the IStringLocalizer Interface in the controller to implement Localization. Additionally, when the user passes the desired language through the query string, it will display content in that language. First, let’s configure the settings in the program.cs file. builder.Services.AddLocalization(options => options.ResourcesPath = "Resources");  The AddLocalization method adds the localization service to the service container. I have added the supported cultures here. I have added two cultures: en for English and nl for Dutch. In the RequestCultureProviders , I have included QueryStringRequestCultureProvider() . This allows the system to determine the culture information from the query string. UseRequestLocalization initializes a RequestLocalizationOptions o...
Read more