Spring Batch 示例

欢迎来到Spring Batch示例。Spring Batch是一个用于执行批处理作业的Spring框架模块。我们可以使用Spring Batch来处理一系列作业。

Spring Batch示例

在深入了解Spring Batch示例程序之前，让我们先了解一些Spring Batch术语。

• A job can consist of ‘n’ number of steps. Each step contains Read-Process-Write task or it can have single operation, which is called tasklet.
• 读取-处理-写入基本上是从诸如数据库、CSV等来源读取数据，然后处理数据并将其写入诸如数据库、CSV、XML等来源。
• 任务意味着执行单个任务或操作，如在处理完成后清理连接、释放资源。
• 读取-处理-写入和任务可以链接在一起来运行一个作业。

Spring Batch示例

让我们考虑一个用于实现Spring Batch的工作示例。我们将考虑以下场景进行实现。一个包含数据的CSV文件需要转换为XML，并且数据和标签将以列名命名。以下是用于Spring Batch示例的重要工具和库。

1. Apache Maven 3.5.0 – 用于项目构建和依赖管理。
2. Eclipse Oxygen Release 4.7.0 – 用于创建 Spring Batch Maven 应用的集成开发环境。
3. Java 1.8
4. Spring Core 4.3.12.RELEASE
5. Spring OXM 4.3.12.RELEASE
6. Spring JDBC 4.3.12.RELEASE
7. Spring Batch 3.0.8.RELEASE
8. MySQL Java Driver 5.1.25 – 根据你的 MySQL 安装使用。这对于 Spring Batch 元数据表是必需的。

Spring Batch 示例目录结构

下面的图片展示了我们 Spring Batch 示例项目中的所有组件。

Spring Batch Maven 依赖

以下是 pom.xml 文件的内容，包含了我们 Spring Batch 示例项目所需的所有依赖项。

