jspSmartUpload組件上傳下載詳解

jspSmartUpload組件上傳下載詳解(全攻略,全集)
一、安裝篇
  jspSmartUpload是由www.jspsmart.com網站開發的一個可免費使用的全功能的文件上傳下載組件,適於嵌入執行上傳下載操作的JSP文件中。該組件有以下幾個特點:
1、使用簡單。在JSP文件中僅僅書寫三五行JAVA代碼就可以搞定文件的上傳或下載,方便。
2、能全程控制上傳。利用jspSmartUpload組件提供的對象及其操作方法,可以獲得全部上傳文件的信息(包括文件名,大小,類型,擴展名,文件數據等),方便存取。
3、能對上傳的文件在大小、類型等方面做出限制。如此可以濾掉不符合要求的文件。
4、下載靈活。僅寫兩行代碼,就能把Web服務器變成文件服務器。不管文件在Web服務器的目錄下或在其它任何目錄下,都可以利用jspSmartUpload進行下載。
5、能將文件上傳到數據庫中,也能將數據庫中的數據下載下來。這種功能針對的是MYSQL數據庫,因爲不具有通用性,所以本文不準備舉例介紹這種用法。
  jspSmartUpload組件可以從www.jspsmart.com網站上自由下載,壓縮包的名字是jspSmartUpload.zip。下載後,用WinZip或WinRAR將其解壓到Tomcat的webapps目錄下(本文以Tomcat服務器爲例進行介紹)。解壓後,將webapps/jspsmartupload目錄下的子目錄Web-inf名字改爲全大寫的WEB-INF,這樣一改jspSmartUpload類才能使用。因爲Tomcat對文件名大小寫敏感,它要求Web應用程序相關的類所在目錄爲WEB-INF,且必須是大寫。接着重新啓動Tomcat,這樣就可以在JSP文件中使用jspSmartUpload組件了。
  注意,按上述方法安裝後,只有webapps/jspsmartupload目錄下的程序可以使用jspSmartUpload組件,如果想讓Tomcat服務器的所有Web應用程序都能用它,必須做如下工作:
1.進入命令行狀態,將目錄切換到Tomcat的webapps/jspsmartupload/WEB-INF目錄下。
2.運行JAR打包命令:jar cvf jspSmartUpload.jar com
(也可以打開資源管理器,切換到當前目錄,用WinZip將com目錄下的所有文件壓縮成jspSmartUpload.zip,然後將jspSmartUpload.zip換名爲jspSmartUpload.jar文件即可。)
3.將jspSmartUpload.jar拷貝到Tomcat的shared/lib目錄下。
二、相關類說明篇
㈠ File類
  這個類包裝了一個上傳文件的所有信息。通過它,可以得到上傳文件的文件名、文件大小、擴展名、文件數據等信息。
  File類主要提供以下方法:
1、saveAs作用:將文件換名另存。
原型:
public void saveAs(java.lang.String destFilePathName)

public void saveAs(java.lang.String destFilePathName, int optionSaveAs)
其中,destFilePathName是另存的文件名,optionSaveAs是另存的選項,該選項有三個值,分別是SAVEAS_PHYSICAL, SAVEAS_VIRTUAL,SAVEAS_AUTO。SAVEAS_PHYSICAL表明以操作系統的根目錄爲文件根目錄另存文件, SAVEAS_VIRTUAL表明以Web應用程序的根目錄爲文件根目錄另存文件,SAVEAS_AUTO則表示讓組件決定,當Web應用程序的根目錄存在另存文件的目錄時,它會選擇SAVEAS_VIRTUAL,否則會選擇SAVEAS_PHYSICAL。
例如,saveAs ("/upload/sample.zip",SAVEAS_PHYSICAL)執行後若Web服務器安裝在C盤,則另存的文件名實際是c:\ upload\sample.zip。而saveAs("/upload/sample.zip",SAVEAS_VIRTUAL)執行後若Web應用程序的根目錄是webapps/jspsmartupload,則另存的文件名實際是webapps/jspsmartupload/upload/sample.zip。 saveAs("/upload/sample.zip",SAVEAS_AUTO)執行時若Web應用程序根目錄下存在upload目錄,則其效果同 saveAs("/upload/sample.zip",SAVEAS_VIRTUAL),否則同saveAs ("/upload/sample.zip",SAVEAS_PHYSICAL)。
建議:對於Web程序的開發來說,最好使用SAVEAS_VIRTUAL,以便移植。
2、isMissing
作用:這個方法用於判斷用戶是否選擇了文件,也即對應的表單項是否有值。選擇了文件時,它返回false。未選文件時,它返回true。
原型:public boolean isMissing()
3、getFieldName
作用:取HTML表單中對應於此上傳文件的表單項的名字。
原型:public String getFieldName()
4、getFileName
作用:取文件名(不含目錄信息)
原型:public String getFileName()
5、getFilePathName
作用:取文件全名(帶目錄)
原型:public String getFilePathName
6、getFileExt
作用:取文件擴展名(後綴)
原型:public String getFileExt()
7、getSize
作用:取文件長度(以字節計)
原型:public int getSize()
8、getBinaryData
作用:取文件數據中指定位移處的一個字節,用於檢測文件等處理。
原型:public byte getBinaryData(int index)。其中,index表示位移,其值在0到getSize()-1之間。
㈡ Files類
  這個類表示所有上傳文件的集合,通過它可以得到上傳文件的數目、大小等信息。有以下方法:
