[Java] xml을 이용한 Quartz Job Scheduler 설정

목차
쿼츠란?
쿼츠 실행 흐름
쿼츠 구성요소
쿼츠 구현 방법 - XML을 이용한 Quartz Scheduler구현
cron Expression

---

쿼츠(Quartz)란?

Job scheduling Library. 특정 시간, 또는 반복적으로 트리거 되어야하는 배치성 작업 생성 시 사용한다. 나는 현업에서 주로  프로그램과의 데이터 송수신 하거나, 지표를 나타내는 데이터를 계산할 때 사용하였다. 예를 들면, 매일 새벽 특정한 시간대마다 특정 서비스의 메소드를 호출하는 식이다. 

 쿼츠의 대표적인 장점은 일련의 작업들의 실행 시간대를 유연하게 조정할 수 있다는 점이다. 특정한 날, 특정한 시간 뿐 아니라 요일 및 시간의 간격까지도 설정할 수 있다.

 

---

쿼츠 실행 흐름

 

쿼츠의 실행 흐름을 간결하게 표현해본 그림이다.

Scheduler가 Job에 적혀진 실행정보를 바탕으로 정해진 시간이나 주기에 Job을 실행한다.

---

쿼츠 구성 요소

1. Scheduler Factory

 - Scheduler 인스턴스 생성 담당 인터페이스. 사용되는 Trigger를 등록시켜주는 역할을 담당하므로 Trigger들을 triggers 속성의 <list> 태그 하위로 등록시킨다. 

 

2. Scheduler 

 - Scheduler Factory에 의해 생성된다. Quartz 스케쥴러의 메인 인터페이스. 스케줄러는 JobDetail과 Trigger를 관리하여, 작업을 실행하는 역할을 한다.

 

3. Job

 - Scheduler에 의해 수행될 실제 작업이 구현되어있는 객체. 즉, 실행해야 할 작업이다. 예를 들어 타 시스템과 연동을 통하여 데이터를 송수신하거나, 자동 메일링 전송 기능 같은 배치성 작업을 구현한 클래스가 이에 해당한다. 같은 그룹에는 동일한 이름을 가진 job을 생성할 수 없다.

 

4. Trigger

 - Job 수행을 위한 조건을 정의한 객체로, 특정 시간이나 횟수, 반복 주기를 설정 할 수 있다. 또한 스프링에서는 쿼츠를 쉽게 사용할 수 있도록 2개의 TriggerBean을 제공한다. SimpleTrigger, CronTrigger는 둘 다 트리거라는 점에서는 동일하다. 하지만, 실행조건에서 차이점을 보인다. CronTriggerBean은 cron 표현을 이용하여 작성하는데, 리눅스에서도 사용하는 방식이라고 한다. (리눅스 크론탭 참고)

 

<!-- crontrigger 방식 -->
<bean id="quartzTestTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
    <property name="jobDetail"><ref bean="quartzTestServiceMethod" /></property>
    <!-- 매 10분마다 실행한다 -->
    <property name="cronExpression"><value>0 0,10,20,30,40,50 * * * ?</value></property>
</bean>

<!-- simpleTrigger 방식 -->
<bean id="quartzTestTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">
    <property name="jobDetail" ref="quartzTestServiceMethod" />
    <!-- 시작하고 1분후에 실행하도록 설정 
    서버 가동 후, 시작할 시간을 설정 가능하다. 단위는 millisecond이다. -->
    <property name="startDelay" value="60000" />
    <!-- 매 24시간마다 실행한다. 반복 시간 설정. 단위는 마찬가지로 millisecond -->
    <property name="repeatInterval" value="864000000" />
</bean>

 

SimpleTrigger : 특정 시간대 및 횟수 정의

CronTrigger : 주기적으로 반복. 좀 더 세부적인 일정을 설정할 수 있다.

• Trigger와 Job의 관계?
  • 1 Trigger = 1 Job: 반드시 하나의 Trigger는 하나의 Job을 지정
  • N Trigger = 1 Job: 하나의 Job을 여러 시간에서 실행

 

5. Listenr

- 조금 이해가 어려웠던 부분. 쿼츠 리스너는 이벤트가 발생할때 프레임워크로부터 콜백을 받는 자바 클래스라고 한다. 이벤트를 받을 수 있도록 하는 인터페이스라고 생각하는게 가장 간결할 것 같다. 

쿼츠 프레임워크는 이렇듯 Scheduler, Job, Trigger를 위한 Listener를 제공한다. JobListenr는 Job 실행 이전, 이후로 이벤트를 받을 수 있고, TriggerLIstener는 Trigger 발생이나 완료, 혹은 불발 시 이벤트를 받을 수 있다.

 

 

