---

文(wén)件上傳

文(wén)件上傳概述

• 實現web開發中(zhōng)的文(wén)件上傳功能，需完成如(rú)下(xià)二步操作：

  （1）在web頁面中(zhōng)添加上傳輸入項；
  （2）在servlet中(zhōng)讀取上傳文(wén)件的數據，并保存到本地硬盤中(zhōng)。

• 如(rú)何在web頁面中(zhōng)添加上傳輸入項?<input type=”file”>标簽用于在web頁面中(zhōng)添加文(wén)件上傳輸入項，設置文(wén)件上傳輸入項時須注意：

  （1）必須要設置input輸入項的name屬性，否則浏覽器(qì)将不會發送上傳文(wén)件的數據；
  （2）必須把form的enctype屬值設為multipart/form-data.設置該值後，浏覽器(qì)在上傳文(wén)件時，将把文(wén)件數據附帶在http請求消息體中(zhōng)，并使用ＭＩＭＥ協議對上傳的文(wén)件進行描述，以方便接收方對上傳數據進行解析和(hé)處理。

• 如(rú)何在Servlet中(zhōng)讀取文(wén)件上傳數據，并保存到本地硬盤中(zhōng)?

  （1）Request對象提供了一個(gè)getInputStream方法，通(tōng)過這個(gè)方法可(kě)以讀取到客戶端提交過來的數據。但由于用戶可(kě)能會同時上傳多個(gè)文(wén)件，在servlet端編程直接讀取上傳數據，并分别解析出相應的文(wén)件數據是一項非常麻煩的工作；
  （2）為方便用戶處理文(wén)件上傳數據，Apache 開源組織提供了一個(gè)用來處理表單文(wén)件上傳的一個(gè)開源組件（ Commons-fileupload ），該組件性能優異，并且其API使用極其簡單，可(kě)以讓開發人員輕松實現web文(wén)件上傳功能，因此在web開發中(zhōng)實現文(wén)件上傳功能，通(tōng)常使用Commons-fileupload組件實現。

• 使用Commons-fileupload組件實現文(wén)件上傳，需要導入該組件相應的支撐jar包：Commons-fileupload和(hé)commons-io。commons-io 不屬于文(wén)件上傳組件的開發jar文(wén)件，但Commons-fileupload 組件從1.1 版本開始，它工作時需要commons-io包的支持。

文(wén)件上傳原理

對請求正文(wén)是multipart/form-data類型的數據進行解析。

fileupload工作流程

fileupload核心API

DiskFileItemFactory工廠類

DiskFileItemFactory 是創建 FileItem 對象的工廠，這個(gè)工廠類常用方法：

• public DiskFileItemFactory(int sizeThreshold, java.io.File repository)：構造方法；
• public void setSizeThreshold(int sizeThreshold) ：設置内存緩沖區的大小，默認值為10K。當上傳文(wén)件大于緩沖區大小時， fileupload組件将使用臨時文(wén)件緩存上傳文(wén)件。
• public void setRepository(java.io.File repository) ：指定臨時文(wén)件目錄，默認值為當前用戶的系統臨時文(wén)件目錄，可(kě)通(tōng)過System.getProperty(“java.io.tmpdir”)打印查看；

ServletFileUpload解析器(qì)

ServletFileUpload 負責處理上傳的文(wén)件數據，并将表單中(zhōng)每個(gè)輸入項封裝成一個(gè) FileItem 對象中(zhōng)。常用方法有：

• boolean isMultipartContent(HttpServletRequest request) ：判斷上傳表單是否為multipart/form-data類型；
• List parseRequest(HttpServletRequest request)：解析request對象，并把表單中(zhōng)的每一個(gè)輸入項包裝成一個(gè)fileItem 對象，并返回一個(gè)保存了所有FileItem的list集合；
• setFileSizeMax(long fileSizeMax) ：設置上傳文(wén)件的最大值；
• setSizeMax(long sizeMax)：設置上傳文(wén)件總量的最大值；
• setHeaderEncoding(java.lang.String encoding) ：設置編碼格式；

FileItem表單字段域對象

FileItem類負責處理表單提交的字段，常用方法有：

