JSP 實(shí)用程序之簡(jiǎn)易文件上傳組件
來(lái)源：程序員人生 發(fā)布時(shí)間：2016-06-16 17:46:17 閱讀次數(shù)：2730次
文件上傳，包括但不限于圖片上傳，是 Web 開(kāi)發(fā)中習(xí)以為常的場(chǎng)景，相信各位或多或少都曾寫(xiě)過(guò)這方面相干的代碼。Java 界若說(shuō)文件上傳，則言必稱 Apache Commons FileUpload，論必及 SmartUpload。愈甚者，Servlet 3.0 將文件上傳列為 JSR 標(biāo)準(zhǔn)，使得通過(guò)幾個(gè)注解就能夠在 Servlet 中配置上傳，不必依賴任何組件。使用第3方組件或 Servlet 自帶組件固然強(qiáng)大，但只靠 JSP 亦能完成任務(wù)，且短小而精悍，豈不美哉？本文實(shí)現(xiàn)的方法純潔基于 JSP 代碼，沒(méi)有弄成 Servlet 和專門(mén)的 Class（.java），實(shí)現(xiàn)方法純潔是基于 JSP，沒(méi)有太高的技術(shù)難度。實(shí)際使用進(jìn)程中直接部署便可。
操作組件的代碼行數(shù)不超過(guò) 10 行，只需幾個(gè)步驟：
- 生成組件實(shí)例
- 設(shè)置實(shí)例屬性
- 調(diào)用上傳/下載方法
- 處理調(diào)用結(jié)果
首先是上傳頁(yè)面，本例是1張靜態(tài)的 HTML。
上傳成功以下圖所示。
使用 POST 的表單，設(shè)置 ContentType 為 multipart/form-data 多段數(shù)據(jù)，還要記得 input 的 name 屬性。
<html>
<body>
<form action="action.jsp" enctype="multipart/form-data" method="POST">
selectimage: <input type="file" name="myfile" /><br> <input
type="submit" value="upload" />
</form>
</body>
</html>
action 中接受客戶端要求的服務(wù)端代碼在 action.jsp 中。action.jsp 通過(guò) <%@include file="Upload.jsp"%>包括了核心 Java 代碼，而 Upload.jsp 里面又包括了另外1個(gè) UploadRequest.jsp 文件。總之，我們這個(gè)小小的 Java 程序，1共包括了 UploadRequest 要求信息類、UploadException 自定義異常類和最重要的 Upload 類這3個(gè)類。
<%@page pageEncoding="UTF⑻"%>
<%@include file="Upload.jsp"%>
<%
UploadRequest ur = new UploadRequest();// 創(chuàng)建要求信息，所有參數(shù)都在這兒設(shè)置
ur.setRequest(request); //1定要傳入 request
ur.setFileOverwrite(true);// 相同文件名是不是覆蓋？true=允許覆蓋
Upload upload = new Upload();// 上傳器
try {
upload.upload(ur);
} catch (UploadException e) {
response.getWriter().println(e.toString());
}
if (ur.isOk()) // 上傳成功
response.getWriter().println("上傳成功：" + ur.getUploaded_save_fileName());
else
response.getWriter().println("上傳失敗！");
%>
這里創(chuàng)建了 UploadRequest 實(shí)例。文件上傳操作通常會(huì)附加1些限制，如：文件類型、上傳文件總大小、每一個(gè)文件的最大大小等。除此之外，作為1個(gè)通用組件還需要斟酌更多的問(wèn)題， 如：支持自定義文件保存目錄、支持相對(duì)路徑和絕對(duì)路徑、支持自定義保存的文件的文件名稱等。這些配置統(tǒng)統(tǒng)在 UploadRequest 里設(shè)置。
至于 JSP 里面的類，我愿意多說(shuō)說(shuō)。 JSP 里面允許我們定義 Java 的類，類本是可以是 static，但不能有 static 成員。實(shí)際上 JSP 類都是內(nèi)部類，定義 static 與否關(guān)系不大。如果不能定義 static 方法，就把 static 方法移出類體外，書(shū)寫(xiě)成，
<%!
/**
* 獲得開(kāi)頭數(shù)據(jù)頭占用的長(zhǎng)度
*
* @param dateBytes
* 文件2進(jìn)制數(shù)據(jù)
* @return
*/
private static int getStartPos(byte[] dateBytes) {
....
}
%>
<%! ... %> 和 <% ... %> 不同，前者是定義類成員的。
好~我們?cè)诳纯?UploadRequest.jsp，就知道具體配置些甚么。
<%@page pageEncoding="UTF⑻"%>
<%!/**
* 上傳要求的 bean，包括所有有關(guān)要求的信息
* @author frank
*
*/
public static class UploadRequest {
/**
* 上傳最大文件大小，默許 1 MB
*/
private int MaxFileSize = 1024 * 1000;
/**
* 保存文件的目錄
*/
private String upload_save_folder = "E:\\temp\\";
/**
* 上傳是不是成功
*/
private boolean isOk;
/**
* 是不是更名
*/
private boolean isNewName;
/**
* 成功上傳以后的文件名。如果 isNewName = false，則是原上傳的名字
*/
private String uploaded_save_fileName;
/**
* 相同文件名是不是覆蓋？true=允許覆蓋
*/
private boolean isFileOverwrite = true;
private HttpServletRequest request;
/**
* @return the maxFileSize
*/
public int getMaxFileSize() {
return MaxFileSize;
}
/**
* @param maxFileSize the maxFileSize to set
*/
public void setMaxFileSize(int maxFileSize) {
MaxFileSize = maxFileSize;
}
/**
* @return the upload_save_folder
*/
public String getUpload_save_folder() {
return upload_save_folder;
}
/**
* @param upload_save_folder the upload_save_folder to set
*/
public void setUpload_save_folder(String upload_save_folder) {
this.upload_save_folder = upload_save_folder;
}
/**
* @return the isOk
*/
public boolean isOk() {
return isOk;
}
/**
* @param isOk the isOk to set
*/
public void setOk(boolean isOk) {
this.isOk = isOk;
}
/**
* @return the isNewName
*/
public boolean isNewName() {
return isNewName;
}
/**
* @param isNewName the isNewName to set
*/
public void setNewName(boolean isNewName) {
this.isNewName = isNewName;
}
/**
* @return the uploaded_save_fileName
*/
public String getUploaded_save_fileName() {
return uploaded_save_fileName;
}
/**
* @param uploaded_save_fileName the uploaded_save_fileName to set
*/
public void setUploaded_save_fileName(String uploaded_save_fileName) {
this.uploaded_save_fileName = uploaded_save_fileName;
}
/**
* @return the isFileOverwrite
*/
public boolean isFileOverwrite() {
return isFileOverwrite;
}
/**
* 相同文件名是不是覆蓋？true=允許覆蓋
* @param isFileOverwrite the isFileOverwrite to set
*/
public void setFileOverwrite(boolean isFileOverwrite) {
this.isFileOverwrite = isFileOverwrite;
}
/**
* @return the request
*/
public HttpServletRequest getRequest() {
return request;
}
/**
* @param request the request to set
*/
public void setRequest(HttpServletRequest request) {
this.request = request;
}
}
%>
這是1個(gè)普通的 Java bean。完成上傳邏輯的是 Upload 類。 其原理是，1、由客戶端把要上傳的文件生成 request 數(shù)據(jù)流，與服務(wù)器端建立連接；2、在服務(wù)器端接收 request 流，將流緩存到內(nèi)存中；3、由服務(wù)器真?zhèn)€內(nèi)存把文件輸出到指定的目錄。Upload.jsp 完全代碼以下所示。
<%@page pageEncoding="UTF⑻" import="java.io.*"%>
<%@include file="UploadRequest.jsp"%>
<%!
public static class UploadException extends Exception {
private static final long serialVersionUID = 579958777177500819L;
public UploadException(String msg) {
super(msg);
}
}
public static class Upload {
/**
* 接受上傳
*
* @param uRequest
* 上傳 POJO
* @return
* @throws UploadException
*/
public UploadRequest upload(UploadRequest uRequest) throws UploadException {
HttpServletRequest req = uRequest.getRequest();
// 獲得客戶端上傳的數(shù)據(jù)類型
String contentType = req.getContentType();
if(!req.getMethod().equals("POST")){
throw new UploadException("必須 POST 要求");
}
if (contentType.indexOf("multipart/form-data") == ⑴) {
throw new UploadException("未設(shè)置表單 multipart/form-data");
}
int formDataLength = req.getContentLength();
if (formDataLength > uRequest.getMaxFileSize()) { // 是不是超大
throw new UploadException("文件大小超過(guò)系統(tǒng)限制！");
}
// 保存上傳的文件數(shù)據(jù)
byte dateBytes[] = new byte[formDataLength];
int byteRead = 0, totalRead = 0;
try(DataInputStream in = new DataInputStream(req.getInputStream());){
while (totalRead < formDataLength) {
byteRead = in.read(dateBytes, totalRead, formDataLength);
totalRead += byteRead;
}
} catch (IOException e) {
e.printStackTrace();
throw new UploadException(e.toString());
}
// 獲得數(shù)據(jù)分割字符串
int lastIndex = contentType.lastIndexOf("="); // 數(shù)據(jù)分割線開(kāi)始位置boundary=---------------------------
String boundary = contentType.substring(lastIndex + 1, contentType.length());// --------------------------⑵57261863525035
// 計(jì)算開(kāi)頭數(shù)據(jù)頭占用的長(zhǎng)度
int startPos = getStartPos(dateBytes);
// 邊界位置
int endPos = byteIndexOf(dateBytes, boundary.getBytes(), (dateBytes.length - startPos)) - 4;
// 創(chuàng)建文件
String fileName = uRequest.getUpload_save_folder() + getFileName(dateBytes, uRequest.isNewName());
uRequest.setUploaded_save_fileName(fileName);
File checkedFile = initFile(uRequest);
// 寫(xiě)入文件
try(FileOutputStream fileOut = new FileOutputStream(checkedFile);){
fileOut.write(dateBytes, startPos, endPos - startPos);
fileOut.flush();
uRequest.setOk(true);
} catch (FileNotFoundException e) {
e.printStackTrace();
throw new UploadException(e.toString());
} catch (IOException e) {
e.printStackTrace();
throw new UploadException(e.toString());
}
return uRequest;
}
}
/**
* 獲得開(kāi)頭數(shù)據(jù)頭占用的長(zhǎng)度
*
* @param dateBytes
* 文件2進(jìn)制數(shù)據(jù)
* @return
*/
private static int getStartPos(byte[] dateBytes) {
int startPos;
startPos = byteIndexOf(dateBytes, "filename=\"".getBytes(), 0);
startPos = byteIndexOf(dateBytes, "\n".getBytes(), startPos) + 1; // 遍歷掉3個(gè)換行符到數(shù)據(jù)塊
startPos = byteIndexOf(dateBytes, "\n".getBytes(), startPos) + 1;
startPos = byteIndexOf(dateBytes, "\n".getBytes(), startPos) + 1;
return startPos;
}
/**
* 在字節(jié)數(shù)組里查找某個(gè)字節(jié)數(shù)組，找到返回>=0，未找到返回⑴
* @param data
* @param search
* @param start
* @return
*/
private static int byteIndexOf(byte[] data, byte[] search, int start) {
int index = ⑴;
int len = search.length;
for (int i = start, j = 0; i < data.length; i++) {
int temp = i;
j = 0;
while (data[temp] == search[j]) {
// System.out.println((j+1)+",值："+data[temp]+","+search[j]);
// 計(jì)數(shù)
j++;
temp++;
if (j == len) {
index = i;
return index;
}
}
}
return index;
}
/**
* 如果沒(méi)有指定目錄則創(chuàng)建；檢測(cè)是不是可以覆蓋文件
*
* @param uRequest
* 上傳 POJO
* @return
* @throws UploadException
*/
private static File initFile(UploadRequest uRequest) throws UploadException {
File dir = new File(uRequest.getUpload_save_folder());
if (!dir.exists())
dir.mkdirs();
File checkFile = new File(uRequest.getUploaded_save_fileName());
if (!uRequest.isFileOverwrite() && checkFile.exists()) {
throw new UploadException("文件已存在，制止覆蓋！");
}
return checkFile;
}
/**
* 獲得 POST Body 中的文件名
*
* @param dateBytes
* 文件2進(jìn)制數(shù)據(jù)
* @param isAutoName
* 是不是自定命名，true = 時(shí)間戳文件名
* @return
*/
private static String getFileName(byte[] dateBytes, boolean isAutoName) {
String saveFile = null;
if(isAutoName){
saveFile = "2016" + System.currentTimeMillis();
} else {
String data = null;
try {
data = new String(dateBytes, "UTF⑻");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
data = "errFileName";
}
// 獲得上傳的文件名
saveFile = data.substring(data.indexOf("filename=\"") + 10);
saveFile = saveFile.substring(0, saveFile.indexOf("\n"));
saveFile = saveFile.substring(saveFile.lastIndexOf("\\") + 1, saveFile.indexOf("\""));
}
return saveFile;
}
%>
通過(guò) DataInputStream 讀取流數(shù)據(jù)到 dataBytes 中然后寫(xiě)入 FileOutputStream。另外還有些圍繞配置的邏輯。
值得1提的是，Tomcat 7 下 JSP 默許的 Java 語(yǔ)法仍舊是 1.6 的。在 JSP 里面嵌入 Java 1.7 特性的代碼會(huì)拋出“Resource specification not allowed here for source level below 1.7”的異常。因而需要修改 Tomcat/conf/web.xml 里面的配置文件，找到 <servlet> 節(jié)點(diǎn)，加入下面粗體部份才可以。注意是 jsp 節(jié)點(diǎn)，不是 default 節(jié)點(diǎn)（很類似）。
<servlet>
<servlet-name>jsp</servlet-name>
<servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
<init-param>
<param-name>fork</param-name>
<param-value>false</param-value>
</init-param>
<init-param>
<param-name>xpoweredBy</param-name>
<param-value>false</param-value>
</init-param>
<strong> <init-param>
<param-name>compilerSourceVM</param-name>
<param-value>1.7</param-value>
</init-param>
<init-param>
<param-name>compilerTargetVM</param-name>
<param-value>1.7</param-value>
</init-param></strong>
<load-on-startup>3</load-on-startup>
</servlet>
至此，1個(gè)簡(jiǎn)單的文件上傳器就完成了。但是本組件的缺點(diǎn)還是很明顯的，試羅列兩項(xiàng)：1、上傳流占用內(nèi)存而非磁盤(pán)，所以上傳大文件時(shí)內(nèi)存會(huì)吃緊；2、尚不支持多段文件上傳，也就是1次只能上傳1個(gè)文件。
生活不易，碼農(nóng)辛苦
如果您覺(jué)得本網(wǎng)站對(duì)您的學(xué)習(xí)有所幫助,可以手機(jī)掃描二維碼進(jìn)行捐贈(zèng)
