Inicializacion Lazy De Spring Para Tests

Spring Framework provee un mecanismo por el cual se le puede indicar que un bean sea consturído lo más tardíamente posbile.

De esta manera el bean no se instanciará hasta que no se necesite en el código en tiempo de ejecución en forma directa o porque es la dependencia de otro bean que es necesario.

Se puede utilizar a nivel de bean: <bean id="lazy" class="com.foo.ExpensiveToCreateBean" lazy-init="true"/>

o a nivel del contenedor <beans default-lazy-init="true">

  ...

</beans>

Esto es muy útil durante los tests de componentes ya que nos permite inicializar e involucrar en el test solamente los beans relacionados.

Durante los tests de componentes es conveniente utilizar los mismos archivos de configuración que se utilizarán en producción. Así se estará comprobando que la configuración de Spring es correcta.

El problema que surge es que si se quiere indicar en la configuración que la incialización sea lazy se estará duplicando los archivos de configuración perdiendo esta posibilidad.

Imaginemos los siguientes archivos de configuración:

app-business.xml <beans>

   ...
   <bean id="UnBo" ...>
   ...

</beans>

app-dao.xml <beans>

   ...
   <bean id="UnDao" ...>
   ...

</beans>

app-jms.xml <beans>

   ...
   <bean id="UnJmsTemplate" ...>
   ...

</beans>

Un test JUnit de componentes comenzaría con algo así:

@ContextConfiguration(locations =

   "classpath:app-business.xml",
   "classpath:app-dao.xml",
   "classpath:app-jms.xml"
   )

public class BlahComponenteTest extends AbstractJUnit4SpringContextTests {

   ...

}

Si queremos que la inicialización sea lazy, cada uno de los archivos de configuración debería comenzar con: <beans default-lazy-init=true>

Esto implica que tengamos que tener archivos alternativos para los tests: @ContextConfiguration(locations =

   "classpath:app-business-componente-test.xml",
   "classpath:app-dao-componente-test.xml",
   "classpath:app-jms-componente-test.xml"
   )

public class BlahComponenteTest extends AbstractJUnit4SpringContextTests {

   ...

}

Una solución que no funciona

Es muy común intentar solucionar el problema de tener que duplicar los archivos de configuración importando los tres archivos en otro y hacer a este lazy:

app-spring-config-componente-test.xml <beans default-lazy-init="true">

   <import resource="app-business.xml" />
   <import resource="app-dao.xml" />
   <import resource="app-jms.xml" />

</beans>

Y después lo incluímos como un sólo archivo:

@ContextConfiguration(locations =

   "classpath:app-spring-config-componente-test.xml"
   )

public class BlahComponenteTest extends AbstractJUnit4SpringContextTests {

   ...

}

Lo que no funciona es que la propiedad default-lazy-init no se propaga por las configuraciones importadas (Verificar si esto sigue siendo así en versiones más nuevas de Spring).

Solución

Una alternativa para hacer la inicialización lazy durante los tests sin duplicar los archivos de configuración es crear un ContextLoader propio y especificarlo en la anotación @ContextConfiguration.

El ContextLoader utilizará un DefinitionDocumentReader que le seteará a cualquier definición que lea, el atributo DEFAULT_LAZY_INIT_ATTRIBUTE como true.

package com.tm.cma.web.base;

import org.springframework.beans.factory.support.BeanDefinitionReader; import org.springframework.beans.factory.xml.BeanDefinitionParserDelegate; import org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader; import org.springframework.beans.factory.xml.XmlBeanDefinitionReader; import org.springframework.beans.factory.xml.XmlReaderContext; import org.springframework.context.support.GenericApplicationContext; import org.springframework.test.context.support.GenericXmlContextLoader; import org.w3c.dom.Element;

public class LazyContextLoader extends GenericXmlContextLoader {

   protected BeanDefinitionReader 
           createBeanDefinitionReader(GenericApplicationContext context) {
       XmlBeanDefinitionReader beanDefinitionReader = 
           new XmlBeanDefinitionReader(context);
       beanDefinitionReader.setDocumentReaderClass(LazyBeanDocumentReader.class);
       return beanDefinitionReader;
   }

}

class LazyBeanDocumentReader extends DefaultBeanDefinitionDocumentReader {

   protected BeanDefinitionParserDelegate 
           createHelper(XmlReaderContext readerContext, Element root) {
       root.setAttribute(
           BeanDefinitionParserDelegate.DEFAULT_LAZY_INIT_ATTRIBUTE,
           "true"
           );
       return super.createHelper(readerContext, root);
   }

Y así quedaría el test en cuestión:

@ContextConfiguration(

       loader = "LazyContextLoader.class"
       locations = "classpath:app-spring-config-componente-test.xml"
   )

public class BlahComponenteTest extends AbstractJUnit4SpringContextTests {

   ...

}