1、處理普通(tōng)字段方法

• boolean isFormField() //判斷是否為普通(tōng)字段；
• String getFieldName() //返回表單字段（普通(tōng)字段）名稱；
• String getString() //返回普通(tōng)字段的值；
• String getString(String encoding) //返回普通(tōng)字段的值，并設置請求參數編碼，常用于get提交

2、處理上傳字段方法

• String getContentType() //返回表單請求類型，即request請求頭中(zhōng)的Content-type的内容，可(kě)用來限制文(wén)件上傳的類型；
• String getName() //返回文(wén)件名（全路(lù)徑名：例如(rú)C:\a.txt）；
• InputStream getInputStream() //返回表單輸入流對象；
• void write(File file) //将上傳文(wén)件寫入到磁盤；
• void delete() //删除該上傳字段存儲在磁盤上的臨時文(wén)件；

文(wén)件上傳案例

實現步驟

1. 創建DiskFileItemFactory對象，設置緩沖區大小和(hé)臨時文(wén)件目錄；
2. 使用DiskFileItemFactory 對象創建ServletFileUpload對象，并設置上傳文(wén)件的大小限制；
3. 調用ServletFileUpload.parseRequest方法解析request對象，得到一個(gè)保存了所有上傳内容的List對象；
4. 對list進行疊代，每疊代一個(gè)FileItem對象，調用其isFormField方法判斷是否是上傳文(wén)件；如(rú)果為普通(tōng)表單字段，則調用getFieldName、getString方法得到字段名和(hé)字段值；如(rú)果為上傳文(wén)件，則調用getInputStream方法得到數據輸入流，從而讀取上傳數據。

上傳文(wén)件的處理細節

1、中(zhōng)文(wén)文(wén)件亂碼問(wèn)題

文(wén)件名中(zhōng)文(wén)亂碼問(wèn)題，可(kě)調用ServletUpLoader的setHeaderEncoding方法，或者設置request的setCharacterEncoding屬性

2、臨時文(wén)件的删除問(wèn)題

• 由于文(wén)件大小超出DiskFileItemFactory.setSizeThreshold方法設置的内存緩沖區的大小時，Commons-fileupload組件将使用臨時文(wén)件保存上傳數據，因此在程序結束時，務必調用FileItem.delete方法删除臨時文(wén)件；
• Delete方法的調用必須位于流關(guān)閉之後，否則會出現文(wén)件占用，而導緻删除失敗的情況；

3、文(wén)件存放位置

• 為保證服務器(qì)安全，上傳文(wén)件應保存在應用程序的WEB-INF目錄下(xià)，或者不受WEB服務器(qì)管理的目錄；
• 為防止多用戶上傳相同文(wén)件名的文(wén)件，而導緻文(wén)件覆蓋的情況發生，文(wén)件上傳程序應保證上傳文(wén)件具有唯一文(wén)件名；
• 為防止單個(gè)目錄下(xià)文(wén)件過多，影響文(wén)件讀寫速度，處理上傳文(wén)件的程序應根據可(kě)能的文(wén)件上傳總量，選擇合适的目錄結構生成算法，将上傳文(wén)件分散存儲；

4、顯示上傳進度

（1）ProgressListener顯示上傳進度

ProgressListener progressListener = new ProgressListener() {
    public void update(long pBytesRead, long pContentLength, int pItems) {
        System.out.println("到現在為止,  " + pBytesRead + " 字節已上傳，總大小為 "
              + pContentLength);
    }
};
upload.setProgressListener(progressListener);

（2）以KB為單位顯示上傳進度

long temp = -1;   //temp注意設置為類變量
long ctemp = pBytesRead /1024; 
if (mBytes == ctemp)  
    return; 
temp = mBytes; 

編碼實現

使用工具類：GUIDUtils.java、DirectoryUtils.java

package com.study.java.utils;

import java.math.BigInteger;
import java.util.Random;

/**
* @Name: GUIDUtils
* @Description: 創建GUID唯一字符串工具類，參考struts2源碼
* @Author: XXX
* @CreateDate: XXX
* @Version: V1.0
 */
public class GUIDUtils {

