[Spring] ⌚ Quartz 라이브러리 Scheduling

📕 CS 스터디/Java, Spring

[Spring] ⌚ Quartz 라이브러리 Scheduling

iknowDev 2023. 3. 9. 22:58

특정 시간 간격을 반복하거나 특정한 시각에 로직을 수행하는 것을 Scheduler라고 합니다.

이러한 작업을 위해 Spring에서는 2가지 옵션을 제공합니다.

Spring Scheduler
Spring Quartz

그 중 세밀한 제어가 가능한 Quartz Scheduler 라이브러리에 대해 알아봅시다.

기본 구성

Job	스케줄링할 실제 작업을 가지는 객체 - JobListener
JobData	Job에서 사용할 데이터를 전달하는 객체
JobDataMap	스케줄러에서 Job 실행 시 사용할 변수 값 전달 용도 (key-value 형식)
JobDetail	Job의 정보를 구성하는 객체
JobBuilder	Job의 instances 정의하는 JobDetail instances 빌드에 사용
Trigger	Job이 언제 시행될지를 구성하는 객체 - TriggerListener
TriggerBuilder	Trigger instances 빌드에 사용
Scheduler	JobDetail과 Trigger 정보를 이용해서 Job을 시스템에 등록하고, Trigger가 동작하면 지정된 Job을 실행시키는 객체
SchedulerFactory	Scheduler 인스턴스를 생성하는 객체
quartz.properties	Quartz 스케줄러를 위한 설정값 구성 파일
JobStore	스케줄러에 등록된 Job의 정보와 실행이력이 저장되는 공간
JobExecutionContext	execute 메서드의 파라미터로 넘어가는 인자이다. JobDetail 인스턴스가 Scheduler에 의해 실행될때 넘어오고, 실행이 완료된 뒤에는 Trigger로 넘어간다.

예시 코드

스케쥴링된 시간에 배치 작업을 하기 위해서

import java.util.Date;

import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.quartz.PersistJobDataAfterExecution;

@PersistJobDataAfterExecution
public class SchedulerTest implements Job{
	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {

        JobDataMap dataMap = context.getJobDetail().getJobDataMap();
        int idx =  dataMap.getInt("idx");
    	
        System.out.println("* " + idx + " 스케줄러 수행 [" + new Date(System.currentTimeMillis()) + "]");

        dataMap.putAsString("idx", idx+1);

        if (5 <= idx) { // 수행 횟수 지정
            JobExecutionException e = new JobExecutionException("End Repeat");
            e.setUnscheduleAllTriggers(true);
            throw e;
        }
    }
}

import org.quartz.CronScheduleBuilder;
import org.quartz.CronTrigger;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerFactory;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.SimpleTrigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;

public class Simpletest {
	public static void main(String[] args) {
        SchedulerFactory schedulerFactory = new StdSchedulerFactory();
        try {
            Scheduler scheduler = schedulerFactory.getScheduler();

            JobDetail job = JobBuilder.newJob(SchedulerTest.class)
            		.withIdentity("jobName", Scheduler.DEFAULT_GROUP)
            		.usingJobData("idx", 1)
            		.build();

            // 5초 주기 Simple 스케줄링
            SimpleTrigger simplTrigger = TriggerBuilder.newTrigger()
            		  .withIdentity("trigger1", Scheduler.DEFAULT_GROUP)
            		  .withSchedule(SimpleScheduleBuilder.simpleSchedule()
            				  .withIntervalInSeconds(5)
            				  .withRepeatCount(3)) // 반복 횟수
            		  .build();

            // 10초 주기 Cron 스케줄링
            CronTrigger cronTrigger = TriggerBuilder.newTrigger()
            		  .withIdentity("trigger2", Scheduler.DEFAULT_GROUP)
            		  .withSchedule(CronScheduleBuilder.cronSchedule("0/10 * * * * ?"))
            		  .build();

            scheduler.scheduleJob(job, cronTrigger);
            scheduler.start();
        } catch (Exception e) {
            e.printStackTrace();
        }
	}
}

SimpleTrigger (3초 간격 작업 수행 반복)

Cron Trigger (10초 간격 작업 수행 반복)

Cron Trigger Expression

CronTrigger는 “매일 월요일 9시”, 또는 “매 주말 오후 7시”, “1월 한달간 매주 토요일 오후 12시에서 1시 사이 10분 간격”과 같이 스케줄 설정을 할 수 있습니다.

초(Seconds)
분(Minutes)
시(Hours)
일(Day-of-Month)
월(Months)
요일(Days-of-Week)
연도(Year) - optional

