(十一)Struts2 文件上傳
Struts2 框架為依據“基於表單的HTML文件上傳”所進行的文件處理上傳提供了內置支持。當文件上傳時，它通常會存儲在臨時目錄中，然後Action類應對其進行處理或移動到固定目錄中，以確保數據不會丟失。
註意：服務器可能有適當的安全策略，禁止你寫入臨時目錄以外的目錄以及屬於Web應用程序的目錄。
通過一個名為FileUpload的預定義攔截器可以在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）。我們需要這些信息來創建action方法和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類
接下來，讓我們創建一個名為uploadFile.java的Java類，它將負責上傳文件並將文件存儲在安全的位置：
package cn.w3cschool.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攔截器和Parameters攔截器為我們承擔了所有的重工作量。默認情況下，FileUpload攔截器為你提供三個參數，它們分別按以下方式命名：
-
[文件名參數] - 這是用戶已上傳的實際文件。在這個例子中它將是“myFile”
-
[文件名參數]ContentType - 這是上傳的文件的內容類型。在這個例子中，它將是“myFileContentType”
-
[文件名參數]FileName - 這是上傳的文件的名稱。在這個例子中，它將是“myFileFileName”
得益於Struts攔截器這三個參數均可供我們使用。我們要做的是在Action類中創建三個帶有正確名稱的參數，並使這些變量可以自動連接。所以，在上面的例子中，我們有三個參數和一個action方法。如果一切正常，則返回“success”，否則返回“error”。
配置文件
以下是控制文件上傳過程的Struts2 配置屬性：
| 序號 | 屬性和說明 |
|---|---|
| 1 | struts.multipart.maxSize
可接受的上傳文件的最大值（以字節為單位），默認值為250M。 |
| 2 | struts.multipart.parser
用於上傳多部分表單的庫，默認為jakarta。 |
| 3 | struts.multipart.saveDir
存儲臨時文件的位置，默認是javax.servlet.context.tempdir。 |
你可以在應用程序的struts.xml文件中使用constant標簽更改任意一個這些設置，我們可以看以下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="cn.w3cschool.struts2.uploadFile">
<result name="success">/success.jsp</result>
<result name="error">/error.jsp</result>
</action>
</package>
</struts>
因為FileUpload攔截器是defaultStack攔截器的一部分，我們不需要準確的配置它，但你可以在<action>中添加<interceptor-ref>標簽。fileUpload攔截器有兩個參數：maximumSize和allowedTypes。 maximumSize參數是設置所允許的文件大小的最大值（默認約為2MB）。allowedTypes參數是所允許的內容（MIME）類型的用逗號分隔的列表，如下所示：
<action name="upload" class="cn.w3cschool.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文件。然後在Tomcat的webapps目錄中部署WAR文件。最後，啟動Tomcat服務器並嘗試訪問URL http://localhost:8080/HelloWorldStruts2/upload.jsp，將顯示如下界面：
現在使用瀏覽按鈕選擇一個文件“Contacts.txt”，然後點擊上傳按鈕，上傳文件到服務器，你將看到如下頁面。你上傳的文件應該保存在C:\apache-tomcat-6.0.33\work下。
註意：FileUpload攔截器會自動刪除上傳的文件，因此你必須在上傳的文件被刪除之前將其以編程方式保存在某個位置。
錯誤信息
fileUplaod攔截器使用幾個默認的錯誤信息key：
| 序號 | 錯誤信息key和說明 |
|---|---|
| 1 | struts.messages.error.uploading
無法上傳文件時發生的常規錯誤。 |
| 2 | struts.messages.error.file.too.large
當上傳的文件過大（由maximumSize指定）時發生。 |
| 3 | struts.messages.error.content.type.not.allowed
當上傳的文件與指定的預期內容類型不匹配時發生。 |
你可以在WebContent/WEB-INF/classes/messages.properties資源文件中覆蓋這些消息文本。
(十一)Struts2 文件上傳