작성일자 글쓴이 youngro

Spring boot – Quartz

Quartz

Java 기반의 오픈소스 “작업 스케줄링 라이브러리”이다. 이를 사용하여 특정 시간에 작업을 실행하거나 특정 간격으로 작업을 수행할 수 있다.

이와 같이 많이 쓰이는 Spring Scheduler와의 차이점은 다음과 같다.

Quartz

  • 매우 강력하고 유연한 스케줄링 라이브러리로, 복잡한 스케줄링 작업을 처리하는데 특화되어 있다. 예를 들어, Cron 표현식을 지원하고, 반복적인 작업, 일정한 시간 간격으로 작업을 실행하거나, 특정 시간대에 작업을 실행하는 등의 고급 기능을 제공한다.
  • Quartz는 독립적으로 사용할 수도 있으며, 자체적인 데이터베이스나 클러스터링 기능도 지원한다.
  • 데이터베이스를 통한 클러스터링이나, 분산 작업이 가능하다.

Spring Scheduler

  1. Spring Framework의 일부로 비교적 단순한 스케줄링 작업을 다루기 위해 설계되었다. 기본적으로 @Scheduled 어노테이션을 사용하여 간단한 주기적인 작업을 설정할 수 있다. 주기적인 실행, 딜레이 및 고정된 속도 기반의 작업에 적합하다.
  2. Quartz에 비해 기능이 단순하고 복잡한 작업을 처리 하는 데는 한계가 있다.

 

주요 클래스 및 인터페이스

  1. Job (인터페이스): 실행할 작업을 정의하는 인터페이스
  2. JobDetail (인터페이스): 실행될 작업을 정의하고 구성하는 인터페이스
  3. JobBuilder (클래스): JobDetail인스턴스를 생성하는데 사용되는 유틸리티 클래스
  4. JobListener (인터페이스): 작업의 생명 주기 동안 발생하는 이벤트를 처리하는 인터페이스
  5. JobDataMap (클래스): 작업 실행시 필요한 데이터를 저장하는 맵
  6. Trigger (인터페이스): 작업의 실행 시간을 결정하는 인터페이스
  7. CronTrigger (인터페이스): 복잡한 실행 스케쥴을 정의할 수 있는 Trigger 인터페이스
  8. TriggerBuilder (클래스): Trigger 인스턴스를 생성하는 데 사용되는 유틸리티 클래스
  9. SimpleScheduleBuilder (클래스): 간단한 실행 크세줄을 정의할 수 있는 클래스
  10. CronScheduleBuilder (클래스): 복잡한 실행 스케줄을 cron표현식으로 정의할 수 있는 클래스
  11. Schedule (인터페이스): 작업과 트리거를 관리하고 실행하는 인터페이스
  12. ScheudlerFactory (클래스): Scheduler 인스턴스를 생성하는 클래스

Spring boot 상에서의 구현

의존성 추가

의존성은 org.springframework.boot:spring-boot-starter-quartz를 추가해 준다.

설정 추가

Spring boot의 설정 파일 (application.yml)에 다음의 설정 정보를 추가해 준다.

 

