如何从Spring Batch中的ItemReader访问作业参数?

时间:2011-05-20 22:03:22

标签: java spring spring-batch

这是我的job.xml

的一部分
<job id="foo" job-repository="job-repository">
  <step id="bar">
    <tasklet transaction-manager="transaction-manager">
      <chunk commit-interval="1"
        reader="foo-reader" writer="foo-writer"
      />
    </tasklet>
  </step>
</job>

这是项目读者:

import org.springframework.batch.item.ItemReader;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component("foo-reader")
public final class MyReader implements ItemReader<MyData> {
  @Override
  public MyData read() throws Exception {
    //...
  }
  @Value("#{jobParameters['fileName']}")
  public void setFileName(final String name) {
    //...
  }
}

这就是Spring Batch在运行时所说的内容:

Field or property 'jobParameters' cannot be found on object of 
type 'org.springframework.beans.factory.config.BeanExpressionContext'

这里有什么问题?我可以在Spring 3.0中阅读更多有关这些机制的内容吗?

7 个答案:

答案 0 :(得分:64)

如上所述,您的读者需要“步入”范围。您可以通过@Scope("step")注释完成此操作。如果您将该注释添加到阅读器中,它应该适用于您,如下所示:

import org.springframework.batch.item.ItemReader;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component("foo-reader")
@Scope("step")
public final class MyReader implements ItemReader<MyData> {
  @Override
  public MyData read() throws Exception {
    //...
  }

  @Value("#{jobParameters['fileName']}")
  public void setFileName(final String name) {
    //...
  }
}

默认情况下,此范围不可用,但如果您使用的是batch XML命名空间,则该范围将是可用的。如果不是这样,将以下内容添加到Spring配置中将根据Spring Batch documentation提供范围:

<bean class="org.springframework.batch.core.scope.StepScope" />

答案 1 :(得分:15)

如果要在单个JavaConfig类中定义ItemReader实例和Step实例。您可以使用@StepScope@Value注释,例如:

@Configuration
public class ContributionCardBatchConfiguration {

   private static final String WILL_BE_INJECTED = null;

   @Bean
   @StepScope
   public FlatFileItemReader<ContributionCard> contributionCardReader(@Value("#{jobParameters['fileName']}")String contributionCardCsvFileName){

     ....
   }

   @Bean
   Step ingestContributionCardStep(ItemReader<ContributionCard> reader){
         return stepBuilderFactory.get("ingestContributionCardStep")
                 .<ContributionCard, ContributionCard>chunk(1)
                 .reader(contributionCardReader(WILL_BE_INJECTED))
                 .writer(contributionCardWriter())
                 .build();
    }
}

诀窍是将null值传递给itemReader,因为它将通过@Value("#{jobParameters['fileName']}")注释注入。

感谢Tobias Flohre的文章:Spring Batch 2.2 – JavaConfig Part 2: JobParameters, ExecutionContext and StepScope

答案 2 :(得分:13)

为了能够使用jobParameters,我认为您需要将阅读器定义为范围“步骤”,但我不确定您是否可以使用注释来执行此操作。

使用xml-config它会是这样的:

<bean id="foo-readers" scope="step"
  class="...MyReader">
  <property name="fileName" value="#{jobExecutionContext['fileName']}" />
</bean>

请参阅Spring Batch documentation

也许它可以通过使用@Scope并在xml-config中定义步骤范围来实现:

<bean class="org.springframework.batch.core.scope.StepScope" />

答案 3 :(得分:10)

很晚,但你也可以通过注释@BeforeStep方法来做到这一点:

@BeforeStep
    public void beforeStep(final StepExecution stepExecution) {
        JobParameters parameters = stepExecution.getJobExecution().getJobParameters();
        //use your parameters
}

答案 4 :(得分:2)

补充一个附加示例,您可以访问JavaConfig类中的所有作业参数:

@Bean
@StepScope
public ItemStreamReader<GenericMessage> reader(@Value("#{jobParameters}") Map<String,Object> jobParameters){
          ....
}

答案 5 :(得分:1)

执行作业时,我们需要传递Job参数,如下所示:

JobParameters jobParameters= new JobParametersBuilder().addString("file.name", "filename.txt").toJobParameters();   
JobExecution execution = jobLauncher.run(job, jobParameters);  

通过使用表达式语言,我们可以按如下方式导入值:

 #{jobParameters['file.name']}

答案 6 :(得分:-2)

您是否将作业参数正确地声明为bean?

或者您是否意外地实例化了一个JobParameters对象,该对象没有文件名的getter?

有关表达式语言的更多信息,可以在Spring文档here中找到信息。