JavaWeb之java實現文件的上傳下載

文件上傳和下載

在Web應用中，文件上傳和下載功能是非常常用的功能，今天來講一下JavaWeb中的文件上傳和下載功能的實現

1. 準備工作

對於文件上傳，瀏覽器在上傳的過程中是將文件以流的形式提交到服務器端的。

一般選擇採用apache的開源工具common-fileupload這個文件上傳組件。

common-fileupload是依賴於common-io這個包的，所以還需要下載這個包。

我們下載最新的jar包

https://mvnrepository.com/artifact/commons-io/commons-io
https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload

在JavaWeb項目中導入jar包:

【注意：使用IDEA導包需要注意修復路徑，將lib添加到項目輸出目錄】

2. 使用類介紹

【文件上傳的注意事項】

1.爲保證服務器安全，上傳文件應該放在外界無法直接訪問的目錄下，比如放於WEB-INF目錄下。
2.爲防止文件覆蓋的現象發生，要爲上傳文件產生一個唯一的文件名
3.要限制上傳文件的最大值。
4.可以限制上傳文件的類型，在收到上傳文件名時，判斷後綴名是否合法。

【需要用到的類詳解】
ServletFileUpload負責處理上傳的文件數據,並將表單中每個輸入項封裝成一個FileItem對象， 在使用ServletFileUpload對象解析請求時需要DiskFileItemFactory對象。所以，我們需要在進行解析工作前構造好DiskFileItemFactory對象，通過ServletFileUpload對象的構造方法或setFileItemFactory()方法設置ServletFileUpload對象的fileItemFactory屬性。

• FileItem類
  在HTML頁面input 必須有 name

表單如果包含一個文件上傳輸入項的話，這個表單的enctype屬性就必須設置爲multipart/form-data

<form action="${pageContext.request.contextPath}/upload.do" 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>

瀏覽器表單的類型如果爲multipart/form-data , 在服務器端想獲取數據就要通過流。

【常用方法介紹】

//isFormField方法用於判斷FileItem類對象封裝的數據是一個普通文本表單
//還是一個文件表單，如果是普通表單字段則返回true，否則返回false
boolean isFormField();

//getFieldName方法用於返回表單標籤name屬性的值。
String getFieldName();
//getString方法用於將FileItem對象中保存的數據流內容以一個字符串返回
String getString();
    
//getName方法用於獲得文件上傳字段中的文件名。
String getName();

//以流的形式返回上傳文件的數據內容。
InputStream getInputStream()

//delete方法用來清空FileItem類對象中存放的主體內容
//如果主體內容被保存在臨時文件中，delete方法將刪除該臨時文件。
void delete();

• ServletFileUpload 類
  ServletFileUpload負責處理上傳的文件數據,並將表單中每個輸入項封裝成一個FileItem對象中 . 使用其parseRequest(HttpServletRequest) 方法可以將通過表單中每一個HTML標籤提交的數據封裝成一個FileItem對象，然後以List列表的形式返回。使用該方法處理上傳文件簡單易用。

3. 代碼編寫

• UploadFileServlet

package com.kuang.servlet;

import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.ProgressListener;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.util.List;
import java.util.UUID;

public class UploadServlet extends HttpServlet {
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