상세 설정 정보

  1. spring.quartz.job-store-type=jdbc

    설명: Quartz가 작업과 트리거 정보를 저장할 방식으로 JDBC를 사용하도록 지정한다. 이 설정은 Quartz가 메모리 대신 데이터베이스에 정보를 저장하게 한다. 이로 인해 애플리케이션이 재시작되더라도 작업 정보를 유지할 수 있다.

     

  2. spring.quartz.jdbc.initialize-schema=always

    설명: JDBC저장소를 사용하면 다음 예와 같이 시작 시 스키마를 초기화 할 수 있다. 기본적으로 제공되는 스크립트를 사용하여 감지되고 초기화 된다. 이렇게 설정하게 되면, 기존 테이블을 삭제하고 모든 재시작 시 모든 트리거를 자동 삭제한다.

     

  3. spring.quartz.scheduler-name=SpringBootQuartzScheduler

    설명: Quartz 스케줄러의 이름을 설정한다. 이 이름은 Quartz 인스턴스를 구별할 때 사용된다. 예를 들어, 여러 개의 스케줄러가 동시에 실행되는 경우, 각 스케줄러를 구분할 수 있도록 이름을 지정할 수 있다.

     

  4. spring.quartz.properties.org.quartz.scheduler.instanceName=MyScheduler

    설명: Quartz 스케줄러의 인스턴스 이름을 설정한다. MyScheduler는 이 인스턴스를 구별하는 이름으로 사용되며, Quartz 스케줄러가 여러 개의 인스턴스를 가질 경우 이를 식별하는 데 유용하다.

     

  5. spring.quartz.properties.org.quartz.scheduler.instanceId=AUTO

    설명: instanceId는 Quartz 스케줄러의 인스턴스를 고유하게 식별하는 데 사용된다. AUTO로 설정하면 Quartz가 자동으로 인스턴스 ID를 할당한다. 이 설정은 클러스터 환경에서 각 스케줄러 인스턴스가 고유한 ID를 가질 수 있도록 돕는다.

     

  6. spring.quartz.properties.org.quartz.threadPool.threadCount=5

    설명: Quartz 스케줄러에서 사용할 스레드 수를 설정한다. 여기서는 5개의 스레드를 사용할 수 있도록 지정했다. 여러 작업을 동시에 처리하기 위해 사용되는 스레드의 개수를 제한하는 설정이다. 작업이 많을 때 이 수치를 늘리면 성능을 개선할 수 있다.

     

  7. spring.quartz.properties.org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX

    설명: JobStore는 Quartz에서 작업과 트리거를 어떻게 저장할지 결정하는 클래스다. JobStoreTX는 트랜잭션을 지원하는 JobStore 클래스로, 작업 저장과 관련된 데이터베이스 트랜잭션을 처리한다. 이 설정은 JDBC를 사용할 때 트랜잭션을 지원하는 JobStoreTX를 선택하도록 지정한 것이다.

     

  8. spring.quartz.properties.org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate

    설명: DriverDelegate는 Quartz의 JobStore가 사용하는 데이터베이스에 맞는 SQL 문을 생성하는 클래스다. StdJDBCDelegate는 일반적인 데이터베이스 (MySQL, PostgreSQL, Oracle 등)에서 사용되는 기본 Delegate 클래스다. 이 설정은 기본적인 SQL 구문을 사용하여 데이터베이스와 상호작용하도록 지정한다.

     

  9. spring.quartz.properties.org.quartz.jobStore.dataSource=QuartzDataSource

    설명: Quartz에서 사용할 데이터 소스의 이름을 설정한다. QuartzDataSource는 Quartz가 작업과 트리거 데이터를 저장할 데이터베이스 연결을 지정하는데 사용된다. 이 설정을 통해 QuartzDataSource라는 이름의 데이터 소스를 참조하도록 설정한다.

     

  10. spring.quartz.properties.org.quartz.dataSource.QuartzDataSource.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate

    설명: 위에서 언급한 QuartzDataSource에 대한 설정이다. 이 속성은 QuartzDataSource 데이터 소스가 사용할 SQL 구문을 정의하는 DriverDelegate 클래스를 설정한다. StdJDBCDelegate는 기본적인 SQL 작업을 처리할 수 있도록 지정하는 클래스이다.

     

  11. spring.quartz.properties.org.quartz.dataSource.QuartzDataSource.URL=jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1

    설명: Quartz가 사용할 데이터베이스 URL을 설정한다. 여기서는 H2 데이터베이스를 메모리 모드에서 사용하도록 설정되어 있다. jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1은 H2 데이터베이스가 메모리에 생성되며, 애플리케이션이 종료되더라도 데이터베이스가 닫히지 않도록 설정하는 URL이다. 실제 운영 환경에서는 MySQL, PostgreSQL 등을 사용할 수 있다.

     

  12. spring.quartz.properties.org.quartz.dataSource.QuartzDataSource.user=sa

    설명: Quartz가 사용할 데이터베이스의 사용자 이름을 설정한다. 여기서는 H2 데이터베이스의 기본 사용자 이름 sa로 설정되어 있다. 실제 환경에서는 데이터베이스 연결에 사용될 적절한 사용자 이름을 지정해야 한다.

     

  13. spring.quartz.properties.org.quartz.dataSource.QuartzDataSource.password=password

    설명: Quartz가 데이터베이스에 접속할 때 사용할 비밀번호를 설정한다. password는 H2 데이터베이스에 대한 기본 비밀번호다. 운영 환경에서는 데이터베이스에 적합한 비밀번호를 설정해야 한다.

     

  14. spring.quartz.properties.org.quartz.dataSource.QuartzDataSource.maxConnections=5

    설명: Quartz가 사용할 최대 연결 수를 설정한다. 5로 설정하면 데이터베이스에 동시에 최대 5개의 연결을 유지할 수 있다. 데이터베이스 연결 풀의 크기를 제한하여 리소스 관리를 최적화하는 데 유용하다.

     

  15. spring.quartz.properties.org.quartz.jobStore.tablePrefix=QRTZ_

    설명: Quartz가 자동 생성할 테이블의 접두사를 설정한다. QRTZ_로 설정하면, 생성되는 테이블이 다음과 같이 된다. QRTZ_JOB_DETAILS, QRTZ_TRIGGERS

     

  16. spring.quartz.properties.org.quartz.jobStore.isClustered=true

    설명: 클러스터링 환경을 사용할 경우, 설정한다. 이 설정을 사용하면, 여러 대의 서버나 인스턴스가 하나의 Quartz 스케줄러로서 작업과 트리거를 공유하고 중복 없이 실행할 수 있는 조건을 만들어 준다. 이를 통해 중복 실행 방지, 부하 분산, 고가용성을 확보할 수 있다.

     

  17. spring.quartz.properties.org.quartz.jobStore.clusterCheckinInterval=20000

    설명: 각 Quartz 인스턴스가 주기적으로 자신을 데이터베이스에 “체크인” 하는 간격을 설정한다. 이를 통해 각 인스턴스들이 자신이 정상 상태인지를 서버에 알리게 된다. 기본값은 20초이며 단위는 ms 이다.

     

  18. spring.quartz.properties.org.quartz.jobStore.maxMisfiresToHandleAtATime=5

    설명: 미처리된 작업을 처리할 때, 한번에 처리할 수 있는 최대 개수를 지정하는 옵션이다.