<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.journaldev.spring</groupId>
	<artifactId>SpringBatchExample</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>SpringBatchDemo</name>
	<url>https://maven.apache.org</url>

	<properties>
		<jdk.version>1.8</jdk.version>
		<spring.version>4.3.12.RELEASE</spring.version>
		<spring.batch.version>3.0.8.RELEASE</spring.batch.version>
		<mysql.driver.version>5.1.25</mysql.driver.version>
		<junit.version>4.11</junit.version>
	</properties>

	<dependencies>

		<!-- Spring Core -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<version>${spring.version}</version>
		</dependency>

		<!-- Spring jdbc, for database -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-jdbc</artifactId>
			<version>${spring.version}</version>
		</dependency>

		<!-- Spring XML to/back object -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-oxm</artifactId>
			<version>${spring.version}</version>
		</dependency>

		<!-- MySQL database driver -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>${mysql.driver.version}</version>
		</dependency>

		<!-- Spring Batch dependencies -->
		<dependency>
			<groupId>org.springframework.batch</groupId>
			<artifactId>spring-batch-core</artifactId>
			<version>${spring.batch.version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework.batch</groupId>
			<artifactId>spring-batch-infrastructure</artifactId>
			<version>${spring.batch.version}</version>
		</dependency>

		<!-- Spring Batch unit test -->
		<dependency>
			<groupId>org.springframework.batch</groupId>
			<artifactId>spring-batch-test</artifactId>
			<version>${spring.batch.version}</version>
		</dependency>

		<!-- Junit -->
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>${junit.version}</version>
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>com.thoughtworks.xstream</groupId>
			<artifactId>xstream</artifactId>
			<version>1.4.10</version>
		</dependency>

	</dependencies>
	<build>
		<finalName>spring-batch</finalName>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-eclipse-plugin</artifactId>
				<version>2.9</version>
				<configuration>
					<downloadSources>true</downloadSources>
					<downloadJavadocs>false</downloadJavadocs>
				</configuration>
			</plugin>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>2.3.2</version>
				<configuration>
					<source>${jdk.version}</source>
					<target>${jdk.version}</target>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

Spring批处理CSV输入文件

这是我们用于Spring批处理的示例CSV文件的内容。

1001,Tom,Moody, 29/7/2013
1002,John,Parker, 30/7/2013
1003,Henry,Williams, 31/7/2013

Spring批处理作业配置

我们需要在配置文件中定义Spring Bean和Spring批处理作业。下面是job-batch-demo.xml文件的内容，这是Spring批处理项目中最重要的部分。

<beans xmlns="https://www.springframework.org/schema/beans"
	xmlns:batch="https://www.springframework.org/schema/batch" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://www.springframework.org/schema/batch
		https://www.springframework.org/schema/batch/spring-batch-3.0.xsd
		https://www.springframework.org/schema/beans 
		https://www.springframework.org/schema/beans/spring-beans-4.3.xsd
	">

	<import resource="../config/context.xml" />
	<import resource="../config/database.xml" />

	<bean id="report" class="com.journaldev.spring.model.Report"
		scope="prototype" />
	<bean id="itemProcessor" class="com.journaldev.spring.CustomItemProcessor" />

	<batch:job id="DemoJobXMLWriter">
		<batch:step id="step1">
			<batch:tasklet>
				<batch:chunk reader="csvFileItemReader" writer="xmlItemWriter"
					processor="itemProcessor" commit-interval="10">
				</batch:chunk>
			</batch:tasklet>
		</batch:step>
	</batch:job>

	<bean id="csvFileItemReader" class="org.springframework.batch.item.file.FlatFileItemReader">

		<property name="resource" value="classpath:csv/input/report.csv" />

		<property name="lineMapper">
			<bean class="org.springframework.batch.item.file.mapping.DefaultLineMapper">
				<property name="lineTokenizer">
					<bean
						class="org.springframework.batch.item.file.transform.DelimitedLineTokenizer">
						<property name="names" value="id,firstname,lastname,dob" />
					</bean>
				</property>
				<property name="fieldSetMapper">
					<bean class="com.journaldev.spring.ReportFieldSetMapper" />

					<!-- if no data type conversion, use BeanWrapperFieldSetMapper to map 
						by name <bean class="org.springframework.batch.item.file.mapping.BeanWrapperFieldSetMapper"> 
						<property name="prototypeBeanName" value="report" /> </bean> -->
				</property>
			</bean>
		</property>

	</bean>

	<bean id="xmlItemWriter" class="org.springframework.batch.item.xml.StaxEventItemWriter">
		<property name="resource" value="file:xml/outputs/report.xml" />
		<property name="marshaller" ref="reportMarshaller" />
		<property name="rootTagName" value="report" />
	</bean>

	<bean id="reportMarshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
		<property name="classesToBeBound">
			<list>
				<value>com.journaldev.spring.model.Report</value>
			</list>
		</property>
	</bean>

</beans>

1. 我们使用FlatFileItemReader来读取CSV文件，CustomItemProcessor来处理数据，并使用StaxEventItemWriter将数据写入XML文件。
2. batch:job – 此标签定义了我们要创建的作业。Id属性指定作业的ID。我们可以在单个xml文件中定义多个作业。
3. batch:step – 此标签用于定义Spring批处理作业的不同步骤。
4. Spring Batch 框架提供了两种不同的处理方式，分别是“TaskletStep 导向”和“Chunk 导向”。在本例中使用的是 Chunk 导向方式，指的是逐个读取数据并创建将写出的“块”，在事务边界内。
5. reader: 用于读取数据的 Spring bean。在本例中，我们使用了 csvFileItemReader bean，它是 FlatFileItemReader 的实例。
6. processor: 用于处理数据的类。在本例中，我们使用了 CustomItemProcessor。
7. writer: 用于将数据写入 XML 文件的 bean。
8. commit-interval: 此属性定义了一次处理后将提交的块的大小。基本上，它意味着 ItemReader 将逐个读取数据，ItemProcessor 也将以相同方式处理数据，但只有当 ItemWriter 的数据量等于 commit-interval 的大小时才会写入数据。
9. 作为该项目的重要组成部分使用的三个接口是来自 org.springframework.batch.item 包的 ItemReader、ItemProcessor 和 ItemWriter。

Spring Batch 模型类

首先，我们将CSV文件读入Java对象，然后使用JAXB将其写入XML文件。以下是我们的模型类，带有必需的JAXB注解。

package com.journaldev.spring.model;

import java.util.Date;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "record")
public class Report {

	private int id;
	private String firstName;
	private String lastName;
	private Date dob;

	@XmlAttribute(name = "id")
	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	@XmlElement(name = "firstname")
	public String getFirstName() {
		return firstName;
	}

	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}

	@XmlElement(name = "lastname")
	public String getLastName() {
		return lastName;
	}

	public void setLastName(String lastName) {
		this.lastName = lastName;
	}

	@XmlElement(name = "dob")
	public Date getDob() {
		return dob;
	}

	public void setDob(Date dob) {
		this.dob = dob;
	}

	@Override
	public String toString() {
		return "Report [id=" + id + ", firstname=" + firstName + ", lastName=" + lastName + ", DateOfBirth=" + dob
				+ "]";
	}

}

