Manejo transaccional de la base de datos con Spring Framework y AOP

Introducción

Manejar la transaccionabilidad contra una base de datos no es un tema complicado al utilizar JDBC, menos aún utilizando un bean TransactionTemplate de Spring. Sin embargo, siempre que hacemos tareas repetitivas -como escribir código para empezar una trasacción, hacer un commit en caso de éxito o hacer rollback en caso de error- abre la puerta a olvidos o errores de programación.

Spring pone a disposición buenas herramientas para el manejo transaccional contra una base de datos, ya sea de forma programática o de forma declarativa. Si elegimos el enfoque programático, contamos con la clase org.springframework.transaction.support.TransactionTemplate. Si preferimos manejar nuestras transacciones de forma declarativa, contamos con opciones de configuración mediante XMLs y AOP (tx:advice) o utilizando annotations (org.springframework.transaction.annotation.Transactional)
Veremos los diferentes atributos en la definición de una transacción, y las formas de uso de cada uno de los enfoques.

Atributos de una transacción

name

Nombre de la transacción. Por defecto no tienen nombre, y si tienen, este nombre se muestra en los monitores transaccionales, cuando el concepto es aplicable.

propagation

Es el comportamiento de la propagación de la transacción. Por propagación entendemos la forma de asociar la transacción al método que estamos ejecutando. Entre los posibles comportamientos tenemos:

  • REQUIRED: Comportamiento por defecto. Si existe una transacción en curso, el método corre dentro de esa transacción. Si no existe una en curso, creará una nueva transacción.
    tx_prop_required
  • REQUIRES_NEW: Indica que el método debe
    correr dentro de su propia transacción. Si existe una transacción en curso, se suspenderá durante la duración de la invocación al método.
    tx_prop_requires_new
  • MANDATORY: Indica que el método debe correr dentro de una transacción. Si no existe una transacción en curso, se lanzará una excepción.
  • NESTED: Indica que si existe una transacción en progreso, el método se ejecutará dentro de una transacción anidada. Sobre esta transacción se ejecutará commit o rollback sin afectar las otras, (utilizando savepoints) . Si no existe ninguna transacción en curso, se comporta de la misma forma que REQUIRED.
  • NEVER: Indica que el método no debe ser ejecutado utilizando una transacción en curso. Si existe una transacción en curso, se lanzará una
    excepción.
  • NOT_SUPPORTED: Indica que el método no debe ser ejecutado dentro de una transacción. Si existe una en progreso, se suspenderá durante la ejecución del método.
  • SUPPORTS: Indica que el método no requiere una transacción, pero se utilizará si existese alguna en curso.

isolation

El isolation level de la transacción. Por isolation level entendemos la configuración de qué tanto afectan los cambios del DBMS que son externos a nuestra transacción. En el nivel de aislación más bajo vemos cómo van cambiando los datos desde que comenzó nuestra transacción, inclusive si son resultados intermedios de otra transacción. En el nivel más alto, trabajamos con una foto de los datos que no cambia mientras nuestra transacción vive. Entre los posibles valores tenemos:

  • DEFAULT: Utiliza el nivel por defecto, lo determinará la fuente de datos.
  • READ_UNCOMMITED: Este nivel permite que en una transacción se puedan leer datos que aún no han sido commiteados en otras transacciones (lecturas sucias). Pueden suceder además lecturas fantasma (si se hace rollback de la otra transacción, los datos que leímos no fueron válidos) y lecturas no repetibles (una misma consulta puede retornar valores diferentes dentro de la misma transacción).
  • READ_COMMITED: Este nivel no expone datos de una tupla aún no commiteados por otras transacciones, pero permite que otras transacciones cambien datos de las tuplas recuperadas por nuestra transacción. De esta forma, las lecturas sucias se evitan, pero pueden suceder las lecturas fantasma y las lecturas no repetibles.
  • REPEATABLE_READ: Este nivel no permite leer datos aún no commiteados de una tupla, y tampoco permite modificar los datos leídos por una transacción en curso. Sin embargo, si hacemos 2 consultas (SELECTs) con una condición de rango en el WHERE, y otra transacción inserta tuplas entre las 2 consultas y que cumplan con la condición de rango, las consultas retornarán conjuntos de tuplas diferentes. Las lecturas sucias y las lecturas no repetibles se evitan, pero pueden suceder las lecturas fantasma.
  • SERIALIZABLE: Además de las condiciones de REPEATABLE_READ, evita el caso en que en nuestra transacción hacemos una consulta con una condición de rango, otra transacción inserta una tupla que cae cumple la condición, y luego repetimos la consulta en nuestra transacción. Si el es isolation level es SERIALIZABLE, ambas consultas retornarán el mismo resultado. Se evitan las lecturas sucias, las lecturas no repetibles y las lecturas fantasma.

