Ejemplo básico con Spring MVC Portlet

0. Índice de
contenidos.

• 1. Entorno
  
• 2. Introducción
  
• 3. Creando el proyecto con Maven
  
• 4. Configurando las dependencias del proyecto
• 5. Configurando el
  web.xml
• 6. Configurando el applicationContext.xml
  
• 7. Configurando el portlet.xml
  
• 8. Configurando el spring-mvc-prueba-portlet.xml
  
• 9. Creando la clase controladora
  
• 10. Creando la vista por defecto (view.jsp)
  
• 11. Configurando el portlet para hacerlo funcionar
  en Liferay
  
• 12. Desplegando el portlet en Liferay
  
• 13. Conclusiones
  

1. Entorno

Este tutorial está escrito usando el siguiente entorno:

• Hardware: Portátil Mac Book Pro 17″ (2,6 Ghz Intel Core
  i7, 8 GB
  DDR3)
• Sistema Operativo: Mac OS X Snow Leopard 10.6.4
• Spring MVC Portlet 3.0.4
• Maven 2.2.1
• Eclipse 3.6 (Helios) con M2Eclipse
• Liferay 6.0.5

2. Introducción

En este tutorial vamos a ver paso a paso cómo crear un portlet
muy básico con la ayuda de Spring MVC Portlet, desde su
creación con Maven hasta su despliegue en Liferay.
Servirá como base para la creación de portlets más
complejos utilizando esta tecnología.

3. Creando el proyecto con Maven

En este tipo de proyectos en los que vamos a utilizar librerías
de
terceros como Spring, se hace especialmente útil la
utililización de
una herramienta de gestión de dependencias como Maven. Teniendo
Maven
ya instalado en nuestra máquina lo único que tenemos que
hacer es abrir
un terminal y situarnos en el directorio donde vayamos a crear el
proyecto de tipo web con el siguiente comando:

mvn archetype:create -DgroupId=com.autentia -DartifactId=spring-mvc-portlet-prueba -DarchetypeId=maven-archetype-webapp

NOTA: para los usuarios de Liferay, existe un arquetipo que crea el
proyecto con el ficheros necesarios de despliegue para Liferay. En este
caso el comando sería:

mvn archetype:create -DgroupId=com.adictos.portlet -DartifactId=maven-portlet -DarchetypeArtifactId=liferay-portlet-archetype -DarchetypeGroupId=com.liferay.maven.archetypes -DarchetypeVersion=6.0.5

Podréis encontrar más detalles en este tutorial: http://www.adictosaltrabajo.com/tutoriales/tutoriales.php?pagina=mavenliferay

4. Configurando las dependencias del proyecto

Con el fin de que la edición del proyecto sea más
cómoda podemos
importarlo a un IDE como Eclipse. Para hacer esto, contamos con el
plugin M2Eclipse que es la evolución del conocido EclipseIAM.

Para configurar las dependencias editamos el fichero pom.xml del
proyecto, añadiendo las siguientes:

	org.springframework
	spring-webmvc-portlet
	3.0.4.RELEASE


	javax.servlet
	jstl
	1.2


	javax.portlet
	portlet-api
	2.0
	provided

La librería portlet-api tiene el scope a provided porque es
necesaria
para compilar el proyecto, pero debe ser proporcionada por el gestor de
portales donde vayamos a desplegar nuestro proyecto. Utilizamos una
versión a partir de la 3.0.x para poder hacer uso del
estándar JSR-286 o más conocido como Portlet 2.0.

5. Configurando el web.xml

Ahora tenemos que editar el fichero web.xml de nuestro proyecto para
intregar nuestro desarrollo con Spring MVC Portlet, de tal modo que
tenemos que añadir los siguientes elementos:

	spring-mvc-prueba-portlet

	
	
		contextConfigLocation
		/WEB-INF/context/applicationContext.xml
	

	
	
		org.springframework.web.context.ContextLoaderListener
	

	
	
		ViewRendererServlet
		org.springframework.web.servlet.ViewRendererServlet
		1
	

	
		ViewRendererServlet
		/WEB-INF/servlet/view
	