请注意，模型类字段应与Spring批处理映射器配置中定义的字段相同，即在我们的情况下是property name="names" value="id,firstname,lastname,dob"。

Spring批处理FieldSetMapper

A custom FieldSetMapper is needed to convert a Date. If no data type conversion is required, then only BeanWrapperFieldSetMapper should be used to map the values by name automatically. The java class which extends FieldSetMapper is ReportFieldSetMapper.

package com.journaldev.spring;

import java.text.ParseException;
import java.text.SimpleDateFormat;

import org.springframework.batch.item.file.mapping.FieldSetMapper;
import org.springframework.batch.item.file.transform.FieldSet;
import org.springframework.validation.BindException;

import com.journaldev.spring.model.Report;

public class ReportFieldSetMapper implements FieldSetMapper {

	private SimpleDateFormat dateFormat = new SimpleDateFormat("dd/MM/yyyy");

	public Report mapFieldSet(FieldSet fieldSet) throws BindException {

		Report report = new Report();
		report.setId(fieldSet.readInt(0));
		report.setFirstName(fieldSet.readString(1));
		report.setLastName(fieldSet.readString(2));

		// 默认格式 yyyy-MM-dd
		// fieldSet.readDate(4);
		String date = fieldSet.readString(3);
		try {
			report.setDob(dateFormat.parse(date));
		} catch (ParseException e) {
			e.printStackTrace();
		}

		return report;

	}

}

Spring批处理Item Processor

现在按照作业配置的定义，itemProcessor将在itemWriter之前触发。我们为此创建了一个CustomItemProcessor.java类。

package com.journaldev.spring;

import org.springframework.batch.item.ItemProcessor;

import com.journaldev.spring.model.Report;

public class CustomItemProcessor implements ItemProcessor<Report, Report> {

	public Report process(Report item) throws Exception {
		
		System.out.println("Processing..." + item);
		String fname = item.getFirstName();
		String lname = item.getLastName();
		
		item.setFirstName(fname.toUpperCase());
		item.setLastName(lname.toUpperCase());
		return item;
	}

}

我们可以在ItemProcessor实现中操作数据，正如您所见，我正在将名字和姓氏的值转换为大写。

Spring配置文件

在我们的spring批处理配置文件中，我们导入了两个额外的配置文件 – context.xml 和 database.xml。

<beans xmlns="https://www.springframework.org/schema/beans"
	xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="
		https://www.springframework.org/schema/beans 
		https://www.springframework.org/schema/beans/spring-beans-4.3.xsd">

	<!-- stored job-meta in memory -->
	<!--  
	<bean id="jobRepository"
		class="org.springframework.batch.core.repository.support.MapJobRepositoryFactoryBean">
		<property name="transactionManager" ref="transactionManager" />
	</bean>
 	 -->
 	 
 	 <!-- stored job-meta in database -->
	<bean id="jobRepository"
		class="org.springframework.batch.core.repository.support.JobRepositoryFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="transactionManager" ref="transactionManager" />
		<property name="databaseType" value="mysql" />
	</bean>
	
	<bean id="transactionManager"
		class="org.springframework.batch.support.transaction.ResourcelessTransactionManager" />
	 
	<bean id="jobLauncher"
		class="org.springframework.batch.core.launch.support.SimpleJobLauncher">
		<property name="jobRepository" ref="jobRepository" />
	</bean>

</beans>

• jobRepository – JobRepository负责将每个Java对象存储到其正确的元数据表中以供spring批处理使用。
• transactionManager – 这负责在提交间隔大小和已处理数据相等时提交事务。
• jobLauncher – 这是spring批处理的核心。此接口包含用于触发作业的run方法。

<beans xmlns="https://www.springframework.org/schema/beans"
	xmlns:jdbc="https://www.springframework.org/schema/jdbc" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://www.springframework.org/schema/beans 
		https://www.springframework.org/schema/beans/spring-beans-4.3.xsd
		https://www.springframework.org/schema/jdbc 
		https://www.springframework.org/schema/jdbc/spring-jdbc-4.3.xsd">

	<!-- connect to database -->
	<bean id="dataSource"
		class="org.springframework.jdbc.datasource.DriverManagerDataSource">
		<property name="driverClassName" value="com.mysql.jdbc.Driver" />
		<property name="url" value="jdbc:mysql://localhost:3306/Test" />
		<property name="username" value="test" />
		<property name="password" value="test123" />
	</bean>

	<bean id="transactionManager"
		class="org.springframework.batch.support.transaction.ResourcelessTransactionManager" />

	<!-- create job-meta tables automatically -->
	<!-- <jdbc:initialize-database data-source="dataSource"> <jdbc:script location="org/springframework/batch/core/schema-drop-mysql.sql" 
		/> <jdbc:script location="org/springframework/batch/core/schema-mysql.sql" 
		/> </jdbc:initialize-database> -->