    public static String generateGUID() {
        return new BigInteger(165, new Random()).toString().toUpperCase() ;
    }
}

package com.study.java.utils;

import java.io.File;
import java.text.SimpleDateFormat;
import java.util.Date;

/**
* @Name: DirectoryUtils
* @Description: 目錄創建工具類
* @Author: XXX
* @CreateDate: XXX
* @Version: V1.0
 */
public class DirectoryUtils {

    /**
    * @Name: getChildDirectoryByDate
    * @Description: 根據當前日期創建子(zǐ)目錄
    * @Author: XXX
    * @Version: V1.0
    * @CreateDate: XXX
    * @Parameters: @param storeDirectory 文(wén)件存儲主目錄
    * @Return: String
     */
    public static String getChildDirectoryByDate(String storeDirectory) {
        Date now = new Date() ;
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd") ;
        String childDirectory = sdf.format(now) ;
        File file = new File(storeDirectory, childDirectory) ;
        if(!file.exists()) {
            file.mkdirs() ;
        }
        return childDirectory ;
    }

    /**
    * @Name: getChildDirectoryByHashCode
    * @Description: 根據文(wén)件名稱字符串的hash碼創建二級子(zǐ)目錄
    * @Author: XXX
    * @Version: V1.0
    * @CreateDate: XXX
    * @Parameters: @param storeDirectory 文(wén)件存儲主目錄
    * @Parameters: @param filename 文(wén)件名稱
    * @Return: String
     */
    public static String getChildDirectoryByHashCode(String storeDirectory, String filename) {
        int hashCode = filename.hashCode() ;
        int dir1 = hashCode & 0xf ;
        int dir2 = (hashCode & 0xf0) >> 4 ;
        String childDirectory = dir1 + "/" + dir2 ;
        File file = new File(storeDirectory, childDirectory) ;
        if(!file.exists()) {
            file.mkdirs() ;
        }
        return childDirectory ;
    }
}

實現文(wén)件上傳代碼：UploadServlet.java

package com.study.java.servlet;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.util.List;

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.FileUploadBase;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

import com.study.java.utils.DirectoryUtils;
import com.study.java.utils.GUIDUtils;

/**
* @Name: UploadServlet
* @Description: 文(wén)件上傳
* @Author: XXX
* @CreateDate: XXX
* @Version: V1.0
 */
