Add java configuration for the Repository item reader/writer sample

Issue #3663

spring-batch-samples/README.md

@@ -109,12 +109,12 @@ efficient updates to a database table.
 
 [Jdbc Readers and Batch Update sample](./src/main/java/org/springframework/batch/sample/jdbc/README.md)
 
-### JPA Reader and Writer sample
+### JPA Readers and Writers sample
 
-The purpose of this sample is to show to usage of the `JpaPagingItemReader`
-and the `JpaItemWriter` to read and write data from/to a database with JPA.
+The purpose of this sample is to show to usage of the JPA item readers and writers
+to read and write data from/to a database with JPA and Hibernate.
 
-[JPA Reader and Writer sample](./src/main/java/org/springframework/batch/sample/jpa/README.md)
+[JPA Readers and Writers sample](./src/main/java/org/springframework/batch/sample/jpa/README.md)
 
 ### Amqp Job Sample
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/data/CustomerCreditCrudRepository.java → spring-batch-samples/src/main/java/org/springframework/batch/sample/jpa/CustomerCreditCrudRepository.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 the original author or authors.
+ * Copyright 2023 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.
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.batch.sample.data;
+package org.springframework.batch.sample.jpa;
 
 import org.springframework.batch.sample.domain.trade.CustomerCredit;
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/data/CustomerCreditPagingAndSortingRepository.java → spring-batch-samples/src/main/java/org/springframework/batch/sample/jpa/CustomerCreditPagingAndSortingRepository.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.batch.sample.data;
+package org.springframework.batch.sample.jpa;
 
 import java.math.BigDecimal;
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/jpa/JpaRepositoryJobConfiguration.java

@@ -0,0 +1,127 @@
+/*
+ * Copyright 2023 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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.batch.sample.jpa;
+
+import java.math.BigDecimal;
+import java.util.Map;
+
+import javax.sql.DataSource;
+import jakarta.persistence.EntityManagerFactory;
+
+import org.springframework.batch.core.Job;
+import org.springframework.batch.core.configuration.annotation.EnableBatchProcessing;
+import org.springframework.batch.core.configuration.annotation.StepScope;
+import org.springframework.batch.core.job.builder.JobBuilder;
+import org.springframework.batch.core.repository.JobRepository;
+import org.springframework.batch.core.step.builder.StepBuilder;
+import org.springframework.batch.item.data.RepositoryItemReader;
+import org.springframework.batch.item.data.RepositoryItemWriter;
+import org.springframework.batch.item.data.builder.RepositoryItemReaderBuilder;
+import org.springframework.batch.item.data.builder.RepositoryItemWriterBuilder;
+import org.springframework.batch.item.database.JpaItemWriter;
+import org.springframework.batch.item.database.JpaPagingItemReader;
+import org.springframework.batch.sample.domain.trade.CustomerCredit;
+import org.springframework.batch.sample.domain.trade.internal.CustomerCreditIncreaseProcessor;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.domain.Sort;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
+import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
+import org.springframework.orm.jpa.JpaTransactionManager;
+import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
+import org.springframework.orm.jpa.persistenceunit.DefaultPersistenceUnitManager;
+import org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager;
+import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;
+
+/**
+ * Hibernate JPA dialect does not support custom tx isolation levels => overwrite with
+ * ISOLATION_DEFAULT.
+ *
+ * @author Mahmoud Ben Hassine
+ */
+@Configuration
+@EnableBatchProcessing(isolationLevelForCreate = "ISOLATION_DEFAULT")
+@EnableJpaRepositories(basePackages = "org.springframework.batch.sample.jpa")
+public class JpaRepositoryJobConfiguration {
+
+	@Bean
+	@StepScope
+	public RepositoryItemReader<CustomerCredit> itemReader(@Value("#{jobParameters['credit']}") Double credit,
+			CustomerCreditPagingAndSortingRepository repository) {
+		return new RepositoryItemReaderBuilder<CustomerCredit>().name("itemReader")
+			.pageSize(2)
+			.methodName("findByCreditGreaterThan")
+			.repository(repository)
+			.arguments(BigDecimal.valueOf(credit))
+			.sorts(Map.of("id", Sort.Direction.ASC))
+			.build();
+	}
+
+	@Bean
+	public RepositoryItemWriter<CustomerCredit> itemWriter(CustomerCreditCrudRepository repository) {
+		return new RepositoryItemWriterBuilder<CustomerCredit>().repository(repository).methodName("save").build();
+	}
+
+	@Bean
+	public Job job(JobRepository jobRepository, JpaTransactionManager transactionManager,
+			RepositoryItemReader<CustomerCredit> itemReader, RepositoryItemWriter<CustomerCredit> itemWriter) {
+		return new JobBuilder("ioSampleJob", jobRepository)
+			.start(new StepBuilder("step1", jobRepository).<CustomerCredit, CustomerCredit>chunk(2, transactionManager)
+				.reader(itemReader)
+				.processor(new CustomerCreditIncreaseProcessor())
+				.writer(itemWriter)
+				.build())
+			.build();
+	}
+
+	// Infrastructure beans
+
+	@Bean
+	public DataSource dataSource() {
+		return new EmbeddedDatabaseBuilder().setType(EmbeddedDatabaseType.HSQL)
+			.addScript("/org/springframework/batch/core/schema-drop-hsqldb.sql")
+			.addScript("/org/springframework/batch/core/schema-hsqldb.sql")
+			.addScript("/org/springframework/batch/sample/jpa/sql/schema.sql")
+			.build();
+	}
+
+	@Bean
+	public JpaTransactionManager transactionManager(EntityManagerFactory entityManagerFactory) {
+		return new JpaTransactionManager(entityManagerFactory);
+	}
+
+	@Bean
+	public EntityManagerFactory entityManagerFactory(PersistenceUnitManager persistenceUnitManager,
+			DataSource dataSource) {
+		LocalContainerEntityManagerFactoryBean factoryBean = new LocalContainerEntityManagerFactoryBean();
+		factoryBean.setDataSource(dataSource);
+		factoryBean.setPersistenceUnitManager(persistenceUnitManager);
+		factoryBean.setJpaVendorAdapter(new HibernateJpaVendorAdapter());
+		factoryBean.afterPropertiesSet();
+		return factoryBean.getObject();
+	}
+
+	@Bean
+	public PersistenceUnitManager persistenceUnitManager(DataSource dataSource) {
+		DefaultPersistenceUnitManager persistenceUnitManager = new DefaultPersistenceUnitManager();
+		persistenceUnitManager.setDefaultDataSource(dataSource);
+		persistenceUnitManager.afterPropertiesSet();
+		return persistenceUnitManager;
+	}
+
+}

