fev 27 2010

Spring MVC 3.0 na prática – Parte 1

Category: Spring MVC 3.0Edson Gonçalves @ 2:50

Olá, tudo bom? Como vão vocês?
Este artigo é o primeiro de uma série ao qual vou ensiná-los a trabalhar com o Spring MVC 3.0.
Nesta primeira parte iremos conhecer o framework Spring MVC 3.0 através de um simples exemplo no estilo “Hello World!”.
Dúvidas e críticas são bem vindas.

Iniciando com o Spring MVC 3.0

Embora no Brasil o mais famoso do Spring Framework seja sua implementação tradicional como contêiner IoC (Inversion of Control – Inversão de Controle[¹]), também temos um excelente framework Web chamado de Spring MVC.

O Spring MVC é um framework open-source que usa como princípio o design MVC  Model 2, ao qual possui suporte, em sua view, também para outras tecnologias como: JSP/JSTL/Tiles, XML/XSLT, Velocity e  FreeMarker. A integração com JasperReports e exportação de documentos para PDF e Excel também estão inclusas.

Em Spring MVC 3.0 – Parte 1, iremos aprender a configurar um ambiente e rodar um exemplo simples utilizando o Spring MVC 3.0.

Download do Framework

Para trabalhar com o Spring MVC 3.0, você deve realizar o download na página: http://www.springsource.org/download. No momento em que este artigo é escrito, a versão utilizada é a Spring Framework 3.0.1.RELEASE. Clique em Download. Neste framework, temos mais de uma opção para baixar. Vamos escolher apenas o framework, cujo tamanho é o menor de todos.

Download do Spring Framework em sua página oficial

Figura 1 - Download do Spring Framework em sua página oficial

Ao baixar, descompacte o arquivo extraindo todos os JARs existentes no diretório lib.

O ambiente de trabalho

A própria empresa responsável pelo Spring Source, divisão da VMware, possui uma ferramenta completa, criada sobre a plataforma Eclipse, chamada de SpringSource Tools Suite.

Para baixar o SpringSource Tools Suite, clique aqui, preencha o formulário e faça o Download. Como a ferramenta possui uma opção de instalador, use-a como facilitador se desejar. Na própria página onde baixar o arquivo, haverá a explicação da instalação em cada plataforma, em Installation Instructions.

Criando um projeto

No SpringSource Tools Suite, clique no menu File>New>Dynamic Web Project. Na caixa de diálogo New Dynamic Web Project, digite ConhecendoSpringMVC (ou o nome que desejar dar) em Project name.

O SpringSource Tools Suite possui embutido um servidor de aplicações Java Web baseado no Apache Tomcat 6, só que com algumas modificações. Como já o temos por padrão, ele será utilizado no primeiro projeto de exemplo.  Confirme no botão Finish.

Criando o projeto ConhecendoSpringMVC

Figura 2 - Criando o projeto Conhecendo SpringMVC

O Apache Tomcat no Projeto

Caso deseje configurar o Apache Tomcat 6.0.x, pode ser adicionado através do botão New. Siga os passos a seguir para instalar:

1) Expanda Apache e selecione Apache Tomcat v6.0. Clique em Next;

Selecionando o Apache Tomcat v6.0 para adicionar a ferramenta

Figura 3 - Selecionando o Apache Tomcat v6.0 para adicionar a ferramenta

2) Na etapa seguinte, em Tomcat Server, selecione Download and Install;

Baixando e Instalando o servidor Apache Tomcat

Figura 4 - Baixando e Instalando o servidor Apache Tomcat

3) Antes de baixar, aceite os termos de licença. Confirme no botão Finish.

Termos de licença para a instalação automática do Tomcat

Figura 5 - Termos de licença para a instalação automática do Tomcat no SO Windows 7

Determine o local onde será instalado o Apache Tomcat e confirme. Retornando a etapa onde determinamos o local de instalação do Tomcat, se houver erro de não reconhecimento após baixá-lo (veja a execução do download na barra de status da ferramenta), clique em Browse e OK novamente para que seja reconhecido o local de instalação. Por fim, confirme em Finish.

Finalizando o projeto

Após retornar a etapa final do projeto, confirme no botão Finish. O SpringSource Tools Suite pedirá para que você mude de perspectiva. E confirme.

