Job

JobLauncher

Job, JobParameters์™€ ํ•จ๊ป˜ ๋ฐฐ์น˜๋ฅผ ์‹คํ–‰ํ•˜๋Š” ์ธํ„ฐํŽ˜์ด์Šค๋กœ, ๋ฉ”์„œ๋“œ๋Š” run ํ•œ๊ฐœ์ด๋‹ค.

  • Job์„ ์‹คํ–‰ํ•˜๋Š” ์—ญํ• 

  • Job.execute() ํ˜ธ์ถœ

  • Job์žฌ์‹คํ–‰ ๊ฐ€๋Šฅ ์—ฌ๋ถ€ ๊ฒ€์ฆ

  • Job ์‹คํ–‰ ๋ฐฉ๋ฒ•(ํ˜„์žฌ ์Šค๋ ˆ๋“œ์—์„œ ์ˆ˜ํ–‰ํ• ์ง€, ์Šค๋ ˆ๋“œ ํ’€์„ ํ†ตํ•ด ์‹คํ–‰ํ• ์ง€ ๋“ฑ)

  • ํŒŒ๋ผ๋ฏธํ„ฐ ์œ ํšจ์„ฑ ๊ฒ€์ฆ

  • ์Šคํ”„๋ง๋ถ€ํŠธ๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด ์Šคํ”„๋ง ๋ถ€ํŠธ๊ฐ€ ์ฆ‰์‹œ Job๋ฅผ ์‹œ์ž‘ํ•˜๋Š” ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•ด, ์ผ๋ฐ˜์ ์œผ๋กœ๋Š” ์ง์ ‘ ๋‹ค๋ฃฐ ํ•„์š” ์—†์Œ

public interface JobLauncher {
  	// Job๊ณผ JobParameters๋ฅผ ๋งค๊ฐœ๋ณ€์ˆ˜๋กœ ๋ฐ›์•„ JobExecution ๋ฐ˜ํ™˜
    // ๋งค๊ฐœ๋ณ€์ˆ˜๊ฐ€ ๋™์ผํ•˜๋ฉฐ, ์ด์ „ JobExecution๊ฐ€ ์ค‘๋‹จ๋œ ์ ์ด ์žˆ์œผ๋ฉด ๋™์ผํ•œ JobExecution ๋ฐ˜ํ™˜
    JobExecution run(Job var1, JobParameters var2) throws JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException, JobParametersInvalidException;
}

JobExplorer

  • org.springframework.batch.core.explore.JobExplorer

  • JobRepository ์— ์žˆ๋Š” ์ด๋ ฅ ๋ฐ์ดํ„ฐ๋‚˜ ์ตœ์‹  ๋ฐ์ดํ„ฐ์— ์ ‘๊ทผํ•˜๋Š” ์‹œ์ž‘์ ์ด๋‹ค.

  • JobExplorer๋Š” ์žก ์ •๋ณด๋ฅผ ์–ป๊ธฐ์œ„ํ•ด ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค์— ์ง์ ‘ ์ ‘๊ทผํ•œ๋‹ค.

๋ฉ”์„œ๋“œ
์„ค๋ช…

Set<JobExecution> findRunningJobExecutions(@Nullable String jobName)

์ข…๋ฃŒ ์‹œ๊ฐ„์ด ์กด์žฌํ•˜์ง€ ์•Š๋Š” ๋ชจ๋“  JobExecution ๋ฐ˜ํ™˜

List<JobInstance> findJobInstancesByJobName(String jobName, int start, int count)

์ „๋‹ฌ๋ฐ›์€ ์ด๋ฆ„์„ ๊ฐ€์ง„ JobInstance ๋ชฉ๋ก ๋ฐ˜ํ™˜(ํŽ˜์ด์ง• ์ฒ˜๋ฆฌ)

JobExecution getJobExecution(@Nullable Long executionId)

์ „๋‹ฌ๋ฐ›์€ ID๋ฅผ ๊ฐ€์ง„ JobExecution ๋ฐ˜ํ™˜ ์กด์žฌํ•˜์ง€ ์•Š๋Š”๋‹ค๋ฉด null ๋ฐ˜ํ™˜

List<JobExecution> getJobExecutions(JobInstance jobInstance)

์ „๋‹ฌ๋ฐ›์€ JobInstance ์™€ ์—ฐ๊ด€๋œ ๋ชจ๋“  JobExecution ๋ชฉ๋ก ๋ฐ˜ํ™˜

JobInstance getJobInstance(@Nullable Long instanceId)

์ „๋‹ฌ๋ฐ›์€ ID๋ฅผ ๊ฐ€์ง„ JobInstance ๋ฐ˜ํ™˜ ์กด์žฌํ•˜์ง€ ์•Š์œผ๋ฉด null ๋ฐ˜ํ™˜

List<JobInstance> getJobInstances(String jobName, int start, int count)

์ „๋‹ฌ๋ฐ›์€ ์ด๋ฆ„์„ ๊ฐ€์ง„ JobInstance ๋ชฉ๋ก ๋ฐ˜ํ™˜(ํŽ˜์ด์ง• ์ฒ˜๋ฆฌ)

int getJobInstanceCount(@Nullable String jobName)

์ „๋‹ฌ๋ฐ›์€ ์žก ์ด๋ฆ„์œผ๋กœ ์ƒ์„ฑ๋œ JobInstance ์ˆ˜

List<String> getJobNames()

JobRepository์— ์ €์žฅ๋ผ ์žˆ๋Š” ๊ณ ์œ ํ•œ ๋ชจ๋“  ์žก ์ด๋ฆ„ ์•ŒํŒŒ๋ฒณ ์ˆœ ๋ฆฌ์ŠคํŠธ

StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable Long stepExecutionId)

์ „๋‹ฌ๋ฐ›์€ jobExecutionId์™€ stepExecutionId๋ฅผ ๊ฐ€์ง„ StepExecution ๋ฐ˜ํ™˜

@AllArgsConstructor
public class ExploringTasklet implements Tasklet {

    private JobExplorer jobExplorer;

    @Override
    public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {

        // ํ˜„์žฌ Job์ด๋ฆ„ ์กฐํšŒ
        String jobName = chunkContext.getStepContext().getJobName();

        // ์ด๋•Œ๊ฐ€์ง€ ์‹คํ–‰๋œ ๋ชจ๋“  JobInstance ์กฐํšŒ
        List<JobInstance> instaces = jobExplorer.getJobInstances(jobName, 0, Integer.MAX_VALUE);

        System.out.println(String.format("%d job instances for the job %s", instaces.size(), jobName));

        System.out.println("===========================");

        for (JobInstance instance : instaces) {

            // JobInstance์™€ ๊ด€๋ จ๋œ JobExecution
            List<JobExecution> jobExecutions = this.jobExplorer.getJobExecutions(instance);
            System.out.println(String.format("Instance %d had %d executions", instance.getInstanceId(), jobExecutions.size()));

            for (JobExecution jobExecution : jobExecutions) {
                System.out.println(String.format("Execution %d resulted in ExitStatus %s", jobExecution.getId(), jobExecution.getExitStatus()));
            }
        }

        return RepeatStatus.FINISHED;

    }
}
@EnableBatchProcessing
@Configuration
public class DemoTaskletConfiguration {
    @Autowired
    private JobBuilderFactory jobBuilderFactory;

