Struts 2 简明教程

Struts 2 - File Uploads

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

Note - 服务器可能会实施禁止写入临时目录和你 Web 应用程序所属目录之外的目录的安全策略。

Struts 中的文件上传可以通过一个称为 FileUpload 的预定义拦截器来实现，可以通过类 org.apache.struts2.interceptor.FileUploadInterceptor 获得，并作为 defaultStack 的一部分包括其中。仍然可以在你自己的 struts.xml 中使用它来设置各种参数，如下所示。

Create View Files

让我们从创建我们的视图开始，该视图需要浏览和上传一个选定的文件。所以让我们创建一个 index.jsp ，带一个允许用户上传文件的简单 HTML 上传表单 −

<%@ 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 方法 upload 和文件上传字段的名称 - myFile 。我们需要这些信息来创建 action 方法和 struts 配置。

接下来，让我们创建一个 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>

Create Action Class

接下来，让我们创建称为 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”
[your file name parameter]ContentType - 这是上传文件的类型。在这个示例中它将是 “myFileContentType”
[your file name parameter]FileName - 这是上传文件的名称。在这个示例中它将是 “myFIleFileName”

这三个参数可供我们使用，这要归功于 Struts 拦截器。我们必须做的就是用正确的名称在我们的 Action 类中创建三个参数，这些变量将自动为我们自动连接。因此，在上面的示例中，我们有三个参数，一个行动方法，如果一切都好，它会返回“成功”，否则它将返回“错误”。

Configuration Files

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

Sr.No

Properties & Description

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>

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

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

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

Error Messages

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

Sr.No

错误消息键和描述

struts.messages.error.uploading 文件无法上传时发生的常规错误。

struts.messages.error.file.too.large 当上传的文件太大（由 maximumSize 指定）时发生。

struts.messages.error.content.type.not.allowed 当上传的文件与指定的预期内容类型不符时发生。

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