Usando JExcel API numa aplicação WEB Struts

Usando JExcel API numa aplica��o WEB Struts

Crie uma aplica��o web que edita planilhas do Microsoft Excel

Hoje em dia as empresas usam planilhas Excel para organizar quase tudo que ainda n�o � organizado por um sistema. Muitas vezes, mesmo havendo um sistema espec�fico para determinada tarefa (como o MS Project para gerenciamento de projetos ou JIRA para controle de Trouble Tickets), muitos ainda preferem usar planilhas Excel, por sua flexibilidade e facilidade de uso. Dessa forma, torna-se extremamente �til poder criar sistemas web que saibam manipular planilhas Excel, que � o que veremos nesse artigo.

Pr�-requisitos

� suporto que o leitor saiba usar a ferramenta ANT para empacotar a aplica��o em um arquivo WAR (Web Archive). Tamb�m � suporto que o mesmo saiba usar algum IDE Java para trabalhar com o c�digo fonte que criaremos e a usar um Web Server como o Apache Tomcat para rodar a aplica��o criada.

� necess�rio tamb�m baixar a vers�o 1.3.8 do framework Struts, que pode ser encontrado no site http://struts.apache.org e a JExcel API, que pode ser encontrada no site http://jexcelapi.sourceforge.net/. N�o se esque�a de ter o ANT instalado em sua m�quina no PATH do sistema.

Definindo a aplica��o

A aplica��o que criaremos ser� bem simples, mas suficiente para os fins de demonstra��o ao qual esse artigo se prop�e. Nossa aplica��o ter� uma p�gina inicial que permite ao usu�rio escolher um arquivo Excel em sua m�quina para formata��o. Ao clicar no bot�o �Formatar�, o arquivo ser� enviado ao servidor e ser� feita uma varredura em todas as c�lulas de cada planilha. Todas as c�lulas num�ricas ter�o sua cor de fundo alterada para vermelho e todas as c�lulas com texto, para azul.

Criando a aplica��o

Crie uma pasta raiz para a aplica��o em seu disco, com o nome de JExcelApiStrutsExample. Essa pasta pode ser a pasta de seu projeto no seu IDE predileto. Dentro dessa pasta, crie as seguintes subpastas:

src:para guardar os arquivos �.java�
lib:para guardar os arquivos �.jar� de depend�ncia
build:para guardar o build do ANT
etc:para guardar arquivos .properties
web/jsp: para guardar os JSPs
web/WEB-INF:para guardar deployment descriptors.
web/tld:para guardar arquivos de Tag library, como os que vem com o Struts.

Copie os JARS necess�rios do struts e da JExcel API para a pasta libs. Isso inclui o arquivo jxl.jar da JExcel API e todos os JARs inclu�dos na pasta lib da distribui��o do struts. Copie os arquivos TLD do struts para a pasta web/tld.

Crie um arquivo chamado index.jsp dentro da pasta web, conforme mostra a listagem 1. Esse � o �nico arquivo que ficar� fora da pasta JSP. Coloque o seguinte conte�do no mesmo:

<%@ taglib uri="/tags/struts-logic" prefix="logic" %>

<logic:redirect forward="welcome"/>

Listagem 01. Arquivo web/index.jsp

Tudo o que esse JSP faz � redirecionar a p�gina atual para o JSP definido como welcome na configura��o do struts.

Como nossa aplica��o � bem simples, usaremos s� mais um JSP. Crie um arquivo chamado Welcome.jsp na pasta web/jsp e ent�o coloque nele o conte�do da listagem 2.

<%@ taglib uri="/tags/struts-bean" prefix="bean"%>

<%@ taglib uri="/tags/struts-html" prefix="html"%>

<%@ taglib uri="/tags/struts-logic" prefix="logic"%>

<html:html>

<head>

<title>Exemplo JExcel API</title>

</head>

<html:base />

<h3>Exemplo JExcel API</h3>

<p>Por favor, escolha o arquivo excel a ser analisdo</p>

<BR>