    @Autowired
    private StepBuilderFactory stepBuilderFactory;

    @Autowired
    private JobExplorer jobExplorer;

    @Bean
    public Tasklet explorerTasklet() {
        return new ExploringTasklet(this.jobExplorer);
    }

    @Bean
    public Step explorerStep() {
        return this.stepBuilderFactory.get("explorerStep")
                .tasklet(explorerTasklet())
                .build();
    }

    @Bean
    public Job explorerJob() {
        return this.jobBuilderFactory.get("explorerJob")
                .start(explorerStep())
                .build();
    }
}

Job

  • ๋ฐฐ์น˜ ์ฒ˜๋ฆฌ ๊ณผ์ •์„ ํ•˜๋‚˜์˜ ๋‹จ์œ„๋กœ ํ‘œํ˜„ํ•œ ๊ฐ์ฒด๋กœ ์ „์ฒด ๋ฐฐ์น˜ ์ฒ˜๋ฆฌ์— ์žˆ์–ด ์ตœ์ƒ๋‹จ ๊ณ„์ธต

  • Job์€ ์ค‘๋‹จ์ด๋‚˜ ์ƒํ˜ธ์ž‘์šฉ ์—†์ด ์ฒ˜์Œ๋ถ€ํ„ฐ ๋๊นŒ์ง€ ์‹คํ–‰๋˜๋Š” ์ฒ˜๋ฆฌ

  • Spring Batch์—์„œ Job ๊ฐ์ฒด๋Š” ์—ฌ๋Ÿฌ step ์ธ์Šคํ„ด์Šค๋ฅผ ํฌํ•จํ•˜๋Š” ์ปจํ…Œ์ด๋„ˆ

Job Runner

Job์˜ ์‹คํ–‰์€ job runner์—์„œ ์‹œ์ž‘๋œ๋‹ค. job runner๋Š” ์žก ์ด๋ฆ„๊ณผ ํŒŒ๋ผ๋ฏธํ„ฐ๋กœ ํ•ด๋‹น ์žก์„ ์‹คํ–‰์‹œํ‚ค๋Š” ์—ญํ• ์„ ํ•œ๋‹ค.

  • CommandLineJobRunner : ์Šคํฌ๋ฆฝํŠธ๋ฅผ ์ด์šฉํ•˜๊ฑฐ๋‚˜ ๋ช…๋ นํ–‰์—์„œ ์ง์ ‘ Job์„ ์ˆ˜ํ–‰ํ•  ๋•Œ ์‚ฌ์šฉ

    • ์Šคํ”„๋ง ๋ฐฐ์น˜ ์ œ๊ณต

    • ์Šคํ”„๋ง์„ ๋ถ€ํŠธ์ŠคํŠธ๋žฉํ•˜๋ฉฐ ์ „๋‹ฌ๋ฐ›์€ ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ์‚ฌ์šฉํ•ด ์š”์ฒญ๋œ ์žก ์‹คํ–‰

    • org.springframework.batch.core.launch.support.CommandLineJobRunner

  • JobRegistryBackgroundJobRunner : ์Šคํ”„๋ง์„ ๋ถ€ํŠธ์ŠคํŠธ๋žฉ์—์„œ ๊ธฐ๋™ํ•œ ์ž๋ฐ” ํ”„๋กœ์„ธ์Šค ๋‚ด์—์„œ Quartz๋‚˜ Jmx ํ›„ํฌ์™€ ๊ฐ™์€ ์Šค์ผ€์ค„๋Ÿฌ๋ฅผ ์‚ฌ์šฉํ•ด ์žก์„ ์‹คํ–‰ํ•˜๋ฉด JobReistry๋ฅผ ์ƒ์„ฑํ•˜๊ฒŒ ๋œ๋‹ค. JobRegistryBackgroundJobRunner๋Š” JobRegistry๋ฅผ ์ƒ์„ฑํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ

    • ์Šคํ”„๋ง ๋ฐฐ์น˜ ์ œ๊ณต

    • org.springframework.batch.core.launch.support.JobRegistryBackgroundJobRunner

  • JobLauncherCommandLineRunner

    • ์Šคํ”„๋ง ๋ถ€ํŠธ ์ œ๊ณต

    • ๋ณ„๋„์˜ ๊ตฌ์„ฑ์ด ์—†๋‹ค๋ฉด ๊ธฐ๋ณธ์ ์œผ๋กœ ApplicationContext์— ์ •์˜๋œ Job ํƒ€์ž…์˜ ๋ชจ๋“  ๋นˆ์„ ๊ธฐ๋™์‹œ ์‹คํ–‰

Job Runner๋Š” ํ”„๋ ˆ์ž„์›Œํฌ๊ฐ€ ์ œ๊ณตํ•˜๋Š” ํ‘œ์ค€ ๋ชจ๋“ˆ์ด ์•„๋‹ˆ๋ฉฐ, ๊ฐ ์‹œ๋‚˜๋ฆฌ์˜ค๋งˆ๋‹ค ๋‹ค๋ฅธ ๊ตฌํ˜„์ฒด๊ฐ€ ํ•„์š”ํ•˜๊ธฐ ๋•Œ๋ฌธ์— ํ”„๋ ˆ์ž„์›Œํฌ๊ฐ€ JobRunner ์ธํ„ฐํŽ˜์ด์Šค๋ฅผ ๋ณ„๋„๋กœ ์ œ๊ณตํ•˜์ง€ ์•Š๋Š”๋‹ค.

์‹ค์ œ๋กœ ์žก ๋Ÿฌ๋„ˆ๊ฐ€ ์•„๋‹Œ org.springframework.batch.core.launch.JobLauncher ์ธํ„ฐํŽ˜์ด์Šค๊ฐ€ ํ”„๋ ˆ์ž„์›Œํฌ ์‹คํ–‰์‹œ์ž‘์ ์ด๋ฉฐ, ์Šคํ”„๋ง ๋ฐฐ์น˜๋Š” SimpleJobLauncher ๋งŒ ์ œ๊ณตํ•œ๋‹ค.

JobBuilderFactory

Job ๊ฐ์ฒด๋ฅผ ๋งŒ๋“œ๋Š” ๋นŒ๋”๋Š” ์—ฌ๋Ÿฌ๊ฐœ๊ฐ€ ์žˆ๋‹ค. JobBuilderFactory๋Š” ์—ฌ๋Ÿฌ ๋นŒ๋”๋ฅผ ํ†ตํ•ฉ ์ฒ˜๋ฆฌํ•˜๋Š” ๊ณต์žฅ์ด๋ฉฐ, ์›ํ•˜๋Š” Job์„ ์†์‰ฝ๊ฒŒ ๋งŒ๋“ค ์ˆ˜ ์žˆ๋‹ค.

package org.springframework.batch.core.configuration.annotation;

import org.springframework.batch.core.job.builder.JobBuilder;
import org.springframework.batch.core.repository.JobRepository;

public class JobBuilderFactory {
    private JobRepository jobRepository;

    public JobBuilderFactory(JobRepository jobRepository) {
        this.jobRepository = jobRepository;
    }

  	// JobBuilder ์ƒ์„ฑ ๋ฐ˜ํ™˜
    public JobBuilder get(String name) {
        JobBuilder builder = (JobBuilder)(new JobBuilder(name)).repository(this.jobRepository);
        return builder;
    }
}

