Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation about throttling deprecation

Browse Source 
Resolves #4389

(cherry picked from commit 6ba7c639a4)
This commit is contained in:
Mahmoud Ben Hassine
2023-11-15 11:44:01 +01:00
parent f40dd9fec1
commit 4610bdac94
2 changed files with 26 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/AbstractTaskletStepBuilder.java
View File

@@ -199,9 +199,9 @@ public abstract class AbstractTaskletStepBuilder<B extends AbstractTaskletStepBu
* in the job repository for this step.
* @param throttleLimit maximum number of concurrent tasklet executions allowed
* @return this for fluent chaining
* @deprecated since 5.0, scheduled for removal in 6.0. Use a pooled
* {@link TaskExecutor} implementation with a limited capacity of its task queue
* instead.
* @deprecated with no replacement since 5.0, scheduled for removal in 6.0. Use a custom
* {@link RepeatOperations} implementation (based on a {@link TaskExecutor} with a bounded
* task queue) and set it on the step with {@link #stepOperations(RepeatOperations)}.
*/
@Deprecated(since = "5.0", forRemoval = true)
public B throttleLimit(int throttleLimit) {

23
spring-batch-docs/src/main/asciidoc/scalability.adoc
View File

@@ -121,6 +121,29 @@ Note also that there may be limits placed on concurrency by any pooled resources
your step, such as a `DataSource`. Be sure to make the pool in those resources at least
as large as the desired number of concurrent threads in the step.
[WARNING]
.Throttle limit deprecation
====
As of v5.0, the throttle limit is deprecated with no replacement. If you want to replace the
current throttling mechanism in the default `TaskExecutorRepeatTemplate`, you need to provide
a custom `RepeatOperations` implementation (based on a `TaskExecutor` with a bounded task queue)
and set it on the step with `StepBuilder#stepOperations`:
.Java Configuration
[source, java]
----
@Bean
public Step sampleStep(RepeatOperations customRepeatOperations, JobRepository jobRepository, PlatformTransactionManager transactionManager) {
return new StepBuilder("sampleStep", jobRepository)
.<String, String>chunk(10, transactionManager)
.reader(itemReader())
.writer(itemWriter())
.stepOperations(customRepeatOperations)
.build();
}
----
====
There are some practical limitations of using multi-threaded `Step` implementations for
some common batch use cases. Many participants in a `Step` (such as readers and writers)
are stateful. If the state is not segregated by thread, those components are not