如何异步启动 Spring Batch 作业

Question

我遵循了spring 批处理文档，但无法异步运行我的工作。

所以我从 web 容器运行作业，作业将通过 REST 端点触发。

我想在完成整个工作之前获得 JobInstance ID以作为响应传递它。 因此，他们可以稍后使用 JobInstance ID 检查作业的状态，而无需等待。 但我无法让它工作。 下面是我试过的示例代码。 请让我知道我错过了什么或错了什么。

BatchConfig 使 Async JobLauncher

@Configuration
public class BatchConfig {

    @Autowired
    JobRepository jobRepository;


    @Bean
    public JobLauncher simpleJobLauncher() throws Exception {
        SimpleJobLauncher jobLauncher = new SimpleJobLauncher();
        jobLauncher.setJobRepository(jobRepository);
        jobLauncher.setTaskExecutor(new SimpleAsyncTaskExecutor());
        jobLauncher.afterPropertiesSet();
        return jobLauncher;
    }
}

控制器

@Autowired
JobLauncher jobLauncher;

@RequestMapping(value="/trigger-job", method = RequestMethod.GET)
public Long workHard() throws Exception {
    JobParameters jobParameters = new JobParametersBuilder().
            addLong("time", System.currentTimeMillis())
            .toJobParameters();
    JobExecution jobExecution = jobLauncher.run(batchComponent.customJob("paramhere"), jobParameters);
    System.out.println(jobExecution.getJobInstance().getInstanceId());
    System.out.println("OK RESPONSE");
    return jobExecution.getJobInstance().getInstanceId();
}

和 JobBuilder 作为组件

@Component
public class BatchComponent {

    @Autowired
    private JobBuilderFactory jobBuilderFactory;

    @Autowired
    private StepBuilderFactory stepBuilderFactory;

    public Job customJob(String someParam) throws Exception {
        return jobBuilderFactory.get("personProcessor")
                .incrementer(new RunIdIncrementer()).listener(listener())
                .flow(personPorcessStep(someParam)).end().build();
    }


    private Step personPorcessStep(String someParam) throws Exception {
        return stepBuilderFactory.get("personProcessStep").<PersonInput, PersonOutput>chunk(1)
                .reader(new PersonReader(someParam)).faultTolerant().
                        skipPolicy(new DataDuplicateSkipper()).processor(new PersonProcessor())
                .writer(new PersonWriter()).build();
    }


    private JobExecutionListener listener() {
        return new PersonJobCompletionListener();
    }

    private class PersonInput {
        String firstName;

        public PersonInput(String firstName) {
            this.firstName = firstName;
        }

        public String getFirstName() {
            return firstName;
        }

        public void setFirstName(String firstName) {
            this.firstName = firstName;
        }
    }

    private class PersonOutput {
        String firstName;

        public String getFirstName() {
            return firstName;
        }

        public void setFirstName(String firstName) {
            this.firstName = firstName;
        }
    }

    public class PersonReader implements ItemReader<PersonInput> {
        private List<PersonInput> items;
        private int count = 0;

        public PersonReader(String someParam) throws InterruptedException {
            Thread.sleep(10000L); //to simulate processing
            //manipulate and provide data in the read method
            //just for testing i have given some dummy example
            items = new ArrayList<PersonInput>();
            PersonInput pi = new PersonInput("john");
            items.add(pi);
        }

        @Override
        public PersonInput read() {
            if (count < items.size()) {
                return items.get(count++);
            }
            return null;
        }
    }


    public class DataDuplicateSkipper implements SkipPolicy {

        @Override
        public boolean shouldSkip(Throwable exception, int skipCount) throws SkipLimitExceededException {
            if (exception instanceof DataIntegrityViolationException) {
                return true;
            }
            return true;
        }
    }


    private class PersonProcessor implements ItemProcessor<PersonInput, PersonOutput> {

        @Override
        public PersonOutput process(PersonInput item) throws Exception {
            return null;
        }
    }

    private class PersonWriter implements org.springframework.batch.item.ItemWriter<PersonOutput> {
        @Override
        public void write(List<? extends PersonOutput> results) throws Exception {
            return;
        }
    }

    private class PersonJobCompletionListener implements JobExecutionListener {
        public PersonJobCompletionListener() {
        }

        @Override
        public void beforeJob(JobExecution jobExecution) {

        }

        @Override
        public void afterJob(JobExecution jobExecution) {
            System.out.println("JOB COMPLETED");
        }
    }
}

主功能

@SpringBootApplication
@EnableBatchProcessing
@EnableScheduling
@EnableAsync
public class SpringBatchTestApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBatchTestApplication.class, args);
    }
}

我正在使用基于注释的配置，并将 gradle 与以下批处理包一起使用。

compile('org.springframework.boot:spring-boot-starter-batch')

如果需要更多信息，请告诉我。 我找不到任何示例来运行这个常见用例。

谢谢你的时间。

Answer 1

试试这个，在您的配置中，您需要使用@Bean(name = "myJobLauncher")创建带有SimpleAsyncTaskExecutor的customJobLauncher，并且将在您的控制器中使用@Qualifier 。

@Bean(name = "myJobLauncher")
public JobLauncher simpleJobLauncher() throws Exception {
    SimpleJobLauncher jobLauncher = new SimpleJobLauncher();
    jobLauncher.setJobRepository(jobRepository);
    jobLauncher.setTaskExecutor(new SimpleAsyncTaskExecutor());
    jobLauncher.afterPropertiesSet();
    return jobLauncher;
}