JobBuilderFactory์˜ get ๋ฉ”์„œ๋“œ๋ฅผ ํ˜ธ์ถœํ•  ๋•Œ๋งˆ๋‹ค ์ƒˆ๋กœ์šด JobBuilder๋ฅผ ์ƒ์„ฑ๋˜๋ฉฐ, ์ƒˆ๋กœ์šด JobBuilder๋ฅผ ์ƒ์„ฑํ•  ๋•Œ๋งˆ๋‹ค JobBuilderFactory๊ฐ€ ์ƒ์„ฑ๋  ๋•Œ ์ฃผ์ž…๋ฐ›์€ JobRepository๋ฅผ ์„ค์ •ํ•˜๋Š” ๊ฒƒ์„ ๋ณผ ์ˆ˜ ์žˆ๋‹ค. ํ•ด๋‹น JobBuilderFactory์—์„œ ์ƒ์„ฑ๋˜๋Š” ๋ชจ๋“  JobBuilder๊ฐ€ ๋™์ผํ•œ JobRepository๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด๋‹ค.

์ฆ‰, JobBuilderFactory๋Š” JobBuilder๋ฅผ ์ƒ์„ฑํ•˜๋Š” ์—ญํ• ๋งŒ ์ˆ˜ํ–‰ํ•œ๋‹ค.

JobBuilder

public class JobBuilder extends JobBuilderHelper<JobBuilder> {
    public JobBuilder(String name) {
        super(name);
    }
		
    // 1. step์„ ์ถ”๊ฐ€ํ•˜์—ฌ ๊ฐ€์žฅ ๊ธฐ๋ณธ์ด ๋˜๋Š” SimpleJobBuilder ์ƒ์„ฑ
    public SimpleJobBuilder start(Step step) {
        return (new SimpleJobBuilder(this)).start(step);
    }

  	// 2. Flow๋ฅผ ์‹คํ–‰ํ•  JobFlowBuilder ์ƒ์„ฑ
    public JobFlowBuilder start(Flow flow) {
        return (new FlowJobBuilder(this)).start(flow);
    }

  	// 3. Step์„ ์‹คํ–‰ํ•  JobFlowBuilder ์ƒ์„ฑ
    public JobFlowBuilder flow(Step step) {
        return (new FlowJobBuilder(this)).start(step);
    }
}

JobBuilder๋Š” ์ง์ ‘์ ์œผ๋กœ Job์„ ์ƒ์„ฑํ•˜๋Š” ๊ฒƒ์ด ์•„๋‹ˆ๋ผ ๋ณ„๋„์˜ ๊ตฌ์ฒด์ ์ธ ๋นŒ๋”๋ฅผ ์ƒ์„ฑํ•ด ๋ฐ˜ํ™˜ํ•œ๋‹ค. ์™œ๋ƒํ•˜๋ฉด ๊ฒฝ์šฐ์— ๋”ฐ๋ผ Job ์ƒ์„ฑ ๋ฐฉ๋ฒ•์ด ๋ชจ๋‘ ๋‹ค๋ฅด๊ธฐ ๋–„๋ฌธ์— ๋ณ„๋„์˜ ๊ตฌ์ฒด์ ์ธ ๋นŒ๋”๋ฅผ ๊ตฌํ˜„ํ•˜๊ณ , ์ด๋ฅผ ํ†ตํ•ด Job ์ƒ์„ฑ์ด ์ด๋ฃจ์–ด์ง€๊ฒŒ ํ•œ๋‹ค.

์ค‘๊ฐ„์— ๋นŒ๋”๋ฅผ ํ•œ๋ฒˆ ๋” ๋ฐ˜ํ™˜ํ•˜์—ฌ ์‚ฌ์šฉํ•ด์•ผํ•˜์ง€๋งŒ, ๋ฉ”์„œ๋“œ ์ฒด์ธ ๋ฐฉ์‹์„ ํ™œ์šฉํ•˜๋ฉด ์†์‰ฝ๊ฒŒ ์ฒ˜๋ฆฌํ•  ์ˆ˜ ์žˆ๋‹ค. Job์€ Step / Flow ์ธ์Šคํ„ด์Šค์˜ ์ปจํ…Œ์ด๋„ˆ ์—ญํ• ์„ ํ•˜๊ธฐ ๋•Œ๋ฌธ์— ์ƒ์„ฑ ์ด์ „์— ์ธ์Šคํ„ด์Šค๋ฅผ ์ „๋‹ฌ ๋ฐ›๋Š”๋‹ค.

  • SimpleJobBuilder๋กœ Job ์ƒ์„ฑํ•˜๊ธฐ

		@Autowired
    private JobBuilderFactory jobBuilderFactory;

    @Bean
    public Job simpleJob(){
        return jobBuilderFactory.get("simpleJob")	// "simpleJob" ์ด๋ฆ„์„ ๊ฐ€์ง„ JobBuilder instance ๋ฐ˜ํ™˜
                                .start(simpleStep()) // step์„ ์ƒ์„ฑํ•˜๋Š” ๋ฉ”์„œ๋“œ๋กœ ์ƒ์„ฑ๋˜๋Š” SimpleJobBuilder
                                .build();						// build ๋ฉ”์„œ๋“œ ํ˜ธ์ถœ๋กœ Job ๋ฐ˜ํ™˜
    }

JobInstance

๋ฐฐ์น˜ ์ฒ˜๋ฆฌ์—์„œ Job์ด ์‹คํ–‰๋  ๋•Œ ํ•˜๋‚˜์˜ Job ์‹คํ–‰๋‹จ์œ„์ด๋‹ค. ์˜ˆ๋ฅผ๋“ค์–ด ํ•˜๋ฃจ์— ํ•œ๋ฒˆ ๋ฐฐ์น˜ Job์ด ์‹คํ–‰๋œ๋‹ค๋ฉด, ์–ด์ œ ์˜ค๋Š˜ ๊ฐ๊ฐ ์‹คํ–‰๋œ Job์„ JobInstance๋ผ ๋ถ€๋ฅธ๋‹ค.

JobInstance๋Š” ์ด๋ฆ„๊ณผ ๋…ผ๋ฆฌ์  ์‹คํ–‰์„ ์œ„ํ•ด ์ œ๊ณต๋˜๋Š” ๊ณ ์œ ํ•œ ์‹๋ณ„ ํŒŒ๋ผ๋ฏธํ„ฐ ๋ชจ์Œ์œผ๋กœ ์œ ์ผํ•˜๊ฒŒ ์กด์žฌํ•œ๋‹ค.

  • ExampleGenerator ์ด๋ฆ„์˜ Job์ด ๋‹ค๋ฅธ ํŒŒ๋ผ๋ฏธํ„ฐ๋กœ ์‹คํ–‰๋  ๋•Œ๋งˆ๋‹ค ์ƒˆ๋กœ์šด JobInstace๊ฐ€ ์ƒ์„ฑ๋œ๋‹ค.

  • BATCH_JOB_INSTANCE ํ…Œ์ด๋ธ”๋กœ ๊ด€๋ฆฌ

  • BATCH_JOB_EXECUTION_PARAMS ์—์„œ ์‹ค์ œ ์‹๋ณ„ ํŒŒ๋ผ๋ฏธํ„ฐ ๊ด€๋ฆฌ