?	설정 값 없음에 사용 일(day-of-month)와 요일(day-of-week) 필드에서만 허용
/	값의 증가 표현에 사용 분(Minutes) 필드에 ‘0/10’ 를 사용한다면, 이것은 “0분 부터 시작하여 (시간의) 매 10분 마다”를 의미
L	일(day-of-month) 필드에서 사용되었을 경우 이달의 마지막 날을 의미 1월이면 31일이 되고, 2월은 28일(윤년 29일)이 됨 "6L” 또는 “FRIL”은 “이달의 마지막 금요일”을 의미
W	주어진 날로부터 가장 가까운 평일(월요일~금요일) “21W”라는 값을 일(day-of-month)필드에 설정하면, “이달의 21번째날에서 가장 가까운 평일”을 의미
#	이달의 n번째 X요일 “2#1” 또는 “MON#1”을 요일(day-of-week) 필드에 설정할 경우 이것은 “이달의 첫번째 월요일”을 의미

출처

Expression	Meaning
0 0 12 * * ?	Fire at 12pm (noon) every day
0 15 10 ? * *	Fire at 10:15am every day
0 15 10 * * ?	Fire at 10:15am every day
0 15 10 * * ? *	Fire at 10:15am every day
0 15 10 * * ? 2005	Fire at 10:15am every day during the year 2005
0 * 14 * * ?	Fire every minute starting at 2pm and ending at 2:59pm, every day
0 0/5 14 * * ?	Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day
0 0/5 14,18 * * ?	Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5 minutes starting at 6pm and ending at 6:55pm, every day
0 0-5 14 * * ?	Fire every minute starting at 2pm and ending at 2:05pm, every day
0 10,44 14 ? 3 WED	Fire at 2:10pm and at 2:44pm every Wednesday in the month of March.
0 15 10 ? * MON-FRI	Fire at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday
0 15 10 15 * ?	Fire at 10:15am on the 15th day of every month
0 15 10 L * ?	Fire at 10:15am on the last day of every month
0 15 10 L-2 * ?	Fire at 10:15am on the 2nd-to-last last day of every month
0 15 10 ? * 6L	Fire at 10:15am on the last Friday of every month
0 15 10 ? * 6L	Fire at 10:15am on the last Friday of every month
0 15 10 ? * 6L 2002-2005	Fire at 10:15am on every last friday of every month during the years 2002, 2003, 2004 and 2005
0 15 10 ? * 6#3	Fire at 10:15am on the third Friday of every month
0 0 12 1/5 * ?	Fire at 12pm (noon) every 5 days every month, starting on the first day of the month.
0 11 11 11 11 ?	Fire every November 11th at 11:11am.

http://www.cronmaker.com/ 링크를 통해 Cron 표현식을 만들어 볼 수 있다.

설정을 위한 pom.xml (코드 보기)

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>quartz_test</groupId>
  <artifactId>simple01</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  
  <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java-version>1.7</java-version>
      <org.springframework-version>4.2.3.RELEASE</org.springframework-version>
      <maven.test.skip>true</maven.test.skip>
      <cobertura.skip>true</cobertura.skip>
  </properties>
  
  <dependencies>
	  <dependency>
	      <groupId>org.springframework</groupId>
	      <artifactId>spring-jdbc</artifactId>
	      <version>${org.springframework-version}</version>
	  </dependency>
	  <dependency>
	      <groupId>org.springframework</groupId>
	      <artifactId>spring-context-support</artifactId>
	      <version>${org.springframework-version}</version>
	  </dependency>
	  <dependency>
	      <groupId>commons-logging</groupId>
	      <artifactId>commons-logging</artifactId>
	      <version>1.2</version>
	  </dependency>
	  <dependency>
	      <groupId>org.springframework</groupId>
	      <artifactId>spring-tx</artifactId>
	      <version>${org.springframework-version}</version>
	  </dependency>
	  <dependency>
	      <groupId>org.springframework</groupId>
	      <artifactId>spring-test</artifactId>
	      <version>${org.springframework-version}</version>
	  </dependency>
	
	  <!-- quartz scheduler -->
	  <dependency>
	      <groupId>org.quartz-scheduler</groupId>
	      <artifactId>quartz</artifactId>
	      <version>2.2.1</version>
	  </dependency>
  </dependencies>
  
  <build>
  	<plugins>
	    <!-- Set a compiler level -->
	    <plugin>
	        <groupId>org.apache.maven.plugins</groupId>
	        <artifactId>maven-compiler-plugin</artifactId>
	        <version>3.2</version>
	        <configuration>
	            <source>${java-version}</source>
	            <target>${java-version}</target>
	            <compilerArgument>-Xlint:all</compilerArgument>
	            <showWarnings>true</showWarnings>
	            <showDeprecation>true</showDeprecation>
	        </configuration>
	    </plugin>
  	</plugins>
  </build>
</project>