Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Spring XD Batch Word-count Sample

This is the Spring Batch word-count sample for Hadoop adapted for Spring XD. This sample will take an input file and counts the occurrences of each word within that document.


In order for the sample to run you will need to have installed:


Build the sample simply by executing:

$ mvn clean assembly:assembly

By default this builds against Apache Hadoop 2.2.0

As a result, you will see the following files and directories created under target/batch-wordcount-1.0.0.BUILD-SNAPSHOT-bin/:

|-- batch-wordcount-1.0.0.BUILD-SNAPSHOT-bin
|   |-- lib
|   |   `-- hadoop-mapreduce-examples-2.2.0.jar
|   |-- modules
|   |   `-- job
|   |       `-- wordcount.xml
|   `-- nietzsche-chapter-1.txt

the wordcount.xml defines the location of the file to import, HDFS directories to use as well as the name node location. You can verify the settings under in util:property element:

<util:properties id="myProperties" >
    <prop key="wordcount.input.path">/count/in/</prop>
    <prop key="wordcount.output.path">/count/out/</prop>
    <prop key="hd.fs">hdfs://localhost:8020</prop>

Please verify particularly the following property:

  • hd.fs - The Hadoop NameNode to use. The setting should be fine, but the port may be different between Hadoop versions (e.g. port 9000 is common also)

Running the Sample

In the batch-wordcount directory copy the result of the build to the XD installation using the script. Your XD_HOME environment variable needs to be set to the install directory of XD

$ ./

Note that the nietzsche-chapter-1.txt file is copied to the /tmp directory.

The wordcount sample is ready to be executed. For ease of use, start up the single node version of Spring XD that combines the admin and container nodes into one process. If it was already running, you must restart it.

xd/bin>$ ./xd-singlenode

Now start the Spring XD Shell in a separate window:

shell/bin>$ ./xd-shell

By default, hadoop 2.2.0 distribution will be used.

You will now create a new Batch Job Stream using the Spring XD Shell:

xd:>job create --name wordCountJob --definition "wordcount"

The UI located on the machine where xd-singlenode is running, will show you the jobs that can be deployed. The UI is located at http://localhost:9393/admin-ui

Alternatively, you can deploy it using the shell command:

xd:>job deploy --name wordCountJob

We will now create a stream that polls a local directory for files. By default the name of the directory is named after the name of the stream, so in this case the directory will be /tmp/xd/input/wordCountFiles. If the directory does not exist, it will be created. You can override the default directory using the --dir option.

xd:>stream create --name wordCountFiles --definition "file --ref=true > queue:job:wordCountJob"  --deploy

If you now drop text files into the /tmp/xd/input/wordCountFiles/ directory, the file will be picked up, copied to HDFS and its words counted. You can move the supplied .txt file there via

xd:>! cp /tmp/nietzsche-chapter-1.txt /tmp/xd/input/wordCountFiles

Important: If you have an empty /count/in directory on the hdfs (check with xd:> hadoop fs ls /), remove it using xd:> hadoop fs rm /count --recursive before copying files to /tmp/xd/input/wordCountFiles.

Verify the result

First specify the Hadoop NameNode for the Spring XD Shell:

xd:>hadoop config fs --namenode hdfs://localhost:8020

We will now take a look at the root of the HDFS filesystem:

xd:>hadoop fs ls /

You should see output like the following:

Found 4 items
drwxr-xr-x   - hillert supergroup          0 2013-08-06 22:35 /Users
drwxr-xr-x   - hillert supergroup          0 2013-08-12 11:01 /count
drwxr-xr-x   - hillert supergroup          0 2013-08-09 11:31 /user
drwxr-xr-x   - hillert supergroup          0 2013-08-08 10:53 /xd

As we declared the property wordcount.output.path in wordcount.xml to be /count/out/, let's have a look at the respective directory:

xd:>hadoop fs ls /count/out
Found 2 items
-rw-r--r--   3 hillert supergroup          0 2013-08-10 00:07 /count/out/_SUCCESS
-rw-r--r--   3 hillert supergroup      31752 2013-08-10 00:07 /count/out/part-r-00000

Finally, executing:

xd:>hadoop fs cat /count/out/part-r-00000

should yield a long list of words, indicating the number of occurrences within the provided input text.

Something went wrong with that request. Please try again.