Job์„ ์ฒ˜์Œ ์‹คํ–‰ํ•˜๋ฉด ์ƒˆ๋กœ์šด JobInstance๋ฅผ ์–ป๋Š”๋‹ค. ํ•˜์ง€๋งŒ ์‹คํ–‰์— ์‹คํŒจํ•œ ์ดํ›„ ๋‹ค์‹œ ์‹คํ–‰ํ•˜๋ฉด, ์—ฌ์ „ํžˆ ๋™์ผํ•œ ๋…ผ๋ฆฌ์  ์‹คํ–‰(ํŒŒ๋ผ๋ฏธํ„ฐ ๋™์ผ)์ด๋ฏ€๋กœ ์ƒˆ๋กœ์šด JobInstance๋ฅผ ์–ป์ง€ ๋ชปํ•˜๋ฉฐ, ์‹ค์ œ ์‹คํ–‰์„ ์ถ”์ ํ•˜๊ธฐ ์œ„ํ•œ ์ƒˆ๋กœ์šด JobExecution์„ ์–ป์„ ๊ฒƒ์ด๋‹ค.

์ฆ‰, JobInstance๋Š” ์‹คํŒจํ•œ JobExecution๊ณผ ์ƒˆ๋กœ ์ˆ˜ํ–‰ํ•œ JobExecution๊ณผ ๊ฐ™์ด JobExecution์„ ์—ฌ๋Ÿฌ ๊ฐœ ๊ฐ€์งˆ ์ˆ˜ ์žˆ๋‹ค.

JobExecution

JobInstance์— ๋Œ€ํ•œ ํ•œ ๋ฒˆ์˜ ์‹คํ–‰(์‹ค์ œ ์‹œ๋„)์„ ๋‚˜ํƒ€๋‚ด๋Š” ๊ฐ์ฒด์ด๋‹ค. JobExecution์€ Job ์‹คํ–‰์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ๋‹ด๊ณ  ์žˆ๋Š” ๋„๋ฉ”์ธ ๊ฐ์ฒด์ด๋ฉฐ, JobInstance, ๋ฐฐ์น˜ ์‹คํ–‰ ์ƒํƒœ, ์‹œ์ž‘ ์‹œ๊ฐ„, ๋๋‚œ ์‹œ๊ฐ„, ์˜ค๋ฅ˜ ๋ฉ”์„ธ์ง€ ๋“ฑ์˜ ์ •๋ณด๋ฅผ ๋‹ด๊ณ  ์žˆ๋‹ค.

  • JobExecution์€ Job์ด ๊ตฌ๋™๋  ๋•Œ ๋งˆ๋‹ค ๋งค๋ฒˆ ์ƒˆ๋กœ์šด JobExecution์„ ์–ป๊ฒŒ๋œ๋‹ค.

  • BATCH_JOB_EXECUTION ํ…Œ์ด๋ธ”์— ๊ฐ ๋ ˆ์ฝ”๋“œ๋กœ ์ €์žฅ

  • BATCH_JOB_EXECUTION_CONTEXT ํ…Œ์ด๋ธ”์— ์ƒํƒœ ๊ฐ’ ์ €์žฅ

public class JobExecution extends Entity {
    private final JobParameters jobParameters; //Job ์‹คํ–‰์— ํ•„์š”ํ•œ ๋งค๊ฐœ ๋ณ€์ˆ˜ ๋ฐ์ดํ„ฐ
    private JobInstance jobInstance; // Job ์‹คํ–‰์˜ ๋‹จ์œ„๊ฐ€ ๋˜๋Š” ๊ฐ์ฒด
    private volatile Collection<StepExecution> stepExecutions; // StepExecution์„ ์—ฌ๋Ÿฌ๊ฐœ ๊ฐ€์งˆ ์ˆ˜ ์žˆ๋Š” Collection ํƒ€์ž…
    private volatile BatchStatus status; // Job์˜ ์‹คํ–‰ ์ƒํƒœ(COMPLETED, STARTING, STARTED ...)
    private volatile Date startTime; // Job์ด ์‹คํ–‰๋œ ์‹œ๊ฐ„(null์€ ์‹œ์ž‘ํ•˜์ง€ ์•Š์€ ๊ฒƒ)
    private volatile Date createTime; // JobExecution์ด ์ƒ์„ฑ๋œ ์‹œ๊ฐ„
    private volatile Date endTime; // JobExecution ์ข…๋ฃŒ ์‹œ๊ฐ„
    private volatile Date lastUpdated; // ๋งˆ์ง€๋ง‰ ์ˆ˜์ •์‹œ๊ฐ„
    private volatile ExitStatus exitStatus; // Job ์‹คํ–‰ ๊ฒฐ๊ณผ์— ๋Œ€ํ•œ ์ƒํƒœ๊ฐ’(UNKOWN, EXECUTING, COMPLETE, ...)
    private volatile ExecutionContext executionContext;// Job ์‹คํ–‰ ์‚ฌ์ด์— ์œ ์ง€ํ•ด์•ผํ•˜๋Š” ์‚ฌ์šฉ์ž ๋ฐ์ดํ„ฐ
    private transient volatile List<Throwable> failureExceptions; // Job ์‹คํ–‰ ์ค‘ ๋ฐœ์ƒํ•œ ์˜ˆ์™ธ 
    private final String jobConfigurationName; // Job ์„ค์ • ์ด๋ฆ„
  	...
}

JobParameters

Job์ด ์‹คํ–‰๋  ๋•Œ ํ•„์š”ํ•œ ํŒŒ๋ผ๋ฏธํ„ฐ๋“ค์„ Map ํƒ€์ž…์œผ๋กœ ์ง€์ •ํ•˜๋Š” ๊ฐ์ฒด๋กœ JobInstance(1:1 ๊ด€๊ณ„)๋ฅผ ๊ตฌ๋ถ„ํ•˜๋Š” ๊ธฐ์ค€์ด ๋˜๊ธฐ๋„ ํ•œ๋‹ค.

