[Spring] Quartz 스케줄러 등록/ SchedulerFactoryBean

🚀 SchedulerFactoryBean 을 통한 Quartz 스케줄러 등록

 

🚀 SchedulerFactoryBean 이란?

Quartz org.quartz.Scheduler 를 생성 및 설정하고, 스프링 애플리케이션 컨텍스트의 일부로 라이프사이클을 관리하며, 종속성 주입을 위한 빈 참조로 스케줄러를 노출하는 FactoryBean. 작업 세부 정보, 캘린더 및 트리거를 등록할 수 있으며, 초기화 시 스케줄러를 자동으로 시작하고 파괴 시 종료할 수 있습니다.

> 즉, 생성 하면 스프링이 알아서 관리해준다! 

"스프링의 IoC 컨테이너에 의해 빈으로 생성되면, 스프링이 해당 빈의 라이프사이클을 관리하므로 개발자는 스케줄러의 생성, 초기화, 시작, 종료 등의 작업을 수동으로 처리할 필요가 없습니다."

IoC 컨테이너의 종류

스프링에서는 여러 가지 IoC 컨테이너를 제공하며, 일반적으로 ApplicationContext 를 가장 많이 사용

IoC 컨테이너설명

 

BeanFactory	가장 기본적인 IoC 컨테이너로, 지연 초기화(lazy loading) 방식으로 객체를 생성함.
ApplicationContext	BeanFactory를 확장한 컨테이너로, 부가적인 기능 (AOP, 트랜잭션, 메시지소스 등) 을 지원함.
WebApplicationContext	웹 애플리케이션 환경에서 사용되는 IoC 컨테이너.

 

 

🔹 SchedulerFactoryBean과 IoC 컨테이너의 관계

💡 SchedulerFactoryBean은 ApplicationContext에 의해 관리되는 하나의 빈(Bean) 입니다.
즉, 스프링 IoC 컨테이너가 SchedulerFactoryBean의 생명주기를 자동으로 관리하므로, 개발자가 직접 Scheduler 객체를 생성하고 종료할 필요 없이 스프링이 알아서 생성하고 소멸시켜 줍니다.

 

 

Quartz 를 통한 스케줄러 설정 방법 기록 했으며 실제 업무에 사용되는 실행 로직은(Job) 원하는 기능을 별도의 클래스파일에 구현하면됨. ➡️ 스케줄러가 실행할 로직

여기서는 Myjob.class로 나오며, 포스팅의 목적이 스케줄러 등록이므로 서비스 로직(ex_쿠폰 누락 확인 기능 등)은 생략하였습니다.

 

 

1. pom.xml 의존성 주입

<!-- quartz -->
<dependency>
	<groupId>org.quartz-scheduler</groupId>
	<artifactId>quartz</artifactId>
	<version>2.3.0</version>
</dependency>

 

 

2. Quartz 스케줄러 등록

예제 파일 : TestQuartzConfiguration.java

Quartz 스케줄러를 3가지 요소로 구성해보면 Scheduler & 실행내용인 Job & Job을 실행할 Trigger 이다.

( Job 클래스 구현 → JobDetail 빈 등록 → Trigger 빈 등록 → Scheduler 빈에 Trigger 등록 )

스케줄러를 빈으로 등록 할 때 자바 기반으로 설정해주었다. Spring의 @Configuration 어노테이션으로 설정 클래스를 정의 하고, @Bean 어노테이션으로 SchedulerFactoryBean을 정의해 스케줄러를 빈으로 등록한다. 이렇게 생성된 스케줄러는 Spring 컨텍스트의 일부로 관리되며, 자동으로 초기화되고 애플리케이션 종료 시 자동으로 종료된다. 

아래 코드를 따라가며 작업(Job)과 트리거(Trigger)를 설정하는 코드를 보면 JobDetailFactoryBean으로 Job 실행 정보를 정의하고, CronTriggerFactoryBean은 크론 표현식을 기반으로 트리거(언제 실행될지)를 설정한다.

