Servlet 檔案上傳


Servlet 可以與 HTML form 標籤一起使用,允許使用者上傳檔案到伺服器。上傳的文件可以是文字文件或圖像文件或任何文件。

建立一個檔案上傳表單

下面的 HTML 程式碼建立了一個檔案上傳表單。以下幾點要注意:

  • 表單 method 屬性應該設定為 POST 方法,不能使用 GET 方法。

  • 表單enctype 屬性應該設定為multipart/form-data.

  • 表單action 屬性應該設定為在後端伺服器上處理檔案上傳的Servlet 檔案。下面的實例使用了 UploadServlet Servlet 來上傳檔案。

  • 上傳單一文件,您應該使用單一帶有屬性 type="file" 的 <input .../> 標籤。為了允許多個檔案上傳,請包含多個 name 屬性值不同的 input 標籤。輸入標籤具有不同的名稱屬性的值。瀏覽器會為每個 input 標籤關聯一個瀏覽按鈕。

 <html>
<head>
<title>文件上传表单</title>
</head>
<body>
<h3>文件上传:</h3>
请选择要上传的文件:<br />
<form action="UploadServlet" method="post"
                        enctype="multipart/form-data">
<input type="file" name="file" size="50" />
<br />
<input type="submit" value="上传文件" />
</form>
</body>
</html>

這將顯示下面的結果,允許使用者從本地電腦選擇一個文件,當使用者點擊"上傳文件"時,表單會連同從本地電腦選擇的文件一起提交:

 <b>文件上传:</b> 
请选择要上传的文件:<br /> 
<input type="file" name="file" size="50" /> 
<br /> 
<input type="button" value="上传文件" /> 
<br /> 
注:这只是虚拟的表单,不会正常工作。

寫後台Servlet

以下是Servlet UploadServlet,會接受上傳的文件,並將它儲存在目錄<Tomcat-installation-directory>/webapps/ data 中。這個目錄名稱也可以使用外部設定來添加,例如web.xml 中的context-param 元素,如下所示:

 <web-app>
....
<context-param> 
    <description>Location to store uploaded file</description> 
    <param-name>file-upload</param-name> 
    <param-value>
         c:\apache-tomcat-5.5.29\webapps\data\
     </param-value> 
</context-param>
....
</web-app>

以下是UploadServlet 的原始程式碼,可以一次處理多個文件的上傳。在繼續操作之前,請確認下列各項:

  • 下面的實例依賴FileUpload,所以一定要確保在您的classpath 中有最新版本的commons-fileupload. x.x.jar 檔案。可從 http://commons.apache.org/fileupload/ 下載。

  • FileUpload 依賴 Commons IO,所以一定要確保在您的 classpath 中有最新版本的 commons-io-x.x.jar 檔案。可從 http://commons.apache.org/io/ 下載。

  • 在測試下面實例時,您上傳的檔案大小不能大於 maxFileSize,否則檔案將無法上傳。

  • 請確保已經提前建立好目錄 c:\temp and c:\apache-tomcat-5.5.29\webapps\data。

// 导入必需的 java 库
import java.io.*;
import java.util.*;
 
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import org.apache.commons.io.output.*;

public class UploadServlet extends HttpServlet {
   
   private boolean isMultipart;
   private String filePath;
   private int maxFileSize = 50 * 1024;
   private int maxMemSize = 4 * 1024;
   private File file ;

   public void init( ){
      // 获取文件将被存储的位置
      filePath = 
             getServletContext().getInitParameter("file-upload"); 
   }
   public void doPost(HttpServletRequest request, 
               HttpServletResponse response)
              throws ServletException, java.io.IOException {
      // 检查我们有一个文件上传请求
      isMultipart = ServletFileUpload.isMultipartContent(request);
      response.setContentType("text/html");
      java.io.PrintWriter out = response.getWriter( );
      if( !isMultipart ){
         out.println("<html>");
         out.println("<head>");
         out.println("<title>Servlet upload</title>");  
         out.println("</head>");
         out.println("<body>");
         out.println("<p>No file uploaded</p>"); 
         out.println("</body>");
         out.println("</html>");
         return;
      }
      DiskFileItemFactory factory = new DiskFileItemFactory();
      // 文件大小的最大值将被存储在内存中
      factory.setSizeThreshold(maxMemSize);
      // Location to save data that is larger than maxMemSize.
      factory.setRepository(new File("c:\temp"));

      // 创建一个新的文件上传处理程序
      ServletFileUpload upload = new ServletFileUpload(factory);
      // 允许上传的文件大小的最大值
      upload.setSizeMax( maxFileSize );

      try{ 
      // 解析请求,获取文件项
      List fileItems = upload.parseRequest(request);
	
      // 处理上传的文件项
      Iterator i = fileItems.iterator();

      out.println("<html>");
      out.println("<head>");
      out.println("<title>Servlet upload</title>");  
      out.println("</head>");
      out.println("<body>");
      while ( i.hasNext () ) 
      {
         FileItem fi = (FileItem)i.next();
         if ( !fi.isFormField () )	
         {
            // 获取上传文件的参数
            String fieldName = fi.getFieldName();
            String fileName = fi.getName();
            String contentType = fi.getContentType();
            boolean isInMemory = fi.isInMemory();
            long sizeInBytes = fi.getSize();
            // 写入文件
            if( fileName.lastIndexOf("\") >= 0 ){
               file = new File( filePath + 
               fileName.substring( fileName.lastIndexOf("\"))) ;
            }else{
               file = new File( filePath + 
               fileName.substring(fileName.lastIndexOf("\")+1)) ;
            }
            fi.write( file ) ;
            out.println("Uploaded Filename: " + fileName + "<br>");
         }
      }
      out.println("</body>");
      out.println("</html>");
   }catch(Exception ex) {
       System.out.println(ex);
   }
   }
   public void doGet(HttpServletRequest request, 
                       HttpServletResponse response)
        throws ServletException, java.io.IOException {
        
        throw new ServletException("GET method used with " +
                getClass( ).getName( )+": POST method required.");
   } 
}

編譯並執行Servlet

編譯上面的Servlet UploadServlet,並在web.xml 檔案中建立所需的項目,如下所示:

 <servlet>
   <servlet-name>UploadServlet</servlet-name>
   <servlet-class>UploadServlet</servlet-class>
</servlet>

<servlet-mapping>
   <servlet-name>UploadServlet</servlet-name>
   <url-pattern>/UploadServlet</url-pattern>
</servlet-mapping>

現在嘗試使用您在上面建立的HTML 表單來上傳檔案。當您在瀏覽器中造訪:http://localhost:8080/UploadFile.htm 時,它會顯示下面的結果,這將有助於您從本機上傳任何檔案。

 <b>文件上传:</b> 
请选择要上传的文件:<br /> 
<input type="file" name="file" size="50" /> 
<br /> 
<input type="button" value="上传文件" />

如果您的 Servelt 腳本能正常運作,那麼您的檔案會上傳到 c:\apache-tomcat-5.5.29\webapps\data\ 目錄中。