詳解Spring batch 入門學(xué)習(xí)教程(附源碼)

更新時間：2017年11月06日 11:24:11 作者：achuo

本篇文章主要介紹了Spring batch 入門學(xué)習(xí)教程(附源碼)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

Spring batch 是一個開源的批處理框架.執(zhí)行一系列的任務(wù). 在 spring batch 中一個job 是由許多 step 組成的。而每一個 step 又是由 READ-PROCESS-WRITE task或者單個 task 組成。

1. "READ-PROCESS-WRITE" 處理，根據(jù)字面意思理解就可以:

READ 就是從資源文件里面讀取數(shù)據(jù)，比如從xml文件,csv文件,數(shù)據(jù)庫中讀取數(shù)據(jù).
PROCESS 就是處理讀取的數(shù)據(jù)
WRITE 就是將處理過的數(shù)據(jù)寫入到其他資源文件中去，可以是XML,CSV,或者數(shù)據(jù)庫.

比如：從CSV文件中讀取數(shù)據(jù)，經(jīng)過處理之后，保存到數(shù)據(jù)庫. spring batch 提供了很多類去處理這方面的東西。

2.單個task, 也就是處理單個任務(wù)。比如在一個step 開始之前或者完成之后清除資源文件等.

3.許多個step 組成在一起，就組成了一個job. 所以他們之間的關(guān)系，就如同下面的描述:

一個 job = 很多steps
一個step = 一個READ-PROCESS-WRITE 或者一個task.
同樣一個job = step1 -->step2--step3 這樣鏈表形式的組成.

Spring batch 例子

考慮如下一個批處理的例子,看起來有點(diǎn)啰嗦，只是為了說明用途:

1. step1 : 從 A 文件夾中讀取csv 文件，處理之后，寫入到B文件夾中(READ-PROCESS-WRITE)
2. step2 : 從 B 文件夾中讀取CSV文件，處理之后，存儲到數(shù)據(jù)庫中(READ-PROCESS-WRITE).
3. step3 : 刪除B文件夾下的CSV文件。(用到單個task)
4. step4 : 從數(shù)據(jù)庫讀取數(shù)據(jù)，處理之后，生成XML報表文件(READ-PROCESS-WRITE).
5. step5 : 讀取XML報表,并發(fā)送EMAIL給管理員(用到單個task)

用spring batch 我們可以如下定義這個job:

<job id="abcJob" xmlns="http://www.springframework.org/schema/batch">
 <step id="step1" next="step2">
  <tasklet>
  <chunk reader="cvsItemReader" writer="cvsItemWriter" 
     processor="itemProcesser" commit-interval="1" />
  </tasklet>
 </step>
 <step id="step2" next="step3">
  <tasklet>
  <chunk reader="cvsItemReader" writer="databaseItemWriter" 
     processor="itemProcesser" commit-interval="1" />
  </tasklet>
 </step>
 <step id="step3" next="step4">
  <tasklet ref="fileDeletingTasklet" />
 </step>
 <step id="step4" next="step5">
  <tasklet>
  <chunk reader="databaseItemReader" writer="xmlItemWriter" 
     processor="itemProcesser" commit-interval="1" />
  </tasklet>
 </step>
 <step id="step5">
  <tasklet ref="sendingEmailTasklet" />
 </step>
 </job>

整個 job 的執(zhí)行是存儲在數(shù)據(jù)庫中的，所以即使是某一個step出錯失敗，也不需要全部從頭開始執(zhí)行這個job.下面是一個真正的入門教程例子.

采用 jar包如下:

spring-batch-2.2.3 以上版本，但是我在2.2.3版本中發(fā)現(xiàn) org/springframework/batch/core/schema-mysql.sql 里面的的mysql 創(chuàng)建表的語句是有問題的，也就是少了“," 號導(dǎo)致的問題( NOT NULL, 后面幾個創(chuàng)建表的語句NOT NULL 后面少了逗號)，當(dāng)然你可以自己修改后再執(zhí)行，執(zhí)行完畢后有如下幾個表:

xstream-1.3.jar 必須的。

jettison-1.3.3.jar也是必須的, 否則會出現(xiàn)

java.lang.NoClassDefFoundError: org/codehaus/jettison/mapped/MappedXMLOutputFactory錯誤。

另外我用的spring 是 3.1 版本的，可以下載相關(guān)jar包，還有apache common 相關(guān)jar包就可以了。

mysql-connect-java-5.1.jar 連接mysql 數(shù)據(jù)庫用的。

假設(shè)要將如下 csv 文件讀取出來處理之后，寫入到一個xml文件之中.

,"213,100",980,"mkyong", 29/7/2013
,"320,200",1080,"staff 1", 30/7/2013
,"342,197",1200,"staff 2", 31/7/2013

用 FlatFileItemReader 去讀取CSV 文件, 用 itemProcessor 去處理數(shù)據(jù)，用 StaxEventItemWriter 去寫數(shù)據(jù)

job 的定義如下(job-hello-world.xml):

