軟體說明
jspSmartUpload是一個可免費使用的全功能的檔案上傳下載組件,適於嵌入執行上傳下載操作的JSP檔案中。該組件有以下幾個特點:
1、使用簡單。在JSP檔案中僅僅書寫三五行java代碼就可以搞定檔案的上傳或下載,方便。
2、能全程控制上傳。利用jspSmartUpload組件提供的對象及其操作方法,可以獲得全部上傳檔案的信息(包括檔案名稱,大小,類型,擴展名,檔案數據等),方便存取。
3、能對上傳的檔案在大小、類型等方面做出限制。如此可以濾掉不符合要求的檔案。
4、下載靈活。僅寫兩行代碼,就能把Web伺服器變成檔案伺服器。不管檔案在Web伺服器的目錄下或在其它任何目錄下,都可以利用jspSmartUpload進行下載。
下載和使用
jspSmartUpload組件可以從網上自由下載,壓縮檔的名字是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)
其中,sourceFilePathName為要下載的檔案名稱(帶目錄的檔案全名),contentType為內容類型(MIME格式的檔案類型信息,可被瀏覽器識別)。
③ public void downloadFile(String sourceFilePathName,String contentType,String destFileName)
其中,sourceFilePathName為要下載的檔案名稱(帶目錄的檔案全名),contentType為內容類型(MIME格式的檔案類型信息,可被瀏覽器識別),destFileName為下載後默認的另外儲存檔案名稱