Struts 2 - การอัปโหลดไฟล์

เฟรมเวิร์ก Struts 2 ให้การสนับสนุนในตัวสำหรับการประมวลผลการอัปโหลดไฟล์โดยใช้ "การอัปโหลดไฟล์แบบฟอร์มใน HTML" เมื่ออัปโหลดไฟล์โดยทั่วไปไฟล์จะถูกเก็บไว้ในไดเร็กทอรีชั่วคราวและควรถูกประมวลผลหรือย้ายโดยคลาส Action ของคุณไปยังไดเร็กทอรีถาวรเพื่อให้แน่ใจว่าข้อมูลจะไม่สูญหาย

Note - เซิร์ฟเวอร์อาจมีนโยบายการรักษาความปลอดภัยที่ห้ามไม่ให้คุณเขียนไปยังไดเร็กทอรีอื่นที่ไม่ใช่ไดเร็กทอรีชั่วคราวและไดเร็กทอรีที่เป็นของเว็บแอปพลิเคชันของคุณ

การอัปโหลดไฟล์ใน Struts ทำได้โดยใช้ตัวสกัดกั้นที่กำหนดไว้ล่วงหน้าที่เรียกว่า FileUpload interceptor ซึ่งพร้อมใช้งานผ่านคลาส org.apache.struts2.interceptor.FileUploadInterceptor และรวมเป็นส่วนหนึ่งของdefaultStack. คุณยังสามารถใช้สิ่งนั้นใน struts.xml เพื่อตั้งค่าพารามิเตอร์ต่างๆตามที่เราจะเห็นด้านล่าง

สร้างไฟล์ดู

เริ่มต้นด้วยการสร้างมุมมองของเราซึ่งจะต้องใช้ในการเรียกดูและอัปโหลดไฟล์ที่เลือก ให้เราสร้างไฟล์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. ควรตั้งค่านี้เพื่อให้ตัวสกัดการอัปโหลดไฟล์จัดการการอัปโหลดไฟล์ได้สำเร็จ ข้อสังเกตต่อไปคือวิธีการดำเนินการของแบบฟอร์มupload และชื่อของช่องอัปโหลดไฟล์ - ซึ่งก็คือ myFile. เราต้องการข้อมูลนี้เพื่อสร้างวิธีการดำเนินการและการกำหนดค่าสตรัท

ต่อไปให้เราสร้างไฟล์ 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>

สร้างคลาสการดำเนินการ

ต่อไปให้เราสร้างคลาส Java ที่เรียกว่า uploadFile.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 Interceptor ทำหน้าที่ยกของหนักทั้งหมดให้กับเรา

ตัวสกัดกั้น FileUpload ทำให้สามพารามิเตอร์พร้อมใช้งานสำหรับคุณโดยค่าเริ่มต้น มีการตั้งชื่อตามรูปแบบต่อไปนี้ -

[your file name parameter] - นี่คือไฟล์จริงที่ผู้ใช้อัปโหลด ในตัวอย่างนี้จะเป็น "myFile"
[your file name parameter]ContentType- นี่คือประเภทเนื้อหาของไฟล์ที่อัปโหลด ในตัวอย่างนี้จะเป็น "myFileContentType"
[your file name parameter]FileName- นี่คือชื่อของไฟล์ที่อัปโหลด ในตัวอย่างนี้จะเป็น "myFileFileName"

มีพารามิเตอร์สามตัวสำหรับเราด้วย Struts Interceptors สิ่งที่เราต้องทำคือสร้างพารามิเตอร์สามตัวที่มีชื่อที่ถูกต้องในคลาส Action ของเราและตัวแปรเหล่านี้จะต่อสายอัตโนมัติให้เรา ดังนั้นในตัวอย่างข้างต้นเรามีพารามิเตอร์สามตัวและวิธีการดำเนินการที่ส่งคืน "ความสำเร็จ" หากทุกอย่างเป็นไปด้วยดีมิฉะนั้นจะส่งคืน "ข้อผิดพลาด"

ไฟล์การกำหนดค่า

ต่อไปนี้เป็นคุณสมบัติคอนฟิกูเรชัน Struts2 ที่ควบคุมกระบวนการอัพโหลดไฟล์ -

ซีเนียร์ No	คุณสมบัติและคำอธิบาย
1	struts.multipart.maxSize ขนาดสูงสุด (เป็นไบต์) ของไฟล์ที่จะยอมรับในการอัปโหลดไฟล์ ค่าเริ่มต้นคือ 250M
2	struts.multipart.parser ไลบรารีที่ใช้ในการอัปโหลดแบบฟอร์มหลายส่วน โดยค่าเริ่มต้นคือjakarta
3	struts.multipart.saveDir ตำแหน่งที่จัดเก็บไฟล์ชั่วคราว โดยค่าเริ่มต้นคือ javax.servlet.context.tempdir

หากต้องการเปลี่ยนการตั้งค่าเหล่านี้คุณสามารถใช้ constant แท็กในไฟล์ 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.tutorialspoint.struts2.uploadFile">
         <result name = "success">/success.jsp</result>
         <result name = "error">/error.jsp</result>
      </action>
   </package>
</struts>

ตั้งแต่, FileUploadinterceptor เป็นส่วนหนึ่งของ Stack ของ interceptors เริ่มต้นเราไม่จำเป็นต้องกำหนดค่าความชัดเจน แต่คุณสามารถเพิ่มแท็ก <interceptor-ref> ภายใน <action> ตัวสกัดกั้น fileUpload รับสองพารามิเตอร์(a) maximumSize และ (b) allowedTypes.

พารามิเตอร์ maximumSize ตั้งค่าขนาดไฟล์สูงสุดที่อนุญาต (ค่าเริ่มต้นคือประมาณ 2MB) พารามิเตอร์ allowTypes คือรายการประเภทเนื้อหาที่ยอมรับ (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 นี้ในไดเร็กทอรี webapps ของ Tomcat สุดท้ายเริ่มเซิร์ฟเวอร์ Tomcat และพยายามเข้าถึง URLhttp://localhost:8080/HelloWorldStruts2/upload.jsp. สิ่งนี้จะสร้างหน้าจอต่อไปนี้ -

ตอนนี้เลือกไฟล์ "Contacts.txt" โดยใช้ปุ่มเรียกดูและคลิกปุ่มอัปโหลดซึ่งจะอัปโหลดไฟล์ในการให้บริการของคุณและคุณจะเห็นหน้าถัดไป คุณสามารถตรวจสอบว่าไฟล์ที่อัปโหลดควรบันทึกใน C: \ apache-tomcat-6.0.33 \ work

โปรดทราบว่า FileUpload Interceptor จะลบไฟล์ที่อัปโหลดโดยอัตโนมัติดังนั้นคุณจะต้องบันทึกไฟล์ที่อัปโหลดด้วยโปรแกรมในบางตำแหน่งก่อนที่ไฟล์นั้นจะถูกลบ

ข้อความแสดงข้อผิดพลาด

ตัวสกัดกั้น fileUplaod ใช้ปุ่มข้อความแสดงข้อผิดพลาดเริ่มต้นหลายปุ่ม -

ซีเนียร์ No	คีย์ข้อความแสดงข้อผิดพลาดและคำอธิบาย
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 ไฟล์ทรัพยากร