<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:batch="http://www.springframework.org/schema/batch" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.springframework.org/schema/batch
  http://www.springframework.org/schema/batch/spring-batch-2.2.xsd
  http://www.springframework.org/schema/beans 
  http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
 ">
 <import resource="../config/context.xml" />
 <import resource="../config/database.xml" />
 <bean id="report" class="yihaomen.model.Report" scope="prototype" />
 <bean id="itemProcessor" class="yihaomen.CustomItemProcessor" />
 <batch:job id="helloWorldJob">
  <batch:step id="step1">
   <batch:tasklet>
    <batch:chunk reader="cvsFileItemReader" writer="xmlItemWriter" processor="itemProcessor"
     commit-interval="10">
    </batch:chunk>
   </batch:tasklet>
  </batch:step>
 </batch:job>
 <bean id="cvsFileItemReader" class="org.springframework.batch.item.file.FlatFileItemReader">
  <property name="resource" value="classpath:cvs/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,sales,qty,staffName,date" />
     </bean>
    </property>
    <property name="fieldSetMapper">
     <bean class="yihaomen.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>yihaomen.model.Report</value>
   </list>
  </property>
 </bean>
</beans>

映射csv文件到 Report 對象并寫XML文件 (通過 jaxb annotations).

package yihaomen.model;
import java.math.BigDecimal;
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 BigDecimal sales;
 private int qty;
 private String staffName;
 private Date date;
 @XmlAttribute(name = "id")
 public int getId() {
  return id;
 }
 public void setId(int id) {
  this.id = id;
 }
 @XmlElement(name = "sales")
 public BigDecimal getSales() {
  return sales;
 }
 public void setSales(BigDecimal sales) {
  this.sales = sales;
 }
 @XmlElement(name = "qty")
 public int getQty() {
  return qty;
 }
 public void setQty(int qty) {
  this.qty = qty;
 }
 @XmlElement(name = "staffName")
 public String getStaffName() {
  return staffName;
 }
 public void setStaffName(String staffName) {
  this.staffName = staffName;
 }
 public Date getDate() {
  return date;
 }
 public void setDate(Date date) {
  this.date = date;
 }
 @Override
 public String toString() {
  return "Report [id=" + id + ", sales=" + sales + ", qty=" + qty + ", staffName=" + staffName + "]";
 }
}

為了轉(zhuǎn)換日期,用了自定義的 FieldSetMapper. 如果沒有數(shù)據(jù)需要轉(zhuǎn)換, BeanWrapperFieldSetMapper 通過名稱name 去自動映射值。

package yihaomen;
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 yihaomen.model.Report;
public class ReportFieldSetMapper implements FieldSetMapper<Report> {
 private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
 
 @Override
 public Report mapFieldSet(FieldSet fieldSet) throws BindException {
  
  Report report = new Report();
  report.setId(fieldSet.readInt(0));
  report.setSales(fieldSet.readBigDecimal(1));
  report.setQty(fieldSet.readInt(2));
  report.setStaffName(fieldSet.readString(3));
  
  //default format yyyy-MM-dd
  //fieldSet.readDate(4);
  String date = fieldSet.readString(4);
  try {
   report.setDate(dateFormat.parse(date));
  } catch (ParseException e) {
   e.printStackTrace();
  }
  
  return report;
  
 }
}

在寫入數(shù)據(jù)之前調(diào)用itemProcessor 處理數(shù)據(jù)

package yihaomen;
import org.springframework.batch.item.ItemProcessor;
import yihaomen.model.Report;
public class CustomItemProcessor implements ItemProcessor<Report, Report> {
 @Override
 public Report process(Report item) throws Exception {
  
  System.out.println("Processing..." + item);
  return item;
 }
}

spring 配置文件和數(shù)據(jù)庫配置文件

<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="
  http://www.springframework.org/schema/beans 
  http://www.springframework.org/schema/beans/spring-beans-3.2.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>


<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:jdbc="http://www.springframework.org/schema/jdbc" 
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.springframework.org/schema/beans 
  http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
  http://www.springframework.org/schema/jdbc 
  http://www.springframework.org/schema/jdbc/spring-jdbc-3.2.xsd">
 
  <!-- connect to MySQL 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="root" />
  <property name="password" value="" />
 </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>

運(yùn)行程序

package yihaomen;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.launch.JobLauncher;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class App {
 public static void main(String[] args) {
  String[] springConfig = 
   { 
    "spring/batch/jobs/job-hello-world.xml" 
   };
  
  ApplicationContext context = 
    new ClassPathXmlApplicationContext(springConfig);
  
  JobLauncher jobLauncher = (JobLauncher) context.getBean("jobLauncher");
  Job job = (Job) context.getBean("helloWorldJob");
  try {
   JobExecution execution = jobLauncher.run(job, new JobParameters());
   System.out.println("Exit Status : " + execution.getStatus());
  } catch (Exception e) {
   e.printStackTrace();
  }
  System.out.println("Done");
 }
}

運(yùn)行結(jié)果：

十二月 03, 2013 8:56:24 下午 org.springframework.batch.core.launch.support.SimpleJobLauncher$1 run
INFO: Job: [FlowJob: [name=helloWorldJob]] launched with the following parameters: [{}]
十二月 03, 2013 8:56:24 下午 org.springframework.batch.core.job.SimpleStepHandler handleStep
INFO: Executing step: [step1]
Processing...Report [id=1001, sales=213100, qty=980, staffName=yihaomen]
Processing...Report [id=1002, sales=320200, qty=1080, staffName=staff 1]
Processing...Report [id=1003, sales=342197, qty=1200, staffName=staff 2]
十二月 03, 2013 8:56:25 下午 org.springframework.batch.core.launch.support.SimpleJobLauncher$1 run
INFO: Job: [FlowJob: [name=helloWorldJob]] completed with the following parameters: [{}] and the following status: [COMPLETED]
Exit Status : COMPLETED
Done

結(jié)果生成了output.xml 在你工程目錄的 xml 目錄下。