Reusability - Spring Batch Part 9

By -
With SpringBatch, you are able to reuse existing steps, jobs.

Lets look at how we can reuse existing steps.

In our case, when a customer orders a chocolate box, we also want to package it and deliver it. These are the steps we used while the customer ordered a corporate gift as well. 




As you can see from the above diagram, after the Package Step everything is the same. (Steps highlighted in blue)

We can reuse these steps using Flows. We will create a Flow consisting of the common steps and use it in both our jobs.
@Bean
public Flow packagingAndDeliveryFlow(){
   return new FlowBuilder<SimpleFlow>("packageAndDeliveryFlow").start(packageStep())
         .on("FAILED").fail()
         .from(packageStep())
         .on("*").to(pickupOrDeliveryDecider())
         .on("DELIVER").to(deliveryStep())
         .from(pickupOrDeliveryDecider())
         .on("PICKUP").to(pickupStep())
         .build();
}
As you can see, the packageAndDeliveryFlow is replicating what we did for the packageJob. We will now have to change our packageJob and orderChocolateBoxJob to use this flow:

@Bean
public Job packageJob(){
   return this.jobBuilderFactory.get("giftShopJob").start(readOrderStep())
         .on("*").to(packagingAndDeliveryFlow())
         .end()
         .build();
}

@Bean
public Job orderChocolateBoxJob(){
   return this.jobBuilderFactory.get("orderChocolateBoxJob")
         .start(selectChocolatesStep())
            .on("NUTTY_CHOCOLATES").to(addNoteStep()).next(arrangeChocolatesStep())
         .from(selectChocolatesStep()).on("NORMAL_CHOCOLATES").to(arrangeChocolatesStep())
         .next(packagingAndDeliveryFlow())
         .end()
         .build();
}

Lets run the application and see the output:
2020-08-05 00:52:48.906  INFO 19936 --- [           main] o.s.b.c.l.support.SimpleJobLauncher      : Job: [FlowJob: [name=giftShopJob]] launched with the following parameters: [{chocolateType=DARK}]
2020-08-05 00:52:48.962  INFO 19936 --- [           main] o.s.batch.core.job.SimpleStepHandler     : Executing step: [readOrderStep]
Order Received
2020-08-05 00:52:48.985  INFO 19936 --- [           main] o.s.batch.core.step.AbstractStep         : Step: [readOrderStep] executed in 22ms
2020-08-05 00:52:48.998  INFO 19936 --- [           main] o.s.batch.core.job.SimpleStepHandler     : Executing step: [packageStep]
Packaging the gift
2020-08-05 00:52:49.005  INFO 19936 --- [           main] o.s.batch.core.step.AbstractStep         : Step: [packageStep] executed in 7ms
Customer choose: DELIVER
2020-08-05 00:52:49.017  INFO 19936 --- [           main] o.s.batch.core.job.SimpleStepHandler     : Executing step: [deliveryStep]
Package out for delivery
2020-08-05 00:52:49.025  INFO 19936 --- [           main] o.s.batch.core.step.AbstractStep         : Step: [deliveryStep] executed in 8ms
2020-08-05 00:52:49.033  INFO 19936 --- [           main] o.s.b.c.l.support.SimpleJobLauncher      : Job: [FlowJob: [name=giftShopJob]] completed with the following parameters: [{chocolateType=DARK}] and the following status: [COMPLETED] in 94ms
2020-08-05 00:52:49.046  INFO 19936 --- [           main] o.s.b.c.l.support.SimpleJobLauncher      : Job: [FlowJob: [name=orderChocolateBoxJob]] launched with the following parameters: [{chocolateType=DARK}]
2020-08-05 00:52:49.058  INFO 19936 --- [           main] o.s.batch.core.job.SimpleStepHandler     : Executing step: [selectChocolatesStep]
Before arranging chocolates
Ordering Chocolate : DARK
After arranging chocolates
2020-08-05 00:52:49.066  INFO 19936 --- [           main] o.s.batch.core.step.AbstractStep         : Step: [selectChocolatesStep] executed in 7ms
2020-08-05 00:52:49.079  INFO 19936 --- [           main] o.s.batch.core.job.SimpleStepHandler     : Executing step: [arrangeChocolatesStep]
Ordering Chocolate : DARK
2020-08-05 00:52:49.086  INFO 19936 --- [           main] o.s.batch.core.step.AbstractStep         : Step: [arrangeChocolatesStep] executed in 7ms
2020-08-05 00:52:49.098  INFO 19936 --- [           main] o.s.batch.core.job.SimpleStepHandler     : Executing step: [packageStep]
Packaging the gift
2020-08-05 00:52:49.105  INFO 19936 --- [           main] o.s.batch.core.step.AbstractStep         : Step: [packageStep] executed in 7ms
Customer choose: PICKUP
2020-08-05 00:52:49.117  INFO 19936 --- [           main] o.s.batch.core.job.SimpleStepHandler     : Executing step: [pickupStep]
Package ready for pickup
2020-08-05 00:52:49.124  INFO 19936 --- [           main] o.s.batch.core.step.AbstractStep         : Step: [pickupStep] executed in 7ms
2020-08-05 00:52:49.130  INFO 19936 --- [           main] o.s.b.c.l.support.SimpleJobLauncher      : Job: [FlowJob: [name=orderChocolateBoxJob]] completed with the following parameters: [{chocolateType=DARK}] and the following status: [COMPLETED] in 81ms
2020-08-05 00:52:49.135  INFO 19936 --- [extShutdownHook] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Shutdown initiated...
2020-08-05 00:52:49.146  INFO 19936 --- [extShutdownHook] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Shutdown completed.