ํ•˜๋‚˜์˜ Job์„ ์ƒ์„ฑํ•  ๋•Œ ์‹œ์ž‘ ์‹œ๊ฐ„ ๋“ฑ์˜ ์ •๋ณด๋ฅผ ํŒŒ๋ผ๋ฏธํ„ฐ๋กœ ํ•ด์„œ ํ•˜๋‚˜์˜ JobInstance๋ฅผ ์ƒ์„ฑํ•œ๋‹ค. ์ฆ‰, 1:1 ๊ด€๊ณ„์ด๋‹ค.

  • ํŒŒ๋ผ๋ฏธํ„ฐ๋Š” key=value๋กœ ์ด๋ฃจ์–ด์ ธ์žˆ๋‹ค.

  • JobParameters๋Š” Map<String,JobParameter>์˜ wrapper์— ๋ถˆ๊ณผํ•˜๋‹ค.

    public class JobParameters implements Serializable {
    private final Map<String,JobParameter> parameters;
    ...
    }
  • ํŒŒ๋ผ๋ฏธํ„ฐ ํƒ€์ž…์€ String, Double, Date ํƒ€์ž…๋„ ๊ธฐ๋ณธ์ ์œผ๋กœ ์ œ๊ณตํ•œ๋‹ค.

  • ํŒŒ๋ผ๋ฏธํ„ฐ ์ด๋ฆ„ ๋’ค์— ๊ด„ํ˜ธ๋ฅผ ์“ฐ๊ณ  ํ•ด๋‹น ํŒŒ๋ผ๋ฏธํ„ฐ ํƒ€์ž…์„ ๋ช…์‹œํ•ด ์ง€์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.

    • ์ด๋•Œ, ํŒŒ๋ผ๋ฏธํ„ฐ ํƒ€์ž…์˜ ์ด๋ฆ„์€ ๋ชจ๋‘ ์†Œ๋ฌธ์ž์—ฌ์•ผํ•œ๋‹ค.

      executionDate(date)=2021/11/27

    image-20211115221637438

    • BATCH_JOB_EXECUTION_PARAMS

    image-20211115221805721

  • ์‹๋ณ„์— ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” ํŒŒ๋ผ๋ฏธํ„ฐ๋„ ์žˆ์„ ์ˆ˜ ์žˆ๋‹ค. ์‹๋ณ„์— ์‚ฌ์šฉํ•˜๊ณ  ์‹ถ์ง€ ์•Š๋Š” ํŒŒ๋ผ๋ฏธํ„ฐ๋Š” ์•ž์— -๋ฅผ ๋‹ค์Œ๊ณผ ๊ฐ™์ด ๋ถ™์—ฌ์ฃผ๋ฉด ๋œ๋‹ค.

    executionDate(date)=2021/11/27 -filename=test
    Caused by: org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException: A job instance already exists and is complete for parameters={executionDate=1637938800000, filename=test}.  If you want to run this job again, change the parameters.
    	at org.springframework.batch.core.repository.support.SimpleJobRepository.createJobExecution(SimpleJobRepository.java:139) ~[spring-batch-core-4.3.3.jar:4.3.3]
    	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:na]
    	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:na]
    	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:na]
    	at java.base/java.lang.reflect.Method.invoke(Method.java:566) ~[na:na]
    	at org.springframework.aop.support.AopUtils.invokeJoinpointUsingReflection(AopUtils.java:344) ~[spring-aop-5.3.12.jar:5.3.12]
    	at org.springframework.aop.framework.ReflectiveMethodInvocation.invokeJoinpoint(ReflectiveMethodInvocation.java:198) ~[spring-aop-5.3.12.jar:5.3.12]
    	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:163) ~[spring-aop-5.3.12.jar:5.3.12]

    ๋‹ค์Œ๊ณผ ๊ฐ™์ด -๋ฅผ ๋ถ™์ธ ํŒŒ๋ผ๋ฏธํ„ฐ๋Š” ์‹๋ณ„ ํŒŒ๋ผ๋ฏธํ„ฐ๋กœ ์‚ฌ์šฉํ•˜์ง€ ์•Š์•„, ๊ธฐ์กด์— ์ด๋ฏธ ์ˆ˜ํ–‰๋œ Job์œผ๋กœ ์‹คํŒจํ•œ ๊ฒƒ์„ ์•Œ ์ˆ˜ ์žˆ๋‹ค.

ํŒŒ๋ผ๋ฏธํ„ฐ์— ์ ‘๊ทผํ•˜๋Š” ๋ฐฉ๋ฒ•

  1. ChunkContext ์ธ์Šคํ„ด์Šค

    • ์‹คํ–‰ ์‹œ์ ์˜ Job ์ƒํƒœ ์ œ๊ณต

    • tasklet ๋‚ด์—์„œ ์ฒ˜๋ฆฌ์ค‘์ธ chunk์™€ ๊ด€๋ จ๋œ ์ •๋ณด(์Šคํƒญ ๋ฐ ์žก๊ณผ ๊ด€๋ จ๋œ ์ •๋ณด ํฌํ•จ) ์ œ๊ณต

    • JobParametes๊ฐ€ ํฌํ•จ๋œ StepContext์ฐธ์กฐ๊ฐ€ ์žˆ์Œ

      public class ChunkContext extends AttributeAccessorSupport {
      
      	private final StepContext stepContext;
      	...
      }
      public class StepContext extends SynchronizedAttributeAccessor {
      
      	private StepExecution stepExecution;
      
      	private Map<String, Set<Runnable>> callbacks = new HashMap<>();
      
      	private BatchPropertyContext propertyContext = null;
      
      	...
          
      	/**
      	 * @return a map containing the items from the {@link JobParameters}
      	 */
      	public Map<String, Object> getJobParameters() {
      		Map<String, Object> result = new HashMap<>();
      		for (Entry<String, JobParameter> entry : stepExecution.getJobParameters().getParameters().entrySet()) 		{
      			result.put(entry.getKey(), entry.getValue().getValue());
      		}
      		return Collections.unmodifiableMap(result);
      	}
        ...
      }
    • ์˜ˆ์ œ

          @Bean Step step2(){
              return this.stepBuilderFactory.get("step2")
                      .tasklet(helloWorldTasklet())
                      .build();
          }
      
          @Bean
          public Tasklet helloWorldTasklet() {
              return ((contribution, chunkContext) -> {
                  String name = (String) chunkContext.getStepContext()
                                      .getJobParameters() // Map<String, Object>์ด๋ฏ€๋กœ ํƒ€์ž… ์บ์ŠคํŒ… ํ•„์š”
                                      .get("name");
      
                  System.out.println(String.format("Hello, %s", name));
                  return RepeatStatus.FINISHED;
              });
          }
  2. Late Binding : ์Šคํ”„๋ง ๊ตฌ์„ฑ์„ ์‚ฌ์šฉํ•ด ์ฃผ์ž…ํ•˜๋Š” ๋ฐฉ๋ฒ•์œผ๋กœ, JobParameters๋Š” ๋ณ€๊ฒฝํ•  ์ˆ˜ ์—†์œผ๋ฏ€๋กœ ๋ถ€ํŠธ์ŠคํŠธ๋žฉ์‹œ ๋ฐ”์ธ๋”ฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹๋‹ค.

    		@StepScope
    		@Bean
        public Tasklet lateBindingParamTasklet(@Value("#{jobParameters['name']}") String name) {
            return ((contribution, chunkContext) -> {
                System.out.println(String.format("Hello, %s", name));
                return RepeatStatus.FINISHED;
            });
        }

ํŒŒ๋ผ๋ฏธํ„ฐ ์œ ํšจ์„ฑ ๊ฒ€์ฆ

  • org.springframework.batch.core.JobParametersValidator

    public interface JobParametersValidator {
    
    	/**
    	 * Check the parameters meet whatever requirements are appropriate, and
    	 * throw an exception if not.
    	 * 
    	 * @param parameters some {@link JobParameters} (can be {@code null})
    	 * @throws JobParametersInvalidException if the parameters are invalid
    	 */
    	void validate(@Nullable JobParameters parameters) throws JobParametersInvalidException;
    
    }

JobParametersValidator ์ธํ„ฐํŽ˜์ด์Šค๋ฅผ ๊ตฌํ˜„ํ•˜๊ณ , ํ•ด๋‹น ๊ตฌํ˜„์ฒด๋ฅผ ์žก ๋‚ด์— ๊ตฌ์„ฑํ•ด ํŒŒ๋ผ๋ฏธํ„ฐ ์œ ํšจ์„ฑ ๊ฒ€์ฆ์„ ํ•  ์ˆ˜ ์žˆ๋‹ค.

