Struts2 文件上传

OStack程序员社区-中国程序员成长平台 › 门户 › 编程› 开发框架›Struts2 教程

原作者: [db:作者] 来自: [db:来源] 收藏邀请

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.ogeek.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.ogeek.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.ogeek.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资源文件中覆盖这些消息文本。