Quartz + Spring Batch 조합!

Quartz Scheduler 와 Spring Batch 의 궁합과 조합을 정리.

Posted by kingbbode on August 20, 2017

Recently by the same author:


3년차 웹 개발자

4년차로 접어든 웹 개발자의 3년차 늦은 회고

You may find interesting:


SpringOne Tour Seoul - Spring Cloud Gateway

스프링 원 투어 서울 컨퍼런스 중 정윤진님의 Spring Cloud Gateway 세션


스프링캠프 2018-Consumer Driven Contract

Consumer Driven Contract 기법을 활용한 마이크로서비스 API의 진화

Quartz + Spring Batch 조합하기

Zum 에서 BeyondJ2EE 김태기 팀장님과 표준화 프로젝트를 진행하며, Zum 에서의 Batch 에 대한 표준을 작성하며 알게 된 Quartz Framework 의 매력과 직접 개발해본 Spring 과의 조합 및 궁합을 소개해보려고 합니다.

Quartz란?

logo

Quartz Scheduler 는 거의 모든 Java 응용 프로그램에 통합 할 수 있는 풍부한 기능의 오픈 소스 작업 스케줄 라이브러리입니다.

저에게는 다소 생소했던 라이브러리였습니다. 그래서 리서치를 해보았더니,

스프링에서 Unix의 Cron 처럼 특정시간 혹은 몇분 혹은 몇시간마다 동작해는 스케쥴러를 구현해야 했다.

그래서 찾아보게 된게 Spring + Quartz Scheduler 조합의 활용이었다.

하지만 Spring 3.1 버전 부터는 Quartz Scheduler를 사용하지 않고도 Scheduler를 통한 Job을 실행할 수 있게 되었다.

출처: http://javafactory.tistory.com/1386 [FreeLife의 저장소]

위와 같은 글을 보았습니다. 위 말 처럼 우리는 이미 Spring Framework 안에서 @Scheduled 를 통해 과거 Quartz 에서 제공해주었던 cron schedule 기능 등을 사용하고 있는 것 입니다.

FreeLife의 저장소 : What is Quartz 의 글을 보면 2001년 봄에 해당 라이브러리가 등장하였다고 소개합니다. 많은 경험과 경력을 가지신 개발자 분들은 이미 Quartz 에 대해 많이 들어보셨을까요?

저에게는 굉장히 생소한 그런 라이브러리였습니다. 그럼에도 그 기능이나 내용에 큰 매력을 느꼈습니다. :)

그래서 추측해보면, Quartz 는 과거 Cron 과 같은 스케줄링을 위해 많이 쓰이던 라이브러리였지만, 스프링 3.1 버전 후부터 그 기능을 Spring Framework 에서 제공해주기 때문에 조금은 Spring Framework 와 멀어졌던 라이브러리라고 생각합니다.


왜 Quartz 인가?

제가 Quartz 에 매력을 느끼게 된 가장 큰 이유 중 2가지만 설명하려 합니다.

첫번째는 Clustering 기능 입니다.

cluster

출처 : http://www.quartz-scheduler.org/documentation/quartz-2.x/configuration/ConfigJDBCJobStoreClustering.html

Schedule에 대한 Clustering 기능입니다.

Quartz 는 Database 기반으로 Scheduler Key 와 Trigger Key 를 통해 Schedule 을 Clustering 합니다.

즉, Database 를 기반으로 모든 Schedule에 대한 제어가 가능하다는 말 입니다.

Schedule 과 Trigger 를 가진 Batch Application 을 Grouping 할 수 있는 구조를 제공하여, 여러 Application을 가지고 있는 Server 들을 제어할 수 있으며, 그 Application 들을 Clustering 기능을 통해 적절히 분배하여 효율적으로 동작시킬 수 있으며, 서버 장애 상황에도 대응할 수도 있을 것 입니다.

간단히 예를 들자면,

특정 주제에 대해 여러 Job 을 가지고 있는 Batch Application이 Clustering이 없는 시스템에서 하나의 서버가 장애 상황에 발생했을 때

non-clustering

위와 같이 Job 이 진행 될 수 없지만, Clustering 기능이 있다면

Clustering