Java Application Config

QuartzConfig를 담음과 같이 생성하여, Job Schedule을 생성할 수 있다.

 

실제 Job 클래스

실제 작업을 수행하는 클래스이다. execute에서 작업을 수행하는 코드를 작성하여 실행한다.

@Component

public class MyJob implements Job {

 

@Override

public void execute(JobExecutionContext context) throws JobExecutionException {

System.out.println(“Quartz Job is running…”);

}

}

 

JobDetail 및 Trigger 설정

작업의 트리거 및 작업 세부 내용을 설정하는 클래스다. 작업을 언제 시작할지 설정하고, 어떤 정보를 통해 실행할 지 등의 설정을 수행한다.

@Configuration

public class QuartzConfig {

 

@Bean

public JobDetail jobDetail() {

return JobBuilder.newJob(MyJob.class)

.withIdentity(“myJob”)

.storeDurably()

.build();

}

 

@Bean

public Trigger trigger() {

return TriggerBuilder.newTrigger()

.withIdentity(“myTrigger”)

.withSchedule(CronScheduleBuilder.cronSchedule(“0/5 * * * * ?”)) // 매 5초마다 실행

.forJob(jobDetail())

.build();

}

 

@Bean

public Scheduler scheduler() throws Exception {

SchedulerFactory schedulerFactory = new StdSchedulerFactory();

Scheduler scheduler = schedulerFactory.getScheduler();

scheduler.scheduleJob(jobDetail(), trigger());

scheduler.start();

return scheduler;

}

}

 

