How to get Job parameteres in to item processor using spring Batch annotation

Question

I am using spring MVC. From my controller, I am calling jobLauncher and in jobLauncher I am passing job parameters like below and I'm using annotations to enable configuration as below:

@Configuration
@EnableBatchProcessing
public class BatchConfiguration {
        // read, write ,process and invoke job
} 

JobParameters jobParameters = new JobParametersBuilder().addString("fileName", "xxxx.txt").toJobParameters();
stasrtjob = jobLauncher.run(job, jobParameters);                              

and here is my itemprocessor                                                         
public class DataItemProcessor implements ItemProcessor<InputData, OutPutData> {

  public OutPutData process(final InputData inputData) throws Exception {

        // i want to get job Parameters here ????

  }

}

Amit Bhati · Accepted Answer · 2015-07-31T03:57:04.570

1) Put a scope annotation on your data processor i.e.

@Scope(value = "step")

2) Make a class instance in your data processor and inject the job parameter value by using value annotation :

@Value("#{jobParameters['fileName']}")
private String fileName;

Your final Data processor class will look like:

@Scope(value = "step")
public class DataItemProcessor implements ItemProcessor<InputData, OutPutData> {

@Value("#{jobParameters['fileName']}")
private String fileName;

  public OutPutData process(final InputData inputData) throws Exception {

        // i want to get job Parameters here ????
      System.out.println("Job parameter:"+fileName);

  }

  public void setFileName(String fileName) {
        this.fileName = fileName;
    }


}

In case your data processor is not initialized as a bean, put a @Component annotation on it:

@Component("dataItemProcessor")
@Scope(value = "step")
public class DataItemProcessor implements ItemProcessor<InputData, OutPutData> {

if your processor is configured in an XML, you should add the scope there, like: — Asturio, Aug 03 '15 at 12:45
is there any way to set custom type list to job parameters and get that list in item processor ? — Mare, Aug 03 '15 at 23:21
Shouldn't it be `@StepScope` rather than `@Scope(value = "step")`? — gohil90, Jan 17 '18 at 12:38

score 16 · Answer 2 · answered Dec 13 '18 at 17:46

A better solution (in my opinion) that avoids using Spring's hacky expression language (SpEL) is to autowire the StepExecution context into your processor using @BeforeStep.

In your processor, add something like:

@BeforeStep
public void beforeStep(final StepExecution stepExecution) {
    JobParameters jobParameters = stepExecution.getJobParameters();
    // Do stuff with job parameters, e.g. set class-scoped variables, etc.
}

The @BeforeStep annotation

Marks a method to be called before a Step is executed, which comes after a StepExecution is created and persisted, but before the first item is read.

Upvoted - this is a really clean approach in batch 1.5.10 – Michael Peacock Feb 12 '19 at 21:59 — Michael Peacock, Feb 12 '19 at 21:59

score 0 · Answer 3 · edited Oct 14 '22 at 06:04

I have written the in the process itself, rather then creating separate file using the lambda expression.

@Bean
    @StepScope
    public ItemProcessor<SampleTable, SampleTable> processor(@Value("#{jobParameters['eventName']}") String eventName) {
        //return new RandomNumberProcessor();
        
        return item -> {
            SampleTable dataSample = new SampleTable();
            if(data.contains(item)) {
                return null;
            }
            else {
                dataSample.setMobileNo(item.getMobileNo());
                dataSample.setEventId(eventName);
                return dataSample;
            }
        };
    }

How to get Job parameteres in to item processor using spring Batch annotation

3 Answers3

Linked