timeout

El timeout de la transacción, expresado en segundos.

read-only

Indica si la transacción debe ser tratada como solo lectura, posibilitando así optimizaciones adicionales.

Uso de transacciones con Spring

Definición de forma programática

Para manejar la transaccionabilidad de forma programática, debemos
tener una referencia a org.springframework.transaction.support.TransactionTemplate en nuestra clase. Para ello, definiremos algunas relaciones entre nuestros beans:

<bean name="hibernateTemplate" class="org.springframework.orm.hibernate3.HibernateTemplate">
	<constructor-arg ref="sessionFactory"/>
</bean>

<bean name="transactionManager" class="org.springframework.orm.hibernate3.HibernateTransactionManager">
	<property name="dataSource" ref="dataSource" />
	<property name="sessionFactory" ref="sessionFactory" />
</bean>

<bean name="transactionTemplate" class="org.springframework.transaction.support.TransactionTemplate">
	<constructor-arg ref="transactionManager"/>
</bean>

En este ejemplo el framework de ORM utilizado es Hibernate, pero la idea aplica para cualquier framework ORM de los que Spring tiene soporte.
El bean hibernateTemplate entonces es el que agrupa funcionalidades de acceso a datos, apoyándose en las funcionalidades de Hibernate.
El bean transactionManager es una subclase de org.springframework.transaction.support.AbstractPlatformTransactionManager, implementando el manejo de transacciones (determinación de transacciones existentes, suspensión de transacciones, definición del comportamiento transaccional, etc.).
Por último, transactionTemplate simplifica el manejo transaccional y el manejo de excepciones por errores.

La forma de uso del transactionTemplate dentro de nuesta aplicación es la siguiente:

public class MyEntityDAOImpl implements MyEntityDAO {

	private HibernateTemplate hibernateTemplate;
	
	private TransactionTemplate transactionTemplate;	
	
	public List<MyEntity> getAll() {
		return (List<MyEntity>)
getTransactionTemplate().execute(new TransactionCallback() {

			@Override
			public Object doInTransaction(TransactionStatus status) {
				return getHibernateTemplate().loadAll(MyEntity.class);
			}
		});
	}
	
	/*
	...
	setters y getters de hibernateTemplate y transactionTemplate
	...
	*/
}

Todo lo que pase dentro del método doInTransaction estará encapsulado dentro de una transacción.

Definición de forma declarativa – XMLs

El bean nos permite crear un aspecto (por más info acerca de AOP, ver este post) encargado de iniciar una transacción contra la base de datos al invocar un método que encaje en la definición del pointcut. En este pointcut se podría definir para un método de una clase, para toda la clase, o incluso para todo un paquete que identifique la capa de negocios o de acceso a datos de nuestra aplicación.

Para configurar un en nuestra aplicación, incluiremos en nuestros XMLs de Spring los siguientes beans:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

	<aop:config>
		<aop:advisor pointcut="execution(public * demo.dao.*.create(..))" advice-ref="tx-advice" />
	</aop:config>
	
	<tx:advice id="tx-advice">
		<tx:attributes>
			<tx:method name="*" propagation="REQUIRED" isolation="DEFAULT" rollback-for="Throwable" no-rollback-for="BusinessException" />
			<tx:method name="get*" propagation="SUPPORTS" read-only="true" />
		</tx:attributes>
	</tx:advice>

</beans>