En primer lugar definimos el parámetro contextConfigLocation
para
establecer donde vamos a almacenar el fichero de configuración
de
Spring de nuestro proyecto, en este caso será dentro de la
carpeta
WEB-INF/context con el nombre applicationContext.xml. Luego tenemos que
crear
el listener y el servlet necesarios para trabajar con Spring MVC.

6. Configurando el applicationContext.xml

Si no lo hemos hecho, ya este es un buen momento para instalar el
plugin Spring IDE en nuestro Eclipse, ya que nos va a facilitar la
tediosa tarea de tener que generar los encabezados de los ficheros de
configuración de Spring.

Creamos el fichero WEB-INF/applicationContext.xml donde vamos a
determinar el comportamiento de Spring dentro de nuestro proyecto. Para
ello añadimos el siguiente contenido:

Estamos determinando que vamos a utilizar anotaciones y que Spring
tiene que comenzar a escanear cuando tenga que localizar un bean, a
partir de la ruta del paquete que establezcamos en el valor
base-package.

7. Configurando el portlet.xml

La gente que ya está acostumbrada al desarrollo de portlet ya
sabe que en este fichero se definen las características de
nuestro portlet: cuál es su ID, que modos de trabajo va a tener,
cuál va a ser el fichero de internacionalización, … y
sobre todo que clase se va a encargar de implementar la lógica
del portlet.

Pues bien, en este caso, todo va a ser igual, sólo que la clase
encargada de implementar el portlet siempre va a ser la misma
org.springframework.web.portlet.DispatcherPortlet que requiere la
inicialización del parámetro contextConfigurationLocation
con la ruta del fichero de Spring que se va a encargar de manejar
nuestro portlet. Este es un posible código de ejemplo:

	
		spring-mvc-prueba-portlet
		spring-mvc-prueba-portlet
		org.springframework.web.portlet.DispatcherPortlet
		
			contextConfigLocation
			/WEB-INF/context/portlet/spring-mvc-prueba-portlet.xml
		
		0
		
			text/html
		
		
			
			spring-mvc-prueba-portlet
			spring-mvc-prueba-portlet
		
	

8. Configurando el spring-mvc-prueba-portlet.xml

Ahora tenemos que crear el fichero de configuración de Spring
para nuestro portlet. La información más importante de
este fichero es qué controlador se va a encargar de manejar las
peticiones y cómo se va a mostrar la vista. En este caso vamos a
tener un controlador para todas las peticiones que se realicen en el
estado de la vista del portlet y vamos a mostrar el contenido a
través de páginas JSP.

Estas definiciones se corresponden con el siguiente contenido:

9. Creando la clase controladora

Para la creación del controlador utilizamos la convención
frente a la configuración por lo que vamos a crear una clase
controladora del mismo nombre (salvo empezando por mayúsculas)
que el id del bean referenciado en la entrada key=»view».

Por lo tanto vamos a crear la clase
SpringMVCPruebaPortletViewController dentro de un paquete que este en
el alcance del escaneado de Spring, por ejemplo,
com.autentia.springmvcpruebaportlet.controllers con el siguiente
contenido:

package com.autentia.springmvcpruebaportlet.controllers;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("VIEW")
public class SpringMVCPruebaPortletViewController {

	public SpringMVCPruebaPortletViewController() {
	}

	@RequestMapping
	protected String defaultView() {
		return "view";
	}

}

Este es el contenido mínimo que tiene que tener nuestro
controlador. Con la anotación @Controller estamos definiendo que
es un controlador manejado por Spring y por tanto implícitamente
estamos creando el bean asociado dentro de nuestro fichero de
configuración. Con la anotación @RequestMapping(«VIEW»)
estamos estableciendo que este controlador se va a encargar de la vista
del portlet y con la anotación @RequestMapping sin ningún
parámetro adicional estamos estableciendo que ese método
es el que se va a ejecutar por defecto.