Associando a perspectiva ao tipo de projeto a ser criado

Figura 6 - Associando a perspectiva ao tipo de projeto a ser criado

Ao finalizar o assistente, terá um projeto criado e acessível através da view Project Explorer.

Projeto com sua estrutura gerada

Figura 7 - Projeto com sua estrutura gerada

Adicionando as bibliotecas ao projeto

Clique com o direito sobre o projeto, na view Project Explorer e selecione, no menu de contexto, o item Properties.

Na caixa de diálogo aberta, vá até Java EE Module Dependencies e adicione os seguintes JARs do Spring Framework que descompactou (através do botão Add JARs):

org.springframework.asm-3.0.1.RELEASE-A.jar
org.springframework.beans-3.0.1.RELEASE-A.jar
org.springframework.context.support-3.0.1.RELEASE-A.jar
org.springframework.context-3.0.1.RELEASE-A.jar
org.springframework.core-3.0.1.RELEASE-A.jar
org.springframework.expression-3.0.1.RELEASE-A.jar
org.springframework.web.servlet-3.0.1.RELEASE-A.jar
org.springframework.web-3.0.1.RELEASE-A.jar

Após adicionar estes JARs, clique em OK para confirmar.

Bibliotecas do Spring Framework adicionadas ao projeto

Figura 8 - Bibliotecas do Spring Framework adicionadas ao projeto

Seu primeiro projeto Spring MVC 3.0

O projeto deste artigo como início será o famoso “Hello World”, necessário para compreendermos as configurações básicas do framework.

Configurando o web.xml

Dê um duplo clique em  Deployment Descriptor na view Project Explorer e altere o arquivo conforme é exibido na Listagem 1:

Listagem 1 – Configurações do Spring Framework no web.xml

Para que o Spring funcione, incluindo o seu módulo MVC, utilizamos o servlet org.springframework.web.servlet.DispatcherServlet, configurado no arquivo web.xml da aplicação.

Por padrão, o Spring MVC procura por beans em arquivos de configuração do próprio framework cujo o princípio de nome possui um similar ao do Servlet configurado no web.xml, seguido de -servlet.xml. A Listagem 2 coloca em prática esta situação, criando o arquivo springmvc-servlet.xml.

Criando o arquivo springmvc-servlet.xml

Para criar o arquivo, clique com o direito do mouse sobre o diretório WebContent/WEB-INF, selecionando no menu de contexto o item XML.

Se estiver utilizando o SpringSource Tool Suite, selecione no menu de contexto o item New>Other.

Na caixa de diálogo New, selecione Spring>Spring Bean Configuration File e prossiga no assistente.

Criando um arquivo de configuração do Spring

Figura 9 - Criando um arquivo de configuração do Spring

Na segunda etapa, mantenha o diretório WEB-INF selecionado e digite o nome do arquivo de springmvc-servlet.xml. Tirando “–servlet.xml”, o nome springmvc foi definido por você no arquivo web.xml da Listagem 1.

Definindo o nome do arquivo

Figura 10 - Definindo o nome do arquivo

Na terceira etapa, selecione os seguintes namespaces e seus respectivos XSDs:

beans – http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd

context – http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd

Seleção do primeiro namespace do arquivo de configuração do Spring MVC

Figura 11 - Seleção do primeiro namespace do arquivo de configuração do Spring MVC

Listagem 2 – Configurações do arquivo springmvc-servlet.xml

O arquivo springmvc-servlet.xml é lido graças ao seguinte trecho encontrado dentro do arquivo web.xml:

Com a classe org.springframework.web.servlet.view.InternalResourceViewResolver, pré-fixamos o caminho das páginas em /WEB-INF/jsp/ e com o sufixo “.jsp”. InternalResourceViewResolver é uma subclasse de UrlBasedViewResolver, que suporta JSTL, também usada em nossas views.

Como boa prática recomendada pelo Spring, colocamos as páginas JSP dentro do diretório WEB-INF, impedindo assim seu acesso direto, manualmente, através da URL.

Criando o Controller

Com o direito do mouse sobre  Java Resources:src, selecione no menu de contexto New>Class. Na caixa de diálogo New Java Class, digite o pacote e, em OlaMundoController no campo Name. Confime em Finish a criação da classe.

