Struts2教學 » Struts2 檔案上傳

Struts2 檔案上傳

Struts 2框架提供了內建支援處理檔案上傳使用基於HTML表單的檔案上傳。上傳一個檔案時，它通常會被儲存在一個臨時目錄中，他們應該由Action類進行處理或移動到一個永久的目錄，以確保資料不丟失。

請注意，伺服器有一個安全策略可能會禁止寫到目錄以外的臨時目錄和屬於web應用的目錄。

在Struts中的檔案上傳是通過預先定義的攔截檔案上傳攔截器這是可通過org.apache.struts2.interceptor.FileUploadInterceptor類的defaultStack中的一部分。仍然可以使用在struts.xml中設定各種引數，我們將在下面看到。

建立檢視檔案：

讓我們開始建立我們認為這將需要瀏覽和上傳選定的檔案。因此，讓我們建立一個純HTML上傳表單，允許使用者上傳檔案 index.jsp：

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
pageEncoding="ISO-8859-1"%>
<%@ taglib prefix="s" uri="/struts-tags"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>File Upload</title>
</head>
<body>
   <form action="upload" method="post" enctype="multipart/form-data">
      <label for="myFile">Upload your file</label>
      <input type="file" name="myFile" />
      <input type="submit" value="Upload"/>
   </form>
</body>
</html>

在上面的例子中值得注意幾點說明。首先，表單的enctype屬性設定為multipart/ form-data。這應該是設定為使得處理檔案上傳檔案上傳。下一個點值得注意的是表單的 action方法上傳和檔案上傳欄位的名稱 - myFile。我們需要這些資訊建立操作方法和struts組態。

接下來讓我們建立一個簡單的 jsp 檔案的success.jsp 結果顯示我們的檔案上傳的情況下成功。

<%@ page contentType="text/html; charset=UTF-8" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
<head>
<title>File Upload Success</title>
</head>
<body>
You have successfully uploaded <s:property value="myFileFileName"/>
</body>
</html>

下面將結果檔案error.jsp 可能會有一些錯誤，在上傳檔案：

<%@ page contentType="text/html; charset=UTF-8" %>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
<head>
<title>File Upload Error</title>
</head>
<body>
There has been an error in uploading the file.
</body>
</html>

建立action類：

接下來讓我們建立一個Java類稱為 uploadFile.java 這會處理上傳檔案，該檔案儲存在一個安全的位置：

package com.yiibai.struts2;

import java.io.File;
import org.apache.commons.io.FileUtils;
import java.io.IOException; 

import com.opensymphony.xwork2.ActionSupport;

public class uploadFile extends ActionSupport{
   private File myFile;
   private String myFileContentType;
   private String myFileFileName;
   private String destPath;

   public String execute()
   {
      /* Copy file to a safe location */
      destPath = "C:/apache-tomcat-6.0.33/work/";

      try{
     	 System.out.println("Src File name: " + myFile);
     	 System.out.println("Dst File name: " + myFileFileName);
     	    	 
     	 File destFile  = new File(destPath, myFileFileName);
    	 FileUtils.copyFile(myFile, destFile);
  
      }catch(IOException e){
         e.printStackTrace();
         return ERROR;
      }

      return SUCCESS;
   }
   public File getMyFile() {
      return myFile;
   }
   public void setMyFile(File myFile) {
      this.myFile = myFile;
   }
   public String getMyFileContentType() {
      return myFileContentType;
   }
   public void setMyFileContentType(String myFileContentType) {
      this.myFileContentType = myFileContentType;
   }
   public String getMyFileFileName() {
      return myFileFileName;
   }
   public void setMyFileFileName(String myFileFileName) {
      this.myFileFileName = myFileFileName;
   }
}

uploadFile.java是一個非常簡單的類。重要的是要注意的是使用FileUpload攔截器隨著引數Intercetpor 確實為我們解決所有繁重工作。檔案上傳攔截器，使三個引數，預設情況下提供。它們被命名為以下模式：

  • [your file name parameter] - 這是實際的檔案的上載。在這個例子中是 "myFile"

  • [your file name parameter]ContentType - 這是被上傳的檔案，該檔案的內容型別。在這個例子中是 "myFileContentType"

  • [your file name parameter]FileName - 這是被上傳的檔案的名稱。在這個例子中是 "myFileFileName"

