Struts 2 - 文件上传

Struts 2 框架通过使用“HTML 中基于表单的文件上传”提供对处理文件上传的内置支持。当上传文件时，它通常会存储在临时目录中，并且应由您的 Action 类处理或移动到永久目录，以确保数据不会丢失。

注意 - 服务器可能已实施安全策略，禁止您写入除临时目录和属于您的 Web 应用程序的目录之外的目录。

Struts 中的文件上传可以通过一个预定义的拦截器来实现，称为FileUpload拦截器，它通过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。应设置此项，以便文件上传拦截器能够成功处理文件上传。接下来需要注意的是表单的动作方法upload和文件上传字段的名称 - 即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 类

接下来，让我们创建一个名为uploadFile.java的 Java 类，该类将负责上传文件并将该文件存储到安全位置：

package com.tutorialspoint.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 - 这是上传文件的 MIME 类型。在本例中，它将是“myFileContentType”
[您的文件名参数]FileName - 这是上传的文件名。在本例中，它将是“myFileFileName”

这三个参数对我们可用，这要归功于 Struts 拦截器。我们所要做的就是在我们的 Action 类中创建三个具有正确名称的参数，并且这些变量会自动为我们自动连接。因此，在上面的示例中，我们有三个参数和一个动作方法，如果一切正常，则该方法只返回“success”，否则返回“error”。

配置文件

以下是控制文件上传过程的 Struts2 配置属性：

序号	属性和描述
1	struts.multipart.maxSize 作为文件上传接受的文件的最大大小（以字节为单位）。默认为 250M。
2	struts.multipart.parser 用于上传多部分表单的库。默认为jakarta
3	struts.multipart.saveDir 存储临时文件的位置。默认为 javax.servlet.context.tempdir。

序号

属性和描述

struts.multipart.maxSize

作为文件上传接受的文件的最大大小（以字节为单位）。默认为 250M。

struts.multipart.parser

用于上传多部分表单的库。默认为jakarta

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 = "com.tutorialspoint.struts2.uploadFile">
         <result name = "success">/success.jsp</result>
         <result name = "error">/error.jsp</result>
      </action>
   </package>
</struts>

由于FileUpload拦截器是拦截器默认堆栈的一部分，因此我们不需要显式配置它。但是，您可以在<action>内添加<interceptor-ref>标签。fileUpload 拦截器接受两个参数(a) maximumSize和(b) allowedTypes。

maximumSize参数设置允许的最大文件大小（默认为大约 2MB）。allowedTypes参数是接受的内容（MIME）类型的逗号分隔列表，如下所示：

<action name = "upload" class = "com.tutorialspoint.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>

现在右键单击项目名称，然后单击导出 > WAR 文件以创建 WAR 文件。然后将此 WAR 部署到 Tomcat 的 webapps 目录中。最后，启动 Tomcat 服务器并尝试访问 URL https://127.0.0.1:8080/HelloWorldStruts2/upload.jsp。这将生成以下屏幕：

现在使用“浏览”按钮选择文件“Contacts.txt”，然后单击“上传”按钮，该按钮将文件上传到您的服务器，您应该会看到下一页。您可以检查上传的文件是否已保存在 C:\apache-tomcat-6.0.33\work 中。

请注意，FileUpload 拦截器会自动删除上传的文件，因此您必须在文件被删除之前以编程方式将上传的文件保存到某个位置。

错误消息

fileUplaod 拦截器使用多个默认错误消息键：

序号	错误消息键和描述
1	struts.messages.error.uploading 当文件无法上传时发生的常规错误。
2	struts.messages.error.file.too.large 当上传的文件大小超过 maximumSize 指定的大小时发生。
3	struts.messages.error.content.type.not.allowed 当上传的文件与指定的内容类型不匹配时发生。

序号

错误消息键和描述

struts.messages.error.uploading

当文件无法上传时发生的常规错误。

struts.messages.error.file.too.large

当上传的文件大小超过 maximumSize 指定的大小时发生。

struts.messages.error.content.type.not.allowed

当上传的文件与指定的内容类型不匹配时发生。

您可以在WebContent/WEB-INF/classes/messages.properties资源文件中覆盖这些消息的文本。

打印页面