Spring MVC sample application for downloading files

深碍√TFBOYSˉ_ 2022-08-27 12:42 134阅读 0赞

[ Print ][Print] [ Email][Email]

Details

Last Updated on 18 March 2014

**[Java 8: The Fundamentals][Java 8_ The Fundamentals]![ir_t_code0ac-20_l_as2_o_1_a_B00J1BQ4G8][]          [ Android 101: Android Development for Beginners][Android 101_ Android Development for Beginners]![show_id_d1Fh24_EiQI_bids_334543.13094_type_2_subid_0][]**

In this article, we are going to show you how to implement file download functionality in a Spring MVC application. The solution is similar to the one described in the article: [ Send files from servlet to client for downloading][Send files from servlet to client for downloading], but is implemented in a Spring MVC application.

The following picture depicts workflow of the sample application we are going to build:

![application workflow][]

Project structure (Eclipse project):

![project structure of FileDownloadSpringMVC application][]

The file to be downloaded in this application is  SpringProject.zip file which resides in the  downloads directory which is relative to the application’s directory.

# 1. Code of download page #

Create  index.jsp file under  WebContent directory with the following HTML code:

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> 
    <div>
      15 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;%@ page language="java" contentType="text/html; charset=ISO-8859-1"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>pageEncoding="ISO-8859-1"%&gt;</code> 
     </div> 
     <div> 
      <code>&lt;!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>"http://www.w3.org/TR/html4/loose.dtd"&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>html</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>head</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>meta</code> 
      <code>http-equiv</code> 
      <code>=</code> 
      <code>"Content-Type"</code> 
      <code>content</code> 
      <code>=</code> 
      <code>"text/html; charset=ISO-8859-1"</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>title</code> 
      <code>&gt;Download Page&lt;/</code> 
      <code>title</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>head</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>body</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>center</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>h2</code> 
      <code>&gt;&lt;</code> 
      <code>a</code> 
      <code>href</code> 
      <code>=</code> 
      <code>"/download.do"</code> 
      <code>&gt;Click here to download file&lt;/</code> 
      <code>a</code> 
      <code>&gt;&lt;/</code> 
      <code>h2</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;/</code> 
      <code>center</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>body</code> 
      <code>&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>html</code> 
      <code>&gt;</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

This page simply shows a link “Click here to download file” with URL points to the relative path: *download.do*. We’ll configure Spring controller class to handle this URL.

#    2. Code of Spring controller class #