같은 Group 군 안에 있는 정상 서버의 Application 들이 나머지 Job 들을 적절히 분배하여 실행할 수 있으므로 효율적인 Batch 수행이 가능할 것이라고 생각 합니다.

위 예가 적절하지 않을 수도 있지만, Batch Application 에서도 Clustering 이 갖는 이점이 많겠다고 생각했습니다.

두번째는 Scheduling 을 위해 최적화된 구조를 제공한다는 점 입니다.

quartzscheduler

Quartz 는 Scheduler, Trigger, JobDetail 등의 구조를 통해 Scheduling 에 최적화된 구조를 제공합니다.

다양한 Java 라이브러리를 통해 해당 설정들을 쉽게 지원하기 위한 도구들도 많이 있습니다.

  • Scheduler : 스케줄러와 상호 작용하기위한 주요 API 입니다.
  • Trigger : 주어진 작업이 실행될 일정을 정의하는 구성 요소입니다.
  • JobDetail : 작업의 인스턴스를 정의하는 데 사용됩니다.

현재는 Spring Boot에서 Quartz를 지원하진 않지만, 곧 나오게 될 Spring Boot 2.0에는 Quartz Starter Pack이 포함되어 있습니다.


왜 Quartz + Spring Batch 조합인가?

Quartz 가 그리 좋은데 왜 Spring Batch 가 필요한가? 라고 생각했을 수도 있지만, 역할을 나누어보면 굉장히 당연한 일 입니다.

제가 생각하는 Quartz 는 Scheduling 에 최적화 되어있을 뿐, Batch성 Job에 최적화 되어있지는 않습니다. 애초에 Project 이름이 Quartz Scheduler 이기도 합니다!

많지는 않지만, 여러 Batch Application을 개발하면서 Spring Batch에서 제공해주는

spring-batch

출처: http://wiki.gurubee.net/pages/viewpage.action?pageId=4949437

Job - Step - Reader - Processor - Writer

라는 구조가 정말 편하고 좋다고 생각했습니다.

Spring Boot에서도 Spring Batch에 대한 설정을 지원해줄 뿐만 아니라, Spring Batch를 위한 수많은 라이브러리가 있습니다.

제가 해야했던 것은 Batch Application 개발이였으니, Spring Batch는 포기할 수 없었습니다.

또한, Spring Batch 에서 Database 를 통해 제공하는 여러가지 정보들도 굉장히 유용히 쓸 수 있을 것 입니다.

그래서 제가 생각한 Quartz 와 Spring Batch 의 구조는,

spring-batch

입니다!

Quartz vs Jenkins

Job Luncher 역할을 하는 다른 도구들과 비교를 해보았습니다.

job luncher

그리고 그 중에서 제 주변에서는 Batch 를 수행할 때 가장 많이 쓰고 있다고 하는 Jenkins 와 비교하여 Quartz 의 장단점을 적어보겠습니다.

Quartz 장점

  • Database 를 기반으로 Schedule 인스턴스들 간의 Clustering 이 가능합니다.

  • Application 이 구동된 상태를 유지하기 때문에, 비교적 정확한 시간에 Job 수행이 가능합니다.

Quartz 단점

  • UI Admin 을 제공하지 않습니다.
    • 알람 기능, Schedule Control 기능 등을 직접 구현하거나, 안써야 함

History 기능

Quartz 자체는 Schedule 실행에 대한 History를 보관하지 않습니다.

그럼 Job 에 대한 History는 어떻게?

spring-batch-erd

바로 Spring Batch 에서 제공해주는 기능을 사용하면 됩니다. Spring Batch 는 다양한 테이블들로 작업에 대한 기록을 남깁니다.

각 Job 과 Step 에 대한 꽤 상세한 히스토리를 알 수 있습니다.

개인적으로는 Jenkins 를 사용한다고 해도 Spring Batch Job History 는 반드시 봐야한다고 생각합니다. 사실 우리가 알고 싶은 건 Job 에 대한 History 지 Scheduling 에 대한 History가 아니기 때문입니다.

결론은 Quartz로 내려고 했으나, 많은 호불호가 있을 것으로 예상하여.. 각각 장단점이 있는 것으로.


Quartz + Spring Batch 조합 개발하기

Quartz 개발과 Spring Batch 개발에 대한 내용은 생략하겠습니다.