        try {
            //判斷上傳的文件是普通的表單還是帶文件的表單
            if (!ServletFileUpload.isMultipartContent(request)) {
                return;//如果是普通文件，我們可以直接返回
            } //如果通過了這個if，說明我們的表單是帶文件上傳的；

            //創建上傳文件的保存路徑，建議在WEB-INF路徑下，安全，用戶無法直接訪問上傳的文件；
            String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
            File uploadFile = new File(uploadPath);
            if (!uploadFile.exists()) {//如果目錄不存在，創建這樣一個目錄；
                uploadFile.mkdir();
            }

            //臨時路徑，假如文件超過了預期的大小，我們就把他放到一個臨時文件中，過幾天自動刪除，或者提醒用戶轉存爲永久
            String tmpPath = this.getServletContext().getRealPath("/WEB-INF/tmp");
            File file = new File(tmpPath);
            if (!file.exists()) {//如果目錄不存在，創建這樣一個目錄；
                file.mkdir();
            }

            //處理上傳的文件，一般都需要通過流來獲取，我們可以使用request.getInputStream(),原生態的文件上傳流獲取，十分麻煩
            //但是我們都建議使用 Apache的文件上傳組件來實現，common-fileupload，它需要依賴於 commons-io組件；

            //1.創建DiskFileItemFactory對象，處理文件上傳路徑或者大小限制的；
            DiskFileItemFactory factory = getDiskFileItemFactory(file);
            //2.獲取ServletFileUpload
            ServletFileUpload upload = getServletFileUpload(factory);
            //3.處理上傳的文件
            String msg = uploadParseRequest(upload, request, uploadPath);

            //servlet請求轉發消息
            request.setAttribute("msg",msg);
            request.getRequestDispatcher("info.jsp").forward(request,response);

        } catch (FileUploadException e) {
            e.printStackTrace();
        }

    }


    public static DiskFileItemFactory getDiskFileItemFactory(File file) {
        DiskFileItemFactory factory = new DiskFileItemFactory();
        //通過這個工廠設置一個緩衝區，當上傳的文件大於這個緩衝區的時候，將他放到臨時文件中；
        factory.setSizeThreshold(1024 * 1024); //緩存區大小爲1M
        factory.setRepository(file);//臨時目錄的保存目錄，需要一個File
        return factory;
    }

    public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory) {
        ServletFileUpload upload = new ServletFileUpload(factory);
        //監聽文件上傳進度；
        upload.setProgressListener(new ProgressListener() {
            @Override
            //pBytesRead:已經讀取到的文件大小
            //pContentLength ： 文件大小
            public void update(long pBytesRead, long pContentLength, int pItems) {
                System.out.println("總大小：" + pContentLength + "已上傳：" + pBytesRead);
            }
        });

        //處理亂碼問題
        upload.setHeaderEncoding("UTF-8");
        //設置單個文件的最大值
        upload.setFileSizeMax(1024 * 1024 * 10);
        //設置總共能夠上傳文件的大小
        //1024 = 1kb * 1024 = 1M * 10 = 10M
        upload.setSizeMax(1024 * 1024 * 10);

        return upload;
    }


    public static String uploadParseRequest(ServletFileUpload upload,HttpServletRequest request,String uploadPath)
            throws FileUploadException, IOException {

        String msg = "";

        //3.把前端請求解析，封裝成一個FileItem對象
        List<FileItem> fileItems = upload.parseRequest(request);
        for (FileItem fileItem : fileItems) {
            if (fileItem.isFormField()){ //判斷上傳的文件是普通的表單還是帶文件的表單
                //getFieldName指的是前端表單控件的name；
                String name = fileItem.getFieldName();
                String value = fileItem.getString("UTF-8"); //處理亂碼
                System.out.println(name+":"+value);
            }else { //判斷它是上傳的文件

                //=======================處理文件===============================//

                //拿到文件名字
                String uploadFileName = fileItem.getName();
                System.out.println("上傳的文件名："+uploadFileName);

                if (uploadFileName.trim().equals("")||uploadFileName==null){
                    continue;
                }

                //獲得上傳的文件名  /images/girl/paojie.png
                String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
                //獲得文件的後綴名
                String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
                    /*
                        如果文件後綴名 fileExtName 不是我們所需要的
                        就直接return，不處理，告訴用戶文件類型不對。
                    */

                System.out.println("文件信息 [件名："+fileName+"---文件類型"+fileExtName+"]");

                //可以使用UUID（唯一識別的通用碼），保證文件名唯一；
                //UUID.randomUUID()，隨機生一個唯一識別的通用碼；
                String uuidPath = UUID.randomUUID().toString();

                //=======================處理文件完畢===============================//

                //存到哪？ uploadPath
                //文件真實存在的路徑 realPath
                String realPath =   uploadPath+"/"+uuidPath;
                //給每個文件創建一個對應的文件夾
                File realPathFile = new File(realPath);
                if (!realPathFile.exists()){
                    realPathFile.mkdir();
                }

                //=======================存放地址完畢===============================//

                //獲得文件上傳的流
                InputStream inputStream = fileItem.getInputStream();

                //創建一個文件輸出流
                //realPath = 真實的文件夾；
                //差了一個文件; 加上輸出文件的名字+"/"+uuidFileName
                FileOutputStream fos = new FileOutputStream(realPath+"/"+fileName);

                //創建一個緩衝區
                byte[] buffer = new byte[1024*1024];

                //判斷是否讀取完畢
                int len = 0;
                //如果大於0說明還存在數據；
                while ((len=inputStream.read(buffer))>0){
                    fos.write(buffer,0,len);
                }

                //關閉流
                fos.close();
                inputStream.close();

                msg = "文件上傳成功！";
                fileItem.delete(); //上傳成功，清除臨時文件
                //=======================文件傳輸完畢===============================//
            }

        }

        return msg;

    }


}

• upload.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>文件上傳</title>
</head>
<body>
    <form action="${pageContext.request.contextPath}/upload.do" 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>

• msg.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>消息提示</title>
</head>
<body>
    ${msg}
</body>
</html>

• web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <servlet>
        <servlet-name>upload</servlet-name>
        <servlet-class>com.kuang.servlet.UploadFileServlet</servlet-class>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>upload</servlet-name>
        <url-pattern>/upload.do</url-pattern>
    </servlet-mapping>
</web-app>