風(fēng)人園

前一陣子有些朋友在電子郵件中問關(guān)于Struts 2實(shí)現(xiàn)文件上傳的問題， 所以今天我們就來討論一下這個(gè)問題。

實(shí)現(xiàn)原理

Struts 2是通過Commons FileUpload文件上傳。Commons FileUpload通過將HTTP的數(shù)據(jù)保存到臨時(shí)文件夾，然后Struts使用fileUpload攔截器將文件綁定到Action的實(shí)例中。從而我們就能夠以本地文件方式的操作瀏覽器上傳的文件。

具體實(shí)現(xiàn)

前段時(shí)間Apache發(fā)布了Struts 2.0.6 GA，所以本文的實(shí)現(xiàn)是以該版本的Struts作為框架的。以下是例子所依賴類包的列表：

 
清單1 依賴類包的列表

首先，創(chuàng)建文件上傳頁面FileUpload.jsp，內(nèi)容如下：

在FileUpload.jsp中，先將表單的提交方式設(shè)為POST，然后將enctype設(shè)為multipart/form-data，這并沒有什么特別之處。接下來，<s:file/>標(biāo)志將文件上傳控件綁定到Action的myFile屬性。

其次是FileUploadAction.java代碼：

package tutorial;

import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Date;

import org.apache.struts2.ServletActionContext;

import com.opensymphony.xwork2.ActionSupport;

public class FileUploadAction extends ActionSupport {
    private static final long serialVersionUID = 572146812454l ;
    private static final int BUFFER_SIZE = 16 * 1024 ;
   
    private File myFile;
    private String contentType;
    private String fileName;
    private String imageFileName;
    private String caption;
   
    public void setMyFileContentType(String contentType) {
        this .contentType = contentType;
   }
   
    public void setMyFileFileName(String fileName) {
        this .fileName = fileName;
   }
       
    public void setMyFile(File myFile) {
        this .myFile = myFile;
   }
   
    public String getImageFileName() {
        return imageFileName;
   }
   
    public String getCaption() {
        return caption;
   }

    public void setCaption(String caption) {
        this .caption = caption;
   }
   
    private static void copy(File src, File dst) {
        try {
           InputStream in = null ;
           OutputStream out = null ;
            try {                
               in = new BufferedInputStream( new FileInputStream(src), BUFFER_SIZE);
               out = new BufferedOutputStream( new FileOutputStream(dst), BUFFER_SIZE);
                byte [] buffer = new byte [BUFFER_SIZE];
                while (in.read(buffer) > 0 ) {
                   out.write(buffer);
               }
           } finally {
                if ( null != in) {
                   in.close();
               }
                if ( null != out) {
                   out.close();
               }
           }
       } catch (Exception e) {
           e.printStackTrace();
       }
   }
   
    private static String getExtention(String fileName) {
        int pos = fileName.lastIndexOf( " . " );
        return fileName.substring(pos);
   }

   @Override
    public String execute()     {        
       imageFileName = new Date().getTime() + getExtention(fileName);
       File imageFile = new File(ServletActionContext.getServletContext().getRealPath( " /UploadImages " ) + " / " + imageFileName);
       copy(myFile, imageFile);
        return SUCCESS;
   }
   
}

在FileUploadAction中我分別寫了setMyFileContentType、setMyFileFileName、setMyFile和setCaption四個(gè)Setter方法，后兩者很容易明白，分別對(duì)應(yīng)FileUpload.jsp中的<s:file/>和<s:textfield/>標(biāo)志。但是前兩者并沒有顯式地與任何的頁面標(biāo)志綁定，那么它們的值又是從何而來的呢？其實(shí)，<s:file/>標(biāo)志不僅僅是綁定到myFile，還有myFileContentType（上傳文件的MIME類型）和myFileFileName（上傳文件的文件名，該文件名不包括文件的路徑）。因此，<s:file name="xxx" />對(duì)應(yīng)Action類里面的xxx、xxxContentType和xxxFileName三個(gè)屬性。

FileUploadAction作用是將瀏覽器上傳的文件拷貝到WEB應(yīng)用程序的UploadImages文件夾下，新文件的名稱是由系統(tǒng)時(shí)間與上傳文件的后綴組成，該名稱將被賦給imageFileName屬性，以便上傳成功的跳轉(zhuǎn)頁面使用。

下面我們就來看看上傳成功的頁面：

ShowUpload.jsp獲得imageFileName，將其UploadImages組成URL，從而將上傳的圖像顯示出來。

然后是Action的配置文件：

fileUpload Action顯式地應(yīng)用fileUploadStack的攔截器。

最后是web.xml配置文件：

發(fā)布運(yùn)行應(yīng)用程序，在瀏覽器地址欄中鍵入：http://localhost:8080/Struts2_Fileupload/FileUpload.jsp，出現(xiàn)圖示頁面：