在您的控制器中

@Autowired
@Qualifier("myJobLauncher")
private JobLauncher jobLauncher;

Answer 2

如果我查看您的代码，我会发现一些错误。 首先，您的自定义配置未加载，因为如果加载了，对于同一接口的重复 bean 实例，注入将失败。

spring boot 有很多神奇的地方，但是如果你不告诉他做一些组件扫描，什么都不会像预期的那样加载。

我能看到的第二个问题是您的 BatchConfig 类：它不扩展 DefaultBatchConfigure，也不覆盖 getJobLauncher()，因此即使启动魔法会加载所有内容，您也将获得默认值。 这是一个可以工作的配置，它符合文档@EnableBatchProcessing API

批量配置

@Configuration
@EnableBatchProcessing(modular = true)
@Slf4j
public class BatchConfig extends DefaultBatchConfigurer {

  @Override
  @Bean
  public JobLauncher getJobLauncher() {
    try {
      SimpleJobLauncher jobLauncher = new SimpleJobLauncher();
      jobLauncher.setJobRepository(getJobRepository());
      jobLauncher.setTaskExecutor(new SimpleAsyncTaskExecutor());
      jobLauncher.afterPropertiesSet();
      return jobLauncher;

    } catch (Exception e) {
      log.error("Can't load SimpleJobLauncher with SimpleAsyncTaskExecutor: {} fallback on default", e);
      return super.getJobLauncher();
    }
  }
}

主功能

@SpringBootApplication
@EnableScheduling
@EnableAsync
@ComponentScan(basePackageClasses = {BatchConfig.class})
public class SpringBatchTestApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBatchTestApplication.class, args);
    }
}

Answer 3

我知道这是一个老问题，但无论如何我都会为未来的用户发布这个答案。

在查看您的代码后，我不知道您为什么会遇到此问题，但我建议您使用 Qualifier 注释并像这样使用 ThreadPoolTask​​Executor，看看它是否能解决您的问题。

您还可以查看本教程： 异步 Spring Batch 作业处理以获取更多详细信息。 它将帮助您异步配置 spring 批处理作业。 这个教程是我写的。

@Configuration
public class BatchConfig {

 @Autowired
 private JobRepository jobRepository;

 @Bean
 public TaskExecutor threadPoolTaskExecutor(){

  ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setMaxPoolSize(12);
        executor.setCorePoolSize(8);
        executor.setQueueCapacity(15);

   return executor;
 }

 @Bean
    public JobLauncher asyncJobLauncher() throws Exception {
        SimpleJobLauncher jobLauncher = new SimpleJobLauncher();

        jobLauncher.setJobRepository(jobRepository);
        jobLauncher.setTaskExecutor(threadPoolTaskExecutor());
        return jobLauncher;
 }
}

Answer 4

JobExecution jobExecution = jobLauncher.run(batchComponent.customJob("paramhere"), jobParameters); . Joblauncher 将在 Job 完成后等待，然后再返回任何内容，这就是为什么如果这是您的问题，您的服务可能需要很长时间才能响应。 如果您想要异步功能，您可能需要查看 Spring 的@EnableAsync & @Async 。

@EnableAsync

Answer 5

尽管您有自定义jobLauncher ，但您正在使用 Spring 提供的默认jobLauncher运行作业。 您simpleJobLauncher在您的控制器中自动装配simpleJobLauncher并尝试一下？

Answer 6

根据 spring 文档，要异步返回 http 请求的响应，需要使用 org.springframework.core.task.SimpleAsyncTaskExecutor。

spring TaskExecutor 接口的任何实现都可用于控制作业的异步执行方式。

spring 批处理文档

<bean id="jobLauncher"
  class="org.springframework.batch.core.launch.support.SimpleJobLauncher">
<property name="jobRepository" ref="jobRepository" />
<property name="taskExecutor">
    <bean class="org.springframework.core.task.SimpleAsyncTaskExecutor" />
</property>

Answer 7

如果您使用的是 Lombok，这可能会对您有所帮助：

TLDR：龙目岛@AllArgsConstructor似乎并没有很好地工作@Qualifier注释编辑：如果你有启用@Qualifier在注释lombok.config文件能够使用@Qualifier与@AllArgsConstructor是这样的：

lombok.copyableAnnotations += org.springframework.beans.factory.annotation.Qualifier

我知道老问题，但是我遇到了完全相同的问题，但没有一个答案解决了它。

我像这样配置了异步作业启动器并添加了限定符以确保注入此 jobLauncher：

 @Bean(name = "asyncJobLauncher")
 public JobLauncher simpleJobLauncher(JobRepository jobRepository) throws Exception {
        SimpleJobLauncher jobLauncher = new SimpleJobLauncher();
        jobLauncher.setJobRepository(jobRepository);
        jobLauncher.setTaskExecutor(new SimpleAsyncTaskExecutor());
        jobLauncher.afterPropertiesSet();
        return jobLauncher;
    }

并像这样注入它

@Qualifier("asyncJobLauncher")
private final JobLauncher jobLauncher;

我在将其更改为自动装配后使用 Lombok @AllArgsConstructor ，注入了正确的作业启动器，现在该作业异步执行：

@Autowired
@Qualifier("asyncJobLauncher")
private JobLauncher jobLauncher;

此外，我不必从DefaultBatchConfigurer扩展我的配置