In this tutorial, we will discuss about an application where we see how to configure a Spring Batch job to read XML file by JAXB2 library into a csv file, and filter out the record before writing with ItemProcessor.
Tools and libraries used
Sample Example of Spring Batch XML To CSV-
1. Project Directory Structure
2. Input XML File
employees.xml
3. ItemReader for XML File
In this example, we use Jaxb2Marshaller to map XML values and attributes to an object.
Employee.java
In JAXB2, for complex data type like Date , will not map to the field automatically, even it’s annotated.
for this to make JAXB2 supports Date conversion, you need to create a custom Adapter to handle the Date format manually, then attaches the adapter via @XmlJavaTypeAdapter. Lets see how to map.
4. Spring Batch Core configuration
Define jobRepository and jobLauncher.
applicationContext.xml
5. Spring Batch Jobs Confifuration file
6. Spring Batch ItemProcessor for filter data
In Spring batch, the wired Processor will be fired before writing to any resources, so, this is the best place to handle any conversion, filtering and business logic. In this example, we will be ignored all employees whose have salaried less than 70000 i.e. not write to csv file.
DataFilterProcessor.java
7. Launching Batch Job-
Spring Batch comes with a simple utility class called CommandLineJobRunner which has a main() method which accepts two arguments. First argument is the spring application context file containing job definition and the second is the name of the job to be executed.
Now run as a java application with both two arguments.
org.springframework.batch.core.launch.support.CommandLineJobRunner
simple-job.xml simpleDojJob
Output. Extracts all employees into an csv file from xml file.
employees.csv
1111,ATUL KUMAR,17,300000.0,delhi
3333,ASHUTOSH RAJPUT,21,400000.0,delhi
4444,Adesh Verma,27,80000.0,Kanpur
5555,Dinesh Rajput,37,300000.0,Noida
Download Source Code with libs
SpringBatchXMTtoCSV.zip
Tools and libraries used
- Spring Tool Suite (STS)
- DK 1.6
- Spring Core 3.2.2.RELEASE
- Spring OXM 3.2.2.RELEASE
- Spring Batch 2.2.0.RELEASE
Sample Example of Spring Batch XML To CSV-
1. Project Directory Structure
2. Input XML File
employees.xml
<?xml version="1.0" encoding="UTF-8"?> <employees> <employee> <address>delhi</address> <age>17</age> <empid>1111</empid> <name>ATUL KUMAR</name> <salary>300000.0</salary> </employee> <employee> <address>delhi</address> <age>27</age> <empid>2222</empid> <name>Dinesh Rajput</name> <salary>60000.0</salary> </employee> <employee> <address>delhi</address> <age>21</age> <empid>3333</empid> <name>ASHUTOSH RAJPUT</name> <salary>400000.0</salary> </employee> <employee> <address>Kanpur</address> <age>27</age> <empid>4444</empid> <name>Adesh Verma</name> <salary>80000.0</salary> </employee> <employee> <address>Noida</address> <age>37</age> <empid>5555</empid> <name>Dinesh Rajput</name> <salary>300000.0</salary> </employee> </employees>
3. ItemReader for XML File
In this example, we use Jaxb2Marshaller to map XML values and attributes to an object.
<bean id="xmlItemReader" class="org.springframework.batch.item.xml.StaxEventItemReader"> <property name="resource" value="classpath:xml/employees.xml" /> <property name="unmarshaller" ref="empUnMarshaller" /> <property name="fragmentRootElementName" value="employee" /> </bean>
Employee.java
package com.doj.batch.bean;
import javax.xml.bind.annotation.XmlAccessOrder;
import javax.xml.bind.annotation.XmlAccessorOrder;
import javax.xml.bind.annotation.XmlRootElement;
/**
* @author Dinesh Rajput
*
*/
@XmlRootElement(name="employee")
@XmlAccessorOrder(XmlAccessOrder.UNDEFINED)
public class Employee {
private int empid;
private String name;
private int age;
private float salary;
private String address;
/**
* @return the empid
*/
public int getEmpid() {
return empid;
}
/**
* @param empid the empid to set
*/
public void setEmpid(int empid) {
this.empid = empid;
}
/**
* @return the name
*/
public String getName() {
return name;
}
/**
* @param name the name to set
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the age
*/
public int getAge() {
return age;
}
/**
* @param age the age to set
*/
public void setAge(int age) {
this.age = age;
}
/**
* @return the salary
*/
public float getSalary() {
return salary;
}
/**
* @param salary the salary to set
*/
public void setSalary(float salary) {
this.salary = salary;
}
/**
* @return the address
*/
public String getAddress() {
return address;
}
/**
* @param address the address to set
*/
public void setAddress(String address) {
this.address = address;
}
}
In JAXB2, for complex data type like Date , will not map to the field automatically, even it’s annotated.
for this to make JAXB2 supports Date conversion, you need to create a custom Adapter to handle the Date format manually, then attaches the adapter via @XmlJavaTypeAdapter. Lets see how to map.
package com.doj.batch.adapter;
import java.text.SimpleDateFormat;
import java.util.Date;
import javax.xml.bind.annotation.adapters.XmlAdapter;
/**
* @author Dinesh Rajput
*
*/
public class DataJaxbAdapter extends XmlAdapter<String, Date>{
private SimpleDateFormat dateFormat = new SimpleDateFormat("dd/MM/yyyy");
@Override
public Date unmarshal(String date) throws Exception {
return dateFormat.parse(date);
}
@Override
public String marshal(Date date) throws Exception {
return dateFormat.format(date);
}
}
@XmlRootElement(name="employee")
@XmlAccessorOrder(XmlAccessOrder.UNDEFINED)
public class Employee {
...
...
private Date doj;
...
@XmlJavaTypeAdapter(JaxbDateAdapter.class)
@XmlElement
public Date getDoj() {
return doj;
}
...
...
}
4. Spring Batch Core configuration
Define jobRepository and jobLauncher.
applicationContext.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:mvc="http://www.springframework.org/schema/mvc"
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-4.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
<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>
<bean id="jobRepository" class="org.springframework.batch.core.repository.support.MapJobRepositoryFactoryBean">
<property name="transactionManager" ref="transactionManager"/>
</bean>
<bean id="simpleJob" class="org.springframework.batch.core.job.SimpleJob" abstract="true">
<property name="jobRepository" ref="jobRepository" />
</bean>
</beans>
5. Spring Batch Jobs Confifuration file
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:batch="http://www.springframework.org/schema/batch"
xmlns:mvc="http://www.springframework.org/schema/mvc"
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-4.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
http://www.springframework.org/schema/batch
http://www.springframework.org/schema/batch/spring-batch-2.0.xsd">
<import resource="applicationContext.xml"/>
<bean id="xmlItemReader" class="org.springframework.batch.item.xml.StaxEventItemReader">
<property name="resource" value="classpath:xml/employees.xml" />
<property name="unmarshaller" ref="empUnMarshaller" />
<property name="fragmentRootElementName" value="employee" />
</bean>
<bean id="filterDataProcessor" class="com.doj.batch.processor.DataFilterProcessor" />
<bean id="csvItemWriter" class="org.springframework.batch.item.file.FlatFileItemWriter">
<property name="shouldDeleteIfExists" value="true" />
<property name="resource" value="file:csv/outputs/employees.csv" />
<property name="lineAggregator">
<bean class="org.springframework.batch.item.file.transform.DelimitedLineAggregator">
<property name="delimiter" value="," />
<property name="fieldExtractor">
<bean class="org.springframework.batch.item.file.transform.BeanWrapperFieldExtractor">
<property name="names" value="empid, name, age, salary, address" />
</bean>
</property>
</bean>
</property>
</bean>
<bean id="empUnMarshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="classesToBeBound">
<value>com.doj.batch.bean.Employee</value>
</property>
</bean>
<batch:job id="simpleDojJob" job-repository="jobRepository" parent="simpleJob">
<batch:step id="step1">
<batch:tasklet transaction-manager="transactionManager">
<batch:chunk reader="xmlItemReader" processor="filterDataProcessor" writer="csvItemWriter" commit-interval="1"/>
</batch:tasklet>
</batch:step>
</batch:job>
</beans>
6. Spring Batch ItemProcessor for filter data
In Spring batch, the wired Processor will be fired before writing to any resources, so, this is the best place to handle any conversion, filtering and business logic. In this example, we will be ignored all employees whose have salaried less than 70000 i.e. not write to csv file.
DataFilterProcessor.java
package com.doj.batch.processor;
import org.springframework.batch.item.ItemProcessor;
import com.doj.batch.bean.Employee;
/**
* @author Dinesh Rajput
*
*/
public class DataFilterProcessor implements ItemProcessor<Employee, Employee> {
@Override
public Employee process(Employee emp) throws Exception {
if(emp.getSalary() > 70000.0){
return emp;
}else{
return null;
}
}
}
7. Launching Batch Job-
Spring Batch comes with a simple utility class called CommandLineJobRunner which has a main() method which accepts two arguments. First argument is the spring application context file containing job definition and the second is the name of the job to be executed.
Now run as a java application with both two arguments.
org.springframework.batch.core.launch.support.CommandLineJobRunner
simple-job.xml simpleDojJob
Output. Extracts all employees into an csv file from xml file.
employees.csv
1111,ATUL KUMAR,17,300000.0,delhi
3333,ASHUTOSH RAJPUT,21,400000.0,delhi
4444,Adesh Verma,27,80000.0,Kanpur
5555,Dinesh Rajput,37,300000.0,Noida
Download Source Code with libs
SpringBatchXMTtoCSV.zip