데이터베이스를 이용한 처리

Quartz는 기본적으로 작업과 트리거를 데이터베이스 저장할 수 있다. 단! 주의할 것이 이렇게 DB를 통한다는 의미가, 코드 수정 없이 Job, JobDetail, Trigger를 추가한다는 것이 아니라, 해당 정보의 Metadata만을 저장하고, 이를 통해 어플리케이션이 종료되거나 서버가 재시작 되더라도 스케줄링 작업을 계속 추적하고 실행할 수 있다는 것이다.

JobDetail => JOB_DETAILS

Trigger => TRIGGERS

Quartz는 자체적으로 스케줄러의 상태를 저장하기 위해 필요한 테이블을 제공한다. 이를 위해Quartz의 데이터베이스 테이블을 생성하는 SQL스크립트를 제공하며, 이를 싱행하여 필요한 테이블을 설정해야 한다.

데이터베이스는 기본적으로, H2, MySQL, PostgreSQL 등에 맞는 SQL 테이블 생성 스크립트를 제공한다.

저장되는 정보와 동작 방식

Job클래스는 Quartz 스케줄러가 실행할 작업을 정의한다. 이 클래스에는 실제 동작할 비즈니스 로직이 포함되어 있다.

JobDetail객체와 Trigger객체는 Quartz 스케줄러에서 작업이 언제, 어떻게 실행될지를 정의하는 데 사용하게 된다.

Quartz는 JobDetail 및 Trigger 정보를 데이터베이스에 저장한다. 하지만 클래스 정보 자체를 저장하지 않고, 메타데이터(작업 이름, 그룹, 클래스 이름 등)만을 저장한다.

 

클러스터링

클러스터링의 장점

  1. 확장성: 여러 서버가 동일한 Quartz 스케줄러를 공유하므로, 클러스터에 새로운 서버를 추가하여 처리 능력을 확장할 수 있다.
  2. 내결함성: 하나의 서버가 다운되더라도 다른 서버가 작업을 계속해서 처리할 수 있어 시스템의 고가용성을 제공한다.
  3. 작업 중복 실행 방지: 클러스터링된 환경에서, 동일한 작업이 여러 번 실행되지 않도록 보장한다.

클러스터링 사용 시 주의점

  1. 데이터베이스: 클러스터 모드를 사용할 때는 모든 서버 인스턴스가 동일한 데이터베이스에 접근할 수 있어야 한다. 따라서, DB의 성능과 동시 처리 능력을 고려해야 한다.
  2. 네트워크 지연: 여러 서버가 분산 환경에서 통신해야 하므로, 네트워크의 지연이나 장애가 작업 처리에 영향을 미칠 수 있다.
  3. 잠금 관리: 분산 잠금 메커니즘을 통해 작업의 중복 실행을 방지하는데, 이 과정에서 잠금 경합(lock contention)이 발생할 수 있다.

상황 별 정보

멀티 스레드 관련

작업이 종료되기 전에, 동일 작업에 대한 요청이 들어오게 되면, Quartz는 일단 이전 작업이 종료될 때 까지 대기하게 된다. 클러스터 환경에서도 동일하다.

하지만, 동시 설정을 위하여 다음과 같이 설정하면, 설정한 정보를 활용하여 동시 수행이 가능하게 설정할 수 있다.

spring.quartz.properties.org.quartz.threadPool.threadCount=[동시수행 Thread개수]

답글 남기기

이메일 주소는 공개되지 않습니다. 필수 필드는 *로 표시됩니다