Fix key collision in execution context with item streams

Credits to @jpraet !

Change set taken from #292

Author: fmbenhassine

spring-batch-core/src/main/java/org/springframework/batch/core/step/item/ChunkMonitor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2024 the original author or authors.
+ * Copyright 2006-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,6 +35,7 @@
  * @author Dave Syer
  * @author Mahmoud Ben Hassine
  * @author Seungrae Kim
+ * @author Jimmy Praet
  * @since 2.0
  * @deprecated Since 6.0 with no replacement. Scheduled for removal in 7.0.
  */
@@ -68,7 +69,6 @@ public ChunkMonitorData(int offset, int chunkSize) {
 	private ItemReader<?> reader;
 
 	public ChunkMonitor() {
-		this.setExecutionContextName(ChunkMonitor.class.getName());
 	}
 
 	/**

spring-batch-core/src/test/java/org/springframework/batch/core/partition/ExampleItemReader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2008-2023 the original author or authors.
+ * Copyright 2008-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,7 +23,6 @@
 import org.springframework.batch.infrastructure.item.ItemStreamException;
 import org.springframework.batch.infrastructure.item.ItemStreamReader;
 import org.springframework.batch.infrastructure.item.support.AbstractItemStreamItemReader;
-import org.springframework.util.ClassUtils;
 
 /**
  * {@link ItemStreamReader} with hard-coded input data.
@@ -43,7 +42,6 @@ public class ExampleItemReader extends AbstractItemStreamItemReader<String> {
 	public static volatile boolean fail = false;
 
 	public ExampleItemReader() {
-		this.setExecutionContextName(ClassUtils.getShortName(this.getClass()));
 	}
 
 	/**

spring-batch-core/src/test/java/org/springframework/batch/core/step/item/ChunkMonitorTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2023 the original author or authors.
+ * Copyright 2006-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@
 /**
  * @author Dave Syer
  * @author Mahmoud Ben Hassine
- *
+ * @author Jimmy Praet
  */
 class ChunkMonitorTests {
 
@@ -96,7 +96,7 @@ void testClose() {
 	@Test
 	void testOpen() {
 		ExecutionContext executionContext = new ExecutionContext();
-		executionContext.putInt(ChunkMonitor.class.getName() + ".OFFSET", 2);
+		executionContext.putInt(monitor.getExecutionContextKey("OFFSET"), 2);
 		monitor.open(executionContext);
 		assertEquals(2, count);
 		assertEquals(0, monitor.getOffset());
@@ -120,7 +120,7 @@ void testOpenWithErrorInReader() {
 			}
 		});
 		ExecutionContext executionContext = new ExecutionContext();
-		executionContext.putInt(ChunkMonitor.class.getName() + ".OFFSET", 2);
+		executionContext.putInt(monitor.getExecutionContextKey("OFFSET"), 2);
 		assertThrows(ItemStreamException.class, () -> monitor.open(executionContext));
 	}
 
@@ -131,7 +131,7 @@ void testUpdateOnBoundary() {
 		monitor.update(executionContext);
 		assertEquals(0, executionContext.size());
 
-		executionContext.put(ChunkMonitor.class.getName() + ".OFFSET", 3);
+		executionContext.put(monitor.getExecutionContextKey("OFFSET"), 3);
 		monitor.update(executionContext);
 		assertEquals(0, executionContext.size());
 	}

spring-batch-infrastructure/src/main/java/org/springframework/batch/infrastructure/item/ItemStreamSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2024 the original author or authors.
+ * Copyright 2006-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@
 
 import org.jspecify.annotations.Nullable;
 import org.springframework.batch.infrastructure.item.util.ExecutionContextUserSupport;
+import org.springframework.beans.factory.BeanNameAware;
+import org.springframework.util.ClassUtils;
 
 /**
  * Empty method implementation of {@link ItemStream}.
@@ -25,12 +27,21 @@
  * @author Dean de Bree
  * @author Mahmoud Ben Hassine
  * @author Stefano Cordio
+ * @author Jimmy Praet
  *
  */
-public abstract class ItemStreamSupport implements ItemStream {
+public abstract class ItemStreamSupport implements ItemStream, BeanNameAware {
 
 	private final ExecutionContextUserSupport executionContextUserSupport = new ExecutionContextUserSupport();
 
+	private final String defaultName = ClassUtils.getShortName(getClass());
+
+	private @Nullable String name;
+
+	public ItemStreamSupport() {
+		setName(defaultName);
+	}
+
 	/**
 	 * The name of the component which will be used as a stem for keys in the
 	 * {@link ExecutionContext}. Subclasses should provide a default value, e.g. the short
@@ -41,6 +52,20 @@ public void setName(String name) {
 		this.setExecutionContextName(name);
 	}
 
+	/**
+	 * Set the name of the bean in the bean factory that created this bean. The bean name
+	 * will only be used as name of the component in case it hasn't already been
+	 * explicitly set to a value other than the default. {@link #setName(String)}
+	 * @see BeanNameAware#setBeanName(String)
+     * @since 6.0
+	 */
+	@Override
+	public void setBeanName(String name) {
+		if (defaultName.equals(this.name)) {
+			setName(name);
+		}
+	}
+
 	/**
 	 * Get the name of the component
 	 * @return the name of the component
@@ -50,6 +75,7 @@ public void setName(String name) {
 	}
 
 	protected void setExecutionContextName(String name) {
+		this.name = name;
 		executionContextUserSupport.setName(name);
 	}
 

spring-batch-infrastructure/src/main/java/org/springframework/batch/infrastructure/item/avro/AvroItemReader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2025 the original author or authors.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -35,7 +35,6 @@
 import org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader;
 import org.springframework.core.io.Resource;
 import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
 
 /**
  * An {@link ItemReader} that deserializes data from a {@link Resource} containing
@@ -48,6 +47,7 @@
  * @author David Turanski
  * @author Mahmoud Ben Hassine
  * @author Song JaeGeun
+ * @author Jimmy Praet
  * @since 4.2
  */
 public class AvroItemReader<T> extends AbstractItemCountingItemStreamItemReader<T> {
@@ -67,8 +67,6 @@ public class AvroItemReader<T> extends AbstractItemCountingItemStreamItemReader<
 	 * @param clazz the data type to be deserialized.
 	 */
 	public AvroItemReader(Resource resource, Class<T> clazz) {
-		setName(ClassUtils.getShortName(AvroItemReader.class));
-
 		Assert.notNull(resource, "'resource' is required.");
 		Assert.notNull(clazz, "'class' is required.");
 
@@ -86,8 +84,6 @@ public AvroItemReader(Resource resource, Class<T> clazz) {
 	 * @param schema the {@link Resource} containing the Avro schema.
 	 */
 	public AvroItemReader(Resource data, Resource schema) {
-		setName(ClassUtils.getShortName(AvroItemReader.class));
-
 		Assert.notNull(data, "'data' is required.");
 		Assert.state(data.exists(), "'data' " + data.getFilename() + " does not exist.");
 		Assert.notNull(schema, "'schema' is required");

spring-batch-infrastructure/src/main/java/org/springframework/batch/infrastructure/item/data/MongoCursorItemReader.java

@@ -37,14 +37,14 @@
 import org.springframework.data.mongodb.util.json.ParameterBindingJsonReader;
 import org.springframework.data.util.CloseableIterator;
 import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
 
 /**
  * Cursor-based {@link ItemReader} implementation for MongoDB.
  *
  * @author LEE Juchan
  * @author Mahmoud Ben Hassine
+ * @author Jimmy Praet
  * @since 5.1
  */
 public class MongoCursorItemReader<T> extends AbstractItemCountingItemStreamItemReader<T> implements InitializingBean {
@@ -86,7 +86,6 @@ public MongoCursorItemReader(MongoOperations template, Class<? extends T> target
 		Assert.notNull(targetType, "Target type must not be null");
 		this.template = template;
 		this.targetType = targetType;
-		setName(ClassUtils.getShortName(MongoCursorItemReader.class));
 	}
 
 	/**

spring-batch-infrastructure/src/main/java/org/springframework/batch/infrastructure/item/data/MongoPagingItemReader.java

@@ -78,6 +78,7 @@
  * @author Takaaki Iida
  * @author Mahmoud Ben Hassine
  * @author Parikshit Dutta
+ * @author Jimmy Praet
  */
 public class MongoPagingItemReader<T> extends AbstractPaginatedDataItemReader<T> implements InitializingBean {
 
@@ -110,7 +111,6 @@ public MongoPagingItemReader(MongoOperations template, Class<? extends T> type)
 		Assert.notNull(type, "Target type must not be null");
 		this.template = template;
 		this.type = type;
-		setName(ClassUtils.getShortName(MongoPagingItemReader.class));
 	}
 
 	/**

spring-batch-infrastructure/src/main/java/org/springframework/batch/infrastructure/item/data/RepositoryItemReader.java

@@ -79,6 +79,7 @@
  * @author Michael Minella
  * @author Antoine Kapps
  * @author Mahmoud Ben Hassine
+ * @author Jimmy Praet
  * @since 2.2
  */
 public class RepositoryItemReader<T> extends AbstractItemCountingItemStreamItemReader<T> implements InitializingBean {
@@ -114,7 +115,6 @@ public RepositoryItemReader(PagingAndSortingRepository<?, ?> repository, Map<Str
 		Assert.notNull(sorts, "A Map of sorts is required.");
 		this.repository = repository;
 		this.sorts = sorts;
-		setName(ClassUtils.getShortName(RepositoryItemReader.class));
 	}
 
 	/**

spring-batch-infrastructure/src/main/java/org/springframework/batch/infrastructure/item/database/AbstractPagingItemReader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2023 the original author or authors.
+ * Copyright 2006-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,6 @@
 import org.springframework.batch.infrastructure.item.support.AbstractItemCountingItemStreamItemReader;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
 
 /**
  * Abstract {@link ItemStreamReader} for to extend when reading database records in a
@@ -46,6 +45,7 @@
  * @author Dave Syer
  * @author Mahmoud Ben Hassine
  * @author Stefano Cordio
+ * @author Jimmy Praet
  * @since 2.0
  */
 public abstract class AbstractPagingItemReader<T> extends AbstractItemCountingItemStreamItemReader<T>
@@ -66,7 +66,6 @@ public abstract class AbstractPagingItemReader<T> extends AbstractItemCountingIt
 	private final Lock lock = new ReentrantLock();
 
 	public AbstractPagingItemReader() {
-		setName(ClassUtils.getShortName(AbstractPagingItemReader.class));
 	}
 
 	/**

spring-batch-infrastructure/src/main/java/org/springframework/batch/infrastructure/item/database/JdbcCursorItemReader.java

@@ -61,6 +61,7 @@
  * @author Thomas Risberg
  * @author Mahmoud Ben Hassine
  * @author Stefano Cordio
+ * @author Jimmy Praet
  */
 public class JdbcCursorItemReader<T> extends AbstractCursorItemReader<T> {
 
@@ -83,7 +84,6 @@ public JdbcCursorItemReader(DataSource dataSource, String sql, RowMapper<T> rowM
 		Assert.notNull(rowMapper, "RowMapper must not be null");
 		this.sql = sql;
 		this.rowMapper = rowMapper;
-		setName(ClassUtils.getShortName(JdbcCursorItemReader.class));
 	}
 
 	/**