這三個引數是為我們提供的，這要歸功於Struts的攔截器。所有我們需要做的是在我們的Action類，這些變數是自動連線我們以正確的名稱建立三個引數。所以，在上面的例子中，我們有三個引數的操作方法簡單地返回“success”，如果一切順利，否則返回“error”。

組態檔案：

以下是Struts2的組態屬性可以控制檔案上傳過程：

SN 屬性& 描述
1 struts.multipart.maxSize
The maximum size (in bytes) of a file to be accepted as a file upload. Default is 250M.
2 struts.multipart.parser
The library used to upload the multipart form. By default is jakarta
3 struts.multipart.saveDir
The location to store the temporary file. By default is javax.servlet.context.tempdir.

為了改變這些設定，可以使用恆定的標籤在應用程式 struts.xml檔案，像我一樣改變要上傳的檔案的最大大小。讓我們有我們的在struts.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>
   <constant name="struts.devMode" value="true" />
   <constant name="struts.multipart.maxSize" value="1000000" />

   <package name="helloworld" extends="struts-default">
   <action name="upload" class="com.yiibai.struts2.uploadFile">
       <result name="success">/success.jsp</result>
       <result name="error">/error.jsp</result>
   </action>
   </package>
</struts>

由於FileUpload攔截器是攔截器defaultStack的一部分，我們並不需要明確地組態。但可以新增<interceptor-ref>標籤到<action>裡面。檔案上傳攔截器需要兩個引數：（a）maximumSize及（b）allowedTypes。maximumSize引數設定允許的最大檔案大小（預設為約2MB）。allowedTypes引數接受的內容是一個逗號分隔的列表（MIME）型別，如下所示：

   <action name="upload" class="com.yiibai.struts2.uploadFile">
       <interceptor-ref name="basicStack">
       <interceptor-ref name="fileUpload">
           <param name="allowedTypes">image/jpeg,image/gif</param>
       </interceptor-ref>
       <result name="success">/success.jsp</result>
       <result name="error">/error.jsp</result>
   </action>

以下是web.xml檔案中的內容：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://java.sun.com/xml/ns/javaee" 
   xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
   http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
   id="WebApp_ID" version="3.0">
   
   <display-name>Struts 2</display-name>
   <welcome-file-list>
      <welcome-file>index.jsp</welcome-file>
   </welcome-file-list>
   <filter>
      <filter-name>struts2</filter-name>
      <filter-class>
         org.apache.struts2.dispatcher.FilterDispatcher
      </filter-class>
   </filter>

   <filter-mapping>
      <filter-name>struts2</filter-name>
      <url-pattern>/*</url-pattern>
   </filter-mapping>
</web-app>

現在右鍵點選專案名稱，並單擊 Export > WAR File 建立一個WAR檔案。然後部署此WAR在Tomcat 的webapps目錄下。最後，啟動Tomcat伺服器和嘗試存取URL http://localhost:8080/HelloWorldStruts2/upload.jsp。這會給出以下畫面：

File Upload

現在選擇一個檔案的“Contacts.txt”使用“瀏覽”按鈕，然後點選上傳按鈕，將檔案上傳，應該看到頁面。可以檢查上傳的檔案儲存在 C:apache-tomcat-6.0.33work.

File Upload Result

請注意，使用FileUpload攔截刪除上傳的檔案自動所以需要程式設計在一些位置上儲存上傳的檔案被刪除之前。

錯誤訊息：

fileUplaod攔截器使用幾個預設的錯誤訊息鍵：

SN 錯誤訊息鍵 & 描述
1 struts.messages.error.uploading
A general error that occurs when the file could not be uploaded.
2 struts.messages.error.file.too.large
Occurs when the uploaded file is too large as specified by maximumSize.
3 struts.messages.error.content.type.not.allowed
Occurs when the uploaded file does not match the expected content types specified.

You can override the text of these messages in WebContent/WEB-INF/classes/messages.propertiesresource files.