validate step listeners#3708
Open
hosuaby wants to merge 1 commit into
Open
Conversation
d7e5bf7 to
cb71ecf
Compare
Author
|
Works also with XML config: <?xml version="1.0" encoding="UTF-8"?>
<beans:beans
xmlns="http://www.springframework.org/schema/batch"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:beans="http://www.springframework.org/schema/beans"
xsi:schemaLocation="http://www.springframework.org/schema/batch
http://www.springframework.org/schema/batch/spring-batch.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
<job id="someJob">
<step id="someStep">
<tasklet ref="someTasklet"/>
<listeners>
<listener ref="dummyJobExecutionListener" />
</listeners>
</step>
</job>
</beans:beans>
|
cb71ecf to
b645523
Compare
Contributor
|
Not sure if this would fix #4808, but just adding this note here for later reference. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The problem:
StepBuilderFactoryis very permissive concerning listeners.Method
AbstractTaskletStepBuilder#listener(Object listener)accepts an Object as parameter, and this can lead to wrong step configurations as following:As you see
DummyJobExecutionListeneris a job listener! Not step listener. Code compiles and executes without a single warning. This mis-configuration can lead to long painful hours of debugging, before user will notice that he passed wrong listener.Solution: add runtime assert that will check that Object listener is a valid step execution listener. We can simply use method
StepListenerFactoryBean#isListener.With this feature, the precedent code will throw an exception during application start-up: