Shulou(Shulou.com)06/02 Report--

This article focuses on "how to use Quartz in .NET". Interested friends may wish to take a look at it. The method introduced in this paper is simple, fast and practical. Let's let the editor take you to learn how to use Quartz in .NET.

I. background

For example, you need to update or synchronize some data in the database in a certain year or month, or execute a part of the code to call the interface at regular intervals, but you don't want to execute it manually.

For this kind of business can use "timing call task", there are many timing scheduling task framework, and even you can use timer to combine Windows service to do a simple version of the task scheduling program, here we learn Quartz, because Quartz is a powerful, open source, lightweight task scheduling framework to support cron-like expression and other excellent features.

II. Quartz

1. Basic concept

SchedulerTriggerJob Scheduler, an independent container trigger when quartz works, defines the time rules for scheduling tasks and containers for invoking specific actions to be performed by the task.

two。 Preliminary use

1.Nuget introduces QuartZ assemblies

two。 Create a Scheduler task scheduling container

3. Specify the task Job and trigger to be executed

4. Put policies and tasks into Scheduler and launch

Public class QuartzManager {public async static void Init () {StdSchedulerFactory factory = new StdSchedulerFactory (); / / create a Scheduler task scheduling container IScheduler scheduler = await factory.GetScheduler (); / / specify the specific task Job IJobDetail sendEmailJob = JobBuilder.Create () .WithIdentity ("sendEmailJob", "sendEmailJobGrop") .WithDescription ("scheduled email") .WithDescription () / / set the trigger condition to execute ITrigger sendEmailTrigger = TriggerBuilder.Create () .WithIdentity ("sendEmailTrigger", "sendEmailJobGrop" .WithDescription ("QuartZ") .WithCronSchedule ("3CronSchedule") .build () once in five seconds; / / put policies and tasks into Scheduler await scheduler.ScheduleJob (sendEmailJob, sendEmailTrigger) / / execute tasks await scheduler.Start ();}} / / add features to ensure that tasks do not overlap [DisallowConcurrentExecution] public class SendMailJob: IJob {/ / Job class public async Task Execute (IJobExecutionContext context) {await Task.Run () = > {/ / doSomthing Console.WriteLine ($"start sending email {DateTime.Now}");}) 3. Transfer parameters

Sometimes we want to need some parameters when Job is executed, and do some logical processing based on these parameters, so we need to use Quartz to pass parameters.

There are several main ways to transfer parameters in Quartz.

1.job parameter transfer

2.Trigger parameter transfer

1.job and Trigger parameter transfer

Use JobDataMap.Add to add parameters, and use context JobDataMap.GetString to get inside job

IJobDetail sendEmailJob = JobBuilder.Create (). Build (); / / pass a parameter sendEmailJob.JobDataMap.Add ("params", "job test parameter") to Job; ITrigger trigger = TriggerBuilder.Create (). Build (); / / pass a parameter trigger.JobDataMap.Add ("params", "trigger test parameter") to trigger) / / get the parameter public async Task Execute (IJobExecutionContext context) {await Task.Run (()) > {/ / get the job parameter string paramJob = context.JobDetail.JobDataMap.GetString ("params") in job; / / get the Trigger parameter string paramTrigger = context.Trigger.JobDataMap.GetString ("params"); / / doSomthing Console.WriteLine ($"start sending email {DateTime.Now}");}) Register listeners in scheduler

Listeners are objects created to perform operations on events that occur in the scheduler. There are three main types of listeners.

1. The scheduling listener ISchedulerListener is mainly used to monitor the scheduling process.

two。 The trigger listener ITriggerListener is mainly used to receive trigger-related event listeners.

3. The job listener IJobListener is used to receive listening for events related to the life cycle of Job runs.

1. Implement listeners

Take the job listener as an example, because triggering is implemented the same as scheduling listeners.

1. Custom job listeners need to inherit from the IJobListener interface and implement methods.

two。 Add a custom listener to the monitor management of the scheduler.

/ / implement listener public class CustomJobListener: IJobListener {public string Name = > "CustomJobListener";} / / add scheduler.ListenerManager.AddJobListener (new CustomJobListener ()) to listening management; 5. Visual management interface

Used by visualization tools to view information about currently running Job.

1. You need to create a new web project or console project.

two。 Introducing Quartz and CrystalQuartz.Remote packages into Nuget in the web project

3. Configure StdSchedulerFactory related information in Job scheduling to specify listening port

Var properties = new NameValueCollection (); properties ["quartz.scheduler.instanceName"] = "Test Monitor System"; / / set thread pool properties ["quartz.threadPool.type"] = "Quartz.Simpl.SimpleThreadPool, Quartz"; properties ["quartz.threadPool.threadCount"] = "5"; properties ["quartz.threadPool.threadPriority"] = "Normal"; / / remote output configuration properties ["quartz.scheduler.exporter.type"] = "Quartz.Simpl.RemotingSchedulerExporter, Quartz" Properties ["quartz.scheduler.exporter.port"] = "8081"; properties ["quartz.scheduler.exporter.bindName"] = "QuartzScheduler"; properties ["quartz.scheduler.exporter.channelType"] = "tcp"; var schedulerFactory = new StdSchedulerFactory (properties); IScheduler _ scheduler = await schedulerFactory.GetScheduler ()

The 4.web monitor accesses the CrystalQuartzPanel.axd under the unified port number to view it.

VI. Configuration file configuration task

In addition to defining various schedules and triggers for tasks in our code, we can also use xml configuration files to create Job tasks

1. Prepare the configuration file, configure Job+trigger-related information, and be sure to set the file property to "always copy"

True sendEmailJob Test MailJob This is Test MailJob DispatcherProject.Job.SendMailJob,DispatcherProject true false sendEmailTrigger sendEmailJobGrop sendEmailJob Test MailJob 5ax 3 *?

two。 Read configuration files, get information, and generate corresponding Job and Trigger

XMLSchedulingDataProcessor processor = new XMLSchedulingDataProcessor (new SimpleTypeLoadHelper ()); / / read the configuration file await processor.ProcessFileAndScheduleJobs ("~ / config/quartz.xml", scheduler); / / start the scheduling task await scheduler.Start (); now that you have a better understanding of "how Quartz is used in .NET", you might as well do it in practice! Here is the website, more related content can enter the relevant channels to inquire, follow us, continue to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.