seon99il

Spring

Quartz Scheduler 알아보기

3분 소요

java : 11 springBoot : 2.7.5

Part 1 : Quartz Scheduler 알아보기 Part 2 : Implementing Scheduler with Quartz Scheduler with SpringBoot Part 3 : Implement sending alerts at specific times per user with QuartzScheduler

Quartz Scheduler로 푸시 알림 서비스를 구현하면서 배운 내용을 시리즈로 정리하려 합니다.

이 글에서는 이론적인 내용과 환경 설정에 대해 설명합니다.

프로젝트를 진행하다 보면 일정한 주기나 사이클로 메서드를 실행해야 할 때가 있습니다. 대부분은 spring scheduler를 사용해 보셨을 것입니다.

저는 Quartz Job Scheduler를 사용해 단순하거나 복잡한 스케줄을 만들어 보겠습니다.

Quartz란?

Quartz는 Terracotta라는 회사에서 개발한 작업 스케줄링 라이브러리입니다. Quartz는 수십에서 수천 개의 작업을 실행할 수 있으며, 단순한 간격 형식이나 Cron 표현식으로 복잡한 스케줄링을 지원합니다. 예를 들어 매주 금요일 오전 1시 30분에 할 일, 매월 마지막 날에 할 일, 또는 특정 시간의 5분 전에 할 일을 지정할 수 있습니다.

장점과 단점

언제나 그렇듯 모든 기술에는 장단점이 있습니다.

장점

  1. DB 기반으로 스케줄러 간 클러스터링을 제공합니다.
  2. 시스템 Fail-over와 랜덤 부하 분산을 지원합니다.
  3. In-memory Job Scheduler를 제공합니다.
  4. ShutdownHookPlugin: JVM 종료 이벤트를 감지해 스케줄러에 종료를 알려 줍니다.
  5. LoggingJobHistoryPlugin: Job 실행에 대한 로그를 남겨 디버깅에 유용하게 쓸 수 있습니다.
  6. 동적 스케줄링이 가능합니다: 오늘 9시에 동작하던 작업을 코드 수정 없이 내일 10시에 동작하게 만들 수 있습니다.

단점

  1. 클러스터링 기능을 제공하지만 단순한 랜덤 방식이라 클러스터 간 로드 밸런싱이 완벽하지 않습니다.
  2. UI를 제공하지 않으므로 필요하다면 직접 구현해야 합니다.
  3. 스케줄링 실행 이력이 보관되지 않습니다.

Quartz 아키텍처와 구성 요소

Job

스케줄러가 실행해 주기를 원하는 컴포넌트가 구현해야 하는 인터페이스입니다.

@Slf4j
@Component
@PersistJobDataAfterExecution
@DisallowConcurrentExecution
public class SampleJob implements Job {

    @Autowired
    private TestRepository testRepository;

    @Override
    public void execute(JobExecutionContext context)
            throws JobExecutionException {
        System.out.println(this.getClass().getName() + "Sample Job Start! [ "
                            + LocalDate.now() + " ]");
    }
}

JobDataMap

JobDataMap은 Job 인스턴스가 실행될 때 사용할 수 있는 정보를 저장하는 객체입니다.

JobDetail

Job을 실행하기 위한 정보를 담고 있는 객체입니다. Job 이름, 그룹, JobDataMap 속성 등을 포함합니다.

public <T extends Job> JobDetail buildJobDetail(Class<? extends Job> job, SampleJobRequest request) {

        JobDataMap jobDataMap = new JobDataMap(); // job Data Map
        jobDataMap.put("executeCount", 1); // put Data

        return JobBuilder.newJob(job)
                .withIdentity(request.getJobName())
                .withDescription(request.getJobDescription())
                .usingJobData(jobDataMap)
                .build();
    }

Trigger

Quartz Scheduler의 핵심 객체라고 생각합니다. Trigger는 Job을 실행하기 위한 스케줄링 조건 (예: 반복 횟수, 시작 시간) 을 담고 있고, 스케줄러는 이 정보를 바탕으로 Job을 수행합니다.

Trigger와 Job의 관계

  • Trigger (1) : Job (1) 하나의 Trigger는 반드시 하나의 Job을 지정해야 합니다.
  • Trigger (N) : Job (1) 하나의 Job은 서로 다른 시간에 여러 번 실행될 수 있습니다.
  • Trigger (1) : Job (N) (X) 하나의 Trigger가 둘 이상의 Job을 가질 수는 없습니다.

Cron Trigger와 Simple Trigger

  • SimpleTrigger 특정 시간에 Job을 실행할 수 있습니다.
private Trigger buildTrigger() {
        SimpleTriggerFactoryBean triggerFactory = new SimpleTriggerFactoryBean();

        triggerFactory.setName("SimpleTriggerName");
        triggerFactory.setGroup("Group");
        triggerFactory.setStartTime(localTimeToDate(LocalTime.now().plusHours(2)));
        triggerFactory.setRepeatCount(0);
        triggerFactory.setRepeatInterval(0);

        triggerFactory.afterPropertiesSet();
        return triggerFactory.getObject();

    }
  • CronTrigger cron을 사용해 Trigger를 만듭니다. 더 복잡한 스케줄을 만들 수 있습니다 (예: 매월 1일 오후 2시부터 4시까지 몇 분마다 실행).
private Trigger buildCronTrigger() {
        CronTriggerFactoryBean CrontriggerFactory = new CronTriggerFactoryBean();
        CrontriggerFactory.setName("CronName");
        CrontriggerFactory.setGroup("Group");
        CrontriggerFactory.setCronExpression("2 * * * * *");
        CrontriggerFactory.setMisfireInstruction(SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW);

        try {
            CrontriggerFactory.afterPropertiesSet();
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return CrontriggerFactory.getObject();
    }

Misfire Instructions

Misfire는 작업 실행 실패를 의미합니다. 스케줄러가 종료되었거나 스레드 풀에 사용 가능한 스레드가 없을 때 발생합니다. 스케줄러가 Misfire된 Trigger를 처리하는 방식에 대해 여러 정책을 지원합니다.

  • MISFIRE_INSTRUCTION_FIRE_NOW
  • MISFIRE_INSTRUCTION_DO_NOTHING

Listener

Listener는 Quartz가 스케줄러의 이벤트를 받을 수 있도록 제공하는 인터페이스입니다.

  • JobListener Job이 시작되고 종료될 때 동작합니다.
  • TriggerListener Trigger가 발생하거나 실패했을 때, 또는 Trigger가 완료될 때 이벤트를 받을 수 있습니다.

JobStore

Job과 Trigger는 메모리나 DB에 저장할 수 있습니다.

Quartz 구성 요소

더 자세한 내용은 아래 링크를 참고해 주세요.

Quartz Scheduler Model - Java Articles

다음 글에서는 구현 방법을 설명하겠습니다.

코드는 제 GitHub에서 확인하실 수 있습니다.

GitHub - Seonggil-Jeong/QuartzScheduler-Sample

이전 글

전체 글 보기 →

댓글