1、getCount
作用:取得上傳文件的數目。
原型:public int getCount()
2、getFile
作用:取得指定位移處的文件對象File(這是com.jspsmart.upload.File,不是java.io.File,注意區分)。
原型:public File getFile(int index)。其中,index爲指定位移,其值在0到getCount()-1之間。
3、getSize
作用:取得上傳文件的總長度,可用於限制一次性上傳的數據量大小。
原型:public long getSize()
4、getCollection
作用:將所有上傳文件對象以Collection的形式返回,以便其它應用程序引用,瀏覽上傳文件信息。
原型:public Collection getCollection()
5、getEnumeration
作用:將所有上傳文件對象以Enumeration(枚舉)的形式返回,以便其它應用程序瀏覽上傳文件信息。
原型:public Enumeration getEnumeration()
㈢ Request類
  這個類的功能等同於JSP內置的對象request。只所以提供這個類,是因爲對於文件上傳表單,通過request對象無法獲得表單項的值,必須通過jspSmartUpload組件提供的Request對象來獲取。該類提供如下方法:
1、getParameter
作用:獲取指定參數之值。當參數不存在時,返回值爲null。
原型:public String getParameter(String name)。其中,name爲參數的名字。
2、getParameterValues
作用:當一個參數可以有多個值時,用此方法來取其值。它返回的是一個字符串數組。當參數不存在時,返回值爲null。
原型:public String[] getParameterValues(String name)。其中,name爲參數的名字。
3、getParameterNames
作用:取得Request對象中所有參數的名字,用於遍歷所有參數。它返回的是一個枚舉型的對象。
原型:public Enumeration getParameterNames()
㈣ SmartUpload類這個類完成上傳下載工作。
A.上傳與下載共用的方法:
只有一個:initialize。
作用:執行上傳下載的初始化工作,必須第一個執行。
原型:有多個,主要使用下面這個:
public final void initialize(javax.servlet.jsp.PageContext pageContext)
其中,pageContext爲JSP頁面內置對象(頁面上下文)。
B.上傳文件使用的方法:
1、upload
作用:上傳文件數據。對於上傳操作,第一步執行initialize方法,第二步就要執行這個方法。
原型:public void upload()
2、save
作用:將全部上傳文件保存到指定目錄下,並返回保存的文件個數。
原型:public int save(String destPathName)
和public int save(String destPathName,int option)
其中,destPathName爲文件保存目錄,option爲保存選項,它有三個值,分別是SAVE_PHYSICAL,SAVE_VIRTUAL和 SAVE_AUTO。(同File類的saveAs方法的選項之值類似)SAVE_PHYSICAL指示組件將文件保存到以操作系統根目錄爲文件根目錄的目錄下,SAVE_VIRTUAL指示組件將文件保存到以Web應用程序根目錄爲文件根目錄的目錄下,而SAVE_AUTO則表示由組件自動選擇。
注:save(destPathName)作用等同於save(destPathName,SAVE_AUTO)。
3、getSize
作用:取上傳文件數據的總長度
原型:public int getSize()
4、getFiles
作用:取全部上傳文件,以Files對象形式返回,可以利用Files類的操作方法來獲得上傳文件的數目等信息。
原型:public Files getFiles()
5、getRequest
作用:取得Request對象,以便由此對象獲得上傳表單參數之值。
原型:public Request getRequest()
6、setAllowedFilesList
作用:設定允許上傳帶有指定擴展名的文件,當上傳過程中有文件名不允許時,組件將拋出異常。
原型:public void setAllowedFilesList(String allowedFilesList)
其中,allowedFilesList爲允許上傳的文件擴展名列表,各個擴展名之間以逗號分隔。如果想允許上傳那些沒有擴展名的文件,可以用兩個逗號表示。例如:setAllowedFilesList("doc,txt,,")將允許上傳帶doc和txt擴展名的文件以及沒有擴展名的文件。
7、setDeniedFilesList
作用:用於限制上傳那些帶有指定擴展名的文件。若有文件擴展名被限制,則上傳時組件將拋出異常。
原型:public void setDeniedFilesList(String deniedFilesList)
其中,deniedFilesList爲禁止上傳的文件擴展名列表,各個擴展名之間以逗號分隔。如果想禁止上傳那些沒有擴展名的文件,可以用兩個逗號來表示。例如:setDeniedFilesList("exe,bat,,")將禁止上傳帶exe和bat擴展名的文件以及沒有擴展名的文件。
8、setMaxFileSize
作用:設定每個文件允許上傳的最大長度。
原型:public void setMaxFileSize(long maxFileSize)
其中,maxFileSize爲爲每個文件允許上傳的最大長度,當文件超出此長度時,將不被上傳。
9、setTotalMaxFileSize
作用:設定允許上傳的文件的總長度,用於限制一次性上傳的數據量大小。
原型:public void setTotalMaxFileSize(long totalMaxFileSize)
其中,totalMaxFileSize爲允許上傳的文件的總長度。
C.下載文件常用的方法
1、setContentDisposition
作用:將數據追加到MIME文件頭的CONTENT-DISPOSITION域。jspSmartUpload組件會在返回下載的信息時自動填寫MIME文件頭的CONTENT-DISPOSITION域,如果用戶需要添加額外信息,請用此方法。
原型:public void setContentDisposition(String contentDisposition)
其中,contentDisposition爲要添加的數據。如果contentDisposition爲null,則組件將自動添加 "attachment;",以表明將下載的文件作爲附件,結果是IE瀏覽器將會提示另存文件,而不是自動打開這個文件(IE瀏覽器一般根據下載的文件擴展名決定執行什麼操作,擴展名爲doc的將用word程序打開,擴展名爲pdf的將用acrobat程序打開,等等)。
2、downloadFile
作用:下載文件。
原型:共有以下三個原型可用,第一個最常用,後兩個用於特殊情況下的文件下載(如更改內容類型,更改另存的文件名)。
① public void downloadFile(String sourceFilePathName)
其中,sourceFilePathName爲要下載的文件名(帶目錄的文件全名)
② public void downloadFile(String sourceFilePathName,String contentType)
其中,sourceFlePathName爲要下載的文件名(帶目錄的文件全名),contentType爲內容類型(MIME格式的文件類型信息,可被瀏覽器識別)。
③ public void downloadFile(String sourceFilePathName,String contentType,String destFileName)
其中,sourceFilePathName爲要下載的文件名(帶目錄的文件全名),contentType爲內容類型(MIME格式的文件類型信息,可被瀏覽器識別),destFileName爲下載後默認的另存文件名。