Criação da classe OlaMundoController

Figura 12 - Criação da classe OlaMundoController

Altere a classe como mostrado na Listagem 3.

Listagem 3 – A classe OlaMundoController

Desde a versão do Spring MVC 2.5, podemos declarar uma classe controller utilizando simplesmente a anotação @Controller, de org.springframework.stereotype.Controller. Esta anotação permite que o Spring faça uma varredura automatica nas classes através do elemento <context:component-scan>.

Através da anotação @RequestMapping, definimos o caminho HTTP que será utilizado na aplicação, sendo mapeada pela classe. Na prática, todas as chamadas à aplicação contendo “/ola” serão analisadas pela classe controller.

DispatcherServlet (configurado no arquivo web.xml – Listagem 1) é o responsável por receber todas as requisições do cliente, executando a parte comum destes pedidos e delegando implementações específicas para os controllers. Este servlet é responsável por ler todas as configurações e usar a leitura de componentes deste framework.

Após DispatcherServlet receber o pedido e fazer o seu trabalho, ele tenta encontrar um controller, usando a interface HandlerMapping (implementada pelos objetos que definem um mapeamento entre requisições e manipulações).

Ao encontrar o controller, o método handleRequest(HttpServletRequest request, HttpServletResponse response) é chamado com a responsabilidade do pedido e, caso seja necessário, retorna um adequado ModelAndView.  Como padrão, uma instância de ModelAndView consiste em um nome da view e um Map, que contém nomes do bean e objetos correspondentes (como um comando ou formulário, contendo dados).

No caso, o Controller chama a view ola e passa mensagem com o valor de “Conhecendo o Spring MVC 3.0”.

Criando a View

Clique com o direito sobre o diretório WebContent/WEB-INF e selecione, no menu de contexto, o item New>Folder. Chame este diretório de jsp. Estamos fazendo isso porque será onde adicionaremos a página JSP. Este nome foi configurado no arquivo springmvc-servlets.xml, conforme a Listagem 2 no elemento <property value=”/WEB-INF/jsp/”/>.

Clique novamente com o direito do mouse, só que, desta vez,  sobre o diretório jsp recém criado, selecionando New>JSP.

Na caixa de diálogo chame de ola.jsp e clique no bota Finish. Altere como mostrado na Listagem 4.

Listagem 4 – A View ola.jsp

Para visualizar a página, digite em seu navegador:

http://localhost:8080/ConhecendoSpringMVC/ola

Resultado da saída gerada pelo Spring MVC 3.0

Figura 13 - Resultado da saída gerada pelo Spring MVC 3.0

O projeto

O resultado final de todos os arquivos criados e configurados no projeto será como mostrado na Figura 14.

Figura 14 – O projeto completo

Figura 14 – O projeto completo


[¹] Veja mais sobre IoC e DI no site do Martin Fowler: http://martinfowler.com/articles/injection.html

Tags: , , ,