2-1. 단일 Job 스케줄러 등록 예시

@Configuration
public class TestQuartzConfiguration {
	private static final Logger logger = LoggerFactory.getLogger(QuartzConfiguration.class);

	@Resource(name = "messageSource")
	protected MessageSource primusProperties; // 개인 설정파일 연동 하시면 됩니다.
	
	// ① JobDetail 빈 생성 - 실행할 Quartz 작업 정보 설정
	@Bean(name = "firstJobDetail")
    public JobDetailFactoryBean firstJobDetail() {
        JobDetailFactoryBean factoryBean = new JobDetailFactoryBean();
        factoryBean.setJobClass(MyJob.class); // 실행할 Job 클래스 지정
        factoryBean.setDescription("Sample Quartz Job");	// 설명 설정
        factoryBean.setDurability(true); // 작업 내구성 유지 (스케줄러 재시작 시 유지)
        return factoryBean;
    }

    // ② CronTrigger 빈 생성 - JobDetail 주입 받아 트리거 스케줄링 설정
    @Bean(name = "firstCronTrigger")
    public CronTriggerFactoryBean firstCronTrigger(@Qualifier("firstJobDetail") JobDetail jobDetail) {
        CronTriggerFactoryBean trigger = new CronTriggerFactoryBean();
        
        trigger.setJobDetail(jobDetail); // 실행할 작업 연결
        trigger.setCronExpression("0 0/1 * * * ?");	// 1분마다 실행하는 크론 표현식
        trigger.setMisfireInstruction(CronTrigger.MISFIRE_INSTRUCTION_DO_NOTHING); // 재시작 시 누락 방지
        return trigger;
    }

    // ③ SchedulerFactoryBean 빈 생성 - 트리거 주입받아 스케줄러 등록 및 실행
    @Bean
    public SchedulerFactoryBean schedulerFactoryBean(@Qualifier("firstCronTrigger") Trigger firstCronTrigger) {

    	// 배치 실행 여부 프로퍼티 조회
    	String batchYn = primusProperties.getMessage("Batch_Server_Yn", null, Locale.getDefault());
		logger.info(" - > 해당 서버는 배치 여부가 '{}'입니다.", batchYn);
        
        Properties quartzProperties = new Properties();
        quartzProperties.setProperty("org.quartz.threadPool.threadCount", "1"); // 스레드 풀 크기 1로 제한 (싱글스레드)
        
        SchedulerFactoryBean schedulerFactory = new SchedulerFactoryBean();

        // 배치 서버일 경우에만 스케줄러 등록 및 실행
        if ("Y".equals(batchYn)) {
        	schedulerFactory.setQuartzProperties(quartzProperties);	// Quartz 설정 적용
        	schedulerFactory.setTriggers(firstCronTrigger);	// 트리거 등록
        }
        return schedulerFactory;
    }
}

 

2-2. 다중 Job과 Trigger를 한 Config에서 등록하는 예시

• JobDetail과 CronTrigger를 각각 여러 개 생성해서 이름으로 구분합니다. -> 여기서는 first, seconf 로 구분
• SchedulerFactoryBean에서 여러 Trigger를 배열 형태로 한꺼번에 등록합니다.
• @Qualifier로 원하는 빈을 정확히 주입합니다.

@Configuration
public class MultiQuartzConfiguration {
    
    @Resource(name = "messageSource")
    protected MessageSource primusProperties;

    // 첫 번째 JobDetail
    @Bean(name = "jobDetailOne")
    public JobDetailFactoryBean jobDetailOne() {
        JobDetailFactoryBean factory = new JobDetailFactoryBean();
        factory.setJobClass(MyJobOne.class);
        factory.setDescription("첫 번째 Job");
        factory.setDurability(true);
        return factory;
    }