<html:form action="/FormatExcelAction.do" method="post"

enctype="multipart/form-data">

<html:file property="arquivo" title="Arquivo Excel" />

<html:submit title="Processar arquivo" />

</html:form>

</body>

</html:html>

Listagem 02. Arquivo web/jsp/Welcome.jsp

Esse JSP simplesmente usa algumas tag libs do Struts para renderizar um form HTML com um input do tipo arquivo e um bot�o submit. Perceba que o form foi configurado para ser enviado via m�todo POST com a codifica��o de multipart. Isso far� com que arquivo selecionado seja enviado pelo pr�prio stream http (e n�o como par�metro da URL) e tamb�m far� com que o arquivo bin�rio seja transformado em texto para que possa ser enviado viu http, numa codifica��o MIME espec�fica para esse fim. O importante disso tudo � que quando o arquivo for recebido no lado do servidor, ser� preciso codific�-lo de volta para bin�rio.

Antes de complicarmos mais, vejamos como ficam o web.xml e o struts-config.xml, nas listagens 3 e 4, respectivamente.

<?xml version="1.0" encoding="ISO-8859-1"?>

<!DOCTYPE web-app

PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"

"http://java.sun.com/j2ee/dtds/web-app_2_2.dtd">

<web-app>

<display-name>JExcel Api Struts Example</display-name>

<servlet-name>action</servlet-name>

<servlet-class>org.apache.struts.action.ActionServlet</servlet-class>

<init-param>

<param-name>config</param-name>

<param-value>/WEB-INF/struts-config.xml</param-value>

</init-param>

<init-param>

<param-name>debug</param-name>

<param-value>2</param-value>

</init-param>

<init-param>

<param-name>detail</param-name>

<param-value>2</param-value>

</init-param>

<load-on-startup>2</load-on-startup>

</servlet>

<servlet-mapping>

<servlet-name>action</servlet-name>

<url-pattern>*.do</url-pattern>

</servlet-mapping>

<welcome-file-list>

<welcome-file>index.jsp</welcome-file>

</welcome-file-list>

<taglib-uri>/tags/struts-bean</taglib-uri>

<taglib-location>/WEB-INF/tld/struts-bean.tld</taglib-location>

</taglib>

<taglib-uri>/tags/struts-html</taglib-uri>

<taglib-location>/WEB-INF/tld/struts-html.tld</taglib-location>

</taglib>

<taglib-uri>/tags/struts-logic</taglib-uri>

<taglib-location>/WEB-INF/tld/struts-logic.tld</taglib-location>

</taglib>

<taglib-uri>/tags/struts-nested</taglib-uri>

<taglib-location>/WEB-INF/tld/struts-nested.tld</taglib-location>

</taglib>

<taglib-uri>/tags/struts-tiles</taglib-uri>

<taglib-location>/WEB-INF/tld/struts-tiles.tld</taglib-location>

</taglib>

</web-app>

Listagem 03. Arquivo web/WEB-INF/web.xml

<?xml version="1.0" encoding="ISO-8859-1" ?>

<!DOCTYPE struts-config PUBLIC

"-//Apache Software Foundation//DTD Struts Configuration 1.3//EN"

"http://struts.apache.org/dtds/struts-config_1_3.dtd">

<struts-config>

<form-beans>

<form-bean name="FormatExcelForm" type="FormatExcelForm" />

</form-beans>

<global-exceptions></global-exceptions>

<global-forwards>

</global-forwards>

<action-mappings>

<action path="/FormatExcelAction" type="FormatExcelAction"

name="FormatExcelForm" scope="request" validate="false"

input="/WEB-INF/jsp/Welcome.jsp">

</action>

</action-mappings>

</struts-config>

Listagem 04. Arquivo web/WEB-INF/struts-config.xml

Nada demais, para quem j� est� acostumado com Struts, certo? Simplesmente configuramos o servlet controller do Struts no web.xml e indicamos as TLDS. No struts-config.xml, configuramos o forward welcome, que hav�amos usado no index.jsp, para que redirecionasse para o Welcome.jsp que criamos. Como esse �ltimo fica dentro de WEB-INF, n�o podemos acess�-lo diretamente, tornando nossa aplica��o mais bem feita em termos de seguran�a.