===============================================================
在SERVLET中使用請注意下面的代碼
===============================================================
import java.io.*;
import java.util.*;
import javax.servlet.*;
import javax.servlet.http.*;


//import com.jspsmart.*;
import com.jspsmart.upload.*;
/**
* <p>Title: </p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2003</p>
* <p>Company: </p>
* @author not attributable
* @version 1.0
*/

public class NewsServlet extends HttpServlet {

private ServletConfig config;

// Init the servlet
final public void init(ServletConfig config) throws ServletException {
this.config = config;
}

final public ServletConfig getServletConfig() {
return config;
}

public void doPost( HttpServletRequest request, HttpServletResponse response )
throws IOException, ServletException {

String fileName="";
String resultMessage = "Upload successful";

SmartUpload mySmartUpload = new SmartUpload();

//debug
System.out.println("Created smartupload");

try {
// Initialization
mySmartUpload.initialize(config,request,response);

//debug
System.out.println("Initialized smartupload");


// Upload
mySmartUpload.upload();

//debug
System.out.println("Invoked upload method");

if (mySmartUpload.getFiles().getCount() > 0) {

com.jspsmart.upload.File myFile = mySmartUpload.getFiles().getFile(0);

//debug
System.out.println("File size is " + myFile.getSize());

// Save it only if this file exists
if (!myFile.isMissing()) {
myFile.saveAs("/news.xml");
}

//debug
System.out.println("saved my file");
}

}
catch (Exception e) {
resultMessage = "Upload failure: " + e.toString();
}
request.setAttribute("message",resultMessage);
goToPage(request,response,"/postupload.jsp");
}

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

String message = null;

PrintWriter out = response.getWriter();
response.setContentType("text/xml");
try {

generateXML( out );
}
catch (Exception e) {
message = e.getMessage();
out.println(message);
}
}

private void generateXML( PrintWriter out ) throws IOException {
ServletContext sc = getServletContext();
InputStream in = sc.getResourceAsStream("/news.xml");
//debug
System.out.println("Getting XML: input stream is: " + in);
StringBuffer sb = new StringBuffer();
String xmlString = "";

int ch;

while ( ( ch = in.read() ) != -1 )
sb.append( ( char )ch );

xmlString = sb.toString();

//debug
System.out.println("XML string is: " + xmlString);

out.println(xmlString);

}


private void goToPage(HttpServletRequest request, HttpServletResponse response, String path)
throws ServletException, IOException {
//specify the path of the resource
RequestDispatcher myRD = request.getRequestDispatcher(path);

myRD.forward(request, response);
}

}


注意初始化的問題:
先看這裏對初始化的處理:
1.用這個初始化就可以了
mySmartUpload.initialize(this.getServlet().getServletConfig(), request, response);
servlet/struts中都可以
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章