En este captulo se dan a conocer todos los aspectos tcnicos de Spring, los conceptos bsicos, como sus creadores, sus caractersticas esenciales, las partes de su arquitectura, as como los componentes que lo conforman. En algunas partes se dan pedazos de cdigo con el fin de ejemplificar mejor cierta situacin. Este captulo es un anlisis un poco ms profundo de las diferentes partes que conforman la arquitectura de Spring. Con el fin de ejemplificar mejor la situacin de la aplicacin mencionada en el captulo siguiente se profundiz en la parte de Web MVC y J DBC. 3.1 Introduccin e historia Spring es un framework de aplicacin desarrollado por la compaa Interface 21, para aplicaciones escritas en el lenguaje de programacin J ava. Fue creado gracias a la colaboracin de grandes programadores, entre ellos se encuentran como principales partcipes y lderes de este proyecto Rod J ohnson y J rgen Hller. Estos dos desarrolladores, adems de otros colaboradores que juntando toda su experiencia en el desarrollo de aplicaciones J 2EE (Java 2 Enterprise Editions), incluyendo EJ B (Enterprise JavaBeans), Servlets y J SP (Java Server Pages), lograron combinar dichas herramientas y otras ms en un slo paquete, para brindar una estructura ms slida y un mejor soporte para este tipo de aplicaciones. Adems se considera a Spring un framework lightweight, es decir liviano o ligero, ya que no es una aplicacin que requiera de muchos recursos para su ejecucin, adems el framework completo puede ser distribuido en un archivo .jar de alrededor de 1 MB, lo cual Captulo 3 representa muy poco espacio, y para la cantidad de servicios que ofrece es relativamente insignificante su tamao. Este framework se encuentra actualmente en su versin 1.2.5, aunque es una versin temprana, est adquiriendo gran auge y una gran popularidad. Una de las caractersticas que ayuda a este xito, es que es una aplicacin open source, lo cual implica que no tiene ningn costo, ni se necesita una licencia para utilizarlo, por lo tanto da la libertad a muchas empresas y desarrolladores a incursionar en la utilizacin de esta aplicacin. Adems de que est disponible todo el cdigo fuente de este framework en el paquete de instalacin. Spring no intenta reinventar la rueda sino integrar las diferentes tecnologas existentes, en un slo framework para el desarrollo ms sencillo y eficaz de aplicaciones J 2EE portables entre servidores de aplicacin [J ohnson, 2005]. Otro de los principales enfoques de Spring y por el cual est ganando dicha popularidad es que simplifica el desarrollo de aplicaciones J 2EE, al intentar evitar el uso de EJ B, ya que como menciona Craig Walls en su libro Spring in Action, En su estado actual, EJ B es complicado. Es complicado porque EJ B fue creado para resolver cosas complicadas, como objetos distribuidos y transacciones remotas. [Walls, 2005]. Y muchas veces aunque el proyecto no es lo suficientemente complejo, se utiliza EJ B, contenedores de alto peso y otras herramientas que soportan un grado mayor de complejidad, como una solucin a un proyecto. Con Spring, la complejidad de tu aplicacin es proporcional a la complejidad del problema que se est resolviendo. [Walls, 2005]. Esto sin embargo no le quita crdito a EJ B, ya que tambin ofrece a los desarrolladores servicios valiosos y tiles para resolver ciertas tareas, la diferencia radica en que Spring intenta brindar los mismos servicios pero simplificando el modelo de programacin. Captulo 3 Spring fue creado basado en los siguientes principios: El buen diseo es ms importante que la tecnologa subyacente. Los J avaBeans ligados de una manera ms libre entre interfaces es un buen modelo. El cdigo debe ser fcil de probar. 3.2 Arquitectura de Spring Spring es un framework modular que cuenta con una arquitectura divida en siete capas o mdulos, como se muestra en la Figura 3.1, lo cual permite tomar y ocupar nicamente las partes que interesen para el proyecto y juntarlas con gran libertad.
Figura 3.1: Arquitectura de Spring [Balani, 2005] 3.2.1 Spring Core Esta parte es la que provee la funcionalidad esencial del framework, est compuesta por el BeanFactory, el cual utiliza el patrn de Inversin de Control (Inversion of Control) y configura los objetos a travs de Inyeccin de Dependencia (Dependency Injection). El
Spring Web MVC Web MVC Framework Vistas Web J SP/Velocity Exportar a PDF
Spring AOP Infraestructura para AOP
Spring ORM Soporte para Hibernate iBats J DO Spring Context Application context Validacin Soporte J NDL, EJ B Mail
Spring Web WebApplicationContext Multipart resolver Spring DAO Infraestructura para transacciones Soporte para J DBC y DAO Spring Core Utilidades desoporte Contenedor deBeans Captulo 3 ncleo de Spring es el paquete or g. spr i ngf r amewor k. beans el cual est diseado para trabajar con J avaBeans [J ohnson, 2005]. 3.2.1.1 Bean Factory Es uno de los componentes principales del ncleo de Spring. Es una implementacin del patrn Factory, pero a diferencia de las dems implementaciones de este patrn, que muchas veces slo producen un tipo de objeto, BeanFactory es de propsito general, ya que puede crear muchos tipos diferentes de Beans [Walls, 2005]. Los Beans pueden ser llamados por nombre y se encargan de manejar las relaciones entre objetos. Todas las Bean Factories implementan la interfase or g. spr i ngf r amewor k. beans. f act or y. BeanFact or y, con instancias que pueden ser accesadas a travs de esta interfaz. Adems tambin soportan objetos de dos modos diferentes [J ohnson. 2005]: Singleton: Existe nicamente una instancia compartida de un objeto con un nombre particular, que puede ser regresado o llamado cada vez que se necesite. Este es el mtodo ms comn y el ms usado. Este modo est basado en el patrn de diseo que lleva el mismo nombre. Prototype: tambin conocido como non-singleton, en este mtodo cada vez que se realiza un regreso o una llamada, se crea un nuevo objeto independiente. La implementacin de BeanFactory ms usada es or g. spr i ngf r amewor k. beans. f act or y. xml . Xml BeanFact or y que se encarga de cargar la definicin de cada Bean que se encuentra guardada en un archivo XML y que consta de: Captulo 3 id (que ser el nombre que el que se le conocer en las clases), clase (tipo de Bean), Singleton o Prototype (modos del Bean antes mencionados), propiedades, con sus atributos name, value y ref, adems argumentos del constructor, mtodo de inicializacin y mtodo de destruccin. A continuacin se muestra un ejemplo de un Bean: <beans> <bean i d=exampl eBean cl ass=eg. Exampl eBean si ngl et on=t r ue/ > <pr oper t y name="dr i ver Cl assName" val ue="com. mysql . j dbc. Dr i ver " / > </ beans>
Como se muestra en el ejemplo la base de este documento XML es el elemento <beans>, y adentro puede contener uno o ms elementos de tipo <bean>, para cada una de las diferentes funciones que se requieran. Para cargar dicho XML se le manda un I nput St r eam al constructor de Xml BeanFact or y de la siguiente manera: BeanFact or y f act = new Xml BeanFact or y( new Fi l eI nput St r eam( bean. xml ) ) ; Esto sin embargo no quiere decir que sea instanciado directamente, una vez que la definicin es cargada, nicamente cuando se necesite el Bean se crear una instancia dependiendo de sus propiedades. Para tomar un Bean de un Factory simplemente se usa el mtodo get Bean( ) , mandndole el nombre del Bean que se desea obtener [Walls, 2005]: MyBean myBean = ( MyBean) f act or y. get Bean( "myBean") ; 3.2.1.2 Inversion of Control Inversion of Control se encuentra en el corazn de Spring [Walls, 2005]. BeanFact or y utiliza el patrn de Inversin de Control o como se le conoce IoC, que es una de las funcionalidades ms importantes de Spring. Esta parte se encarga de separar del Captulo 3 cdigo de la aplicacin que se est desarrollando, los aspectos de configuracin y las especificaciones de dependencia del framework. Todo esto configurando los objetos a travs de Inyeccin de Dependencia o Dependency Injection, que se explicar ms adelante. Una forma sencilla de explicar el concepto de IoC es el principio Hollywood: No me llames, yo te llamar a ti. Traduciendo este principio a trminos de este trabajo, en lugar de que el cdigo de la aplicacin llame a una clase de una librera, un framework que utiliza IoC llama al cdigo. Es por esto que se le llama Inversin, ya que invierte la accin de llamada a alguna librera externa [J ohnson, 2005]. 3.2.1.3 Dependency Injection Es una forma de Inversin de Control, que est basada en constructores de J ava, en vez de usar interfaces especficas del framework. Con este principio en lugar de que el cdigo de la aplicacin utilic el API del framework para resolver las dependencias como: parmetros de configuracin y objetos colaborativos, las clases de la aplicacin exponen o muestran sus dependencias a travs de mtodos o constructores que el framework puede llamar con el valor apropiado en tiempo de ejecucin, basado en la configuracin [J ohnson, 2005]. Todo esto se puede ver de una forma de push y pop, el contenedor hace un push de las dependencias para ponerlas dentro de los objetos de la aplicacin, esto ocurre en tiempo de ejecucin. La forma contraria es tipo pull, en donde los objetos de la aplicacin jalan las dependencias del ambiente. Adems los objetos de la Inyeccin de Dependencia nunca cargan las propiedades ni la configuracin, el framework es totalmente responsable de leer la configuracin. Captulo 3 Spring soporta varios tipos de Inyeccin de Dependencia, pero en si estos son los dos ms utilizados: Setter Injection: en este tipo la Inyeccin de Dependencia es aplicada por medio de mtodos JavaBeans setters, que a la vez tiene un getter respectivo. Constructor Injection: esta Inyeccin es a travs de los argumentos del constructor. A continuacin se muestra un ejemplo tomado del libro deJava Development with Spring framework del autor Rob J ohnson, en el cual se muestra como un objeto es configurado a travs de Inyeccin de Dependencia. Se tiene una interfaz Ser vi ce y su implementacin Ser vi ceI mpl . Supngase que la Ser vi ceI mpl tiene dos dependencias: un i nt que tiene configura un t i meout y un DAO (Data Access Object). Con el mtodo Set t er I nj ect i on se puede configurar Ser vi ceI mpl utilizando las propiedades de un JavaBean para satisfacer estas 2 dependencias. publ i c cl ass Ser vi ceI mpl i mpl ement s Ser vi ce { pr i vat e i nt t i meout ; pr i vat e Account Dao account Dao;
publ i c voi d set Ti meout ( i nt t i meout ) { t hi s. t i meout = t i meout ; }
publ i c voi d set Account Dao( Account Dao account Dao) { t hi s. account Dao = account Dao; }
Con Constructor Injection se le da las dos propiedades al constructor: publ i c cl ass Ser vi ceI mpl i mpl ement s Ser vi ce { pr i vat e i nt t i meout ; Captulo 3 pr i vat e Account Dao account Dao;
publ i c Ser vi ceI mpl ( i nt t i meout , Account Dao account Dao) { t hi s. t i meout = t i meout ; t hi s. account Dao = account Dao; }
La clave de la innovacin de la Inyeccin de Dependencia es que trabaja con sintaxis pura de J ava: no es necesaria la dependencia del API del contenedor [J ohnson, 2005]. 3.2.2 Spring Context El mdulo BeanFactory del ncleo de Spring es lo que lo hace un contenedor, y el mdulo de contexto es lo que hace un framework [Walls, 2005]. En s Spring Context es un archivo de configuracin que provee de informacin contextual al framework general. Adems provee servicios enterprise como JNDI, EJ B, e- mail, validacin y funcionalidad de agenda. 3.2.2.1 Application Context Appl i cat i onCont ext es una subinterfaz de BeanFact or y, ya que or g. spr i ngf r amewor k. cont ext . Appl i cat i onCont ext es una subclase de BeanFact or y. En si todo lo que puede realizar una BeanFact or y tambin lo puede realizar Appl i cat i onCont ext . En s agrega informacin de la aplicacin que puede ser utilizada por todos los componentes. Adems brinda las siguientes funcionalidades extra: Captulo 3 Localizacin y reconocimiento automtico de las definiciones de los Beans Cargar mltiples contextos Contextos de herencia Bsqueda de mensajes para encontrar su origen. Acceso a recursos Propagacin de eventos, para permitir que los objetos de la aplicacin puedan publicar y opcionalmente registrarse para ser notificados de los eventos. Agrega soporte para internacionalizacin (i18n) En algunos casos es mejor utilizar ApplicationContext ya que obtienes ms funciones a un costo muy bajo, en cuanto a recursos se refiere. Ejemplo de un ApplicationContext: Appl i cat i onCont ext ct = new Fi l eSyst emXml Appl i cat i onCont ext ( c: \ bean. xml ) ; Exampl eBean eb = ( Exampl eBean) ct . get Bean( exampl eBean) ; 3.2.3 Spring AOP Aspect-oriented programming, o AOP, es una tcnica que permite a los programadores modularizar ya sea las preocupaciones crosscutting, o el comportamiento que corta a travs de las divisiones de responsabilidad, como logging, y manejo de transacciones. El ncleo de construccin es el aspect, que encapsula comportamiento que afectan a diferentes clases, en mdulos que pueden ser reutilizados [J ohnson, 2005]. Captulo 3 AOP se puede utilizar para: Persistencia Manejo de transacciones Seguridad Logging Debugging AOP es un enfoque diferente y un poco ms complicado de acostumbrarse en comparacin con OOP (Object Oriented Programming). Rob J ohnson prefiere referirse a AOP como un complemento en lugar de como un rival o un conflicto. Spring AOP es portable entre servidores de aplicacin, funciona tanto en servidores Web como en contenedores EJ B. Spring AOP soporta las siguientes funcionalidades: Intercepcin: se puede insertar comportamiento personalizado antes o despus de invocar a un mtodo en cualquier clase o interfaz. Introduccin: Especificando que un advice (accin tomada en un punto particular durante la ejecucin de un programa) debe causar que un objeto implemente interfaces adicionales. Pointcuts dinmicos y estticos: para especificar los puntos en la ejecucin del programa donde debe de haber intercepcin. Captulo 3 Spring implementa AOP utilizando proxies dinmicos. Adems se integra transparentemente con los BeanFactory que existen. En el ejemplo siguiente se muestra como definir un proxy AOP [J ohnson, 2005]: <bean i d="myTest " cl ass="or g. spr i ngf r amewor k. aop. Fr amewor k. Pr oxyFact or yBean"> <pr oper t y name="pr oxyI nt er f aces"> <val ue>or g. spr i ngf r amewor k. beans. I Test Bean</ val ue> </ pr oper t y> <pr oper t y name="i nt er cept or Names" > <l i st > <val ue>t xI nt er cept or </ val ue> <val ue>t ar get </ val ue> </ l i st > </ pr oper t y> </ bean> 3.2.4 Spring ORM En lugar de que Spring proponga su propio mdulo ORM (Object-Relational Mapping), para los usuarios que no se sientan confiados en utilizar simplemente J DBC, propone un mdulo que soporta los frameworks ORM ms populares del mercado, entre ellos [J ohnson, 2005]: Hibernate (2.1 y 3.0): es una herramienta de mapeo O/R open source muy popular, que utiliza su propio lenguaje de query llamada HQL. iBATIS SQL Maps (1.3 y 2.0). una solucin sencilla pero poderosa para hacer externas las declaraciones de SQL en archivos XML. Apache OJ B (1.0): plataforma de mapeo O/R con mltiples APIs para clientes. Entre otros como J DO (1.0 y 2.0) y Oracle TopLink. Captulo 3 Todo esto se puede utilizar en conjunto con las transacciones estndar del framework. Spring y Hibernate es una combinacin muy popular. Algunas de las ventajas que brinda Spring al combinarse con alguna herramienta ORM son: Manejo de sesin: Spring hace de una forma ms eficiente, sencilla y segura la forma en que se manejan las sesiones de cualquier herramienta ORM que se quiera utilizar. Manejo de recursos: se puede manejar la localizacin y configuracin de los SessionFactories de Hibernate o las fuentes de datos de J DBC por ejemplo. Haciendo que estos valores sean ms fciles de modificar. Manejo de transacciones integrado: se puede utilizar una plantilla de Spring el para las diferentes transacciones ORM. Envolver excepciones: con esta opcin se pueden envolver todas las excepciones para evitar las molestas declaraciones y los catch en cada segmento de cdigo necesarios. Evita limitarse a un solo producto: Si se desea migrar o actualizar a otra versin de un ORM distinto o del mismo, Spring trata de no crear una dependencia entre la herramienta ORM, el mismo Spring y el cdigo de la aplicacin, para que cuando sea necesario migrar a un nuevo ORM no sea necesario realizar tantos cambios. Facilidad de prueba: Spring trata de crear pequeos pedazos que se puedan aislar y probar por separado, ya sean sesiones o una fuente de datos (datasource). Captulo 3 3.2.5 Spring DAO El patrn DAO (Data Access Object) es uno de los patrones ms importantes y usados en aplicaciones J 2EE, y la arquitectura de acceso a los datos de Spring provee un buen soporte para este patrn [J ohnson, 2005]. 3.2.5.1 DAO y JDBC Existen dos opciones para llevar a cabo el acceso, conexin y manejo de bases de datos: utilizar alguna herramienta ORM o utilizar el template de J DBC (Java Database Connectivity) que brinda Spring. La eleccin de una de estas dos herramientas es totalmente libre y en lo que se debe basar el desarrollador para elegir es en la complejidad de la aplicacin. En caso de ser una aplicacin sencilla en la cual nicamente una clase har dicha conexin, entonces la mejor opcin sera el Spring J DBC o en caso contrario que se requiera un mayor soporte y sea ms robusta la aplicacin se recomienda utilizar una herramienta ORM. El uso de J DBC muchas veces lleva a repetir el mismo cdigo en distintos lugares, al crear la conexin, buscar informacin, procesar los resultados y cerrar la conexin. El uso de las dos tecnologas mencionadas anteriormente ayuda a mantener simple este cdigo y evitar que sea tan repetitivo, adems minimiza los errores al intentar cerrar la conexin con alguna base datos [Walls, 2005]. Este es un ejemplo de como se hace la insercin de datos en una base de datos utilizando JDBC tradicional: publ i c voi d i nser t Per son( Per son per son) t hr ows SQLExcept i on { / / Se decl ar an r ecur sos Connect i on conn = nul l ; Pr epar edSt at ement st mt = nul l ; t r y { / / Se Abr e una conexi n Captulo 3 conn = dat aSour ce. get Connect i on( ) ; / / Se cr ea l a decl ar aci n st mt = conn. pr epar eSt at ement ( "i nser t i nt o per son ( " + " i d, f i r st Name, l ast Name) val ues ( ?, ?, ?) ") ; / / Se I nt r oducen l os par met r os st mt . set I nt ( 0, per son. get I d( ) . i nt Val ue( ) ) ; st mt . set St r i ng( 1, per son. get Fi r st Name( ) ) ; st mt . set St r i ng( 2, per son. get Last Name( ) ) ; / / Se ej ecut a l a i nst r ucci n st mt . execut eUpdat e( ) ; } / / Se at r apan l as excepci ones cat ch( SQLExcept i on e) { LOGGER. er r or ( e) ; } f i nal l y { / / Se l i mpi an l os r ecur sos t r y { i f ( st mt ! = nul l ) st mt . cl ose( ) ; } cat ch( SQLExcept i on e) { LOGGER. war n( e) ; } t r y { i f ( conn ! = nul l ) conn. cl ose( ) ; } cat ch( SQLExcept i on e) { LOGGER. war n( e) ; } } } De todo este cdigo nicamente el 20% es para un propsito especfico, el otro 80% es de propsito general en cada una de las diferentes operaciones de acceso a una base de datos. Esto no quiere decir que no sea importante si no que al contrario es lo que le da la estabilidad y robustez al guardado y recuperacin de informacin. Las clases bases que Spring provee para la utilizacin de los DAO son abstractas y brindan un fcil acceso a recursos comunes de base de datos. Existen diferentes implementaciones para cada una de las tecnologas de acceso a datos que soporta Spring. Para J DBC existe la clase J dbcDaoSuppor t que provee mtodos para accesar al Dat aSour ce y al template pre-configurado que se menciono anteriormente: J dbcTempl at e. Captulo 3 nicamente se extiende la clase J dbcDaoSuppor t y se le da una referencia al Dat aSour ce actual. En el ejemplo que se muestra a continuacin la clase base es J dbcTemplate, que es la clase central que maneja la comunicacin con la base de datos y el manejo de excepciones. [J ohnson, 2005]. Esta clase provee varios mtodos que realizan la carga pesada y resultan bastante convenientes, como el mtodo execut e( ) que aparece en el ejemplo, el cual recibe un comando de SQL como su nico parmetro. Para este ejemplo se supone que se tiene una tabla ya creada dentro de una base de datos utilizando el siguiente comando SQL: cr eat e t abl e myt abl e ( i d i nt eger , name var char ( 100) ) Ahora se quiere agregar algunos datos de prueba: i mpor t or g. spr i ngf r amewor k. j dbc. cor e. J dbcTempl at e; i mpor t or g. spr i ngf r amewor k. j dbc. dat asour ce. Dr i ver Manager Dat aSour ce;
publ i c cl ass Mi ni mal Test ext end Test Case{ pr i vat e Dr i ver Manager Dat aSour ce dat aSour ce;
publ i c voi d set up( ) { dat aSour ce = new Dr i ver Manager Dat aSour ce( ) ; dat aSour ce. set Dr i ver Cl assName( or g. hsql db. j dbcDr i ver ) ; dat aSour ce. set Ur l ( j dbc: hsql db: hsql : / / l ocal host : ) ; dat aSour ce. set User name( sa) ; dat aSour ce. set Passwor d( ) ;
J dbcTempl at e J t = new J dbcTempl at e( dat aSour ce) ; J t . execut e( del et e f r ommyt abl e) ; J t . execut e( i nser t i nt o myt abl e ( i d, name) val ues( 1, `J ohn) ) ; J t . execut e( i nser t i nt o myt abl e ( i d, name) val ues( 2, `J ane) ) ; }
Captulo 3 publ i c voi d t est Somet hi ng( ) { / / Aqu va el codi go de pr ueba que se puede apl i car }
Como se pudo apreciar en el ejemplo anterior no existe manejo de excepciones, ya que el J dbcTempl at e se encarga de atrapar todas las SQLExcept i ons y las convierte a una subclase de Dat aAccessExcept i on, que es la clase que se encuentra en el nivel superior de la jerarqua de las excepciones de acceso a datos. Tambin el J dbcTempl at e se encarga de controlar la conexin con la base de datos. Y se puede evitar configurar el Dat aSour ce en DAO, nicamente se tiene que establecer a travs de la inyeccin de dependencia. 3.2.6 Spring Web El mdulo web de Spring se encuentra en la parte superior del mdulo de contexto, y provee el contexto para las aplicaciones web. Este mdulo tambin provee el soporte necesario para la integracin con el framework Struts de Yakarta. Este mdulo tambin se encarga de diversas operaciones web como por ejemplo: las peticiones multi-parte que puedan ocurrir al realizar cargas de archivos y la relacin de los parmetros de las peticiones con los objetos correspondientes (domain objetcs o business objects). 3.2.7 Spring Web MVC Spring brinda un MVC (Model View Controller) para web bastante flexible y altamente configurable, pero esta flexibilidad no le quita sencillez, ya que se pueden desarrollar aplicaciones sencillas sin tener que configurar muchas opciones. Captulo 3 Para esto se puede utilizar muchas tecnologas ya que Spring brinda soporte para J SP, Struts, Velocity, entre otros. El MVC de Spring presenta una arquitectura Tipo 2, para mayor informacin consultar el Captulo 2: Marco Terico de este documento de tesis. El Web MVC de Spring presenta algunas similitudes con otros frameworks para web que existen en el mercado, pero son algunas caractersticas que lo vuelven nico: Spring hace una clara divisin entre controladores, modelos de J avaBeans y vistas. El MVC de Spring est basado en interfaces y es bastante flexible. Provee interceptores (interceptors) al igual que controladores. Spring no obliga a utilizar J SP como nica tecnologa View tambin se puede utilizar otras. Los Controladores son configurados de la misma manera que los dems objetos en Spring, a travs de IoC. Los web tiers son ms sencillos de probar que en otros frameworks. El web tiers se vuelve una pequea capa delgada que se encuentra encima de la capa de business objects.
La arquitectura bsica de Spring MVC est ilustrada en la Figura 3.2. Captulo 3 Figura 3.2: Arquitectura bsica del Web MVC de Spring [J ohnson, 2005]
Para intentar comprender cada parte de la arquitectura del Web MVC de Spring se presenta en la Figura 3.3, el ciclo de vida de una peticin o request [Walls, 2005]: Dispatcher Servlet Handler Mapping Controller View Resolver View ModelAndView 1 2 3 4 5 6 Request
Figura 3.3: Ciclo de vida de un request [Walls, 2005]
1. El navegador manda un request y lo recibe un DispatcherServlet. 2. Se debe escoger que Controller manejar el request, para esto el HandlerMapping mapea los diferentes patrones de URL hacia los controladores, y se le regresa al DispatcherServlet el Controller elegido.
WebApplicationContext (Archivo-servlet.xml) WebApplication Context(s) Otros archivos xml DataSource, entre otros HandlerMapping ViewResolver Controladores DispatcherServlet (Peticiones entrantes) Captulo 3 3. El Controller elegido toma el request y ejecuta la tarea. 4. El Controller regresa un ModelAndView al DispatcherServlet. 5. Si el ModelAndView contiene un nombre lgico de un View se tiene que utilizar un ViewResolver para buscar ese objeto View que representar el request modificado. 6. Finalmente el DispatcherServlet despacha el request al View. Spring cuenta con una gran cantidad de controladores de los cuales se puede elegir dependiendo de la tarea, entre los ms populares se encuentra: Controller y AbstractController para tareas sencillas; el SimpleFormController ayuda a controlar formularios y el envi de los mismos, MultiActionController ayuda a tener varios mtodos dentro un solo controlador a travs del cual se podrn mapear las diferentes peticiones a cada uno de los mtodos correspondientes. 3.2.7.1 Dispatcher Servlet Para configurar el Di spat cher Ser vl et como el servlet central, se tiene que hacer como cualquier servlet normal de una aplicacin web, en el archivo de configuracin web.xml (Deployment Descriptor). <ser vl et > <ser vl et - name>t r ai ni ng</ ser vl et - name> <ser vl et - cl ass> or g. spr i ngf r amewor k. web. ser vl et . Di spat cher Ser vl et </ ser vl et - cl ass> <l oad- on- st ar t up>1</ l oad- on- st ar t up> </ ser vl et > <ser vl et - mappi ng> <ser vl et - name>ej empl o</ ser vl et - name> Captulo 3 <ur l - pat t er n>*. ht m</ ur l - pat t er n> </ ser vl et - mappi ng>
Entonces el DispatcherServlet buscar como est indicado por el tag <ser vl et - name> el contexto de aplicacin (application Context) correspondiente con el nombre que se haya puesto dentro de ese tag acompaado de la terminacin servlet.xml, en este caso buscar el archivo ejemplo-servlet.xml. En donde se pondrn las definiciones y como su nombre lo indica el contexto de la aplicacin dentro de diferentes beans, con sus correspondientes propiedades y atributos, para el caso del Web MVC, se pondrn los diferentes ViewResolver a utilizar, los controladores y sus propiedades, el HandlerMapping, as como los diferentes beans que sean necesarios. 3.2.7.2 Handler Mappings Existen diversas maneras en que el DispatcherServlet pueda determinar y saber que controlador es el encargado de procesar un request, y a que bean del Application Context se lo puede asignar. Esta tarea la lleva a cabo el Handler Mapping o el manejador de mapeo, existen 2 tipos principales que son los que mas se usan: BeanNameUrlHandlerMapping: mapea el URL hacia el controlador en base al nombre del bean del controlador. Ejemplo de cmo se declara: Esta es la declaracin principal del Handler Mapping: <bean i d="beanNameUr l Mappi ng" cl ass="or g. spr i ngf r amewor k. web. ser vl et . handl er . BeanNameUr l Handl er Mappi ng"/ > A continuacin se escribe cada uno de los diferentes URLs que se vayan a utilizar en la aplicacin, ponindolo en el atributo name del bean y en el atributo class la clase del Captulo 3 Controlador que vaya a procesar ese dicho request, y finalmente se ponen las diferentes propiedades que utilizar dicho controlador. <bean name=" / ej empl o. ht m" cl ass="web. Exampl eCont r ol l er "> <pr oper t y name=" Ser vi ci o"> <r ef bean="Ser vi ci o" / > </ pr oper t y> </ bean> As cuando el usuario entre a una pgina con el URL /ejemplo.htm el request que haga ser dirigido hacia el controlador Exampl eCont r ol l er SimpleUrlHandlerMapping: mapea el URL hacia el controlador basando en una coleccin de propiedades declarada en el applicationContext. Ejemplo de cmo declarar un HandlerMapping de este tipo: <bean i d="si mpl eUr l Mappi ng" cl ass= "or g. spr i ngf r amewor k. web. ser vl et . handl er . Si mpl eUr l Handl er Mappi ng"> <pr oper t y name=" mappi ngs"> <pr ops> <pr op key="/ ej empl o. ht m" >Exampl eCont r ol l er </ pr op> <pr op key="/ l ogi n. ht m">Logi nCont r ol l er </ pr op> </ pr ops> </ pr oper t y> </ bean>
En este Handler Mapping se declara una lista de propiedades en las cuales se pondr cada uno de los URLs como una propiedad, con el URL como atributo key y como valor el nombre del bean del controlador que ser responsable de procesar la peticin o request. Por ejemplo el URL /login.htm ser responsabilidad del controlador con el nombre del bean LoginController. Captulo 3 Se pueden trabajar con mltiples Handler Mappings por si son necesarios en diferentes situaciones, nicamente se le tiene que agregar la propiedad order para poder asignarle en que orden el DispatcherServlet va a considerarlas para poder invocarlas. 3.2.7.3 View Resolvers En el Spring MVC una vista o View es un bean que transforma los resultados para que sean visibles para el usuario y los pueda interpretar de una mejor forma. En s un View Resolver es cualquier bean que implemente la interfaz or g. spr i ngf r amewor k. web. ser vl et . Vi ewResol ver . [Walls, 2005]. Esto quiere decir que un View Resolver es el encargado de resolver el nombre lgico que regresa un controlador en un objeto Model AndVi ew, a un nombre de archivo fsico que el navegador podr desplegarle al usuario junto con los resultados procesados. Spring MVC cuenta con cuatro View Resolvers diferentes: InternalResourceViewResolver: Resuelve los nombres lgicos en un archivo tipo View que es convertido utilizando una plantilla de archivos como J SP, J STL o Velocity BeanNameViewResolver: Resuelve los nombres lgicos de las vistas en beans de tipo View en el applicationContext del DispatcherServlet ResourceBundleViewResolver: Resuelve los nombres lgicos de las vistas en objetos de tipo View contenidos en un ResourceBundle o un archivo con extensin .properties. XMLViewResolver: Resuelve los nombres los lgicos de las vistas que se encuentran en un archivo XML separado. Captulo 3 El View Resolver ms utilizado es el InternalResourceViewResolver, y se especifica en el web applicationContext de nuestra aplicacin de la siguiente manera: <bean i d="vi ewResol ver " cl ass="or g. spr i ngf r amewor k. web. ser vl et . vi ew. I nt er nal Resour ceVi ewResol ver "> <pr oper t y name="vi ewCl ass"> <val ue>or g. spr i ngf r amewor k. web. ser vl et . vi ew. J st l Vi ew</ val ue> </ pr oper t y> <pr oper t y name="pr ef i x"><val ue>/ WEB- I NF/ j sp/ </ val ue></ pr oper t y> <pr oper t y name="suf f i x"><val ue>. j sp</ val ue></ pr oper t y> </ bean> En este bean de i d vi ewResol ver , se especifica de que clase se quiere que se implemente, para este caso ser el tipo de View Resolver que se quiere de los 4 mencionados anteriormente. Despus vienen tres propiedades: viewClass: sirve para especificar que tipo de plantilla se quiere usar para desplegar la vista, en este caso se utiliz J STL (Java Standard Tag Library), que es una de las plantillas ms comunes para este tipo de tarea, tambin se puede seleccionar Velocity o Tiles para desplegar la informacin prefix: el prefijo que anteceder al nombre lgico de la vista, generalmente es la ruta donde se encontrarn los J SP, Ejemplo: /WEB-INF/jsp suffix: el sufijo que tendrn nuestras vistas, ya que la mayora de los nombres fsicos que se utilizan son J SPs se le asigna la extensin .jsp. Todo esto es con el afn de tener una programacin que no sea tan dependiente, ya que si se quisiera cambiar de carpeta todas las vistas, lo nico que se tendra que modificar sera el prefix del viewResolver. Captulo 3 3.2.7.4 Controladores Si el DispatcherServlet es el corazn del Spring MVC los controladores son los cerebros. [Walls, 2005]. Existen varios controladores cada uno especializado para una tarea en particular, claro que como en todos los casos existen algunos que son de uso general. Para poder crear un controlador basta con implementar la interfaz del Controlador deseado, sobrescribir los mtodos que sean necesarios para procesar la peticin. Esta situacin ayuda a poder modularizar la aplicacin ya que con la combinacin de diversos controladores que sean enfocados a una tarea en particular se puede concentrarse en cada parte de aplicacin aislada y tener una mejor estructura que ayudar a detectar ms fcilmente las fallas y errores que puedan surgir. Existe una variedad de controladores, como se muestra en la Figura 3.4, los cuales poseen una jerarqua. Spring brinda libertad al desarrollador de escoger que tipo de controlador desea implementar, no lo limita como en algunos otros frameworks.
Captulo 3 Figura 3.4: Controladores que provee Spring [J ohnson, 2005] La manera en que trabaja cada uno de dichos controladores es similar, cada uno tiene su mtodo especfico para procesar las peticiones que haga el usuario, pero todos regresan un objeto tipo ModelAndView, que es como su nombre lo dice el modelo y la vista, ya que se est compuesto de 2 o ms atributos. El principal es el nombre de la vista a la que se va a regresar el modelo para que sea desplegado, y los dems atributos pueden ser parmetros que se le agregan por medio del mtodo . addObj ect ( nombr e_par met r o, val or _par met r o) . Adems el Modelo puede estar formado por un solo objeto o por un Map de Objetos, los cuales se identificarn en la vista con el mismo nombre que se haya mandado dentro del Modelo que se le dio al objeto ModelAndView que se este regresando para ser procesado. Co Controladores AbstractC ThrowAwayCon Controlador BaseCommandCo AbstractFormCo SimpleFormCo AbstractWizardFormC Controladores para Controladores para Controladores de Comandos AbstractCommandC MultiActionCon Controladores Multi-
Controller Controladores Simples AbstractController ThrowAwayController Controlador ThowAway BaseCommandController AbstractFormController SimpleFormController AbstractWizardFormController Controladores para Asistentes Controladores para Formularios Controladoresde Comandos AbstractCommandController MultiActionController Controladores Multi-Accin Captulo 3 El siguiente ejemplo muestra el cdigo bsico de un controlador. publ i c cl ass Movi esCont r ol l er ext ends Abst r act Cont r ol l er { / / Mt odo que cont r ol a el Request publ i c Model AndVi ew handl eRequest I nt er nal ( Ht t pSer vl et Request r equest , Ht t pSer vl et Response r esponse) t hr ows Except i on { / / Se r ecuper a una l i st a de t odas l as pel i cul as Li st movi es = Movi eSer vi ce. get Al l Movi es( ) ; / / Se manda a l a vi st a movi eLi st el obj et o movi es, con el nombr e l gi co / / movi es r et ur n new Model AndVi ew( " movi eLi st ", "movi es" , movi es) ; } }
El objeto ModelAndView contiene el nombre lgico de la vista, el cual el framework se encarga a travs del View Resolver de convertir ese nombre lgico al nombre fsico que es el que buscar el servidor web. 3.2.7.5 Procesamiento de formularios Una de las increbles facilidades que brinda Spring es la de llenar, recibir y procesar formularios, a travs de los 3 diferentes controladores que brinda Spring para el manejo de formas o formularios. Ya que con estos controladores, se facilita el procesamiento, llenado de la forma, almacenamiento ( si es necesario) de los datos, as como desplegar errores y confirmaciones. Para el usuario todo este proceso es totalmente transparente ya que el formulario que este llenando tendr el mismo formato y los mismos elementos que cualquier otro formulario normal. Existen varios pasos a seguir para poder utilizar un controlador de formularios, uno de ellos rellenar el archivo .jsp con tags que provee la librera spring.tld. Esta librera se Captulo 3 debe de combinar de la siguiente manera: En el Deployment Descriptor de la aplicacin se pone el siguiente tag: <t agl i b> <t agl i b- ur i >/ spr i ng</ t agl i b- ur i > <t agl i b- l ocat i on>/ WEB- I NF/ spr i ng. t l d</ t agl i b- l ocat i on> </ t agl i b>
Una vez realizada esta accin se configura el applicationContext de la aplicacin con el bean que describir toda la informacin que el controlador necesitar. Para el control de las formas, se recomienda crear un Objeto que tenga atributos, cada uno de ellos con sus respectivos mtodos set y get, para que a travs del patrn de Inyeccin de Dependencia se pueda poner la informacin dentro de ese objeto y sea ms fcil de manipular y almacenar. A este objeto se le conoce como objeto commando o command object. Estas son algunas de las propiedades que el controlador necesita, no todas son obligatorias. formView: nombre lgico de la vista que contiene la forma. successView: nombre lgico de la vista que se desplegar una vez que la forma sea llenada con xito. commandClass: la clase a la que pertenecer el Objeto comando u objeto base sobre el cual se va a trabajar. commandName: nombre lgico que se le quiere dar al objeto comando, con el cual se le reconocer en la vista. Captulo 3 validator: este ser el bean de referencia de la clase que extiende a la interfaz org.springframework.validation.Validator que se encarga despus de que se hizo la vinculacin (binding) de validar que todos los campos cumplan con los requisitos que le desarrollador desee y regresar los errores y las violaciones, y en que campo fue donde se cometieron, as como el mensaje de error que se debe desplegar. Este es un ejemplo de un bean de configuracin de un Si mpl eFor mCont r ol l er : <bean i d="r egi st er Cont r ol l er " cl ass="web. Regi st er Cont r ol l er " > <pr oper t y name=" f or mVi ew"> <val ue>newSt udent For m</ val ue> </ pr oper t y> <pr oper t y name=" successVi ew" > <val ue>st udent Wel come</ val ue> </ pr oper t y> <pr oper t y name=" commandCl ass"> <val ue>busi ness. User </ val ue> </ pr oper t y> <pr oper t y name=" commandName" > <val ue>user </ val ue> </ pr oper t y> <pr oper t y name=" val i dat or "> <r ef bean="r egi st er Val i dat or "/ > </ pr oper t y> </ bean> <bean i d="r egi st er Val i dat or " cl ass=" val i dat or s. Regi st er Val i dat or "/ >
Una vez realizada esta configuracin se debe crear una clase para el controlador, la cual debe extender a la clase Si mpl eFor mCont r ol l er , en la cual se pueden sobrescribir varios mtodos como por ejemplo: Captulo 3 Map r ef er enceDat a( Ht t pSer vl et Request r eq, Obj ect command, Bi ndExcept i on er r or s) : en este mtodo se realiza el llenado de los campos que el desarrollador desee que aparezcan llenos una vez que se cargue el formulario. Estos campos vendrn llenos con los datos que se encuentren en el Map que ser regresado. Este se mezclar con el modelo para que la vista los procese y se desplieguen en los campos del formulario necesarios. Model AndVi ew onSubmi t ( Ht t pSer vl et Request r eq, Ht t pSer vl et Response r es, Obj ect command, Bi ndExcept i on er r or s) : Este mtodo puede tener variaciones en cuanto al nmero de parmetros que recibe, ya que existen formas ms sencillas de este mtodo. Estos mtodos son llamados despus de que ocurri la validacin y en el objeto Bi ndExcept i on no hubo ningn error, se ejecuta est mtodo, en el cual se realiza la accin que se desee una vez que el usuario haya enviado el formulario, ya sea almacenar la informacin en una base de datos, etc. voi d doSubmi t Act i on( Ht t pSer vl et Request r eq) : este mtodo es la forma ms simple de los mtodos para enviar los formularios ya que no se necesita crear un objeto ModelAndView, el mtodo crea uno nuevo con la instancia successView que se haya dado en la configuracin del controlador en el applicationContext. Y se pueden llevar a cabo las mismas operaciones que en cualquier mtodo de envo, por ejemplo almacenar en una base de datos la informacin del formulario.
Ahora solamente queda utilizar los tags dentro del J SP para poder vincular cada uno de los campos a un atributo del Objeto comando que se haya escogido. Para esto se utiliza el tag <spr i ng: bi nd> que nicamente tiene el atributo pat h, que es donde se asigna a que Captulo 3 atributo del objeto comando se va a referir ese campo del formulario. Este tag trae dentro tambin los errores de validacin que se llegarn a dar al momento de enviar el formulario. Esto se da gracias a un objeto status de tipo Bi nd- St at us que a travs de 3 parmetros ayudar a vincular [Walls, 2005]: expression: La expresin usada para recuperar el nombre del campo, si por ejemplo la propiedad es Movie.name, el valor de la expresin y el nombre del campo ser name. value: El valor del campo asociado, una vez que fue enviada la forma se utiliza para volver a poner el valor de este campo si es que hubo errores y que no se pierda toda la informacin que el usuario proporciono. errorMessages: Un arreglo de Strings que contiene los errores relacionados con este campo. Ejemplo del cdigo fuente de un J SP utilizando los tags de vinculacin <spr i ng: bi nd>. <%@t agl i b pr ef i x="c" ur i ="ht t p: / / j ava. sun. com/ j st l / cor e" %> <%@t agl i b pr ef i x="spr i ng" ur i =" / spr i ng" %>
<f or mmet hod="POST" act i on=" / r egi st er User . ht m">
<spr i ng: bi nd pat h="user . f i r st Name"> Nombr e: <i nput t ype="t ext " name="<c: out val ue=" ${st at us. expr essi on}"/ >" val ue="<c: out val ue="${st at us. val ue}"/ >" > <p>Er r or es: <c: out val ue=${st at us. er r or Messages}/ ></ p> </ spr i ng: bi nd>
</ f or m> Captulo 3 Una de las combinaciones ms importante en cuanto a las vistas J SP es utilizar la tecnologa J STL para poder realizar ciclos, condiciones, entre otros de una manera ms rpida, sencilla y eficaz para el desarrollador.