아래 내용에서는 Quartz와 Spring Batch의 연동을 위한 핵심 내용만 기록할 것이며, 그 외의 설정들은 Github 소스를 참고 부탁드립니다.

전반적인 Spring Batch와 Quartz 조합 개발은 javacodegeeks:Quartz Spring Batch Example 을 참고하시면 됩니다.

위 내용은 매우 잘 정리되었지만, Database 기반으로 Clustering 환경을 구성하기에는 어려운 부분이 있습니다. 그 부분을 고쳐가며, 보다 안정적인 환경으로 개발을 해보겠습니다.

QuartzJobLauncher

Quartz 와 Spring Batch 를 구성함에 핵심 은 Quartz의 Job(Spring Batch Job이 아닌.. 둘 다 Job이라 조금 혼돈이 올 수 있습니다)에서 사용되는 Class가 단 하나라는 것 입니다. 그 Class 는 QuartzJobLauncher 라는 파라미터를 기반으로 Spring Batch의 Job을 구동시키는 역할을 합니다.

springquartzbatch

기존 Spring Framework + Quartz 가 위와 같고,

springquartzbatch

Spring Framework + Quartz + Spring Batch 조합은 위와 같습니다.

문제점

javacodegeeks:Quartz Spring Batch ExampleQuartzJobLauncher Class가 Database 기반에서 효율적인 못한 문제점은 아래 부분입니다.

public class QuartzJobLauncher extends QuartzJobBean {
    private String jobName;
    private JobLauncher jobLauncher;
    private JobLocator jobLocator;

@Bean
public JobDetailFactoryBean jobDetailFactoryBean() {
    JobDetailFactoryBean factory = new JobDetailFactoryBean();
    factory.setJobClass(QuartzJobLauncher.class);
    Map map = new HashMap();
    map.put("jobName", "fxmarket_prices_etl_job");
    map.put("jobLauncher", jobLauncher);
    map.put("jobLocator", jobLocator);
    factory.setJobDataAsMap(map);
    factory.setGroup("etl_group");
    factory.setName("etl_job");
    return factory;
}

Spring Batch Job을 실행 시키기 위한 JobLauncherJobLocatorQuartzJobBean를 이용하여, Parameter 기반으로 주입받고 있습니다. 이것이 문제가 되는 것은 Database를 사용할 때는 Parameter가 데이터베이스의 필드에 저장되야 하기 때문입니다.

그래서 QuartzJobBean를 사용하는데신, 필요한 Bean의 Injection을 Spring에게 위임하여야 합니다.

AutowireCapableBeanJobFactory

BatchConfiguration.java

@Bean
public JobFactory jobFactory(AutowireCapableBeanFactory beanFactory) {
    return new SpringBeanJobFactory(){
        @Override
        protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
            Object job = super.createJobInstance(bundle);
            beanFactory.autowireBean(job);
            return job;
        }
    };
}

Quartz Job Class 의 auto-wiring 을 지원하는 JobFactory를 만들어 줍니다. Spring Boot 2.0 에서는 AutowireCapableBeanJobFactory 라는 이름의 Class로 제공될 예정입니다. 이 Class를 통해 앞으로 Quartz Job 클래스가 만들어질 때는 Quartz 내부 로직이 아닌 Spring을 통해 필요한 의존성을 주입할 수 있습니다.

QuartzJobLauncher도 다시 작성하게 되면

public class BatchJobExecutor implements org.quartz.Job {
    @Autowired
    private JobLocator jobLocator;

    @Autowired
    private JobLauncher jobLauncher;

우리가 잘 알고 있는 @Autowire 를 통해 Injection 받을 수 있게 작성합니다.

ADMIN UI를 만들기 위해 필요한 것

아직 저도 ADMIN UI를 직접 만들진 않았지만, 여기서는 Quartz Table 과 Spring Batch Table 을 어떻게 연결할 것인지 고민했던 내용을 기록합니다.

일단 이 내용이 없어도 가능한 것을 먼저 보겠습니다.