์Šคํ”„๋ง์€ ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ๊ฐ€ ๋ˆ„๋ฝ์—†์ด ์ „๋‹ฌ๋๋Š”์ง€ ํ™•์ธํ•˜๋Š” DefaultJobParametersValidator๋ฅผ ๊ธฐ๋ณธ์ ์œผ๋กœ ์ œ๊ณตํ•ด์ค€๋‹ค.

  • DefaultJobParametersValidator ์‚ฌ์šฉํ•œ ์œ ํšจ์„ฑ ๊ฒ€์ฆ : ํŒŒ๋ผ๋ฏธํ„ฐ ์กด์žฌ ์—ฌ๋ถ€๋ฅผ ์ œ์™ธํ•œ ๋‹ค๋ฅธ ์œ ํšจ์„ฑ ๊ฒ€์ฆ์€ ์ˆ˜ํ–‰ํ•˜์ง€ ์•Š์Œ.

        @Bean
        public JobParametersValidator validator() {
            DefaultJobParametersValidator validator = new DefaultJobParametersValidator();
    
            validator.setRequiredKeys(new String[] {"executionDate", "fileName"}); // ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ ํ™•์ธ
            validator.setOptionalKeys(new String[] {"name"}); // ์„ ํƒ ํŒŒ๋ผ๋ฏธํ„ฐ
            validator.afterPropertiesSet(); // ์„ ํƒ ํŒŒ๋ผ๋ฏธํ„ฐ์— ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ๊ฐ€ ํฌํ•จ๋˜์ง€ ์•Š์•˜๋Š”์ง€ ํ™•์ธ
    
            return validator;
        }
    • ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ ๋ฏธํฌํ•จ์‹œ ์˜ค๋ฅ˜

      Caused by: org.springframework.batch.core.JobParametersInvalidException: The JobParameters do not contain required keys: [fileName]
      	at org.springframework.batch.core.job.DefaultJobParametersValidator.validate(DefaultJobParametersValidator.java:120) ~[spring-batch-core-4.3.3.jar:4.3.3]
    • ์„ ํƒ ํŒŒ๋ผ๋ฏธํ„ฐ์™€ ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ ๊ฒน์น˜๋Š” ๊ฒฝ์šฐ ์˜ค๋ฅ˜

      Caused by: java.lang.IllegalStateException: Optional keys cannot be required: fileName
      	at org.springframework.util.Assert.state(Assert.java:76) ~[spring-core-5.3.12.jar:5.3.12]
      	at org.springframework.batch.core.job.DefaultJobParametersValidator.afterPropertiesSet(DefaultJobParametersValidator.java:73) ~[spring-batch-core-4.3.3.jar:4.3.3]
    • ์„ ํƒ ํŒŒ๋ผ๋ฏธํ„ฐ์™€ ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ์— ํฌํ•จ๋˜์ง€ ์•Š์€ ํŒŒ๋ผ๋ฏธํ„ฐ ์ „์†ก์‹œ ์˜ค๋ฅ˜

      Caused by: org.springframework.batch.core.JobParametersInvalidException: The JobParameters contains keys that are not explicitly optional or required: [displyYn]
      	at org.springframework.batch.core.job.DefaultJobParametersValidator.validate(DefaultJobParametersValidator.java:107) ~[spring-batch-core-4.3.3.jar:4.3.3]
  • ์ปค์Šคํ…€ ์œ ํšจ์„ฑ ๊ฒ€์ฆ : ํŒŒ๋ผ๋ฏธํ„ฐ ์กด์žฌ ์—ฌ๋ถ€ ์™ธ์˜ ์ถ”๊ฐ€ ์œ ํšจ์„ฑ ๊ฒ€์ฆ์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ ์ปค์Šคํ…€ JobParametersValidator ๊ตฌํ˜„ ํ•„์š”

    public class ParameterValidator implements JobParametersValidator {
        @Override
        public void validate(JobParameters parameters) throws JobParametersInvalidException {
            String fileName = parameters.getString("fileName");
    
            if (!StringUtils.hasText(fileName)) {
                throw new JobParametersInvalidException("fileName ํŒŒ๋ผ๋ฏธํ„ฐ๊ฐ€ ์กด์žฌํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.");
            } else if (!StringUtils.endsWithIgnoreCase(fileName, ".csv")) {
                throw new JobParametersInvalidException("csv ํŒŒ์ผ์ด ์•„๋‹™๋‹ˆ๋‹ค.");
            }
        }
    }
  • CompositeJobParametersValidator : ์—ฌ๋Ÿฌ๊ฐœ์˜ ์œ ํšจ์„ฑ ๊ฒ€์ฆ

        @Bean
        public CompositeJobParametersValidator validator() {
    
            CompositeJobParametersValidator validator = new CompositeJobParametersValidator();
    
            // ํŒŒ๋ผ๋ฏธํ„ฐ ์œ ๋ฌด ๊ฒ€์ฆ
            DefaultJobParametersValidator defaultJobParametersValidator = new DefaultJobParametersValidator();
    
            defaultJobParametersValidator.setRequiredKeys(new String[] {"executionDate", "fileName"}); // ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ ํ™•์ธ
            defaultJobParametersValidator.setOptionalKeys(new String[] {"name"}); // ์„ ํƒ ํŒŒ๋ผ๋ฏธํ„ฐ
            defaultJobParametersValidator.afterPropertiesSet(); // ์„ ํƒ ํŒŒ๋ผ๋ฏธํ„ฐ์— ํ•„์ˆ˜ ํŒŒ๋ผ๋ฏธํ„ฐ๊ฐ€ ํฌํ•จ๋˜์ง€ ์•Š์•˜๋Š”์ง€ ํ™•์ธ
    
          	// custom validator์™€ defaultJobParametersValidator List๋กœ ์ „์†ก
            validator.setValidators(Arrays.asList(new ParameterValidator(), defaultJobParametersValidator));
            return validator;
        }

์žก ํŒŒ๋ผ๋ฏธํ„ฐ ์ฆ๊ฐ€์‹œํ‚ค๊ธฐ

  • org.springframework.batch.core.JobParametersIncrementer

    public interface JobParametersIncrementer {
    
    	/**
    	 * Increment the provided parameters. If the input is empty, then this
    	 * should return a bootstrap or initial value to be used on the first
    	 * instance of a job.
    	 * 
    	 * @param parameters the last value used
    	 * @return the next value to use (never {@code null})
    	 */
    	JobParameters getNext(@Nullable JobParameters parameters);
    
    }

JobParametersIncrementer๋Š” ์‚ฌ์šฉํ•  ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ๊ณ ์œ ํ•˜๊ฒŒ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ๊ฒŒ ์Šคํ”„๋ง ๋ฐฐ์น˜๊ฐ€ ์ œ๊ณตํ•˜๋Š” ์ธํ„ฐํŽ˜์ด์Šค๋กœ ๋งค ์‹คํ–‰ ์‹œ timestamp๋ฅผ ์ถ”๊ฐ€ํ•˜๊ฑฐ๋‚˜ ํŒŒ๋ผ๋ฏธํ„ฐ๋ฅผ ์ฆ๊ฐ€์‹œ์ผœ์•ผํ•˜๋Š” ๊ฒฝ์šฐ์— ์‚ฌ์šฉํ•˜๊ธฐ ์ ํ•ฉํ•˜๋‹ค.

  • RunIdIncrementer : ํŒŒ๋ผ๋ฏธํ„ฐ ์ด๋ฆ„์ด run.id(long)์˜ ๊ฐ’์„ ์ฆ๊ฐ€

  • Custom Incrementer

    public class DailyJobTimestamper implements JobParametersIncrementer {
        @Override
        public JobParameters getNext(JobParameters parameters) {
            return new JobParametersBuilder(parameters)
                    .addDate("executionDate", new Date())
                    .toJobParameters();
        }
    }

