Spring Batch Tasklet With Spring Boot + How to create Tasklet in Spring Batch

Hi All,

Greetings of the day,

Today we will explore what is tasklet in the spring batch, what is the use of tasklet & how we can configure tasklet in spring batch job so let's start 

What is a tasklet in the spring batch è  Tasklet is used when we need to execute some independent task such as, sending emails, decompressing or compressing files, cleaning directory/temp files etc. 

How to create tasklet in spring batch è We can create our own tasklet by implementing the tasklet interface of the spring batch and overriding execute method as shown below.

package com.order.processor.tasklet; import org.springframework.batch.core.StepContribution; import org.springframework.batch.core.scope.context.ChunkContext; import org.springframework.batch.core.step.tasklet.Tasklet; import org.springframework.batch.repeat.RepeatStatus; import org.springframework.stereotype.Component; @Component public class CleanUpTasklet implements Tasklet { @Override public RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception { return null; } }

How to clean all temporary files from a specified directory using the spring batch tasklet?

@Component public class CleanUpTasklet implements Tasklet { @Override public RepeatStatus execute(StepContribution stepContribution, ChunkContext chunkContext) throws Exception { System.out.println("Deleting files from F://tmp_files"); FileUtils.cleanDirectory(new File("F://tmp_files//")); System.out.println("All files deleted successfully."); stepContribution.setExitStatus(ExitStatus.COMPLETED); return RepeatStatus.FINISHED; } }

How to configure tasklet in the spring batch?

We can configure tasklet in spring batch under step using stepBuilderFactory as shown below.

package com.order.processor.config; import com.order.processor.tasklet.CleanUpTasklet; import org.springframework.batch.core.Job; import org.springframework.batch.core.Step; import org.springframework.batch.core.configuration.annotation.JobBuilderFactory; import org.springframework.batch.core.configuration.annotation.StepBuilderFactory; import org.springframework.batch.core.launch.support.RunIdIncrementer; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class BatchConfig { @Autowired private JobBuilderFactory jobBuilderFactory; @Autowired private StepBuilderFactory stepBuilderFactory; @Autowired private CleanUpTasklet cleanUpTasklet; @Bean(name = "processOrderJob") public Job processOrderJob() { return jobBuilderFactory.get("processOrderJob").incrementer(new RunIdIncrementer()) .start(cleanUpStep()).build(); } @Bean public Step cleanUpStep(){ return stepBuilderFactory.get("cleanUpStep").tasklet(cleanUpTasklet).build(); } }

So we have seen what is tasklet in the spring batch, the use case of tasklet, and how to configure tasklet with spring boot using annotation.

If you have any questions feel free to comment.

Other spring batch articles 

Conditional Flow + Decider In Spring Batch + JobExecutionDecider + Spring Boot

 Spring Batch Components And Architecture

Spring Batch Example -CSV To Database with Spring Boot & Oracle

Reading And Writing Multiple Files In Spring Batch Using MultiResourceItemReader & ItemReader

Spring Batch - Skip Limit, Skip Policy & No Skip

Spring batch metadata tables 

Spring Batch Example Database To CSV Export

Spring Batch Job Listener + beforeJob +& afterJob In Spring Batch & Spring Boot+ JobExecutionListener

Thanks 

Happy Learning