Create  FileDownloadController.java file under the source package  net.codejava.spring with the following code:

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> 
    <div>
      15 
    </div> 
    <div>
      16 
    </div> 
    <div>
      17 
    </div> 
    <div>
      18 
    </div> 
    <div>
      19 
    </div> 
    <div>
      20 
    </div> 
    <div>
      21 
    </div> 
    <div>
      22 
    </div> 
    <div>
      23 
    </div> 
    <div>
      24 
    </div> 
    <div>
      25 
    </div> 
    <div>
      26 
    </div> 
    <div>
      27 
    </div> 
    <div>
      28 
    </div> 
    <div>
      29 
    </div> 
    <div>
      30 
    </div> 
    <div>
      31 
    </div> 
    <div>
      32 
    </div> 
    <div>
      33 
    </div> 
    <div>
      34 
    </div> 
    <div>
      35 
    </div> 
    <div>
      36 
    </div> 
    <div>
      37 
    </div> 
    <div>
      38 
    </div> 
    <div>
      39 
    </div> 
    <div>
      40 
    </div> 
    <div>
      41 
    </div> 
    <div>
      42 
    </div> 
    <div>
      43 
    </div> 
    <div>
      44 
    </div> 
    <div>
      45 
    </div> 
    <div>
      46 
    </div> 
    <div>
      47 
    </div> 
    <div>
      48 
    </div> 
    <div>
      49 
    </div> 
    <div>
      50 
    </div> 
    <div>
      51 
    </div> 
    <div>
      52 
    </div> 
    <div>
      53 
    </div> 
    <div>
      54 
    </div> 
    <div>
      55 
    </div> 
    <div>
      56 
    </div> 
    <div>
      57 
    </div> 
    <div>
      58 
    </div> 
    <div>
      59 
    </div> 
    <div>
      60 
    </div> 
    <div>
      61 
    </div> 
    <div>
      62 
    </div> 
    <div>
      63 
    </div> 
    <div>
      64 
    </div> 
    <div>
      65 
    </div> 
    <div>
      66 
    </div> 
    <div>
      67 
    </div> 
    <div>
      68 
    </div> 
    <div>
      69 
    </div> 
    <div>
      70 
    </div> 
    <div>
      71 
    </div> 
    <div>
      72 
    </div> 
    <div>
      73 
    </div> 
    <div>
      74 
    </div> 
    <div>
      75 
    </div> 
    <div>
      76 
    </div> 
    <div>
      77 
    </div> 
    <div>
      78 
    </div> 
    <div>
      79 
    </div> 
    <div>
      80 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>package</code> 
      <code> net.codejava.spring;</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>import</code> 
      <code> java.io.File;</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code> java.io.FileInputStream;</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code> java.io.IOException;</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code> java.io.OutputStream;</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>import</code> 
      <code> javax.servlet.ServletContext;</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code> javax.servlet.http.HttpServletRequest;</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code> javax.servlet.http.HttpServletResponse;</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>import</code> 
      <code> org.springframework.stereotype.Controller;</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code> org.springframework.web.bind.annotation.RequestMapping;</code> 
     </div> 
     <div> 
      <code>import</code> 
      <code> org.springframework.web.bind.annotation.RequestMethod;</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>@Controller</code> 
     </div> 
     <div> 
      <code>@RequestMapping</code> 
      <code>(</code> 
      <code>"/download.do"</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>public</code> 
      <code> class</code> 
      <code>FileDownloadController { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>/**</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>* Size of a byte buffer to read/write file</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>*/</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>private</code> 
      <code>static</code> 
      <code>final</code> 
      <code> int</code> 
      <code>BUFFER_SIZE = </code> 
      <code>4096</code> 
      <code>;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>/**</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>* Path of the file to be downloaded, relative to application's directory</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>*/</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>private</code> 
      <code>String filePath = </code> 
      <code>"/downloads/SpringProject.zip"</code> 
      <code>;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>/**</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>* Method for handling file download request from client</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>*/</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>@RequestMapping</code> 
      <code>(method = RequestMethod.GET)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code> 
      <code>void</code> 
      <code>doDownload(HttpServletRequest request,</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>HttpServletResponse response) </code> 
      <code>throws</code> 
      <code>IOException { </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>// get absolute path of the application</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>ServletContext context = request.getServletContext();</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>String appPath = context.getRealPath(</code> 
      <code>""</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(</code> 
      <code>"appPath = "</code> 
      <code>+ appPath);</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>// construct the complete absolute path of the file</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>String fullPath = appPath + filePath;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>File downloadFile = </code> 
      <code>new</code> 
      <code>File(fullPath);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>FileInputStream inputStream = </code> 
      <code>new</code> 
      <code>FileInputStream(downloadFile);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>// get MIME type of the file</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>String mimeType = context.getMimeType(fullPath);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>if</code> 
      <code>(mimeType == </code> 
      <code>null</code> 
      <code>) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>// set to binary type if MIME mapping not found</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>mimeType = </code> 
      <code>"application/octet-stream"</code> 
      <code>;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(</code> 
      <code>"MIME type: "</code> 
      <code>+ mimeType);</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>// set content attributes for the response</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>response.setContentType(mimeType);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>response.setContentLength((</code> 
      <code>int</code> 
      <code>) downloadFile.length());</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>// set headers for the response</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>String headerKey = </code> 
      <code>"Content-Disposition"</code> 
      <code>;</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>String headerValue = String.format(</code> 
      <code>"attachment; filename=\"%s\""</code> 
      <code>,</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>downloadFile.getName());</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>response.setHeader(headerKey, headerValue);</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>// get output stream of the response</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>OutputStream outStream = response.getOutputStream();</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>byte</code> 
      <code>[] buffer = </code> 
      <code>new</code> 
      <code>byte</code> 
      <code>[BUFFER_SIZE];</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>int</code> 
      <code>bytesRead = -</code> 
      <code>1</code> 
      <code>;</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>// write bytes read from the input stream into the output stream</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>while</code> 
      <code>((bytesRead = inputStream.read(buffer)) != -</code> 
      <code>1</code> 
      <code>) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>outStream.write(buffer, </code> 
      <code>0</code> 
      <code>, bytesRead);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>inputStream.close();</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>outStream.close();</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

This is a typical Spring controller class which is annotated by Spring MVC annotation types. The method  doDownload() will receive requests from the client, read the file on server and send it to the client for downloading. Note that, unlike traditional Spring controller’s methods, the method  doDownload()does not return a view name, because our purpose is to send a file to the client. The method exits as soon as the file is completely transferred to the client.

Recommended Book: **[Getting started with Spring Framework][]**

#    3. Code of Spring configuration file #

Create  spring-mvc.xml file under  WebContent\\WEB-INF directory with the following content:

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>&lt;?</code> 
      <code>xml</code> 
      <code>version</code> 
      <code>=</code> 
      <code>"1.0"</code> 
      <code>encoding</code> 
      <code>=</code> 
      <code>"UTF-8"</code> 
      <code>?&gt;</code> 
     </div> 
     <div> 
      <code>&lt;</code> 
      <code>beans</code> 
      <code>xmlns</code> 
      <code>=</code> 
      <code>"http://www.springframework.org/schema/beans"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>xmlns:xsi</code> 
      <code>=</code> 
      <code>"http://www.w3.org/2001/XMLSchema-instance"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>xmlns:context</code> 
      <code>=</code> 
      <code>"http://www.springframework.org/schema/context"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>xsi:schemaLocation="http://www.springframework.org/schema/beans</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>http://www.springframework.org/schema/beans/spring-beans-3.0.xsd</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>http://www.springframework.org/schema/context</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>http://www.springframework.org/schema/context/spring-context-3.0.xsd"&gt;</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;</code> 
      <code>context:component-scan</code> 
      <code>base-package</code> 
      <code>=</code> 
      <code>"net.codejava.spring"</code> 
      <code>/&gt;</code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>&lt;!-- your beans declaration goes here --&gt;</code> 
     </div> 
     <div> 
      <code>&lt;/</code> 
      <code>beans</code> 
      <code>&gt;</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

This is a deadly simple Spring configuration file which tells the framework to scan the package  net.codejava.spring for annotated types (element  <context:component-scan />). Of course your application will have some bean definitions, but for the purpose of this application, such configuration is enough to work.

Related Course: **[The Java Spring Tutorial][]![show_id_d1Fh24_EiQI_bids_323058.65830_type_2_subid_0][]**

#    4. Code of web.xml #

The Spring dispatcher servlet is configured to handle requests in the  web.xml file as follows:

Recommended Book: **[Spring in Action][]**

#    5. Required jar files #

Add the following jar files into the  WebContent\\WEB-INF\\lib directory:

1.  1.  commons-logging-1.1.1.jar
    2.  spring-beans-3.2.1.RELEASE.jar
    3.  spring-context-3.2.1.RELEASE.jar
    4.  spring-core-3.2.1.RELEASE.jar
    5.  spring-expression-3.2.1.RELEASE.jar
    6.  spring-web-3.2.1.RELEASE.jar
    7.  spring-webmvc-3.2.1.RELEASE.jar

The Commons Logging jar files can be downloaded from [ Apache Commons Logging][Apache Commons Logging], other jar files come from [ Spring framework 3.2.1 RELEASE][Spring framework 3.2.1 RELEASE] download.

Related Course: **[The Java Spring Tutorial][]![show_id_d1Fh24_EiQI_bids_323058.65830_type_2_subid_0][]**

#    6. Testing the application #

Deploy the application on localhost Tomcat server, type the following URL into browser’s address bar:

*[http://localhost:8080/FileDownloadSpringMVC/][http_localhost_8080_FileDownloadSpringMVC]*

The download page is displayed:

![test download page][]

Click on the link, the browser will ask to download the file:

![download dialog][]

You can download Eclipse project for this application as well as deployable WAR file in the attachment section below.

**NOTES:**One may ask why not just putting a file somewhere on the server and give the users a link to download it? Of course that will work, however that is a static way. By handling the file to be downloaded programmatically, we can obtain the following benefits:

*   *  Delivering the files dynamically, based on user’s requests.
     *  Controlling access to the files: who can download and when the download is available.
     *  Hiding the actual location of files on the server.

Recommended Book: **[Spring in Practice][]**

[Print]: http://www.codejava.net/frameworks/spring/spring-mvc-sample-application-for-downloading-files?tmpl=component&print=1&page=
[Email]: http://www.codejava.net/component/mailto/?tmpl=component&template=protostar&link=ddfb12ccd8310248cb391f98fe2703a054cf79c7
[Java 8_ The Fundamentals]: http://www.amazon.com/gp/product/B00J1BQ4G8/ref=as_li_qf_sp_asin_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=B00J1BQ4G8&linkCode=as2&tag=code0ac-20
[ir_t_code0ac-20_l_as2_o_1_a_B00J1BQ4G8]: http://ir-na.amazon-adsystem.com/e/ir?t=code0ac-20&l=as2&o=1&a=B00J1BQ4G8
[Android 101_ Android Development for Beginners]: http://click.linksynergy.com/link?id=d1Fh24*EiQI&offerid=334543.13094&type=2&murl=https%3A%2F%2Fwww.udemy.com%2Fandroid-programming-for-beginners%2F
[show_id_d1Fh24_EiQI_bids_334543.13094_type_2_subid_0]: http://ad.linksynergy.com/fs-bin/show?id=d1Fh24*EiQI&bids=334543.13094&type=2&subid=0
[Send files from servlet to client for downloading]: http://www.codejava.net/java-ee/servlet/send-files-from-servlet-to-client-for-downloading
[application workflow]: http://www.codejava.net/images/articles/frameworks/spring/filedownload/application%20workflow.png
[project structure of FileDownloadSpringMVC application]: http://www.codejava.net/images/articles/frameworks/spring/filedownload/project%20structure%20of%20FileDownloadSpringMVC%20application.png
[Getting started with Spring Framework]: http://www.amazon.com/gp/product/1480013978/ref=as_li_tf_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1480013978&linkCode=as2&tag=code0ac-20
[The Java Spring Tutorial]: http://click.linksynergy.com/link?id=d1Fh24*EiQI&offerid=323058.65830&type=2&murl=https%3A%2F%2Fwww.udemy.com%2Fjavaspring%2F
[show_id_d1Fh24_EiQI_bids_323058.65830_type_2_subid_0]: http://ad.linksynergy.com/fs-bin/show?id=d1Fh24*EiQI&bids=323058.65830&type=2&subid=0
[Spring in Action]: http://www.amazon.com/gp/product/1935182358/ref=as_li_tf_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1935182358&linkCode=as2&tag=code0ac-20
[Apache Commons Logging]: http://commons.apache.org/logging/download_logging.cgi
[Spring framework 3.2.1 RELEASE]: http://repo.springsource.org/libs-release-local/org/springframework/spring/3.2.1.RELEASE/spring-framework-3.2.1.RELEASE-dist.zip
[http_localhost_8080_FileDownloadSpringMVC]: http://localhost:8080/FileDownloadSpringMVC/
[test download page]: http://www.codejava.net/images/articles/frameworks/spring/filedownload/test%20download%20page.png
[download dialog]: http://www.codejava.net/images/articles/frameworks/spring/filedownload/download%20dialog.png
[Spring in Practice]: http://www.amazon.com/gp/product/1935182056/ref=as_li_tf_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1935182056&linkCode=as2&tag=code0ac-20