jobBuilderFactory์—์„œ .incrementer() ๋กœ ์ˆ˜ํ–‰ํ•  ์ˆ˜ ์žˆ๋‹ค.

 @Bean
    public Job job() {
        // jobBuilderFactory.get("์žก์ด๋ฆ„")
        return this.jobBuilderFactory.get("basicJob")
                .start(step1())
                .validator(validator())
                .incrementer(new RunIdIncrementer())
                .next(step2())
                .build(); // ์‹ค์ œ job ์ƒ์„ฑ
    }

JobListener

๋ชจ๋“  Job์€ ์ƒ๋ช…์ฃผ๊ธฐ๋ฅผ ๊ฐ€์ง€๊ณ  ์žˆ์œผ๋ฉฐ, ์Šคํ”„๋ง ๋ฐฐ์น˜๋Š” ์ƒ๋ช…์ฃผ๊ธฐ์˜ ํŠน์ • ์‹œ์ ์—์„œ ๋กœ์ง์„ ์ถ”๊ฐ€ํ•  ์ˆ˜ ์žˆ๊ฒŒ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•ด์ค€๋‹ค.

  • JobExecutionListener : Job ์‹คํ–‰๊ณผ ๊ด€๋ จ๋œ ๋ฆฌ์Šค๋„ˆ ์ธํ„ฐํŽ˜์ด์Šค

    public interface JobExecutionListener {
    
    	/**
    	 * Callback before a job executes.
    	 *
    	 * @param jobExecution the current {@link JobExecution}
    	 */
    	void beforeJob(JobExecution jobExecution);
    
    	/**
    	 * Callback after completion of a job. Called after both both successful and
    	 * failed executions. To perform logic on a particular status, use
    	 * "if (jobExecution.getStatus() == BatchStatus.X)".
    	 *
    	 * @param jobExecution the current {@link JobExecution}
    	 */
    	void afterJob(JobExecution jobExecution);
    
    }
    • beforeJob : Job ์ˆ˜ํ–‰ ์ด์ „์— ์ˆ˜ํ–‰

    • afterJob : Job ์ˆ˜ํ–‰์™„๋ฃŒ ํ›„ ์ˆ˜ํ–‰ํ•˜๋ฉฐ Job์˜ ์™„๋ฃŒ ์ƒํƒœ์™€ ์ƒ๊ด€ ์—†์ด ํ˜ธ์ถœ๋œ๋‹ค.

Job Listener๋ฅผ ์ž‘์„ฑํ•˜๋Š”๋ฐ ๋‘๊ฐ€์ง€ ๋ฐฉ๋ฒ•์ด ์žˆ๋‹ค.

  1. JobExecutionListener ์ธํ„ฐํŽ˜์ด์Šค ๊ตฌํ˜„

    public class JobLoggerListener implements JobExecutionListener {
    
        private static String START_MESSAGE = "%s is beginning execution";
        private static String END_MESSAGE = "%s has completed with the status %s";
    
        @Override
        public void beforeJob(JobExecution jobExecution) {
            System.out.println(String.format(START_MESSAGE, jobExecution.getJobInstance().getJobName()));
        }
    
        @Override
        public void afterJob(JobExecution jobExecution) {
            System.out.println(String.format(END_MESSAGE, jobExecution.getJobInstance().getJobName()
                                                        , jobExecution.getStatus()));
        }
    }

    JobBuilder ์˜ listener ๋ฉ”์„œ๋“œ๋ฅผ ํ˜ธ์ถœํ•˜๋ฉด ๋‹ค์Œ๊ณผ ๊ฐ™์ด Job์ˆ˜ํ–‰ ์ „ํ›„๋กœ ์ˆ˜ํ–‰๋œ ๊ฒƒ์„ ๋ณผ ์ˆ˜ ์žˆ๋‹ค.

    return this.jobBuilderFactory.get("basicJob")
                    .start(step1())
                    .validator(validator())
                    .incrementer(new DailyJobTimestamper())
                    .listener(new JobLoggerListener())
                    .next(step2())
                    .build(); // ์‹ค์ œ job ์ƒ์„ฑ
    2021-11-16 23:35:57.266  INFO 80890 --- [           main] o.s.b.c.l.support.SimpleJobLauncher      : Job: [SimpleJob: [name=basicJob]] launched with the following parameters: [{name=faker, executionDate=1637073357082, fileName=test4.csv, run.id=3}]
    basicJob is beginning execution
    ...
    2021-11-16 23:35:57.656  INFO 80890 --- [           main] o.s.batch.core.step.AbstractStep         : Step: [step2] executed in 129ms
    basicJob has completed with the status COMPLETED
  2. ์–ด๋…ธํ…Œ์ด์…˜ ์‚ฌ์šฉ(@BeforeJob, @AfterJob) : ์ธํ„ฐํŽ˜์ด์Šค๋ฅผ ๊ตฌํ˜„ํ•  ํ•„์š” ์—†์ด ์–ด๋…ธํ…Œ์ด์…˜๋งŒ์œผ๋กœ ๊ตฌํ˜„ํ•˜๋ฉด ๋œ๋‹ค.

    public class JobLoggerListener {
    
        private static String START_MESSAGE = "%s is beginning execution";
        private static String END_MESSAGE = "%s has completed with the status %s";
    
        @BeforeJob
        public void beforeJob(JobExecution jobExecution) {
            System.out.println(String.format(START_MESSAGE, jobExecution.getJobInstance().getJobName()));
        }
    
        @AfterJob
        public void afterJob(JobExecution jobExecution) {
            System.out.println(String.format(END_MESSAGE, jobExecution.getJobInstance().getJobName()
                                                        , jobExecution.getStatus()));
        }
    }

    ์–ด๋…ธํ…Œ์ด์…˜์œผ๋กœ ๊ตฌํ˜„ํ•˜๋Š” ๊ฒฝ์šฐ JobListenerFactoryBean ์œผ๋กœ ๋ฆฌ์Šค๋„ˆ๋ฅผ ์ฃผ์ž…ํ•  ์ˆ˜ ์žˆ๋‹ค.

    return this.jobBuilderFactory.get("basicJob")
                    .start(step1())
                    .validator(validator())
                    .incrementer(new DailyJobTimestamper())
                    .listener(JobListenerFactoryBean.getListener(new JobLoggerListener()))
                    .next(step2())
                    .build(); // ์‹ค์ œ job ์ƒ์„ฑ

ExecutionContext

Spring Batch

ExecutionContext๋Š” ๋ฐฐ์น˜ ์žก์˜ ์„ธ์…˜์œผ๋กœ, ๊ฐ„๋‹จํ•œ ํ‚ค-๊ฐ’์„ ๋ณด๊ด€ํ•œ๋‹ค. ์ด๋•Œ Job์˜ ์ƒํƒœ๋ฅผ ์•ˆ์ „ํ•˜๊ฒŒ ๋ณด๊ด€ํ•  ์ˆ˜ ์žˆ๊ฒŒ ์ œ๊ณตํ•ด์ค€๋‹ค. Job์„ ์ˆ˜ํ–‰ํ•˜๋Š” ๊ณผ์ •์—์„œ ์—ฌ๋Ÿฌ๊ฐœ์˜ ExecutionContext๊ฐ€ ์กด์žฌํ•  ์ˆ˜ ์žˆ๋‹ค.

  • Job์— ๋Œ€ํ•œ ์ƒํƒœ : JobExecution์˜ ExecutionContext์— ์ €์žฅ

  • Step์— ๋Œ€ํ•œ ์ƒํƒœ : StepExecution์˜ ExecutionContext