public class UploadServlet extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("text/html;charset=UTF-8") ;
        PrintWriter out = response.getWriter() ;
        //設置請求參數編碼，适用于post提交，用于處理上傳文(wén)件中(zhōng)文(wén)編碼問(wèn)題
        request.setCharacterEncoding("UTF-8") ;
        //1、創建FileItem工廠對象
        DiskFileItemFactory factory = new DiskFileItemFactory() ;
        //設置緩沖區大小1M，默認10kb
        factory.setSizeThreshold(1*1024*1024) ;
        //設置臨時文(wén)件存放目錄，默認為當前用戶系統臨時文(wén)件存放目錄
        String template = getServletContext().getRealPath("/WEB-INF/template") ;
        File templatePath = new File(template) ;
        if(!templatePath.exists()) {
            templatePath.mkdirs() ;
        }
        factory.setRepository(templatePath) ;
        //2、創建上傳文(wén)件核心解析器(qì)對象
        ServletFileUpload sfu = new ServletFileUpload(factory) ;
        //判斷表單提交類型是否為multipart/form-data
        boolean isMultipartContent = sfu.isMultipartContent(request) ;
        if(!isMultipartContent) {
            out.write("表單提交類型不正确！！！") ;
        }
        //限制單文(wén)件上傳大小
        sfu.setFileSizeMax(3*1024*1024) ;
        //限制一次上傳總文(wén)件大小
        sfu.setSizeMax(10*1024*1024) ;
        //3、解析表單提交參數
        try {
            List<FileItem> items = sfu.parseRequest(request) ;
            //獲取表單提交參數信息對象
            for (FileItem item : items) {
                if(item.isFormField()) {
                    //普通(tōng)字段
                    processFormField(item) ;
                } else {
                    //上傳字段
                    processUploadField(item) ;
                }
            }
            out.write("上傳成功！！！") ;
            response.setHeader("Refresh", "2;URL=" + request.getContextPath()) ;
        } catch (FileUploadBase.FileSizeLimitExceededException e) {
            out.write("單文(wén)件上傳大小超出限制3M.") ;
        } catch (FileUploadBase.SizeLimitExceededException e) {
            out.write("總文(wén)件上傳大小超出限制10M.") ;
        } catch (FileUploadException e) {
            out.write("表單提交參數解析失敗！！！") ;
        }
    }

    /**
    * @Name: processUploadField
    * @Description: 上傳表單提交的文(wén)件
    * @Author: XXX
    * @Version: V1.0
    * @CreateDate: XXX
    * @Parameters: @param item
    * @Return: void
     */
    private void processUploadField(FileItem item) {
        //獲取文(wén)件上傳主目錄
        String storeDirectory = getServletContext().getRealPath("/WEB-INF/upload") ;
        File file = new File(storeDirectory) ;
        if(!file.exists()) {
            file.mkdirs() ;
        }
        //獲取上傳文(wén)件名
        String filename = item.getName() ;
        if(filename != null && !"".equals(filename.toString().trim())) {
            filename = GUIDUtils.generateGUID() + "_" + filename.substring(filename.lastIndexOf("//") + 1) ;
        }
        //獲取文(wén)件上傳子(zǐ)目錄
        String childDirectory = DirectoryUtils.getChildDirectoryByHashCode(storeDirectory, filename) ;
        File f = new File(storeDirectory + "/" + childDirectory, filename) ;
        //上傳
        try {
            item.write(f) ;
        } catch (Exception e) {
            throw new RuntimeException("文(wén)件上傳失敗！！！") ;
        }
    }

    /**
    * @Name: processFormField
    * @Description: 處理表單提交普通(tōng)字段，打印到控制台
    * @Author: XXX
    * @Version: V1.0
    * @CreateDate: XXX
    * @Parameters: @param item
    * @Return: void
     */
    private void processFormField(FileItem item) {
        try {
            String fieldName = item.getFieldName() ;
            String fieldValue = item.getString("UTF-8") ;
            System.out.println(fieldName + "->" + fieldValue);
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        this.doGet(request, response);
    }
}

文(wén)件下(xià)載

Web應用中(zhōng)實現文(wén)件下(xià)載的兩種方式

1. 超鍊接直接指向下(xià)載資(zī)源；

2. 程序實現下(xià)載：程序實現下(xià)載需設置兩個(gè)響應頭，

   （1）設置Content-Type 的值為：application/x-msdownload。Web 服務器(qì)需要告訴浏覽器(qì)其所輸出的内容的類型不是普通(tōng)的文(wén)本文(wén)件或 HTML 文(wén)件，而是一個(gè)要保存到本地的下(xià)載文(wén)件；

   （2）Web 服務器(qì)希望浏覽器(qì)不直接處理相應的實體内容，而是由用戶選擇将相應的實體内容保存到一個(gè)文(wén)件中(zhōng)，這需要設置 Content-Disposition 報頭。該報頭指定了接收程序處理數據内容的方式，在 HTTP 應用中(zhōng)隻有 attachment 是标準方式，attachment 表示要求用戶幹預。在 attachment 後面還可(kě)以指定 filename 參數，該參數是服務器(qì)建議浏覽器(qì)将實體内容保存到文(wén)件中(zhōng)的文(wén)件名稱。在設置 Content-Dispostion 之前一定要指定 Content-Type。

   （3）因為要下(xià)載的文(wén)件可(kě)以是各種類型的文(wén)件，所以要将文(wén)件傳送給客戶端，其相應内容應該被當做二進制來處理，所以應該調用response.getOutputStream()方法返回 ServeltOutputStream 對象來向客戶端寫入文(wén)件内容。

response.setContentType("application/x-msdownload") ;
String str = "attachment;filename=" + java.net.URLEncoder.encode(fileName, "UTF-8") ;
response.setHeader("Content-Disposition", str) ;

