Spring Batchの例

チュートリアル
Spring

ようこそ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.
  • Read-Process-Writeは基本的にはデータベース、CSVなどのソースから読み取り、データを処理し、データベース、CSV、XMLなどのソースに書き込むことを意味します。
  • Taskletは、接続のクリーニングや処理が完了した後のリソースの解放など、単一のタスクまたは操作を行うことを意味します。
  • Read-Process-Writeとタスクレットを連結してジョブを実行できます。

Spring Batchの例

Spring Batchの実装の作業例を考えてみましょう。実装の目的のために、次のシナリオを考慮します。データが含まれているCSVファイルを、データとタグが列名に基づいてXMLに変換する必要があります。以下は、Spring Batchの例で使用される重要なツールとライブラリです。

  1. Apache Maven 3.5.0 – プロジェクトのビルドと依存関係の管理に使用します。
  2. Eclipse Oxygen Release 4.7.0 – SpringバッチMavenアプリケーションを作成するためのIDE。
  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の依存関係

以下は、Spring Batchの例プロジェクトに必要なすべての依存関係を含むpom.xmlファイルの内容です。

<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 Batch CSV入力ファイルの処理

こちらは、Spring Batch処理のためのサンプルCSVファイルの内容です。

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

Spring Batchジョブの構成

構成ファイルでSpring BeanとSpring Batchジョブを定義する必要があります。以下は、job-batch-demo.xmlファイルの内容で、これがSpring Batchプロジェクトの中で最も重要な部分です。

<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. CSVファイルを読み込むためにFlatFileItemReaderを使用し、データを処理してStaxEventItemWriterを使用してXMLファイルに書き込んでいます。
  2. batch:job – このタグは、作成したいジョブを定義します。IdプロパティはジョブのIDを指定します。1つのXMLファイルに複数のジョブを定義できます。
  3. batch:step – このタグはSpring Batchジョブの異なるステップを定義するために使用されます。
  4. Spring Batchフレームワークでは、2つの異なる処理スタイルが提供されています。それらは「TaskletStep Oriented」と「Chunk Oriented」です。Chunk Orientedスタイルは、データを1つずつ読み取り、トランザクションの範囲内で書き込む「チャンク」を作成することを意味します。
  5. reader：データを読み取るために使用されるSpringビーン。この例では、csvFileItemReaderビーンが使用されています。これはFlatFileItemReaderのインスタンスです。
  6. processor：データを処理するために使用されるクラス。この例ではCustomItemProcessorが使用されています。
  7. writer：データをXMLファイルに書き込むために使用されるビーンです。
  8. commit-interval：このプロパティは、処理が完了した後にコミットされるチャンクのサイズを定義します。基本的には、ItemReaderはデータを1つずつ読み取り、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 Batchマッパー構成で定義されているものと同じである必要があります。私たちの場合、property name="names" value="id,firstname,lastname,dob"です。

Spring Batch 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 Batch 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設定ファイル

春のバッチ構成ファイルでは、2つの追加の構成ファイル、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オブジェクトをその正しいメタデータテーブルに保存する責任があります。
  • transactionManager – これは、コミット間隔のサイズと処理されたデータが等しい場合にトランザクションをコミットする責任があります。
  • jobLauncher – これはSpring Batchの中心です。このインターフェースには、ジョブをトリガするために使用される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 Batchの構成から作成できますが、上記のコメントコードで示されているように、SQLファイルを実行して手動で行うことが勧められます。セキュリティの観点からは、Spring Batchデータベースユーザーに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に関連するデータが含まれます。ジョブ実行ごとに1つのJob ExecutionContextがあり、その特定のジョブ実行に必要なすべてのジョブレベルのデータが含まれます。このデータは通常、失敗後に再開する必要がある状態を表し、JobInstanceが失敗した場所から再開できるようにするために取得する必要があります。
  6. Batch_step_execution_context: BATCH_STEP_EXECUTION_CONTEXTテーブルは、ステップのExecutionContextに関連するデータを保持します。 StepExecutionごとに正確に1つのExecutionContextがあり、特定のステップ実行のために永続化する必要があるすべてのデータが含まれています。 このデータは通常、失敗後に再開できるようにするために取得する必要がある状態を表します。
  7. Batch_job_execution_seq: このテーブルは、ジョブのデータ実行シーケンスを保持します。
  8. Batch_step_execution_seq: このテーブルは、ステップ実行のシーケンスのデータを保持します。
  9. Batch_job_seq: このテーブルは、複数のジョブがある場合にジョブのシーケンスのデータを保持します。複数の行が得られます。

Spring Batchテストプログラム

Spring Batchの例題プロジェクトは準備ができました。最後のステップは、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 Batchの例題は終了です。最終プロジェクトは以下のリンクからダウンロードできます。

Spring Batchの例題プロジェクトのダウンロード

参考：公式ガイド

Source:
https://www.digitalocean.com/community/tutorials/spring-batch-example