</beans>

Spring Batch使用一些元数据表来存储批处理作业信息。我们可以从spring批处理配置中创建它们，但最好通过执行SQL文件手动执行，就像您在上面的注释代码中看到的那样。从安全性的角度来看，最好不要给予spring批处理数据库用户DDL执行权限。

Spring Batch表

Spring Batch表非常接近于在Java中表示它们的领域对象。例如 – JobInstance、JobExecution、JobParameters和StepExecution分别映射到BATCH_JOB_INSTANCE、BATCH_JOB_EXECUTION、BATCH_JOB_EXECUTION_PARAMS和BATCH_STEP_EXECUTION。ExecutionContext同时映射到BATCH_JOB_EXECUTION_CONTEXT和BATCH_STEP_EXECUTION_CONTEXT。JobRepository负责将每个Java对象保存和存储到其正确的表中。下面是每个元数据表的详细信息。

1. Batch_job_instance: BATCH_JOB_INSTANCE表包含与JobInstance相关的所有信息。
2. Batch_job_execution_params: BATCH_JOB_EXECUTION_PARAMS表包含与JobParameters对象相关的所有信息。
3. Batch_job_execution: BATCH_JOB_EXECUTION表包含与JobExecution对象相关的数据。每次运行作业时都会添加一行新记录。
4. Batch_step_execution: BATCH_STEP_EXECUTION表包含与StepExecution对象相关的所有信息。
5. Batch_job_execution_context: BATCH_JOB_EXECUTION_CONTEXT表包含与作业的ExecutionContext相关的数据。每个JobExecution恰好对应一个Job ExecutionContext，它包含所有需要的作业级数据，用于特定的作业执行。这些数据通常表示必须在失败后检索的状态，以便JobInstance可以从失败的位置重新启动。
6. 批处理步骤执行上下文: BATCH_STEP_EXECUTION_CONTEXT表保存与步骤的ExecutionContext相关的数据。每个StepExecution都有一个ExecutionContext，它包含特定步骤执行所需持久化的所有数据。这些数据通常表示在故障后必须检索的状态，以便JobInstance可以从故障发生的地方重新启动。
7. Batch_job_execution_seq: 该表保存作业的数据执行顺序。
8. Batch_step_execution_seq: 该表保存步骤执行的序列数据。
9. Batch_job_seq: 该表保存作业序列的数据，如果我们有多个作业，将获得多个行。

Spring批处理测试程序

我们的Spring批处理示例项目已准备就绪，最后一步是编写一个测试类将其作为Java程序执行。

package com.journaldev.spring;

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.context.support.ClassPathXmlApplicationContext;

public class App {
	public static void main(String[] args) {

		String[] springConfig = { "spring/batch/jobs/job-batch-demo.xml" };

		ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(springConfig);

		JobLauncher jobLauncher = (JobLauncher) context.getBean("jobLauncher");
		Job job = (Job) context.getBean("DemoJobXMLWriter");

		JobParameters jobParameters = new JobParametersBuilder().addLong("time", System.currentTimeMillis())
				.toJobParameters();

		try {

			JobExecution execution = jobLauncher.run(job, jobParameters);
			System.out.println("Exit Status : " + execution.getStatus());

		} catch (Exception e) {
			e.printStackTrace();
		}

		System.out.println("Done");
		context.close();
	}
}

只需运行上述程序，您将获得以下输出xml。

<?xml version="1.0" encoding="UTF-8"?><report><record id="1001"><dob>2013-07-29T00:00:00+05:30</dob><firstname>TOM</firstname><lastname>MOODY</lastname></record><record id="1002"><dob>2013-07-30T00:00:00+05:30</dob><firstname>JOHN</firstname><lastname>PARKER</lastname></record><record id="1003"><dob>2013-07-31T00:00:00+05:30</dob><firstname>HENRY</firstname><lastname>WILLIAMS</lastname></record></report>

这就是Spring批处理示例的全部内容，您可以从下面的链接下载最终项目。

下载Spring批处理示例项目

参考：官方指南