在Web應用系統開發中,文件上傳和下載功能是非常常用的功能,今天來講一下JavaWeb中的文件上傳和下載功能的實現。
對於文件上傳,瀏覽器在上傳的過程中是將文件以流的形式提交到服務器端的,如果直接使用Servlet獲取上傳文件的輸入流然後再解析裡面的請求參數是比較麻煩,所以一般選擇採用apache的開源工具common-fileupload這個文件上傳組件。這個common-fileupload上傳組件的jar包可以去apache官網上面下載,也可以在struts的lib文件夾下面找到,struts上傳的功能就是基於這個實現的。 common-fileupload是依賴於common-io這個包的,所以還需要下載這個包。
一、開發環境搭建
創建一個FileUploadAndDownLoad項目,加入Apache的commons-fileupload文件上傳組件的相關Jar包,如下圖所示:
二、實現文件上傳
2.1、文件上傳頁面和消息提示頁面
upload.jsp頁面的代碼如下:
<%@ page language="java" pageEncoding="UTF-8"%> <!DOCTYPE HTML> <html> <head> <title>文件上傳</title> </head> <body> <form action=" ${pageContext.request.contextPath}/servlet/UploadHandleServlet" enctype="multipart/form-data" method="post"> 上傳用戶:<input type="text" name="username"><br/> 上傳文件1:<input type="file" name="file1"><br/> 上傳文件2:<input type="file" name="file2"><br/> <input type="submit" value="提交"> </form> </body> </html>
message.jsp的代碼如下:
<%@ page language="java" pageEncoding="UTF-8"%> <!DOCTYPE HTML> <html> <head> <title>消息提示</title> </head> <body> ${message} < /body> </html>
2.2、處理文件上傳的Servlet
UploadHandleServlet的代碼如下:
package me.gacl.web.controller;import java.io.File;import java.io.FileOutputStream;import java.io.IOException;import java.io.InputStream;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.disk. DiskFileItemFactory;import org.apache.commons.fileupload.servlet.ServletFileUpload;public class UploadHandleServlet extends HttpServlet {public void doGet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {//得到上傳文件的保存目錄,將上傳的文件存放於WEB-INF目錄下,不允許外界直接訪問,保證上傳文件的安全String savePath = this.getServletContext().getRealPath("/WEB-INF/upload");File file = new File(savePath);//判斷上傳文件的保存目錄是否存在if (!file.exists() && !file.isDirectory()) {System.out.println(savePath+"目錄不存在,需要創建");//創建目錄file.mkdir( );}//消息提示String message = "";try{//使用Apache文件上傳組件處理文件上傳步驟://1、創建一個DiskFileItemFactory工廠DiskFileItemFactory factory = new DiskFileItemFactory();//2、創建一個文件上傳解析器ServletFileUpload upload = new ServletFileUpload(factory);//解決上傳文件名的中文亂碼upload.setHeaderEncoding("UTF-8"); //3、判斷提交上來的數據是否是上傳表單的數據if(! ServletFileUpload.isMultipartContent(request)){//按照傳統方式獲取數據return;}//4、使用ServletFileUpload解析器解析上傳數據,解析結果返回的是一個List<FileItem>集合,每一個FileItem對應一個Form表單的輸入項List<FileItem> list = upload.parseRequest(request);for(FileItem item : list){//如果fileitem中封裝的是普通輸入項的數據if(item.isFormField()){String name = item. getFieldName();//解決普通輸入項的數據的中文亂碼問題String value = item.getString("UTF-8");//value = new String(value.getBytes("iso8859-1"),"UTF -8");System.out.println(name + "=" + value);}else{//如果fileitem中封裝的是上傳文件//得到上傳的文件名稱,String filename = item.getName(); System.out.println(filename);if(filename==null || filename.trim().equals("")){continue;}//注意:不同的瀏覽器提交的文件名是不一樣的,有些瀏覽器提交上來的文件名是帶有路徑的,如: c:/a/b/1.txt,而有些只是單純的文件名,如:1.txt//處理獲取到的上傳文件的文件名的路徑部分,只保留文件名部分filename = filename.substring(filename.lastIndexOf("//")+1);//獲取item中的上傳文件的輸入流InputStream in = item.getInputStream();/ /創建一個文件輸出流FileOutputStream out = new FileOutputStream(savePath + "//" + filename);//創建一個緩衝區byte buffer[] = new byte[1024];//判斷輸入流中的數據是否已經讀完的標識int len = 0;//循環將輸入流讀入到緩衝區當中,(len=in.read(buffer))>0就表示in裡面還有數據while((len=in.read(buffer ))>0){//使用FileOutputStream輸出流將緩衝區的數據寫入到指定的目錄(savePath + "//" + filename)當中out.write(buffer, 0, len);}//關閉輸入流in.close();//關閉輸出流out.close();//刪除處理文件上傳時生成的臨時文件item.delete();message = "文件上傳成功! ";}}}catch (Exception e) {message= "文件上傳失敗! ";e.printStackTrace();}request.setAttribute("message",message);request.getRequestDispatcher("/message.jsp").forward(request, response);}public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {doGet(request, response);}}
在Web.xml文件中註冊UploadHandleServlet
<servlet><servlet-name>UploadHandleServlet</servlet-name><servlet-class>me.gacl.web.controller.UploadHandleServlet</servlet-class></servlet><servlet-mapping><servlet-name>UploadHandleServlet </servlet-name><url-pattern>/servlet/UploadHandleServlet</url-pattern></servlet-mapping>
運行效果如下:
文件上傳成功之後,上傳的文件保存在了WEB-INF目錄下的upload目錄,如下圖所示:
2.3、文件上傳的細節
上述的代碼雖然可以成功將文件上傳到服務器上面的指定目錄當中,但是文件上傳功能有許多需要注意的小細節問題,以下列出的幾點需要特別注意的
1、為保證服務器安全,上傳文件應該放在外界無法直接訪問的目錄下,比如放於WEB-INF目錄下。
2、為防止文件覆蓋的現象發生,要為上傳文件產生一個唯一的文件名。
3、為防止一個目錄下面出現太多文件,要使用hash算法打散存儲。
4、要限制上傳文件的最大值。
5、要限制上傳文件的類型,在收到上傳文件名時,判斷後綴名是否合法。
針對上述提出的5點細節問題,我們來改進一下UploadHandleServlet,改進後的代碼如下:
package me.gacl.web.controller; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.util.List; import java.util.UUID ; 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.ProgressListener; import org.apache.commons.fileupload.disk.DiskFileItemFactory; import org.apache.commons.fileupload.servlet.ServletFileUpload; /** * @ClassName : UploadHandleServlet * @Description: TODO(這裡用一句話描述這個類的作用) * @author: 孤傲蒼狼* @date: 2015-1-3 下午11:35:50 * */ public class UploadHandleServlet extends HttpServlet { public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { //得到上傳文件的保存目錄,將上傳的文件存放於WEB-INF目錄下,不允許外界直接訪問,保證上傳文件的安全String savePath = this .getServletContext().getRealPath("/WEB-INF/upload"); //上傳時生成的臨時文件保存目錄String tempPath = this.getServletContext().getRealPath("/WEB-INF/temp"); File tmpFile = new File(tempPath); if (!tmpFile.exists()) { //創建臨時目錄tmpFile.mkdir(); } //消息提示String message = ""; try{ //使用Apache文件上傳組件處理文件上傳步驟: //1、創建一個DiskFileItemFactory工廠DiskFileItemFactory factory = new DiskFileItemFactory(); //設置工廠的緩衝區的大小,當上傳的文件大小超過緩衝區的大小時,就會生成一個臨時文件存放到指定的臨時目錄當中。 factory.setSizeThreshold(1024*100);//設置緩衝區的大小為100KB,如果不指定,那麼緩衝區的大小默認是10KB //設置上傳時生成的臨時文件的保存目錄factory.setRepository(tmpFile); //2、創建一個文件上傳解析器ServletFileUpload upload = new ServletFileUpload(factory); //監聽文件上傳進度upload.setProgressListener(new ProgressListener(){ public void update(long pBytesRead, long pContentLength, int arg2) { System. out.println("文件大小為:" + pContentLength + ",當前已處理:" + pBytesRead); /** * 文件大小為:14608,當前已處理:4096 文件大小為:14608,當前已處理:7367文件大小為:14608,當前已處理:11419 文件大小為:14608,當前已處理:14608 */ } }); //解決上傳文件名的中文亂碼upload.setHeaderEncoding("UTF-8"); // 3、判斷提交上來的數據是否是上傳表單的數據if(!ServletFileUpload.isMultipartContent(request)){ //按照傳統方式獲取數據return; } //設置上傳單個文件的大小的最大值,目前是設置為1024*1024字節,也就是1MB upload.setFileSizeMax(1024*1024); //設置上傳文件總量的最大值,最大值=同時上傳的多個文件的大小的最大值的和,目前設置為10MB upload.setSizeMax(1024*1024*10); //4、使用ServletFileUpload解析器解析上傳數據,解析結果返回的是一個List<FileItem>集合,每一個FileItem對應一個Form表單的輸入項List<FileItem> list = upload.parseRequest(request); for(FileItem item : list){ //如果fileitem中封裝的是普通輸入項的數據if(item.isFormField()){ String name = item.getFieldName(); //解決普通輸入項的數據的中文亂碼問題String value = item.getString("UTF-8"); //value = new String(value.getBytes("iso8859-1"),"UTF-8"); System. out.println(name + "=" + value); }else{//如果fileitem中封裝的是上傳文件//得到上傳的文件名稱, String filename = item.getName(); System.out.println(filename ); if(filename==null || filename.trim().equals("")){ continue; } //注意:不同的瀏覽器提交的文件名是不一樣的,有些瀏覽器提交上來的文件名是帶有路徑的,如: c:/a/b/1.txt,而有些只是單純的文件名,如:1.txt //處理獲取到的上傳文件的文件名的路徑部分,只保留文件名部分filename = filename.substring(filename.lastIndexOf("//")+1); //得到上傳文件的擴展名String fileExtName = filename.substring(filename.lastIndexOf(".")+1); / /如果需要限制上傳的文件類型,那麼可以通過文件的擴展名來判斷上傳的文件類型是否合法System.out.println("上傳的文件的擴展名是:"+fileExtName); //獲取item中的上傳文件的輸入流InputStream in = item.getInputStream(); //得到文件保存的名稱String saveFilename = makeFileName(filename); //得到文件的保存目錄String realSavePath = makePath(saveFilename, savePath); //創建一個文件輸出流FileOutputStream out = new FileOutputStream(realSavePath + "//" + saveFilename); //創建一個緩衝區byte buffer[] = new byte[1024]; //判斷輸入流中的數據是否已經讀完的標識int len = 0; //循環將輸入流讀入到緩衝區當中,(len=in.read(buffer))>0就表示in裡面還有數據while((len=in.read(buffer))> 0){ //使用FileOutputStream輸出流將緩衝區的數據寫入到指定的目錄(savePath + "//" + filename)當中out.write(buffer, 0, len); } //關閉輸入流in. close(); //關閉輸出流out.close(); //刪除處理文件上傳時生成的臨時文件//item.delete(); message = "文件上傳成功! "; } } }catch (FileUploadBase.FileSizeLimitExceededException e) { e.printStackTrace(); request.setAttribute("message", "單個文件超出最大值!!!"); request.getRequestDispatcher("/message.jsp") .forward(request, response); return; }catch (FileUploadBase.SizeLimitExceededException e) { e.printStackTrace(); request.setAttribute("message", "上傳文件的總的大小超出限制的最大值!!!") ; request.getRequestDispatcher("/message.jsp").forward(request, response); return; }catch (Exception e) { message= "文件上傳失敗! "; e.printStackTrace(); } request.setAttribute("message",message); request.getRequestDispatcher("/message.jsp").forward(request, response); } /** * @Method: makeFileName * @ Description: 生成上傳文件的文件名,文件名以:uuid+"_"+文件的原始名稱* @Anthor:孤傲蒼狼* @param filename 文件的原始名稱* @return uuid+"_"+文件的原始名稱* / private String makeFileName(String filename){ //2.jpg //為防止文件覆蓋的現象發生,要為上傳文件產生一個唯一的文件名return UUID.randomUUID().toString() + "_" + filename ; } /** * 為防止一個目錄下面出現太多文件,要使用hash算法打散存儲* @Method: makePath * @Description: * @Anthor:孤傲蒼狼* * @param filename 文件名,要根據文件名生成存儲目錄* @param savePath 文件存儲路徑* @return 新的存儲目錄*/ private String makePath(String filename,String savePath){ //得到文件名的hashCode的值,得到的就是filename這個字符串對像在內存中的地址int hashcode = filename.hashCode(); int dir1 = hashcode&0xf; //0--15 int dir2 = (hashcode&0xf0)>>4; //0-15 //構造新的保存目錄String dir = savePath + "//" + dir1 + "//" + dir2; //upload/2/3 upload/3/5 //File既可以代表文件也可以代表目錄File file = new File(dir); //如果目錄不存在if(!file.exists()){ //創建目錄file.mkdirs(); } return dir; } public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }
針對上述提出的5點小細節問題進行改進之後,我們的文件上傳功能就算是做得比較完善了。
三、文件下載
3.1、列出提供下載的文件資源
我們要將Web應用系統中的文件資源提供給用戶進行下載,首先我們要有一個頁面列出上傳文件目錄下的所有文件,當用戶點擊文件下載超鏈接時就進行下載操作,編寫一個ListFileServlet,用於列出Web應用系統中所有下載文件。
ListFileServlet的代碼如下:
package me.gacl.web.controller;import java.io.File;import java.io.IOException;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;/*** @ClassName: ListFileServlet* @Description: 列出Web系統中所有下載文件* @author: 孤傲蒼狼* @ date: 2015-1-4 下午9:54:40**/ public class ListFileServlet extends HttpServlet {public void doGet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {//獲取上傳文件的目錄String uploadFilePath = this.getServletContext ().getRealPath("/WEB-INF/upload");//存儲要下載的文件名Map<String,String> fileNameMap = new HashMap<String,String>();//遞歸遍歷filepath目錄下的所有文件和目錄,將文件的文件名存儲到map集合中listfile(new File(uploadFilePath),fileNameMap);//File既可以代表一個文件也可以代表一個目錄//將Map集合發送到listfile.jsp頁面進行顯示request.setAttribute("fileNameMap", fileNameMap);request.getRequestDispatcher("/listfile.jsp").forward(request, response);}/*** @Method: listfile* @Description: 遞歸遍歷指定目錄下的所有文件* @Anthor:孤傲蒼狼* @param file 即代表一個文件,也代表一個文件目錄* @param map 存儲文件名的Map集合*/ public void listfile(File file,Map<String,String> map) {//如果file代表的不是一個文件,而是一個目錄if(!file.isFile()){//列出該目錄下的所有文件和目錄File files[] = file.listFiles();//遍歷files[]數組for(File f : files){//遞歸listfile(f,map);}}else{/*** 處理文件名,上傳後的文件是以uuid_文件名的形式去重新命名的,去除文件名的uuid_部分file.getName().indexOf("_")檢索字符串中第一次出現"_"字符的位置,如果文件名類似於:9349249849-88343-8344_阿_凡_達.avi那麼file.getName().substring(file.getName().indexOf("_")+1)處理之後就可以得到阿_凡_達.avi部分*/String realName = file.getName ().substring(file.getName().indexOf("_")+1);//file.getName()得到的是文件的原始名稱,這個名稱是唯一的,因此可以作為key,realName是處理過後的名稱,有可能會重複map.put(file.getName(), realName);}}public void doPost(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {doGet(request, response);}}
這裡簡單說一下ListFileServlet中listfile方法,listfile方法是用來列出目錄下的所有文件的,listfile方法內部用到了遞歸,在實際開發當中,我們肯定會在數據庫創建一張表,裡面會存儲上傳的文件名以及文件的具體存放目錄,我們通過查詢表就可以知道文件的具體存放目錄,是不需要用到遞歸操作的,這個例子是因為沒有使用數據庫存儲上傳的文件名和文件的具體存放位置,而上傳文件的存放位置又使用了散列算法打散存放,所以需要用到遞歸,在遞歸時,將獲取到的文件名存放到從外面傳遞到listfile方法裡面的Map集合當中,這樣就可以保證所有的文件都存放在同一個Map集合當中。
在Web.xml文件中配置ListFileServlet
<servlet><servlet-name>ListFileServlet</servlet-name><servlet-class>me.gacl.web.controller.ListFileServlet</servlet-class></servlet><servlet-mapping><servlet-name>ListFileServlet </servlet-name><url-pattern>/servlet/ListFileServlet</url-pattern></servlet-mapping>
展示下載文件的listfile.jsp頁面如下:
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><%@taglib prefix="c" uri="http://java.sun.com/jsp /jstl/core" %><!DOCTYPE HTML><html><head><title>下載文件顯示頁面</title></head><body><!-- 遍歷Map集合--><c:forEach var="me" items="${fileNameMap}"><c:url value="/servlet/DownLoadServlet" var="downurl"><c:param name="filename" value="${me.key} "></c:param></c:url>${me.value}<a href="${downurl}">下載</a><br/></c:forEach></body> </html>
訪問ListFileServlet,就可以在listfile.jsp頁面中顯示提供給用戶下載的文件資源,如下圖所示:
3.2、實現文件下載
編寫一個用於處理文件下載的Servlet,DownLoadServlet的代碼如下:
package me.gacl.web.controller;import java.io.File;import java.io.FileInputStream;import java.io.IOException;import java.io.OutputStream;import java.net.URLEncoder;import javax.servlet.ServletException ;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;public class DownLoadServlet extends HttpServlet {public void doGet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {/ /得到要下載的文件名String fileName = request.getParameter("filename"); //23239283-92489-阿凡達.avifileName = new String(fileName.getBytes("iso8859-1"),"UTF-8"); //上傳的文件都是保存在/WEB-INF/upload目錄下的子目錄當中String fileSaveRootPath=this.getServletContext().getRealPath("/WEB-INF/upload");//通過文件名找出文件的所在目錄String path = findFileSavePathByFileName(fileName,fileSaveRootPath);//得到要下載的文件File file = new File(path + "//" + fileName);//如果文件不存在if(!file.exists() ){request.setAttribute("message", "您要下載的資源已被刪除!!");request.getRequestDispatcher("/message.jsp").forward(request, response);return;}//處理文件名String realname = fileName.substring(fileName.indexOf("_")+1);//設置響應頭,控制瀏覽器下載該文件response.setHeader("content-disposition", "attachment;filename=" + URLEncoder .encode(realname, "UTF-8"));//讀取要下載的文件,保存到文件輸入流FileInputStream in = new FileInputStream(path + "//" + fileName);//創建輸出流OutputStream out = response.getOutputStream();//創建緩衝區byte buffer[] = new byte[1024];int len = 0;//循環將輸入流中的內容讀取到緩衝區當中while((len=in. read(buffer))>0){//輸出緩衝區的內容到瀏覽器,實現文件下載out.write(buffer, 0, len);}//關閉文件輸入流in.close();//關閉輸出流out.close();}/*** @Method: findFileSavePathByFileName* @Description: 通過文件名和存儲上傳文件根目錄找出要下載的文件的所在路徑* @Anthor:孤傲蒼狼* @param filename 要下載的文件名* @param saveRootPath 上傳文件保存的根目錄,也就是/WEB-INF/upload目錄* @return 要下載的文件的存儲目錄*/ public String findFileSavePathByFileName(String filename,String saveRootPath){int hashcode = filename.hashCode();int dir1 = hashcode&0xf; //0--15int dir2 = (hashcode&0xf0)>>4; //0-15String dir = saveRootPath + "//" + dir1 + "//" + dir2; / /upload/2/3 upload/3/5File file = new File(dir);if(!file.exists()){//創建目錄file.mkdirs();}return dir;}public void doPost(HttpServletRequest request , HttpServletResponse response)throws ServletException, IOException {doGet(request, response);}}
在Web.xml文件中配置DownLoadServlet
<servlet><servlet-name>DownLoadServlet</servlet-name><servlet-class>me.gacl.web.controller.DownLoadServlet</servlet-class></servlet><servlet-mapping><servlet-name>DownLoadServlet </servlet-name><url-pattern>/servlet/DownLoadServlet</url-pattern></servlet-mapping>
點擊【下載】超鏈接,將請求提交到DownLoadServlet就行處理就可以實現文件下載了,運行效果如下圖所示:
從運行結果可以看到,我們的文件下載功能已經可以正常下載文件了。
本文已被整理到了《Java上傳操作技巧匯總》,歡迎大家學習閱讀。
關於JavaWeb中的文件上傳和下載功能的內容就這麼多。