์ด๋ ‡๊ฒŒ ๊ฐ Step์šฉ ๋ฐ์ดํ„ฐ์™€ Job ์ „์ฒด์šฉ ๋ฐ์ดํ„ฐ์™€ ๊ฐ™์ด ๋ฐ์ดํ„ฐ ์‚ฌ์šฉ ๋ฒ”์œ„๋ฅผ ์ง€์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.

ExecutionContext๊ฐ€ ๋‹ด๊ณ ์žˆ๋Š” ๋ชจ๋“  ๋ฐ์ดํ„ฐ๋Š” JopRepository์— ์ €์žฅ๋œ๋‹ค.

ExecutionContext ๋‹ค๋ฃจ๊ธฐ

  1. Job์˜ ExecutionContext๋ฅผ ๊ฐ€์ ธ์˜ค๊ธฐ

      @Override
      public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
          String name = (String) chunkContext.getStepContext()
                          .getJobParameters()
                          .get("name");
    
          ExecutionContext jobContext = chunkContext.getStepContext()
                                              .getStepExecution()
                                              .getJobExecution()
                                              .getExecutionContext();
    
    
          jobContext.put("user.name", name);
    
          System.out.println(String.format(HELLO_WORLD, name));
    
          return RepeatStatus.FINISHED;
      }
  2. Step ExecutionContext

      @Override
      public RepeatStatus execute(StepContribution contribution, ChunkContext chunkContext) throws Exception {
          String name = (String) chunkContext.getStepContext()
                          .getJobParameters()
                          .get("name");
    
          // 2. Step ExecutionContext
          ExecutionContext stepContext = chunkContext.getStepContext()
                                              .getStepExecution()
                                              .getExecutionContext();
    
    
          jobContext.put("user.name", name);
    
          System.out.println(String.format(HELLO_WORLD, name));
    
          return RepeatStatus.FINISHED;
      }
  3. ExecutionContextPromotionListener : Step์˜ ExecutionContext์— ์žˆ๋Š” ํ‚ค๋ฅผ JobExecution์˜ ExecutionContext๋กœ ์Šน๊ฒฉํ•  ์ˆ˜ ์žˆ๋‹ค.

    @EnableBatchProcessing // ๋ฐฐ์น˜ ์ž‘์—…์— ํ•„์š”ํ•œ ๋นˆ์„ ๋ฏธ๋ฆฌ ๋“ฑ๋กํ•˜์—ฌ ์‚ฌ์šฉ, ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ๋‚ด ํ•œ๋ฒˆ๋งŒ ์ ์šฉํ•˜๋ฉด ๋จ.
    @SpringBootApplication
    public class JavaGradleApplication {
    
        @Autowired
        private JobBuilderFactory jobBuilderFactory;
    
        @Autowired
        private StepBuilderFactory stepBuilderFactory;
    
        /**
         * ์‹ค์ œ ์Šคํ”„๋ง ๋ฐฐ์น˜ Job ์ƒ์„ฑ
         */
        @Bean
        public Job job() {
            // jobBuilderFactory.get("์žก์ด๋ฆ„")
            return this.jobBuilderFactory.get("basicJob")
                    .start(step1())
                    .next(step2())
                    .build(); // ์‹ค์ œ job ์ƒ์„ฑ
        }
    
        /**
         * ์‹ค์ œ ์Šคํ”„๋ง ๋ฐฐ์น˜ step ์ƒ์„ฑ
         *
         * @return
         */
        @Bean
        public Step step1() {
            // stepBuilderFactory.get("์Šคํƒญ ์ด๋ฆ„")
            // tasklet ๊ตฌํ˜„์ฒด
            return this.stepBuilderFactory.get("step1")
                    .tasklet((contribution, chunkContext) -> {
                        System.out.println("Hello, world!");
                        return RepeatStatus.FINISHED;
                    })
                    .listener(promotionListener()) // step์ด ์™„๋ฃŒ ์ƒํƒœ๋กœ ์ข…๋ฃŒ๋œ ์ดํ›„ ์ˆ˜ํ–‰
                    .build();
        }
    
        @Bean
        Step step2() {
            return this.stepBuilderFactory.get("step2")
                    .tasklet(lateBindingParamTasklet("test"))
                    .build();
        }
    
        /**
         * step์ด ์™„๋ฃŒ ์ƒํƒœ๋กœ ์ข…๋ฃŒ๋œ ์ดํ›„ ์ˆ˜ํ–‰
         * "name" ํ‚ค๋ฅผ ์ฐพ์•„ Job์˜ ExecutionContext์— ๋ณต์‚ฌ
         *
         * @return
         */
        @Bean
        public StepExecutionListener promotionListener() {
            ExecutionContextPromotionListener listener = new ExecutionContextPromotionListener();
    
            listener.setKeys(new String[]{"name"});
    
            return listener;
        }
    
        public static void main(String[] args) {
            SpringApplication.run(JavaGradleApplication.class, args);
        }
    }

    ์œ„ ์˜ˆ์ œ์™€ ๊ฐ™์ด ์Šคํ…๊ฐ„์˜ ๊ณต์œ ํ•  ๋ฐ์ดํ„ฐ๊ฐ€ ์žˆ์ง€๋งŒ ์ฒซ๋ฒˆ์งธ step์ด ์„ฑ๊ณตํ–ˆ์„๋•Œ๋งŒ ๊ณต์œ ํ•  ๋•Œ ์œ ์šฉํ•˜๋‹ค.

ExecutionContext ์ €์žฅ

Job์ด ์ฒ˜๋ฆฌ๋˜๋Š” ๋™์•ˆ ์Šคํ”„๋ง ๋ฐฐ์น˜๋Š” ๊ฐ ์ฒญํฌ๋ฅผ ์ปค๋ฐ‹ํ•˜๋ฉฐ Job๊ณผ Step์˜ ์ƒํƒœ๋ฅผ ์ €์žฅํ•œ๋‹ค. (ExecutionContext ๋ฅผ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค์— ์ €์žฅ)

์œ„์˜ Step ExecutionContext ์˜ˆ์ œ๋ฅผ ์ˆ˜ํ–‰ํ•˜๋ฉด BATCH_STEP_EXECUTION_CONTEXT์— ๋‹ค์Œ๊ณผ ๊ฐ™์ด "user.name":"dahyelele" ์ง€์ •ํ•œ ๋ฐ์ดํ„ฐ๊ฐ€ ํ‚ค-๊ฐ’์œผ๋กœ ๋“ค์–ด๊ฐ„ ๊ฒƒ์„ ์•Œ ์ˆ˜ ์žˆ๋‹ค.

{"@class":"java.util.HashMap","batch.taskletType":"io.spring.batch.javagradle.tasklet.HelloWorld","user.name":"dahyelele","batch.stepType":"org.springframework.batch.core.step.tasklet.TaskletStep"}

Last updated

Was this helpful?