Tamb�m definimos uma action e um form. A action ser� chamada pelo bot�o submit de nosso formul�rio JSP e o form � um bean que conter� o arquivo transmitido. O forward �sucesso� � opcional, n�o vamos us�-lo em nosso exemplo, est� a� somente para ficar claro que n�o vamos sair nunca dessa p�gina.

Vejamos como ficou o bean Form que usamos na listagem 5.

import org.apache.struts.action.ActionForm;

import org.apache.struts.upload.FormFile;

public class FormatExcelForm extends ActionForm {

private static final long serialVersionUID = 4294242013432948993L;

private FormFile arquivo;

public FormFile getArquivo() {

return arquivo;

}

public void setArquivo(FormFile arquivo) {

this.arquivo = arquivo;

}

Listagem 05. Arquivo src/FormatExcelForm.java

O serial version UID existe somente pelo fato do arquivo implementar a interface Serializable. Perceba que usamos a classe FormFile do Struts. Essa classe faz parte do suporte que o Struts tem para upload de arquivos. Como temos uma propriedade desse tipo em nosso form com o mesmo nome do campo tipo �file� do formul�rio html (o nome da propriedade � �arquivo�), o Struts automaticamente ir� decodificar o arquivo de volta para bin�rio, colocar nessa propriedade atrav�s do m�todo setter e fornecer o form como par�metro para nossa action.

Vejamos como ficou a action na listagem 6:

import java.io.InputStream;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import jxl.Cell;

import jxl.CellType;

import jxl.Workbook;

import jxl.format.Colour;

import jxl.write.WritableCell;

import jxl.write.WritableCellFormat;

import jxl.write.WritableWorkbook;

import org.apache.struts.action.Action;

import org.apache.struts.action.ActionForm;

import org.apache.struts.action.ActionForward;

import org.apache.struts.action.ActionMapping;

import org.apache.struts.upload.FormFile;

public class FormatExcelAction extends Action {

public ActionForward execute(ActionMapping mapping, ActionForm form,

HttpServletRequest request, HttpServletResponse response)

throws Exception {

FormatExcelForm uploadForm = (FormatExcelForm) form;

FormFile arquivo = uploadForm.getArquivo();

try {

InputStream in = arquivo.getInputStream();

response.setContentType("application/vnd.ms-excel");

response.setHeader("Content-Disposition",

"attachment; filename=sampleName.xls");

// Cria workbook novo a partir do recebido

WritableWorkbook w = Workbook.createWorkbook(response

.getOutputStream(), Workbook.getWorkbook(in));

for (int i = 0; i < w.getNumberOfSheets(); i++) {

for (int j = 0; j < w.getSheet(i).getColumns(); j++)

for (int k = 0; k < w.getSheet(i).getRows(); k++) {

Cell celula = w.getSheet(i).getCell(j, k);

System.out.println("celula sheet(" + i + ") [" + j

+ ", " + k + "] = " + celula);

if (celula.getType() == CellType.NUMBER) {

WritableCellFormat novoFormato = new WritableCellFormat(

celula.getCellFormat());

novoFormato.setBackground(Colour.RED);

WritableCell celulaModificavel = w.getSheet(i)

.getWritableCell(j, k);

celulaModificavel.setCellFormat(novoFormato);

} else if (celula.getType() == CellType.LABEL) {

WritableCellFormat novoFormato = new WritableCellFormat(

celula.getCellFormat());

novoFormato.setBackground(Colour.AQUA);

WritableCell celulaModificavel = w.getSheet(i)

.getWritableCell(j, k);

celulaModificavel.setCellFormat(novoFormato);

}

w.write();

w.close();

} catch (Exception e) {

throw new Exception("Erro ao transformar o arquivo: ", e);

} finally {

}

return null;

}

Listagem 06. Arquivo src/FormatExcelAction.java

Aqui � que come�a a entrar a JExcel API. Atrav�s do FormFile que o Struts j� nos forneceu prontinho, s� precisamos conseguir um InputStream para ler os dados transmitidos. O que queremos fazer �: criar um novo arquivo Excel a partir desse, para que seja modificado e enviado como resposta.

Para tanto, obtemos tamb�m um OutputStream a partir do objeto response, usando o m�todo Response.getOutputStream(). Dessa forma, usamos o InputStream para recuperar os dados transmitidos pela p�gina e o OutputStream para transmitir os dados de volta.

Com a JExcel API, esse trabalho � facilitado. O comando

WritableWorkbook w = Workbook.createWorkbook(

response.getOutputStream(), Workbook.getWorkbook(in));

cria um novo objeto WorkBook modific�vel, que corresponde a uma planilha, no OutputStream, usando o arquivo transmitido como base. Ent�o n�s modificamos o Workbook e executamos os comandos

w.write();

w.close();

para escrever de fato o arquivo para a resposta http.

Perceba que setamos alguma propriedade importantes no objeto response:

response.setContentType("application/vnd.ms-excel");

response.setHeader("Content-Disposition",

"attachment; filename=sampleName.xls");

O primeiro comando dir� ao browser que um arquivo Excel est� sendo transmitido. A segunda linha indica que n�o estamos redirecionando para uma outra p�gina, mas sim para um download, de forma que o browser mostrar� uma tela ao usu�rio perguntando se ele deseja abrir ou salvar o arquivo sendo transmitido. Se escolher salvar, o arquivo ter� o nome default de sampleName.xls.

Mas afinal, o que fizemos no arquivo Excel? Fizemos um loop (ali�s, tr�s loops) pelo arquivo, percorrendo cada uma de suas worksheets. Para cada worksheet, usamos os comandos w.getSheet(i).getColumns() e w.getSheet(i).getRows() para percorrer por todas as c�lulas de cada sheet. O tamanho de cada sheet � retornado dependendo do conte�do existente em suas c�lulas.

Para cada c�lula, verificamos o tipo do conte�do. Se for um n�mero, pintamos a cor de vermelho e, se for texto est�tico (LABEL), pintamos de azul.

Foi muito importante criarmos um objeto do tipo WriteableCell para modificarmos o formato. A JExcel API faz distin��o entre Cell e WriteableCell, de forma que o �ltimo herda do primeiro. S� conseguimos modificar o arquivo porque criamos um objeto WritableWorkbook a partir do arquivo de entrada no OutputStream do response. N�o � poss�vel criar um objeto desses apenas a partir de um InputStream, somente um Workbook simples, n�o modific�vel.

Por �ltimo, mas n�o menos importante, falta o arquivo de build, para construirmos nossa aplica��o. Vejamos como ficou o nosso nas listagens 7 e 8:

tomcat_home=G:/dev_env/Tomcat5/

tomcatlib=${tomcat_home}/common/lib

tomcatapps=${tomcat_home}/webapps

lib=lib

debug_on=true

Listagem 07. Arquivo build/build.properties

<?xml version='1.0'?>

</target>

</fileset>

</fileset>

</classpath>

</javac>

</target>

</fileset>

</copy>

</fileset>

</copy>

</fileset>

</copy>

</fileset>

</copy>

</fileset>

</copy>

</fileset>

</lib>

</war>

</target>

</target>

</target>

</project>

Listagem 08. Arquivo build/build.xml

O build.properties simplesmente configura algumas propriedades a serem usadas no build.xml, como a pasta onde se encontra instalado o tomcat, pastas onde se encontram as libs e op��es de debug. O segundo tem os targets para constru��o. O target init simplesmente cria uma pasta dist dentro do projeto, o target compile compila os arquivos .Java e os joga para dentro de dist, o target package copie os arquivos do projeto para uma estrutura de pastas de um arquivo war dentro de DIST e gera o WAR a partir da mesma. Finalmente, existe um target deploy, que copia o WAR gerado para dentro da pasta webapps do Tomcat, apagando primeiro a vers�o anterior.

Vejamos como funciona a aplica��o rodando:

Figura 01. Entrando na aplica��o

Figura 02. Escolhendo um arquivo exemplo

Figura 03. Arquivo exemplo original

Figura 04. Clicando no bot�o submit

Figura 05. Arquivo exemplo depois do processamento

A �ltima linha n�o foi modificada, pois era uma f�rmula. Poder�amos t�-la modificado tamb�m, bastante verificar seu tipo.

Agora � sua vez! Baixe a JExcel API e manipule arquivos Excel a vontade em suas aplica��es web! At� o pr�ximo artigo.

Tecnologias:

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

Assista grátis a nossa aula inaugural

Perguntas frequentes

Quem somos?

Por que a programação se tornou a profissão mais promissora da atualidade?

Como faço para começar a estudar?

Em quanto tempo de estudo vou me tornar um programador?

Sim, você pode se tornar um programador e não precisa ter diploma de curso superior!

O que eu irei aprender estudando pela DevMedia?

Principais diferenciais da DevMedia

Qual o investimento financeiro que preciso fazer para me tornar um programador?

Como funciona a forma de pagamento da DevMedia?

Por Marcelo Em 2007

Nossos casos de sucesso

Leonardo Carlos

Eu sabia pouqu�ssimas coisas de programa��o antes de come�ar a estudar com voc�s, fui me especializando em v�rias �reas e ferramentas que tinham na plataforma, e com essa bagagem consegui um est�gio logo no in�cio do meu primeiro per�odo na faculdade.

Lucas Rodrigues

Estudo aqui na Dev desde o meio do ano passado! Nesse per�odo a Dev me ajudou a crescer muito aqui no trampo.
Fui o primeiro desenvolvedor contratado pela minha empresa. Hoje eu lidero um time de desenvolvimento!
Minha meta � continuar estudando e praticando para ser um Full-Stack Dev!

Her�clito J�nior

Economizei 3 meses para assinar a plataforma e sendo sincero valeu muito a pena, pois a plataforma � bem intuitiva e muuuuito did�tica a metodologia de ensino. Sinto que estou EVOLUINDO a cada dia. Muito obrigado!

Julio Cablen

Nossa! Plataforma maravilhosa. To amando o curso de desenvolvimento front-end, tinha coisas que eu ainda n�o tinha visto. A did�tica � do jeito que qualquer pessoa consegue aprender. S�rio, to apaixonado, adorando demais.

Joelberth Sena

Adquiri o curso de voc�s e logo percebi que s�o os melhores do Brasil. � um passo a passo incr�vel. S� n�o aprende quem n�o quer. Foi o melhor investimento da minha vida!

Felipe Nunes

Foi um dos melhores investimentos que j� fiz na vida e tenho aprendido bastante com a plataforma. Voc�s est�o fazendo parte da minha jornada nesse mundo da programa��o, irei assinar meu contrato como programador gra�as a plataforma.

Wanderson Oliveira

Comprei a assinatura tem uma semana, aprendi mais do que 4 meses estudando outros cursos. Exerc�cios pr�ticos que n�o tem como n�o aprender, est�o de parab�ns!

Jos� Lucas

Obrigado DevMedia, nunca presenciei uma plataforma de ensino t�o presente na vida acad�mica de seus alunos, parab�ns!

Eduardo Dorneles

Aprendi React na plataforma da DevMedia h� cerca de 1 ano e meio... Hoje estou h� 1 ano empregado trabalhando 100% com React!

Adauto Junior

J� fiz alguns cursos na �rea e nenhum � t�o bom quanto o de voc�s. Estou aprendendo muito, muito obrigado por existirem. Est�o de parab�ns... Espero um dia conseguir um emprego na �rea.

Ver todos os casos de sucesso

Usando JExcel API numa aplica��o WEB Struts

Crie uma aplica��o web que edita planilhas do Microsoft Excel.

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

Perguntas frequentes

Nossos casos de sucesso