Struts 2 - Uploads de arquivos

A estrutura do Struts 2 fornece suporte integrado para processamento de upload de arquivo usando "Upload de arquivo baseado em formulário em HTML". Quando um arquivo é carregado, ele normalmente é armazenado em um diretório temporário e deve ser processado ou movido por sua classe Action para um diretório permanente para garantir que os dados não sejam perdidos.

Note - Os servidores podem ter uma política de segurança em vigor que o proíba de gravar em diretórios que não sejam o diretório temporário e os diretórios que pertencem ao seu aplicativo da web.

O upload de arquivos no Struts é possível através de um interceptor pré-definido chamado FileUpload interceptor que está disponível por meio da classe org.apache.struts2.interceptor.FileUploadInterceptor e incluído como parte dadefaultStack. Ainda assim, você pode usar isso em seu struts.xml para definir vários parâmetros, como veremos a seguir.

Criar arquivos de visualização

Vamos começar criando nossa visão que será necessária para navegar e carregar um arquivo selecionado. Então, vamos criar umindex.jsp com formulário de upload de HTML simples que permite ao usuário fazer upload de um arquivo -

<%@ 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>

Há alguns pontos dignos de nota no exemplo acima. Primeiro, o enctype do formulário é definido comomultipart/form-data. Isso deve ser definido para que os uploads de arquivos sejam tratados com êxito pelo interceptor de upload de arquivos. O próximo ponto a ser observado é o método de ação do formulárioupload e o nome do campo de upload de arquivo - que é myFile. Precisamos dessas informações para criar o método de ação e a configuração do struts.

A seguir, vamos criar um arquivo jsp simples success.jsp para exibir o resultado de nosso upload de arquivo, caso seja um sucesso.

<%@ 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>

A seguir estará o arquivo de resultado error.jsp caso haja algum erro no upload do arquivo -

<%@ 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>

Criar classe de ação

A seguir, vamos criar uma classe Java chamada uploadFile.java que cuidará de enviar o arquivo e armazená-lo em um local seguro -

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;
   }
}

o uploadFile.javaé uma aula muito simples. O importante a observar é que o interceptor FileUpload, junto com o Parameters Interceptor, faz todo o trabalho pesado para nós.

O interceptor FileUpload disponibiliza três parâmetros para você por padrão. Eles são nomeados no seguinte padrão -

[your file name parameter] - Este é o arquivo real que o usuário carregou. Neste exemplo, será "myFile"
[your file name parameter]ContentType- Este é o tipo de conteúdo do arquivo que foi carregado. Neste exemplo, será "myFileContentType"
[your file name parameter]FileName- Este é o nome do arquivo que foi carregado. Neste exemplo, será "myFileFileName"

Os três parâmetros estão disponíveis para nós, graças aos Struts Interceptors. Tudo o que temos que fazer é criar três parâmetros com os nomes corretos em nossa classe Action e automaticamente essas variáveis são conectadas automaticamente para nós. Portanto, no exemplo acima, temos três parâmetros e um método de ação que simplesmente retorna "sucesso" se tudo correr bem, caso contrário, retorna "erro".

Arquivos de configuração

A seguir estão as propriedades de configuração do Struts2 que controlam o processo de upload de arquivos -

Sr. Não	Propriedades e descrição
1	struts.multipart.maxSize O tamanho máximo (em bytes) de um arquivo a ser aceito como upload de arquivo. O padrão é 250M.
2	struts.multipart.parser A biblioteca usada para carregar o formulário multiparte. Por padrão éjakarta
3	struts.multipart.saveDir O local para armazenar o arquivo temporário. Por padrão, é javax.servlet.context.tempdir.

Para alterar qualquer uma dessas configurações, você pode usar constant tag no arquivo struts.xml de seus aplicativos, como fiz para alterar o tamanho máximo de um arquivo a ser carregado.

Deixe-nos ter nosso struts.xml como segue -

<?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>

Desde a, FileUploadinterceptor é uma parte da pilha de interceptores padrão, não precisamos configurá-lo explicitamente. Mas, você pode adicionar a tag <interceptor-ref> dentro de <action>. O interceptor fileUpload leva dois parâmetros(a) maximumSize e (b) allowedTypes.

O parâmetro maximumSize define o tamanho máximo de arquivo permitido (o padrão é aproximadamente 2 MB). O parâmetro allowedTypes é uma lista separada por vírgulas de tipos de conteúdo aceito (MIME), conforme mostrado abaixo -

<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>

A seguir está o conteúdo de web.xml arquivo -

<?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>

Agora clique com o botão direito no nome do projeto e clique Export > WAR Filepara criar um arquivo de guerra. Em seguida, implante esse WAR no diretório webapps do Tomcat. Finalmente, inicie o servidor Tomcat e tente acessar o URLhttp://localhost:8080/HelloWorldStruts2/upload.jsp. Isso produzirá a seguinte tela -

Agora selecione um arquivo "Contacts.txt" usando o botão Browse e clique no botão upload que fará o upload do arquivo em seu servidor e você verá a próxima página. Você pode verificar se o arquivo carregado deve ser salvo em C: \ apache-tomcat-6.0.33 \ work.

Observe que o FileUpload Interceptor exclui o arquivo carregado automaticamente, então você terá que salvar o arquivo carregado programaticamente em algum local antes de ser excluído.

Mensagens de erro

O interceptor fileUplaod usa várias chaves de mensagem de erro padrão -

Sr. Não	Chave e descrição da mensagem de erro
1	struts.messages.error.uploading Um erro geral que ocorre quando o arquivo não pode ser carregado.
2	struts.messages.error.file.too.large Ocorre quando o arquivo carregado é muito grande, conforme especificado por maximumSize.
3	struts.messages.error.content.type.not.allowed Ocorre quando o arquivo carregado não corresponde aos tipos de conteúdo especificados especificados.

Você pode substituir o texto dessas mensagens em WebContent/WEB-INF/classes/messages.properties arquivos de recursos.