  • Spring Batch Job 모니터링 : 테이블 정보만 출력해주면 되므로..
  • Quartz Schedule Control : 테이블 정보만 업데이트해주면 되므로..

그리고 현재 상황에서는 불가능한 것이 Spring Batch Job이 어떤 Schedule Instance와 Trigger에 의해서 실행되었는지 모니터링 입니다.

불가능한 이유는 현재 Spring Batch Job 과 Quartz Schedule 간의 연관관계를 기록한 내용이 없기 때문입니다.

그래서 저는 이렇게 해결하려고 합니다.


@Override
    public void execute(JobExecutionContext context) throws JobExecutionException {

...

JobParameters jobParameters = new JobParametersBuilder(jobName)
.addString(JOB_PARAMETERS_QUARTZ_KEY,
  context.getScheduler().getSchedulerName()
          + TOKEN + context.getJobDetail().getKey().getGroup()
          + TOKEN + context.getJobDetail().getKey().getName())
.addLong("timestamp", System.currentTimeMillis())
      .toJobParameters();

...

jobLauncher.run(jobLocator.getJob(jobName), jobParameters);

Quartz Job을 만들면 주입받는 Quartz JobExecutionContext을 통해 Spring Batch Job으로 Schedule에 대한 정보를 Parameter로 공급하는 것 입니다.

이렇게 되면 어떤 형태로든, Quartz와 Spring Batch 간의 관계를 찾을 수 있지 않을까 합니다!

GracefulShutdown

Quartz 는 자체 Plugin을 통해 GracefulShutdown을 지원하고 있기는 합니다.

Scheduler에 등록되는 Properties에서 org.quartz.plugin.shutdownhook 을 사용하는 것 입니다. 그러나! DataSource에 대한 설정을 Spring Framework에게 위임했다면 이 설정을 쓸 수 없습니다.

그 이유는 Spring Framework가 종료될 때 독립적으로 수행되고 있는 Quartz Job을 기다리지 않기 때문입니다. 기다리지 않기 때문에 Spring Framework는 DataSource Connection을 close할 것이고, Quartz는 Job이 정상적으로 완료되었다고 할지라도 DataSource 에 정보를 업데이트하지 못한 채 종료가 됩니다.

해결책은 간단합니다. Spring Framework 가 종료될 때 Quartz 상태를 체크하고 기다리거나 종료하거나 하는 것 입니다.

@Bean
public SmartLifecycle gracefulShutdownHookForQuartz(SchedulerFactoryBean schedulerFactoryBean) {
    return new SmartLifecycle() {
        private boolean isRunning = false;
        private final Logger logger = LoggerFactory.getLogger(this.getClass());
        @Override
        public boolean isAutoStartup() {
            return true;
        }

        @Override
        public void stop(Runnable callback) {
            stop();
            logger.info("Spring container is shutting down.");
            callback.run();
        }

        @Override
        public void start() {
            logger.info("Quartz Graceful Shutdown Hook started.");
            isRunning = true;
        }

        @Override
        public void stop() {
            isRunning = false;
            try {
                logger.info("Quartz Graceful Shutdown... ");
                schedulerFactoryBean.destroy();
            } catch (SchedulerException e) {
                try {
                    logger.info(
                            "Error shutting down Quartz: " + e.getMessage(), e);
                    schedulerFactoryBean.getScheduler().shutdown(false);
                } catch (SchedulerException ex) {
                    logger.error("Unable to shutdown the Quartz scheduler.", ex);
                }
            }
        }

        @Override
        public boolean isRunning() {
            return isRunning;
        }

        @Override
        public int getPhase() {
            return Integer.MAX_VALUE;
        }
    };
}

shutdowngif

Spring Application에 Showdown Hook을 등록해놓고, Quartz Job이 종료될 때까지 기다린 후 Application이 종료되게 합니다.


결론

clsutering

(위 그림은 동일한 Schedule 의 Application이 Job1, Job2 를 데이터베이스 기반으로 Clustering 하여 Job을 수행하는 모습입니다.)

회사 표준화 프로젝트의 일환으로 최대한 간소화한 코드를 공개하는 점에 양해를 부탁드립니다. 철저히 제 생각을 기반으로 Spring Batch + Quartz 를 만들고 정리해보았습니다.

잘못된 정보가 있을 수도 있고, 맞지 않는 생각이나, 불안요소가 있을 것 입니다.

jsg

개발자님들의 많은 피드백 부탁드립니다 :)