섹션 4. 스프링 배치 실행 - Job

[0JUUU]

• [x] 배치 초기화 설정
• [x] Job and Step 소개
• [x] JobBuilderFactory
• [x] SimpleJob - 개념 및 API 소개
• [x] SimpleJob - start() / next()
• [x] SimpleJob - validator()
• [x] SimpleJob - preventRestart()
• [x] SimpleJob - incrementer()
• [x] SimpleJob 아키텍처

[0JUUU]

배치 초기화 설정

많이 사용하는 설정들을 알아보자

spring:
  batch:
    job:
      names: batchJob1 # 이렇게 하드코딩해서 실행시키고자 하는 Job을 설정할 수 있음

만약 없는 Job 이름을 설정한다면 ❓

• 이렇게 실행이 안된다.

있는 Job으로 설정한다면 ❓

• 하지만 이렇게 하드코딩을 하는 경우는 많이 없음 (배치Job의 종류대로 선택해서 수행해야하는 경우가 많기 때문에)

• 바인딩할 수 있는 내용을 적음 (외부에서 Job의 이름을 실행 시점에 Arguments로 전달해서 job.name에 바인딩되도록 함)

  spring:
  batch:
  job:
    names: ${job.name:NONE} # 전달받은 인자 내용이 job.name에 매핑되고, 전달받은 인자가 없다면 NONE이라는 Job이 수행됨

  

• --(하이픈 2개) 가 붙어야함!

• 여기서 설정한 Job의 name 값이 BatchProperties에 저장이 됨.

• 여러 개를 선택하고 싶다면 ,로 구분

디버깅 🐞

• 매칭되지 않으면, execute(실행)하지 않음 / 매칭되면 Job 실행!

테이블 prefix 변경

spring:
  batch:
    jdbc:
      table-prefix: SYSTEM_ # default : BATCH_

• 앞에 SYSTEM_이 붙어있는 것을 확인할 수 있음
• 맞는 Table이 없기에 에러가 발생한다
• 이를 실행시키려면 SYSTEM_xxx로 테이블명을 변경해줘야한다

여러 개의 Job을 실행시켜보자.

// 다른 Job 하나 더 생성
@RequiredArgsConstructor
@Configuration
public class JobConfiguration2 {

    private final JobBuilderFactory jobBuilderFactory;
    private final StepBuilderFactory stepBuilderFactory;

    @Bean
    public Job batchJob2() {
        return this.jobBuilderFactory.get("batchJob2")
                                     .incrementer(new RunIdIncrementer())
                                     .start(step3())
                                     .next(step4())
                                     .build();
    }

    @Bean
    public Step step3() {
        return this.stepBuilderFactory.get("step3")
                                      .tasklet(new Tasklet() {
                                          @Override
                                          public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
                                              System.out.println(">> step3 has executed");
                                              return RepeatStatus.FINISHED;

                                          }
                                      })
                                      .build();
    }

    @Bean
    public Step step4() {
        return this.stepBuilderFactory.get("step4")
                                      .tasklet(((contribution, chunkContext) -> {
                                          System.out.println(">> step4 has executed");
                                          return RepeatStatus.FINISHED;
                                      }))
                                      .build();

    }
}

• 2개의 Job이 실행되는 것을 확인할 수 있다.

[0JUUU]

JobBuilderFactory

• Spring Batch: Job과 Step을 쉽게 생성 및 설정할 수 있도록 util 성격의 빌더 클래스 제공

JobBuilderFactory

• JobBuilder를 생성하는 팩토리 클래스 ➡️ get(String name) 메서드 제공
• jobBuilderFactory.get("jobName") : "jobName" ➡️ Job을 실행시킬 때 참조하는 Job의 이름 (DB에도 저장)

JobBuilder

• Job을 구성하는 설정 조건에 따라 2개의 하위 빌더 클래스 생성 & 실제 Job 생성 위임
• SimpleJobBuilder
  • SimpleJob을 생성하는 Builder 클래스
  • Job 실행과 관련된 여러 설정 API 제공
• FlowJobBuilder
  • FlowJob을 생성하는 Builder 클래스
  • 내부적으로 FlowBuilder를 반환 ➡️ Flow 실행과 관련된 여러 설정 API 제공

아키텍처

상속 구조

• JobBuilderHelper 내부 static 클래스로 CommonJobProperties를 갖고 있음 ➡️ 이를 필드값으로 갖고 있어 Job을 생성하는 공통적인 내용이 저장됨
• JobBuilderFactory에서 JobBuilder를 생성할 때, 생성자의 인자로 JobRepository를 넘기는데 이게 JobBuilder에 CommonJobProperties에 담김
• JobRepository는 빌더 클래스를 통해 Job객체에 전달되어 메타데이터를 기록하는데 사용

[0JUUU]

SimpleJob - 개념 및 API 소개

