Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Spring Batch SkipListener not called when exception occurs in reader

This is my step configuration. My skip listeners onSkipInWrite() method is called properly. But onSkipInRead() is not getting called. I found this by deliberately throwing a null pointer exception from my reader.

<step id="callService" next="writeUsersAndResources">
        <tasklet allow-start-if-complete="true">
            <chunk reader="Reader" writer="Writer"
                commit-interval="10" skip-limit="10">
                <skippable-exception-classes>
                    <include class="java.lang.Exception" />
                </skippable-exception-classes>
            </chunk>
            <listeners>
                <listener ref="skipListener" />
            </listeners>
        </tasklet>
    </step>

I read some forums and interchanged the listeners-tag at both levels: Inside the chunk, and outside the tasklet. Nothing is working...

Adding my skip Listener here

package com.legal.batch.core;

import org.apache.commons.lang.StringEscapeUtils;
import org.springframework.batch.core.SkipListener;
import org.springframework.jdbc.core.JdbcTemplate;


public class SkipListener implements SkipListener<Object, Object> {


    @Override
    public void onSkipInProcess(Object arg0, Throwable arg1) {
        // TODO Auto-generated method stub

    }

    @Override
    public void onSkipInRead(Throwable arg0) {
    }

    @Override
    public void onSkipInWrite(Object arg0, Throwable arg1) {
}

}

Experts please suggest

like image 629
juniorbansal Avatar asked Oct 03 '11 18:10

juniorbansal


People also ask

How does Spring Batch handle exceptions?

By default , if there's an uncaught exception when processing the job, spring batch will stop the job. If the job is restarted with the same job parameters, it will pick up where it left off. The way it knows where the job status is by checking the job repository where it saves all the spring batch job status.

What is skip listener?

Interface SkipListener<T,S>Interface for listener to skipped items. Callbacks will be called by Step implementations at the appropriate time in the step lifecycle. Implementers of this interface should not assume that any method will be called immediately after an error has been encountered.

Can we skip processor in Spring Batch?

Using Custom SkipPolicy For that purpose, Spring Batch framework provides the SkipPolicy interface. We can then provide our own implementation of skip logic and plug it into our step definition.

What is skip limit in Spring Batch?

Skipping ItemsDefine a skip-limit on your chunk element to tell Spring how many items can be skipped before the job fails (you might handle a few invalid records, but if you have too many then the input data might be invalid).


1 Answers

Skip listeners respect transaction boundary, which means they always be called just before the transaction is committed.

Since a commit interval in your example is set to "10", the onSkipInRead will be called right at the moment of committing these 10 items (at once).

Hence if you try to do a step by step debugging, you would not see a onSkipInRead called right away after an ItemReader throws an exception.

A SkipListener in your example has an empty onSkipInRead method. Try to add some logging inside onSkipInRead, move a and rerun your job to see those messages.

EDIT:

Here is a working example [names are changed to 'abc']:

<step id="abcStep" xmlns="http://www.springframework.org/schema/batch">
    <tasklet>
        <chunk writer="abcWriter"
               reader="abcReader"
               commit-interval="${abc.commit.interval}"
               skip-limit="1000" >

            <skippable-exception-classes>
                <include class="com.abc....persistence.mapping.exception.AbcMappingException"/>
                <include class="org.springframework.batch.item.validator.ValidationException"/>
                ...
                <include class="...Exception"/>
            </skippable-exception-classes>

            <listeners>
                <listener ref="abcSkipListener"/>
            </listeners>

        </chunk>

        <listeners>
            <listener ref="abcStepListener"/>
            <listener ref="afterStepStatsListener"/>
        </listeners>

        <no-rollback-exception-classes>
            <include class="com.abc....persistence.mapping.exception.AbcMappingException"/>
            <include class="org.springframework.batch.item.validator.ValidationException"/>
            ...
            <include class="...Exception"/> 
        </no-rollback-exception-classes>

        <transaction-attributes isolation="READ_COMMITTED"
                                propagation="REQUIRED"/>
    </tasklet>
</step>

where an abcSkipListener bean is:

public class AbcSkipListener {

    private static final Logger logger = LoggerFactory.getLogger( "abc-skip-listener" );

    @OnReadError
    public void houstonWeHaveAProblemOnRead( Exception problem ) {
        // ...
    }


    @OnSkipInWrite
    public void houstonWeHaveAProblemOnWrite( AbcHolder abcHolder, Throwable problem ) {
        // ...
    }

    ....
}
like image 164
tolitius Avatar answered Sep 17 '22 17:09

tolitius