As you can see we were able to reuse the steps using Flows in SpringBatch.



Note: I have dropped the Spring Job Repository tables just to able to rerun the application just to make it easy to rerun the Job

DROP TABLE BATCH_STEP_EXECUTION_CONTEXT ;
DROP TABLE BATCH_STEP_EXECUTION ;
DROP TABLE BATCH_JOB_INSTANCE ;
DROP TABLE BATCH_JOB_EXECUTION_PARAMS ;
DROP TABLE BATCH_JOB_EXECUTION_CONTEXT ;
DROP TABLE BATCH_JOB_EXECUTION ;

Comments

Post a Comment

Popular posts from this blog

Writing your own ejabberd Module

By -
Coming soon: What is ejabberd? What is erlang? Installation details. I will start with writing the ejabberd module first. Once you have done all the installations: sudo make sudo make install sudo ejabberdctl start sudo ejabberdctl stop You can check the status using: sudo ejabberdctl status You can locate logs at: (With default installation) /var/log/ejabberd All config related changes will be mainly done at: /etc/ejabberd/ejabberd.yml You will need a basic understanding of erlang. You can take a short crash course at: http://www.erlang.org/course/course.html This is a good reference. Go to your ejabberd-15.07/src directory. This is where you will write the hook for your ejabberd server. Create a file, say mod_changeBody.erl. Your module name and file name should be same. Add the following basic contents into your erl file: -module(mod_changeBody). -behavior(gen_mod). -include("ejabberd.hrl"). -include("logger.hrl"). -expo
Read more

npm ECONNREFUSED error

By -
If you face error which says ECONNREFUSED while doing npm install <<package name>>, you are probably behind a proxy which is not allowing you to connect to the server and download the packages required. Just follow the below steps: npm config set proxy  http://your_proxy_name:port npm config set https-proxy https://your_proxy_name:port And then try npm install How to get npm config? npm get proxy will do the work :)
Read more

Conditional Flow - Spring Batch Part 6

By -
Jump to Conditional Flow using Custom Status There can be muliple scenario where you want your jobs to proceed depending on the outcome of your steps. For example, in case of our Corporate gifts shop, in case the automatic packaging of the gifts fails, we want some manual intervention to be done i.e. somebody should manually package the item.  IF-ELSE IF loop for packaging:     if packageStep fails                              then manualPackageStep                         else if packageStep executes successfully                              then sendOutForDelivery Entire code available at git repo:   https://github.com/ricsr/spring-batch-demo/tree/exercise_06 Using SpringBatch you can achieve it as follows: Create you manualPackageStep, which is very similar to your packageStep, except that it does the packaging manually. @Bean public Step manualPackageStep () { return this . stepBuilderFactory .get( "manualPackageStep" ).tasklet( new Tasklet() { @Override pu
Read more