文件上傳
1. Servlet3.0 新的API Part接口
1.1 展示層 - 前臺(tái)JSP
- 前臺(tái)頁面比較簡(jiǎn)單, 只是需要注意form表單中的下面幾個(gè)點(diǎn)
- <form>表單中, 需要添加 enctype='multipart/form-data'
- <form>表單中, 需要指定 method='post'; <form action="/uploadServlet" method="post" enctype='multipart/form-data'>
- <input> 需要使用 file 控件; <＼input type='file' name="upload">
1.2 展示層 - 后臺(tái)Servlet
- Part是一個(gè)接口, 可以方便的進(jìn)行文件的上傳
- 通過 HttpServletRequest 的 getPart() 方法獲取Part對(duì)象
- 在Servlet后臺(tái)代碼中, 需要添加 @MultipartConfig()注解
1.2.1 Part接口 API
- 獲取part: Part part = request.getPart();
-
void write(String fileName) : 將文件內(nèi)容寫入指定的磁盤位置(參數(shù)就是磁盤的地址)
- long getSize() : 獲取上傳文件的大小
-
String getName() : 獲取file控件的name屬性
-
String getHeader(String name): 獲取指定的請(qǐng)求頭(如請(qǐng)求頭: Content-Desposition:form-data; name="photo"; filename="xxxxxx.png")
- Collection<String> getHeadres(String name) : 獲取指定header名稱的集合數(shù)據(jù)
- String getContentTpye() : 獲取文件的MIME類型 (如類型: Content-Type: image/png)
- InputStream getInputStream() : 獲取輸入流用于檢索文件的內(nèi)容
- void delete() : 刪除Part數(shù)據(jù)和臨時(shí)目錄數(shù)據(jù), 默認(rèn)不會(huì)刪除
- String getSubmittedFileName() : 獲取上傳文件名 Servlet3.1和Tomcat8之后實(shí)現(xiàn)
1.2.2 @MultipartConfig 注解參數(shù)
-
String location: 指定文件上傳的目錄, 要求是絕對(duì)路徑
- int fileSize Threshold : 指定緩存大小, 超過會(huì)先寫入臨時(shí)目錄, 默認(rèn)是0
- long maxFileSize : 單個(gè)上傳文件最大值, 默認(rèn)是-1, 表示沒有限制, 單位是byte
- long maxRequestSize : 限制該multipart/form-data請(qǐng)求中數(shù)據(jù)的大小,默認(rèn)是-1,表示沒有限制,單位是byte
- multipart/form-data 發(fā)送的每個(gè)內(nèi)容區(qū)段, 都會(huì)有(Content-Desposition:form-data; name="photo"; filename="xxxxxx.png"; Content-Type: image/png) 的標(biāo)頭信息, 這其中就有上傳的該文件的文件名;
- 通過 Part 對(duì)象的 getHeader("Content-Disposition") 方法可以拿到String類型Content-Disposition的值, 然后通過 subString("截取的開始位置", "截取的結(jié)束位置") 來拿到該文件名
1.2.3展示層前臺(tái) - JSP代碼示例
<%-- filename: upload.jsp --%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Upload</title>
</head>
<body>
<%-- 文件上傳前臺(tái)表單 --%>
<form action="uploadServlet.do" method="post" enctype="multipart/form-data">
選擇文件: <input type="file" name="upload">
<input type="submit" name="提交">
</form>
</body>
</html>
1.2.4 展示層后臺(tái) - Servlet代碼示例
package xyz.xmcs;
import javax.servlet.ServletException;
import javax.servlet.annotation.MultipartConfig;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.Part;
import java.io.IOException;
/**
* @author jefxff
* @date 2020/3/5 - 11:19
* 使用Part接口通過Servlet實(shí)現(xiàn)文件的上傳
*/
@MultipartConfig(location = "D:\\upload") // location屬性的值就是文件上傳的路徑
@WebServlet(name = "PartUploadServlet", urlPatterns = "/partUploadServlet.do")
public class PartUploadServlet extends HttpServlet {
protected void doPost(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
// 設(shè)置請(qǐng)求編碼
request.setCharacterEncoding("UTF-8");
// 設(shè)置響應(yīng)編碼
response.setCharacterEncoding("UTF-8");
// 設(shè)置展示編碼
response.setContentType("text/html;charset=UTF-8");
// 通過 request獲取Part對(duì)象(參數(shù)是input標(biāo)簽中的, name屬性)
Part part = request.getPart("upload");
// 獲取文件的文件名
String fileName = getName(part);
part.write(fileName);
System.out.println(fileName + " Upload OK!");
}
// 獲取文件名
private String getName(Part part){
String headr = part.getHeader("Content-Disposition");
String fileName = headr.substring(headr.indexOf("filename=\"") + 10, headr.lastIndexOf("\""));
return fileName;
}
protected void doGet(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
doPost(request, response);
}
}
2. Apache Commons FileUpload
2.1 展示層前臺(tái) - JSP文件
- 前臺(tái)展示層和Part時(shí)的沒有區(qū)別, 主要就是注意 <from>標(biāo)簽中的 method, enctype屬性, 以及 <input> 標(biāo)簽中的 file 控件
2.2 展示層后臺(tái) - Servlet
- 使用 Commons FileUpload 實(shí)現(xiàn)文件的上傳, 需要用到兩個(gè)jar包, commons-fileupload-1.3.1.jar, commons-io-2.4.jar; 其中前一個(gè)jar包依賴與后一個(gè)jar包
- 通過 ServletFileUpload.isMultipartContent(request) 來判斷request請(qǐng)求中是否有 multipart/form-data 屬性
- 文件上傳最關(guān)鍵的類是 ServletFileUpload類, 創(chuàng)建該類的實(shí)例時(shí), 需要一個(gè) FileItemFactory 實(shí)例, FileItemFactory是一個(gè)接口, 其最常用的實(shí)現(xiàn)類是 DiskFileItemFactory
- 使用fileUpload固定步驟：
- 創(chuàng)建工廠類：DiskFileItemFactory factory=new DiskFileItemFactory();
- 創(chuàng)建解析器：ServletFileUpload upload=new ServletFileUpload(factory);
- 使用解析器解析request對(duì)象：List<FileItem> list=upload.parseRequest(request);
2.2.1 FileItemFactory 接口及 DiskFileItemFactory 實(shí)現(xiàn)類
- 用于將請(qǐng)求消息實(shí)體中的每一個(gè)項(xiàng)目封裝成單獨(dú)的DiskFileItem (FileItem接口的實(shí)現(xiàn)) 對(duì)象, DiskFileItemFactory 是默認(rèn)實(shí)現(xiàn)類
- DiskFileItemFactory 屬性:
- public static final int DEFAULT_SIZE_THRESHOLD ：將文件保存在內(nèi)存還是磁盤臨時(shí)文件夾的默認(rèn)臨界值捉撮，值為10240，即10kb
- private File repository：用于配置在創(chuàng)建文件項(xiàng)目時(shí)，當(dāng)文件項(xiàng)目大于臨界值時(shí)使用的臨時(shí)文件夾诱篷，默認(rèn)采用系統(tǒng)默認(rèn)的臨時(shí)文件路徑，可以通過系統(tǒng)屬性 java.io.tmpdir獲取。如下代碼:System.getProperty("java.io.tmpdir");
- private int sizeThreshold：用于保存將文件保存在內(nèi)存還是磁盤臨時(shí)文件夾的臨界值
- DiskFileItemFactory 構(gòu)造方法:
- public DiskFileItemFactory() : 采用默認(rèn)臨界值和系統(tǒng)臨時(shí)文件夾構(gòu)造文件項(xiàng)工廠對(duì)象
- public DiskFileItemFactory(int sizeThreshold,File repository) : 采用參數(shù)指定臨界值大小和系統(tǒng)臨時(shí)文件夾位置來構(gòu)造文件項(xiàng)工廠對(duì)象
- DiskFileItemFactory常用方法:
-
void setSizeThreshold(int sizeThreshold) : 設(shè)置是否將上傳文件以臨時(shí)文件的形式保存在磁盤的臨界值（參數(shù)是以字節(jié)為單位的int值）
-
void setRepository(File repository) : 設(shè)置當(dāng)上傳文件尺寸大于setSizeThreshold方法設(shè)置的臨界值時(shí)，將文件以臨時(shí)文件形式保存在磁盤上的存放目錄
- void getRepository() : 獲取臨時(shí)文件夾
2.2.2 ServletFileUpload 類
- ServletFileUpload 是 Apache 上傳文件的核心類
2.2.2.1 常用方法:
- boolean isMultipartContent(HttpServletRequest request) : 判斷request請(qǐng)求中是否有 multipart/form-data 屬性, 如果有返回true
- List<FileItem> parseRequest(HttpServletRequest request) : 返回對(duì)request解析的 List<FileItem> 類型的值
- Map<String, List<FileItem>> parseParameterMap(HttpServletRequest request) : 返回對(duì)request解析的 Map<String, List<FileItem>> 類型的屬性名和值
- FileItemIterator getItemIterator(HttpServletRequest request) : 返回request的 FileItemIterator
- setFileSizeMax(long fileSizeMax) : 設(shè)置單個(gè)上傳文件的大小的最大值,
- setSizeMax(long sizeMax) : 設(shè)置上傳文件總量的最大值, 最大值等于同時(shí)上傳多個(gè)文件的大小的最大值之和
2.2.3 展示層前臺(tái) - JSP代碼示例
<%--
Created by IntelliJ IDEA.
Filename: apcheupload.jsp
Date: 2020/3/5
Time: 11:11
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Upload</title>
</head>
<body>
<%-- 文件上傳前臺(tái)表單 --%>
<form action="commonsUploadServlet.do" method="post" enctype="multipart/form-data">
姓名: <input type="text" name="sname"><br/>
選擇文件: <input type="file" name="upload"><br/>
<input type="submit" name="提交"><br/>
</form>
</body>
</html>
2.2.4 展示層后臺(tái) - Servlet代碼示例
package xyz.xmcs;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileItemFactory;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
/**
* @author jefxff
* @date 2020/3/5 - 13:59
*/
@WebServlet(name = "CommonsUploadServlet", urlPatterns = "/commonsUploadServlet.do")
public class CommonsUploadServlet extends HttpServlet {
protected void doPost(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
// 設(shè)置請(qǐng)求編碼
request.setCharacterEncoding("UTF-8");
// 設(shè)置響應(yīng)編碼
response.setCharacterEncoding("UTF-8");
// 設(shè)置展示編碼
response.setContentType("text/html;charset=UTF-8");
try {
// 判斷前臺(tái)提交request請(qǐng)求中含有 multipart/form-data 屬性
if (ServletFileUpload.isMultipartContent(request)){
// 創(chuàng)建 ServletFileUpload對(duì)象, 其參數(shù)是一個(gè)FileItemFactory類型的實(shí)例
// FileItemFactory 是一個(gè)接口, 所以需要它的實(shí)現(xiàn)類
FileItemFactory factory = new DiskFileItemFactory();
ServletFileUpload upload = new ServletFileUpload(factory);
// 通過parseRequest解析form表單中的所有請(qǐng)求字段, 并保存items中
// 即本例中 前臺(tái)傳遞的 sname upload
List<FileItem> items = upload.parseRequest(request);
String name = null;
// 可以采用 Iterator 或者 forEach 等方法來遍歷
for (FileItem item : items){
if (item.isFormField()){ // 此處為真的, item,就是普通表單文件
if (item.getFieldName().equals("sname")){
name = item.getString("UTF-8");
}
} else { // 否則就是待上傳的文件
// getFieldName() 獲取普通表單的Name, getName() 獲取文件的Name
String fileName = item.getName();
// 獲取服務(wù)器路徑, 上傳文件至服務(wù)器, 也可以指定路徑
String path = request.getSession().getServletContext().getRealPath("upload");
//System.out.println(name);
// 取出當(dāng)前時(shí)間
String nowTime = new SimpleDateFormat("yyyyMMdd_HHmmss").format(new Date());
fileName = name + "_" + nowTime + "_" + fileName;
//System.out.println(fileName);
File file = new File(path, fileName);
item.write(file);
// 上傳完畢, 可以輸出提示, 也可以直接return; 結(jié)束方法
System.out.println(fileName + " 上傳成功!");
}
}
} else{
System.out.println("這里編寫解析普通form表單的代碼");
}
} catch (Exception e){
e.printStackTrace();
}
}
protected void doGet(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
doPost(request, response);
}
}
3. 文件下載
3.1 展示層前臺(tái) - JSP 文件
- 一般情況下, 展示層前臺(tái)即前端頁面只是留一個(gè)下載鏈接
- 如: <a href="downloadServlet?fileName=Xxx.png">點(diǎn)擊下載Xxx.png</a>
3.2 展示層后臺(tái) - Servlet
- 需要注意設(shè)置request 和 response 編碼
- <form> 和 <a> 標(biāo)簽中, 都是通過 request.getParamter("name") 來獲取文件名或值
- 下載需要設(shè)置響應(yīng)頭
- response.addHeader("contentType","application/octet-stream") ; 記住: MIME類型:二進(jìn)制(適合任意文件)
- response.addHeader("content-Disposition", "attachment; fileName="+ fileName); 其中這里需要注意, 如果fileName中如果出現(xiàn)了中文名, 會(huì)在瀏覽器中出現(xiàn)亂碼, 不同瀏覽器出現(xiàn)的亂碼時(shí),解決的辦法也不一樣
- 通過 getServletContent().getResourceAsStream("/download/網(wǎng)頁.html"); 來獲取InputStream輸入流
- 通過 response.getOutputStream(); 來獲取輸出流, 通過常用的方法將輸入流編程輸出流即可完成下載
3.2.1 展示層前臺(tái) - JSP代碼示例
<%--
Created by IntelliJ IDEA.
Filename: apcheupload.jsp
Date: 2020/3/5
Time: 11:11
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Upload</title>
</head>
<body>
<%-- 文件上傳前臺(tái)表單 --%>
<form action="commonsUploadServlet.do" method="post" enctype="multipart/form-data">
姓名: <input type="text" name="sname"><br/>
選擇文件: <input type="file" name="upload"><br/>
<input type="submit" name="提交"><br/>
</form>
<br/>
<a href="downloadServlet?fileName=13009726_JSP&Servlet.pdf">點(diǎn)擊下載:13009726_JSP&Servlet.pdf</a>
</body>
</html>
3.2.2 展示層后臺(tái) - Servlet代碼示例
package xyz.xmcs.download;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URLEncoder;
/**
* @author jefxff
* @date 2020/3/6 - 10:02
*/
@WebServlet(name = "DownloadServlet", urlPatterns = {"/downloadServlet"})
public class DownloadServlet 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 {
// 設(shè)置request編碼
request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");
// 獲取文件名
String fileName = request.getParameter("fileName");
// 設(shè)置響應(yīng)標(biāo)頭信息
response.addHeader("contentType","application/octet-stream");
response.addHeader("content-disposition", "attachment; fileName=" + URLEncoder.encode(fileName, "UTF-8"));
// 獲取InputStream
InputStream in = getServletContext().getResourceAsStream("/download/13009726_JSP&Servlet.pdf");
OutputStream out = response.getOutputStream();
byte[] buffer = new byte[1024];
int len = -1;
while ((len=in.read(buffer)) != -1){
out.write(buffer, 0, len);
}
out.close();
in.close();
}
}