29 Responses to “Spring MVC 3.0 na prática – Parte 1”

  1. ROGÉRIO RODRIGUES says:

    Muito bom.

    Boa iniciativa, ainda mais agora que estou começando a estudar.

    Parabéns!

  2. Gefson LD says:

    Ótimo,

    Este blog está começando com o pé direito, todos os assuntos abordados até agora me despertam grande interesse.

    Parabéns!

  3. Edson Gonçalves says:

    @Gefson, obrigado!
    Continue acompanhando que vem mais novidades.
    Abraços

  4. Edson Gonçalves says:

    @Rogério,
    Obrigado

  5. Edinei says:

    Está de parabéns Edson.. Fiquei sabendo do seu blog após ler o ótimo livro “Dominando Java Server Faces e Facelets”. Leitura clara e objetiva sempre…. Muito bom !!!

  6. Edson Gonçalves says:

    @Edinei,

    Obrigado e bons Códigos!

  7. Sandro says:

    Olá Edson,

    Muito legal o post… Estou tentando fazer alguns exemplos, mas surgiu uma dúvida iniciante. Tenho algumas requisições já mapeadas através do @RequestMapping, também tenho minha página principal (login) na qual está mapeada @RequestMapping(value = “/login”). Como faço porém para restringir as requisições para ser autenticadas primeiro, proibindo por exemplo o acesso direto em alguma página particular, pois no meu caso o login está funcionando, mas consigo acessar as outras páginas sem passar pelo login.

    Obrigado

    Sandro

  8. Edson Gonçalves says:

    @Sandro,

    Estude o Spring Security. Tem posts a respeito aqui no blog.

    Bons Códigos!

  9. Lucas Campos says:

    Boa tarde, não sei mais o que fazer, já tentei de tudo, deixei o comando igual ao seu, nao dá certo, aparece toda hora: INFO: Servlet springmvc is currently unavailable, alguém me ajuda!!!!

  10. Edson Gonçalves says:

    @Lucas,

    Leia os logs. Tem algum erro ocorrendo que somente os logs do servidor Java poderão esclarecer.

  11. Lucas Campos says:

    Teria como vc salvar o arquivo em WAR e publicar?

  12. Lucas Campos says:

    Cara, eu consegui, finalemte!!!!!!! Só me faltou compilar o “OlaMundoController”, isso que dá ser novato… penei ahuhuauha

  13. Cassiano Raimar Silva says:

    Estou começando agora a fazer meu TCC e irei utilizar o spring framework. Seus posts estão sendo de grande valia. Muito obrigado. Se lançar um livro sobre spring já estou na fila para comprar.

  14. Felipe Arimatéia says:

    Edson tudo bom, voce tem algum material do spring mvc com RestFul

  15. Darlan de Moraes says:

    Realmente muito bom! Estou começando a usar spring e tive diversas dificuldades em encontrar um material simples de entender que fosse direto ao ponto… Parabéns

  16. joao says:

    pelo netbeans nao roda esse exemplo…

  17. Renan Reis says:

    Excelente artigo.

  18. Edson Gonçalves says:

    @João,

    O Spring MVC não é específico de uma ferramenta, portanto, colocando as bibliotecas corretas, roda 100%.

  19. Douglas says:

    Parabens, otimo artigo, mas estou tendo uns problemas pois qunado coloco o pacote jsp em WebContent ele apresenta a pagina em branco quando coloco dentro de WEB-INF ele da erro Status 404, não e so com este exemplo mas outros que tentei tambem deu o mesmo problema.(ja a varios dias e nao consigo resolver) alguem ja pssou por isso

  20. fred says:

    Muito atrativo e de fácil configuração em relação outros framework. Seria importante frisar mais informações sobre proceder outras partes como a criação de telas e menus.

  21. Rafael Casabona says:

    Cara, muito obrigado
    Esta matéria esta perfect, me ajudou muito. Iniciei meus estudos e acabei na Caelum agora, más tem alguns detalhes que estava me enrolando, más este material me ajudou muito.

    Abraços

  22. Victor says:

    FLW CARA!!! eu toh pesquisando vários sites só agora eu ACHEI graças a vc!!!

  23. Norberto says:

    Olá Edson, parabéns pelo tutorial. Me ajudou muito e todos seus códigos rodaram tranquilamente aqui.

    Muito obrigado.

  24. Ari says:

    Bom dia Edson.

    Fiz o download da ferramente conforme você disse, criei um novo projeto, porém não estou conseguindo achar dentro do properties do projeto o Java EE Dependencies.

    Você sabe o que pode ser?

    Obrigado desde já.

  25. Gil Cezar says:

    Muito bom Edson. Como outros já disseram. ficou muito mais claro para quem está começando, já que com a documentação oficial dá muita volta para se chegar no “How To”.
    Mas é sempre bom ler a documentação oficial também.
    Valeu.

  26. Anderson Dourado says:

    kra… muito obrigado… finalmente consegui por esse kra pra funcionar !!! / … ALELUIAA !!! (depois de qse 6hrs tentando !!! ç___Ç …) … vlws kra… 0/

  27. Miguel Arcanjo says:

    Muito bom, fiz o exemplo e rodou belezinha.
    Parabéns pela iniciativa, com certeza ajudou e irá ajudar muita gente.

  28. Carolina says:

    Edson, parabéns, este foi o melhor tutorial que eu encontrei.

Leave a Reply