Tendiendo hacia convención en lugar de configuración, asume que existe un bean llamado “transactionManager”, instancia de la clase -en caso de Hibernate- org.springframework.orm.hibernate3.HibernateTransactionManager. Si nuestro transaction manager tiene un nombre diferente, debemos referenciarlo incluyendo un atributo transaction-manager al bean .

El atributo name es el único parámetro requerido, y tiene un significado diferente al que se le da en la configuración programática. En este caso, sirve para filtrar los nombres de los métodos que se asociarán a esta las transacciones. Soporta comodines (*) en los nombres, por ejemplo ‘get*’, ‘handle*’, ‘on*Event’.

Al bean le podemos configurar todos los atributos descritos al inicio del post (propagation, isolation leven, timeout, etc.), y además:

  • rollback-for: Lista de excepciones -separadas por comas- para las cuales se dispara un rollback de la transacción
  • no-rollback-for: Lista de excepciones -separadas por comas- para las cuales no se dispara un rollback de la transacción

Uso de forma declarativa – @Annotations

Si bien simplifica mucho el manejo de transacciones, podemos utilizar annotations para simplificarlo aún más.

Utilizando sólo una línea en la configuración XML de nuestra aplicación podemos dar lugar a configurar el manejo transaccional a nivel de annotations. Esta línea tiene el siguiente formato:

<tx:annotation-driven transaction-manager="txManager" />

El atributo transaction-manager debe ser incluido si nuestro transaction manager no se llama “transactionManager”.

El tener configurado este bean nos habilita a poder anotar nuestras clases y métodos con @Transactional y definir de esta forma nuestras transacciones de forma declarativa y dentro de nuestro código Java.

@Transactional(propagation=Propagation.SUPPORTS, readOnly=true)
public class MyServiceImpl implements MyService {
	
	...
	
	@Transactional(propagation=Propagation.REQUIRED, readOnly=false)
	public void addMyEntity(MyEntity e) {
		...
	}
	
	...
}

En este ejemplo, todos los métodos de la clase son anotados como de solo lectura y con el comportamiento de propagación SUPPORTS. Al método addMyEntity se le especifica un comportamiento diferente, anotándolo con el comportamiento de propagación REQUIRED, y eliminando la restricción de solo lectura.

Cabe destacar que @Transactional puede ser utilizado también en interfaces indicando el comportamiento de todas las implementaciones de dicha interface.

Conclusión

Un manejo transaccional apropiado en nuestras aplicaciones es cada día más importante para asegurar robustez, especialmente en ambientes inciertos (desconexiones, latencias) y de alta concurrencia.

Spring nos brinda posiblidades concretas y muy poderosas para aislarnos de la problemática del manejo transaccional, dándonos opciones para las diferentes preferencias de enfoque y opciones en el desarrollo de aplicaciones. Vimos desde cómo hacer para declarar transacciones en el código, teniendo total control acerca del inicio y fin de las mismas. También vimos cómo declarar el ciclo de vida de las transacciones utilizando AOP y Spring juntos, a través de configuración XML. Finalmente vimos aún más simplificada la tarea, habilitando la configuración transaccional mediante annotations, y de esta manera definir en nuestras clases -o interfaces- el comportamiento deseado.

Hoy en día podemos hacer uso de esta flexibilidad y potencia, que quizá hasta hace poco estaba restringida a EJBs, utilizando un framework no intrusivo como Spring, un concepto cada ves más utilizado como AOP y nuestros viejos y queridos POJOs para nuestra lógica.

Referencias

AOP con Spring framework

Introducción

¿Qué es AOP?

Aspect-Oriented Programming (AOP) es un paradigma de programación que nos permite separar “aspectos” o “intenciones” de nuestro software en diferentes módulos según su responsabilidad. De esta manera puede verse como otra herramienta para poder diferenciar en nuestro código las diferentes necesidades, encapsulando los diferentes conceptos como ser los requerimientos funcionales, seguridad, profiling de tiempos, transaccionabilidad contra una base de datos, logging, entre otros.