• SimpleJob은 Step을 실행시키는 Job의 구현체 ➡️ SimpleJobBuilder에 의해 생성
• Step을 순차적으로 실행
• 모든 Step의 실행이 성공적으로 완료되어야 Job이 성공적으로 완료
• 맨 마지막에 실행한 Step의 BatchStatus가 Job의 최종 BatchStatus가 됨
• 다양한 API를 가짐

@Bean
public Step step3() {
    return stepBuilderFactory.get("step3")
                .tasklet((contribution, chunkContext) -> {
                         chunkContext.getStepContext().getStepExecution().setStatus(BatchStatus.FAILED);
                         contribution.setExitStatus(ExitStatus.STOPPED);
                         System.out.println(">> step3 has executed");
                         return RepeatStatus.FINISHED;
                })
               .build();
}

• 의도적으로 실패

BATCH_STEP_EXECUTION

BATCH_JOB_EXECUTION

[0JUUU]

SimpleJob - start() / next()

• start(step) : 처음 실행할 Step 설정. 최초 한 번 설정, SimpleJobBuilder가 생성되고 반환
• next(step) : 여러 번 설정 가능. 모든 next()의 Step이 종료되면 Job이 종료

[0JUUU]

SimpleJob - validator()

• Job 실행에 꼭 필요한 파라미터를 검증하는 용도
• JobParametersValidator 검증 로직을 수행하는 곳 2가지
  1. Job이 수행되기 전, JobRepository 기능 시작하기 전
  2. Job이 수행될 때

첫 번째 체크 단계. SimpleJobLauncher

두 번째 체크 단계. SimpleJob(실제는 AbstractJob에 구현)

• 기본 : DefaultJobParametersValidator

DefaultJobParametersValidator 사용

• 필수값 (requiredKeys) / 선택값(optionalKeys)로 나누어 설정할 수 있음

  // 1st Parameter : requiredKeys, 2nd Parameter : optionalKeys
  new DefaultJobParametersValidator(new String[]{"name", "date"}, new String[]{"count"})

• 필수키가 존재하지 않으면 JobParameterInvalidException
• option키는 존재하지 않아도 됨
• 하지만 얘는 파라미터 존재 여부를 제외한 다른 유효성 검증을 수행하지는 ❌
• 더 강력한 유효성 검증이 필요하다면 JobParametersValidator를 용도에 맞게 직접 구현해야 함

[0JUUU]

SimpleJob - preventRestart()

• Job의 재시작 여부를 설정
• 재시작과 관련 있는 기능 ➡️ Job을 처음 실행하는 것과는 아무 관련 ❌
• 기본 true이던 설정값을 해당 API를 호출하면 false로 변경되도록 함
• 절대로 Job을 재시작해서는 안되는 경우에 유용

JobBuilderHelper

public abstract class JobBuilderHelper<B extends JobBuilderHelper<B>> {
    public B preventRestart() {
        properties.restartable = false;
        @SuppressWarnings("unchecked")
        B result = (B) this;
        return result;
    }
}

의도적인 에러 발생

BATCH_JOB_EXECUTION

• 에러를 고치면 원래대로라면 재실행이 가능해야함
• 하지만 preventRestart()를 설정했기에 불가능하다.

[0JUUU]

SimpleJob - incrementer()

• JobParameters에서 필요한 값을 증가시켜 다음에 사용될 JobParameters 오브젝트를 리턴
• 기존의 JobParameters 변경없이 Job을 여러 번 시작하고자 할 때 사용

커스텀해서

public class CustomJobParametersIncrementer implements JobParametersIncrementer {

    static final SimpleDateFormat format = new SimpleDateFormat("yyyyMMdd-hhmmss");
    @Override
    public JobParameters getNext(JobParameters parameters) {
        String id = format.format(new Date());
        return new JobParametersBuilder().addString("run.id", id).toJobParameters();
    }
}

    @Bean
    public Job batchJob() {
        return this.jobBuilderFactory.get("batchJob")
                                     .start(step1())
                                     .next(step2())
                                     .incrementer(new CustomJobParametersIncrementer())
                                     .build();
    }

• 커스텀한 Incrementer를 사용한다고 명세

• 재시작을 해도 에러를 내뱉지않고 정상작동

  

• run.id : 다시 실행하기 위한 목적으로 생성한 JobParameters

Spring Batch 에서 기본 제공하는 기능 : RunIdIncremeter

.incrementer(new RunIdIncrementer())

[0JUUU]

SimpleJob 아키텍처

• JobLauncher는 SimpleJob과 Jobparameters를 갖고 Job 실행
• 그 사이에 Job이 실행될 때 필요한 메타 데이터 생성(JobInstance, JobExecution, ExecutionContext)
• Job이 실행되기 전에 JobListener에서 beforeJob 호출
• 각각 Step이 실행되면서 StepExecution과 ExecutionContext 생성
• Step이 모두 종료되면 JobListener에서 afterJob 호출
• 마지막 Step 단계의 BatchStatus와 ExitStatus를 Job에 업데이트