清單7 FileUpload頁面

選擇圖片文件，填寫Caption并按下Submit按鈕提交，出現(xiàn)圖示頁面：

清單8 上傳成功頁面

更多配置

在運(yùn)行上述例子，如果您留心一點(diǎn)的話，應(yīng)該會(huì)發(fā)現(xiàn)服務(wù)器控制臺(tái)有如下輸出：

上述信息告訴我們，struts.multipart.saveDir沒有配置。struts.multipart.saveDir用于指定存放臨時(shí)文件的文件夾，該配置寫在struts.properties文件中。例如，如果在struts.properties文件加入如下代碼：

這樣上傳的文件就會(huì)臨時(shí)保存到你根目錄下的tmp文件夾中（一般為c:\tmp），如果此文件夾不存在，Struts 2會(huì)自動(dòng)創(chuàng)建一個(gè)。

錯(cuò)誤處理

上述例子實(shí)現(xiàn)的圖片上傳的功能，所以應(yīng)該阻止用戶上傳非圖片類型的文件。在Struts 2中如何實(shí)現(xiàn)這點(diǎn)呢？其實(shí)這也很簡(jiǎn)單，對(duì)上述例子作如下修改即可。

首先修改FileUpload.jsp，在<body>與<s:form>之間加入“<s:fielderror />”，用于在頁面上輸出錯(cuò)誤信息。

然后修改struts.xml文件，將Action fileUpload的定義改為如下所示：

顯而易見，起作用就是fileUpload攔截器的allowTypes參數(shù)。另外，配置還引入defaultStack它會(huì)幫我們添加驗(yàn)證等功能，所以在出錯(cuò)之后會(huì)跳轉(zhuǎn)到名稱為“input”的結(jié)果，也即是FileUpload.jsp。

發(fā)布運(yùn)行應(yīng)用程序，出錯(cuò)時(shí)，頁面如下圖所示：

清單12 出錯(cuò)提示頁面

上面的出錯(cuò)提示是Struts 2默認(rèn)的，大多數(shù)情況下，我們都需要自定義和國(guó)際化這些信息。通過在全局的國(guó)際資源文件中加入“struts.messages.error.content.type.not.allowed=The file you uploaded is not a image”，可以實(shí)現(xiàn)以上提及的需求。對(duì)此有疑問的朋友可以參考我之前的文章《在Struts 2.0中國(guó)際化(i18n)您的應(yīng)用程序》。

實(shí)現(xiàn)之后的出錯(cuò)頁面如下圖所示：

清單13 自定義出錯(cuò)提示頁面

同樣的做法，你可以使用參數(shù)“maximumSize”來限制上傳文件的大小，它對(duì)應(yīng)的字符資源名為：“struts.messages.error.file.too.large”。

字符資源“struts.messages.error.uploading”用提示一般的上傳出錯(cuò)信息。

多文件上傳

與單文件上傳相似，Struts 2實(shí)現(xiàn)多文件上傳也很簡(jiǎn)單。你可以將多個(gè)<s:file />綁定Action的數(shù)組或列表。如下例所示。

如果你希望綁定到數(shù)組，Action的代碼應(yīng)類似：

    private File[] uploads;
    private String[] uploadFileNames;
    private String[] uploadContentTypes;

    public File[] getUpload() { return this .uploads; }
    public void setUpload(File[] upload) { this .uploads = upload; }

    public String[] getUploadFileName() { return this .uploadFileNames; }
    public void setUploadFileName(String[] uploadFileName) { this .uploadFileNames = uploadFileName; }

    public String[] getUploadContentType() { return this .uploadContentTypes; }
    public void setUploadContentType(String[] uploadContentType) { this .uploadContentTypes = uploadContentType; }

如果你想綁定到列表，則應(yīng)類似：

    private List < File > uploads = new ArrayList < File > ();
    private List < String > uploadFileNames = new ArrayList < String > ();
    private List < String > uploadContentTypes = new ArrayList < String > ();

    public List < File > getUpload() {
        return this .uploads;
   }
    public void setUpload(List < File > uploads) {
        this .uploads = uploads;
   }

    public List < String > getUploadFileName() {
        return this .uploadFileNames;
   }
    public void setUploadFileName(List < String > uploadFileNames) {
        this .uploadFileNames = uploadFileNames;
   }

    public List < String > getUploadContentType() {
        return this .uploadContentTypes;
   }
    public void setUploadContentType(List < String > contentTypes) {
        this .uploadContentTypes = contentTypes;
   }

總結(jié)

在Struts 2中實(shí)現(xiàn)文件上傳的確是輕而易舉，您要做的只是使用<s:file />與Action的屬性綁定。這又一次有力地證明了Struts 2的簡(jiǎn)單易用。