En Spring MVC Portlet, tenemos que dintiguir dos tipos de
métodos: lo que devuelven String y los que no devuelven nada
(void). Los del primer caso se corresponden con métodos Render
donde el String que devuelven le indica a Spring que tiene que buscar
un .jsp dentro de la carpeta establecida con ese nombre, para mostrarlo
en la vista del portlet. Los del segundo caso se corresponden con
métodos Action que reciben las peticiones del usuarios, ejecutan
la lógica asociada y establecen que método Render va a
ser el siguiente a ejecutar, en caso de no establecer ninguno, se
ejecutaría el de por defecto, anotado con @RequesMapping sin
parámetros adicionales.

10. Creando la vista por defecto (view.jsp)

Como se puede ver en el código anterior estamos definiendo que
la vista por defecto muestre el fichero view.jsp. Por tanto tenemos que
crear este fichero dentro de la ruta configurado en el ViewResolver de
nuestro portlet con el siguiente contenido, por ejemplo:

<%@ taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet" %>



This is the spring-mvc-prueba-portlet.

11. Configurando el portlet para hacerlo
funcionar en Liferay

Hasta este punto nuestro desarrollo es perfectamente portable a
cualquier gestor de portales que queramos utilizar (a no ser que se
haya utilizado el arquetipo de Liferay definido en el punto 3, en cuyo
caso podemos obviar este punto).

Para hacer funcionar nuestro desarrollo en Liferay tenemos que crear
los siguientes ficheros de configuración dentro de la carpeta
WEB-INF de nuestro proyecto:

liferay-display.xml: que define la categoría del árbol de
portlets donde vamos a encontrarlo a la hora de instanciarlo en una
página. Este es un contenido de ejemplo:

liferay-portlet.xml que le da información extra de
características sólo aplicables a Liferay como si va a
llevar un icono, si va a ser instanciable, que ficheros CSS y
Javascript tiene que cargar, …

	
		spring-mvc-prueba-portlet
		/icon.png
		true
		/css/main.css
		/js/main.js
	

liferay-plugin-package.properties: que determina información del
tipo autoría del plugin, versión, compatibilidad con
otras versiones, etc …

name=spring-mvc-prueba-portlet
module-group-id=liferay
module-incremental-version=1
tags=
short-description=
change-log=
page-url=http://www.liferay.com
author=Liferay, Inc.
licenses=LGPL

12. Desplegando el portlet en Liferay

Para probar el resultado en Liferay basta con empaquetar nuestro
desarrollo a través del plugin de Eclipse o a través del
terminal, ejecutando dentro de la carpeta del proyecto el comando:

mvn clean package

Y ahora trasladar el .war resultante a la carpeta deploy de nuestro
Liferay. En caso de que esté en ejecución el despliegue
se realizará en caliente y ya podremos instanciar nuestro con
Spring MVC dentro de la página que queramos.

Los que estén utilizando el arquetipo de Maven para Liferay, se
pueden ahorrar este paso ejecutando el siguiente comando por el terminal:

mvn liferay:deploy

Pero es muy importante indicar que esto sólo hace el traslado
del .war a la carpeta que le indicamos en la propiedad
<liferay.auto.deploy.dir> del pom.xml y que no generá el
empaquetado, por lo que antes de ejecutarlo, siempre hay que hacer, un
empaquetado para que se despliegue la última versión del
plugin.

13. Conclusiones

Cómo véis no es díficil crear un portlet con
Spring MVC y las ventajas que nos reporta van a ser muchas. Por
ejemplo, nos facilita la navegación cuando nuestro portlet tiene
muchas pantallas, nos permite hacer pruebas unitarias de nuestros
controladores a través de Mocks, implementación de
validadores y buena forma de desacoplar nuestros desarrollos del gestor
de portales. Pero esto lo iremos viendo en sucesivos tutoriales, donde
crearemos un portlet para la gestión CRUD de una entidad
utilizando Spring MVC Portlet e iremos viendo otras anotaciones
fundamentales y técnicas necesarias.

Saludos.