6. Jobstore

 - Job과 Trigger 정보를 저장하는 메모리, 저장소

---

쿼츠의 문제점?

쿼츠 스케줄 실행에 대한 히스토리 관리가 어렵다. 스케쥴 실행에 대한 히스토리를 관리하고 싶다면, 서비스 단에 실행과 관련한 로그를 구현한 뒤, ADMIN UI를 직접 개발하여 관리하여야한다. 실제로 현재 회사에서는 쿼츠 스케쥴러 실행에 대한 성공 여부나, 송수신 데이터 로그를 확인하기 위한 UI가 따로 개발 되어있다.

 

---

 

쿼츠 구현 방법 : XML을 이용한 Quartz Scheduler 구현

 

1. Quartz library 파일 추가

 쿼츠 라이브러리 사용을 위하여 파일 혹은 dependency 추가. 쿼츠 라이브러리 파일은 하단의 URL에서 다운로드 할 수 있다.

(quartz를 정상적으로 사용하기 위하여서는 slf4j-api jar가 있어야한다고 하니 참고하도록 하자!)

* 라이브러리 다운로드 URL : http://www.quartz-scheduler.org/downloads/ 

라이브러리 추가

 

 

2. 실행할 Job class 구현

public class BatchServiceImpl implements BatchService {

    public void sendSmsMessageList() throws Exception {
    	SimpleDateFormat format = new SimpleDateFormat ("yyyy-MM-dd HH:mm:ss");
    	Date time = new Date();
    	String currentTime = format.format(time);
    	System.out.println(currentTime); //현재시간 출력
    }
}

 

 

3. Quartz.xml 파일 구현

<bean id="quartzTestServiceMethod" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
    <!-- Job 구현한 class 객체의 bean 이름을 설정한다 -->
    <property name="targetObject"><ref bean="batchService" /></property>
    <!-- 해당 class에서 실행할 주기적으로 실행되어질 메소드를 셋팅한다. -->
    <property name="targetMethod"><value>sendSmsMessageList</value></property>
    <!-- 동시 실행 방지 옵션 
    다수의 Job을 동시에 발생시키려면 true로 설정하고, 순차적으로 발생시키려면 false로 설정한다
    (하단에서 이와 관련한 테스트 예정) -->
    <property name="concurrent"><value>false</value></property>
</bean>
<!-- Trigger설정. cronTrigger를 사용하였으며, 30초마다 실행되도록 설정함 -->
<bean id="quartzTestTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
    <property name="jobDetail"><ref bean="quartzTestServiceMethod" /></property>
    <property name="cronExpression"><value>0/30 * * * * ?</value></property>
</bean>
<!-- 스케쥴러 설정. 위에서 설정한 트리거의 bean id를 ref bean에 작성 -->
<bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
    <property name="triggers">
        <list>
            <ref bean="quartzTestTrigger"/>
        </list>
    </property>
</bean>

 

 

4. 구동

 실제 서버를 실행시켜보면, console에 30초마다 current Time이 찍히는 것을 확인할 수 있다.

---

 

Cron Expression

 

Cron 표현식 기본구조는 6~7자리로 구성되어있다.

 *     *     *     *    *      *      *
초    분   시   일   월   요일  년도(생략가능)

 

표현식의 범위

초(Seconds)	0~59
분(Minutes)	0~59
시간(Hours)	0~23
달의 날짜(Day-of-month)	1~31
달(Month)	1~12 / JAN~DEC
주의 날짜(Day-of-week)	1~7 / SUN~SAT

 

 

표현식의 예제

0 0 10 * * *	매일 12시 실행
0 15 09  * * *	매일 09시 15분에 실행
0 * 14 * * *	매일 14시에 0분~59분까지 매분 실행
0 0/5 14 * * *	매일 14시에 시작해서 5분 간격으로 실행
0 0/5 14, 18 * * *	매일 14시, 18시에 시작해서 5분 간격으로 실행
0 0-5 14 * * *	매일 14시에 0,1,2,3,4,5분에 실행
0 0 20 ? * MON-FRI	월요일~금요일 20시 0분 0초에 실행
* /1 * * * *	매 1분마다 실행
* ./10 * * * *	매 10분마다 실행
0/30 * * * * ?	매 30초마다 실행
0 0,10,20,30,40,50 * * * ?	매 10분마다 실행
0 0,20,40 * * * ?	매 20분마다 실행
0 0 1 * * ?	매일 1회 01시 실행
0 30 1 * * ?	매일 1회 1시 30분 실행

 

 

References

https://jaeuk2274.tistory.com/48
https://hmjkor.tistory.com/286
https://m.blog.naver.com/PostView.naver?isHttpsRedirect=true&blogId=ljpark6&logNo=221883162795