    // 첫 번째 CronTrigger (1분마다 실행)
    @Bean(name = "cronTriggerOne")
    public CronTriggerFactoryBean cronTriggerOne(@Qualifier("jobDetailOne") JobDetail jobDetail) {
        CronTriggerFactoryBean trigger = new CronTriggerFactoryBean();
        trigger.setJobDetail(jobDetail);
        trigger.setCronExpression("0 0/1 * * * ?");
        trigger.setMisfireInstruction(CronTrigger.MISFIRE_INSTRUCTION_DO_NOTHING);
        return trigger;
    }

    // 두 번째 JobDetail
    @Bean(name = "jobDetailTwo")
    public JobDetailFactoryBean jobDetailTwo() {
        JobDetailFactoryBean factory = new JobDetailFactoryBean();
        factory.setJobClass(MyJobTwo.class);
        factory.setDescription("두 번째 Job");
        factory.setDurability(true);
        return factory;
    }

    // 두 번째 CronTrigger (5분마다 실행)
    @Bean(name = "cronTriggerTwo")
    public CronTriggerFactoryBean cronTriggerTwo(@Qualifier("jobDetailTwo") JobDetail jobDetail) {
        CronTriggerFactoryBean trigger = new CronTriggerFactoryBean();
        trigger.setJobDetail(jobDetail);
        trigger.setCronExpression("0 0/5 * * * ?");
        trigger.setMisfireInstruction(CronTrigger.MISFIRE_INSTRUCTION_DO_NOTHING);
        return trigger;
    }

    // SchedulerFactoryBean - 두 트리거 모두 등록
    @Bean
    public SchedulerFactoryBean schedulerFactoryBean(
            @Qualifier("cronTriggerOne") Trigger cronTriggerOne,
            @Qualifier("cronTriggerTwo") Trigger cronTriggerTwo) {
        
        String batchYn = primusProperties.getMessage("Batch_Server_Yn", null, Locale.getDefault());

        Properties quartzProps = new Properties();
        quartzProps.setProperty("org.quartz.threadPool.threadCount", "1");

        SchedulerFactoryBean scheduler = new SchedulerFactoryBean();

        if ("Y".equals(batchYn)) {
            scheduler.setQuartzProperties(quartzProps);
            scheduler.setTriggers(cronTriggerOne, cronTriggerTwo);
        }
        return scheduler;
    }
}

 

@Configuration과 @Bean의 조합은 스프링의 핵심적인 설정 메커니즘을 제공하며,  특히 프록시를 통한 싱글톤 보장이 가능해집니다.

@Bean 메서드의 역할: 컨테이너는 @Bean 어노테이션이 붙은 메서드를 찾아 해당 메서드가 반환하는 객체를 Spring 애플리케이션 컨텍스트에 빈으로 등록합니다.

 

☑  컨테이너가 빈을 등록하고 관리하는 과정에 대해서 헷갈린다면 아래 블로그를 추천하며 출처 남깁니다.

1. 먼저 @Configuration이 붙은 클래스를 찾습니다. 이 클래스들이 설정 정보를 담고 있습니다.
2. 그다음 @Component, @Controller, @Service, @Repository 등의 어노테이션이 붙은 클래스들을 찾아서 빈으로 등록합니다.
3. @Bean이 붙은 메서드들을 찾아 그 메서드가 반환하는 객체들도 빈으로 등록합니다.
4. 이렇게 등록된 빈들의 의존관계를 분석하고 필요한 경우 자동으로 주입해 줍니다.

☑  출처: https://curiousjinan.tistory.com/entry/deep-dive-spring-container-configuration-and-bean#빈의 범위(Scope)란%3F-1 [오늘도 개발중입니다:티스토리]

 

 

3. Job.class 생성

위 설정 파일 소스에서 factoryBean.setJobClass(MyJob.class); 와 같이 job을 지정해주었기 때문에 MyJob.class라는 이름으로 서비스 로직 클래스를 생성하면 된다.