En Wikipedia ofrecen una definición bastante completa de los términos básicos utilizados en el mundo AOP:

  • Aspect (Aspecto) es una funcionalidad transversal (cross-cutting) que se va a implementar de forma modular y separada del resto del sistema. El ejemplo más común y simple de un aspecto es el logging (registro de sucesos) dentro del sistema, ya que necesariamente afecta a todas las partes del sistema que generan un suceso.
  • Join point (Punto de Cruce o de Unión) es un punto de ejecución dentro del sistema donde un aspecto puede ser conectado, como una llamada a un método, el lanzamiento de una excepción o la modificación de un campo. El código del aspecto será insertado en el flujo de ejecución de la aplicación para añadir su funcionalidad.
  • Advice (Consejo) es la implementación del aspecto, es decir, contiene el código que implementa la nueva funcionalidad. Se insertan en la aplicación en los Puntos de Cruce.
  • Pointcut (Puntos de Corte) define los Consejos que se aplicarán a cada Punto de Cruce. Se especifica mediante Expresiones Regulares o mediante patrones de nombres (de clases, métodos o campos), e incluso dinámicamente en tiempo de ejecución según el valor de ciertos parámetros.
  • Introduction (Introducción) permite añadir métodos o atributos a clases ya existentes. Un ejemplo en el que resultaría útil es la creación de un Consejo de Auditoría que mantenga la fecha de la última modificación de un objeto, mediante una variable y un método setUltimaModificacion(fecha), que podrían ser introducidos en todas las clases (o sólo en algunas) para proporcionarlas esta nueva funcionalidad.
  • Target (Destinatario) es la clase aconsejada, la clase que es objeto de un consejo. Sin AOP, esta clase debería contener su lógica, además de la lógica del aspecto.
  • Proxy (Resultante) es el objeto creado después de aplicar el Consejo al Objeto Destinatario. El resto de la aplicación únicamente tendrá que soportar al Objeto Destinatario (pre-AOP) y no al Objeto Resultante (post-AOP).
  • Weaving (Tejido) es el proceso de aplicar Aspectos a los Objetos Destinatarios para crear los nuevos Objetos Resultantes en los especificados Puntos de Cruce. Este proceso puede ocurrir a lo largo del ciclo de vida del Objeto Destinatario:
    • Aspectos en Tiempo de Compilación, que necesita un compilador especial.
    • Aspectos en Tiempo de Carga, los Aspectos se implementan cuando el Objeto Destinatario es cargado. Requiere un ClassLoader especial.
    • Aspectos en Tiempo de Ejecución.

AOP con Spring Framework

Spring Framework nos ofrece un potencial muy interesante, utilizando el framework de AOP AspectJ, y permitiéndonos usarlo declarando beans muy similares a los tradicionales, y ofreciendo la suficiente flexibilidad para la gran mayoría de los escenarios.
Podemos modificar o agregar comportamiento de nuestros beans en diferentes momentos de la invocación:

  • Antes de invocar a un metodo.
  • Luego de invocar un método, si retornó OK.
  • Luego de invocar un método, si lanzó excepción.
  • Reemplazar la ejecución de un método.

Ejemplos de uso

A continuación veremos algunos casos de uso típicos en los que AOP aplica como solución.

Transaccionabilidad contra una base de datos

Escribí otro post que se centra en este tema, y uno de los enfoques que plantea para resolver esta problemática es definir las transacciones de forma declarativa utilizando AOP.

Profiling

Supongamos que queremos medir y enviar a un log el tiempo que demora la invocación a un conjunto de métodos de nuestras clases. Una opción sería agregar un cronómetro en cada uno de los métodos a monitorear -tomando el tiempo al iniciar, y tomando nuevamente el tiempo en un finally antes de retornar-. Otra opción es crear un aspecto al cual le especificamos qué métodos serán los que tiene que cronometrar.

Definiremos entonces una clase totalmente aislada del resto de la lógica de nuestro sistema, encargada de iniciar un cronómetro, ejecutar el método, parar el cronómetro y enviar a System.out el tiempo insumido.

package demo.aop;

import org.
aspectj.lang.ProceedingJoinPoint;
import org.springframework.util.StopWatch;

public class AopProfiler {

	public Object doProfile(ProceedingJoinPoint call) throws Throwable {

		StopWatch clock = new StopWatch("Started profiling");
		
		try {
			clock.start(call.toShortString());
			return call.proceed();
		} finally {
			clock.stop();
			System.out.println(clock.prettyPrint());
		}
	}
}