spring-batch-samples/src/main/java/org/springframework/batch/sample/jpa/README.md

@@ -1,13 +1,13 @@
-### JPA Reader and Writer sample
+### JPA Readers and Writers sample
 
 ## About
 
-The purpose of this sample is to show to usage of the `JpaPagingItemReader`
-and the `JpaItemWriter` to read and write data from/to a database with JPA.
+The purpose of this sample is to show to usage of the JPA item readers and writers
+to read and write data from/to a database with JPA and Hibernate.
 
-## Run the sample
+## Run the samples
 
-You can run the sample from the command line as following:
+You can run the sample of the `JpaPagingItemReader`/`JpaItemWriter` from the command line as following:
 
 ```
 $>cd spring-batch-samples
@@ -16,3 +16,13 @@ $>../mvnw -Dtest=JpaFunctionalTests#testLaunchJobWithXmlConfig test
 # Launch the sample using the Java configuration
 $>../mvnw -Dtest=JpaFunctionalTests#testLaunchJobWithJavaConfig test
 ```
+
+You can run the sample of the `RepositoryItemReader`/`RepositoryItemWriter` from the command line as following:
+
+```
+$>cd spring-batch-samples
+# Launch the sample using the XML configuration
+$>../mvnw -Dtest=RepositoryFunctionalTests#testLaunchJobWithXmlConfig test
+# Launch the sample using the Java configuration
+$>../mvnw -Dtest=RepositoryFunctionalTests#testLaunchJobWithJavaConfig test
+```

spring-batch-samples/src/main/resources/jobs/iosample/repository.xml → spring-batch-samples/src/main/resources/org/springframework/batch/sample/jpa/job/repository.xml