InputStream is = new FileInputStream(file) ;
OutputStream os = response.getOutputStream() ;
int len = -1 ;
byte[] buf = new byte[1024] ;
while((len = is.read(buf)) != -1) {
    os.write(buf, 0, len) ;
    os.flush() ;
}
is.close() ;
os.close() ;

下(xià)載案例

遍曆上傳目錄下(xià)的所有文(wén)件顯示給用戶，并允許用戶完成下(xià)載。

（1）ShowAllUploadFiles.java

package com.study.java.servlet;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
* @Name: ShowAllUploadFiles
* @Description: 顯示所有已經上傳的文(wén)件
* @Author: XXX
* @CreateDate: XXX 
* @Version: V1.0
 */
public class ShowAllUploadFiles extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        Map<String, String> map = new HashMap<String, String>() ;
        //獲取文(wén)件上傳主目錄
        String storeDirectory = getServletContext().getRealPath("/WEB-INF/upload") ;
        File file = new File(storeDirectory) ;
        treeWalk(file, map) ;
        request.setAttribute("map", map) ;
        request.getRequestDispatcher("/listFiles.jsp").forward(request, response) ;
    }

    /**
    * @Name: treeWalk
    * @Description: 将文(wén)件上傳主目錄中(zhōng)的所有文(wén)件名稱放入到Map集合中(zhōng)
    * @Author: XXX
    * @Version: V1.0
    * @CreateDate: XXX
    * @Parameters: @param file
    * @Parameters: @param map
    * @Return: void
     */
    private void treeWalk(File file, Map<String, String> map) {
        if(file.isDirectory()) {
            File[] list = file.listFiles() ;
            for (File f : list) {
                treeWalk(f, map) ;
            }
        } else {
            String guidFileName = file.getName() ;
            String oldFileName = guidFileName.substring(guidFileName.indexOf("_") + 1) ;
            map.put(guidFileName, oldFileName) ;
        }
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        this.doGet(request, response);
    }
}

（2）JSP視圖頁面

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title></title>
    <meta http-equiv="pragma" content="no-cache">
    <meta http-equiv="cache-control" content="no-cache">
    <meta http-equiv="expires" content="0">    
      </head>
  <body>
    <c:forEach items="${map}" var="me">
        <c:url value="/servlet/DownloadServlet" var="url">
            <c:param name="guidFileName" value="${me.key}"/>
        </c:url><hr/>
        ${me.value}
        &nbsp;&nbsp;
        <a href="${url}">下(xià)載</a><hr/>
    </c:forEach>
  </body>
</html>

（3）DownloadServlet.java

package com.study.java.servlet;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.net.URLEncoder;

import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.study.java.utils.DirectoryUtils;

/**
* @Name: DownloadServlet
* @Description: 文(wén)件下(xià)載
* @Author: XXX
* @CreateDate: XXX
* @Version: V1.0
 */
public class DownloadServlet extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        //獲取請求鍊接中(zhōng)的參數，并進行編碼，解決文(wén)件名中(zhōng)帶中(zhōng)文(wén)的情況
        String guidFileName = request.getParameter("guidFileName") ;
        guidFileName = new String(guidFileName.getBytes("ISO-8859-1"), "utf-8") ;
        //獲取文(wén)件儲存目錄
        String storeDirectory = getServletContext().getRealPath("/WEB-INF/upload") ;
        String childDirectory = DirectoryUtils.getChildDirectoryByHashCode(storeDirectory, guidFileName) ;
        File file = new File(storeDirectory + "/" + childDirectory, guidFileName) ;
        if(file.exists()) {
            //通(tōng)知客戶端下(xià)載
            String oldFileName = guidFileName.substring(guidFileName.indexOf("_") + 1) ;
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(oldFileName, "UTF-8")) ;
            //下(xià)載
            InputStream is = new FileInputStream(file) ;
            OutputStream os = response.getOutputStream() ;
            int len = -1 ;
            byte[] buf = new byte[1024] ;
            while((len = is.read(buf)) != -1) {
                os.write(buf, 0, len) ;
                os.flush() ;
            }
            is.close() ;
            os.close() ;
        } else {
            throw new RuntimeException("下(xià)載文(wén)件不存在！！！") ;
        }
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        this.doGet(request, response);
    }
}