Utilizando Spring y AspectJ, la única restricción impuesta a la clase que define el aspecto es que tenga un método que recibe un objeto de tipo ProceedingJoinPoint y que lance Throwable; no son importantes ni el nombre de la clase ni el del método.

La configuración de los beans en Spring quedaría de la siguiente forma:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.
springframework.org/schema/aop"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

	<bean name="aopProfiler" class="demo.aop.AopProfiler" />

	<aop:config>
		<aop:aspect ref="aopProfiler">
			<aop:pointcut id="pointcut" expression="execution(public * demo.dao.PersonDAOImpl.getById(..))" />
			<aop:around method="doProfile" pointcut-ref="pointcut" />
		</aop:aspect>
	</aop:config>
</beans>

Lo destacable de esta configuración son los namespaces que agregamos en el elemento para soportar los beans especiales para la configuración de AOP. El bean llamado “aopProfiler” no tiene nada de especial, simplemente es una referencia a la clase antes definida. La magia ocurre en el bean , en donde definimos el aspecto. define el pointcut del aspecto. Este pointcut en particular significa que el aspecto se va a ejecutar cada vez que ejecutemos el método getById de la clase demo.dao.PersonDAOImpl, sin importar qué parametros le pasemos. El elemento describe el comportamiento del aspecto; cuando se detecte una invocación a este método, el framework desviará la llamada al método doProfile de la clase definida en el bean aopProfiler. Cabe notar que parte de la implementación de este aspecto es invocar al método original (invocando el método org.aspectj.lang.ProceedingJoinPoint.proceed()), pero no es mandatorio.

Logging

Otra aplicación de AOP interesante podría ser registrar las invocaciones a cada método de un conjunto determinado de paquetes, clases o métodos de nuestra aplicación. Adaptando el ejemplo anterior no sería muy difícil implementar un aspecto de logging.
Podríamos darle una funcialidad extra, registrando además los parámetros de la invocación; el método org.aspectj.lang.ProceedingJoinPoint.getArgs() nos abre esta posibilidad, retornando un Object[] con los parámetros de invocación.

Seguridad

El control de acceso a nuestros objetos es otra aplicación típica en las que AOP encaja de forma muy natural. En este caso no daremos ejemplos puntuales de implementación, sino que nos referiremos a un producto ya maduro y centrado especialmente en este punto: Spring Security.

Una de las funcionalidades disponibles en Spring Security es la configuración de restricciones de acceso a los métodos de nuestra lógica de negocios. Esta configuración de las restricciones se puede hacer mediante annotations como por ejemplo @Secured de la siguiente forma:

npublic interface BankService {

	@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
	public Account readAccount(Long id);

	@Secured("IS_AUTHENTICATED_ANONYMOUSLY")
	public Account[] findAccounts();

	@Secured("ROLE_TELLER")
	public Account post(Account account, double amount);
}

Otra forma posible -la que nos interesa destacar- es definiendo pointcuts específicos para este fin, de la forma:

<global-method-security>
	<protect-pointcut expression="execution(* com.mycompany.*Service.*(..))" access="ROLE_USER"/>
</global-method-security>

Este enfoque es particularmente potente; este ejemplo en particular nos permite definir en 3 líneas una restricción de acceso a todos los métodos de las clases llamadas *Service del paquete com.mycompany.

Por información más detallada, referirse a la documentación y ejemplos de Spring Security.

Conclusiones

Si bien se puede argumentar que el uso de las herramientas de AOP pueden impactar en la performance de una aplicación (aunque la performance no fue considerada en este post), nos abre un abanico de posiblidades en lo que tiene que ver con mejorar la claridad de nuestro código, dado que separamos la lógica de negocios de otros aspectos de nuestra aplicación como ser transaccionabilidad, logging, verificación de permisos de acceso, entre otros.
Gracias a esta separación de responsabilidades nuestra lógica que más simple de verificar, ya que es más fácil escribir POJOs -y sus correspondientes tests- que encapsulen las funciones para la que fueron concebidas.

Referencias