@@ -1,11 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <beans xmlns="http://www.springframework.org/schema/beans"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xmlns:jpa="http://www.springframework.org/schema/data/jpa"
-	xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
-	 					http://www.springframework.org/schema/data/jpa https://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
+		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		xmlns:batch="http://www.springframework.org/schema/batch"
+		xmlns:jdbc="http://www.springframework.org/schema/jdbc"
+		xmlns:jpa="http://www.springframework.org/schema/data/jpa"
+		xsi:schemaLocation="
+		http://www.springframework.org/schema/batch https://www.springframework.org/schema/batch/spring-batch.xsd
+		http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
+		http://www.springframework.org/schema/jdbc https://www.springframework.org/schema/jdbc/spring-jdbc.xsd
+		http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
 
-	<jpa:repositories base-package="org.springframework.batch.sample.data"/>
+	<jpa:repositories base-package="org.springframework.batch.sample.jpa"/>
+
+	<batch:job id="ioSampleJob" xmlns="http://www.springframework.org/schema/batch">
+		<batch:step id="step1">
+			<batch:tasklet>
+				<batch:chunk reader="itemReader" processor="itemProcessor" writer="itemWriter"
+							 commit-interval="2"/>
+			</batch:tasklet>
+		</batch:step>
+	</batch:job>
+
+	<bean id="itemProcessor" class="org.springframework.batch.sample.domain.trade.internal.CustomerCreditIncreaseProcessor" />
 
 	<bean id="itemReader"
 		class="org.springframework.batch.item.data.RepositoryItemReader" scope="step">
@@ -58,4 +74,16 @@
 		<property name="dataSource" ref="dataSource" />
 		<property name="transactionManager" ref="transactionManager" />
 	</bean>
+
+	<bean id="jobLauncher"
+		  class="org.springframework.batch.core.launch.support.TaskExecutorJobLauncher">
+		<property name="jobRepository" ref="jobRepository" />
+	</bean>
+
+	<jdbc:embedded-database id="dataSource" generate-name="true">
+		<jdbc:script location="org/springframework/batch/core/schema-drop-hsqldb.sql"/>
+		<jdbc:script location="org/springframework/batch/core/schema-hsqldb.sql"/>
+		<jdbc:script location="org/springframework/batch/sample/jpa/sql/schema.sql"/>
+	</jdbc:embedded-database>
+
 </beans>

spring-batch-samples/src/test/java/org/springframework/batch/sample/jpa/RepositoryFunctionalTests.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2013-2023 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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.batch.sample.jpa;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.batch.core.BatchStatus;
+import org.springframework.batch.core.Job;
+import org.springframework.batch.core.JobExecution;
+import org.springframework.batch.core.JobParameters;
+import org.springframework.batch.core.JobParametersBuilder;
+import org.springframework.batch.core.launch.JobLauncher;
+import org.springframework.batch.test.JobLauncherTestUtils;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@SpringJUnitConfig(
+		locations = { "/org/springframework/batch/sample/jpa/job/repository.xml", "/job-runner-context.xml" })
+class RepositoryFunctionalTests {
+
+	@Autowired
+	private JobLauncherTestUtils jobLauncherTestUtils;
+
+	@Test
+	void testLaunchJobWithXmlConfig() throws Exception {
+		// given
+		JobParameters jobParameters = new JobParametersBuilder().addDouble("credit", 10000D).toJobParameters();
+
+		// when
+		JobExecution jobExecution = this.jobLauncherTestUtils.launchJob(jobParameters);
+
+		// then
+		assertEquals(BatchStatus.COMPLETED, jobExecution.getStatus());
+	}
+
+	@Test
+	public void testLaunchJobWithJavaConfig() throws Exception {
+		// given
+		ApplicationContext context = new AnnotationConfigApplicationContext(JpaRepositoryJobConfiguration.class);
+		JobLauncher jobLauncher = context.getBean(JobLauncher.class);
+		Job job = context.getBean(Job.class);
+		JobParameters jobParameters = new JobParametersBuilder().addDouble("credit", 10000D).toJobParameters();
+
+		// when
+		JobExecution jobExecution = jobLauncher.run(job, jobParameters);
+
+		// then
+		assertEquals(BatchStatus.COMPLETED, jobExecution.getStatus());
+	}
+
+}