QuartzJobBean을 상속하면 executeInternal만 구현하면 되기 때문에, Spring과의 통합이 쉬워지고 Job 구현이 간단해진다.

(서비스 로직이란? 반복문을 돌며 db를 조회하여 쿠폰을 발급한다 등등. 스케줄러가 실행되며 수행해야 할 로직을 작성.)

MyJob.clas 예제

package com.batch.job;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.quartz.QuartzJobBean;

import com.batch.config.QuartzConfiguration;

public class MyJob extends QuartzJobBean {
	private static final Logger logger = LoggerFactory.getLogger(QuartzConfiguration.class);

	@Override
	protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
		
        // TODO Auto-generated method stub
		logger.info("myJob이 실행됩니다.");
		
	}
}

스케줄러 실행 로그

 

 

 

✅ Scheduler 등록 방법에 대한 추가 메모

스케줄러는 Quartz의 핵심 인터페이스로, 잡(Job)을 스케줄링하고 관리하는 역할을 한다.

Quartz 스케줄러에서 Scheduler를 인스턴스화하고 사용하는 대표적 사용법이 두가지가 있는데 

첫째, StdSchedulerFactory 로 직접 인스턴스화 해 사용하는 것이고

둘째, 이 포스팅에 설명한 내용으로 SchedulerFactoryBean 을 사용하여 스케줄러를 Spring 컨텍스트에 Bean으로 등록하고, 관리하는 방법이다.

두번째 방법이 더 쉽게 스케줄링 작업을 설정하고 관리할 수 있다고 하여 사용했는데 실제로 코드 작성 구조가 단일화 되기 때문에 다른 사람이 작성한 코드를 알아보기도 쉬운 것 같다.

 

① StdSchedulerFactory

* StdSchedulerFactory를 사용하여 직접 Scheduler 인스턴스화 하는 방법.

이 팩토리는 내부적으로 Quartz 설정 파일을 읽어 스케줄러를 초기화 함.

import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;

public class QuartzStdSchedulerExample {
    public static void main(String[] args) {
        try {
        
            // SchedulerFactory를 통해 기본 Scheduler 인스턴스를 생성합니다.
            Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
            scheduler.start();

            // 작업(Job) 정의
            JobDetail job = JobBuilder.newJob(MyJob.class)
                    .withIdentity("myJob", "group1")
                    .build();

            // 트리거 정의 (10초마다 실행)
            Trigger trigger = TriggerBuilder.newTrigger()
                    .withIdentity("myTrigger", "group1")
                    .startNow()
                    .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                            .withIntervalInSeconds(10)
                            .repeatForever())
                    .build();

            // 스케줄러에 작업과 트리거를 스케줄링
            scheduler.scheduleJob(job, trigger);

            // 다른 작업 추가 또는 스케줄러 유지 작업 수행...

            // 스케줄러 종료 (필요할 때)
            scheduler.shutdown(true);
        } catch (SchedulerException se) {
            se.printStackTrace();
        }
    }
}

 

 

② SchedulerFactoryBean

* Spring은 SchedulerFactoryBean을 통해 Quartz 스케줄러를 관리하며, 이 방식은 Spring 애플리케이션 내에서 Quartz 작업을 통합 관리하기에 적합함. 

Spring ApplicationContext 가 시작될 때, SchedulerFactoryBean이 자동으로 Quartz 스케줄러를 초기화하고 시작한다. Spring이 스케줄러의 생명주기를 관리하므로, 별도의 코드로 스케줄러를 시작하거나 종료할 필요가 없다.

https://docs.spring.io/spring-framework/docs/3.2.4.RELEASE_to_4.0.0.M3/Spring%20Framework%203.2.4.RELEASE/org/springframework/scheduling/quartz/SchedulerFactoryBean.html

SchedulerFactoryBean