Skip to content

ARSW-ECI-archive/aop-find-the-bug

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

###Escuela Colombiana de Ingeniería ###Arquitecturas de Software ####Programación Orientada por Aspectos

#####Parte I. Ejemplo básico

En este repositoroio están los fuentes y las librerías de una aplicación que está generando errores, para la cual, debido a las malas prácticas de su programador en cuanto al manejo de excepciones (no propagarlas ni escalarlas), no se sabe a ciencia cierta cual es la causa (además, la causa parece estar en una de las librerías para las cuales no existen fuentes). Para poder identificar la causa, se le ha pedido que diseñe e implemente un aspecto que intercepte cualquier excepción lanzada por cualquier método, y que imprima su traza correspondiente. Algo a favor es que la aplicación está montada alrededor del framework Spring, de manera que es posible utilizar las facilidades de AOP que vienen incluidas en el mismo.

  1. Revise en el archivo de configuración de Spring los Beans definidos y sus dependencias.

  2. Cree un nuevo Bean, que se encargue de manejar los consejos (‘advice’) de los aspectos que se definan.

  3. En dicho Bean agregue un método que reciba por parámetro un objeto de tipo JoinPoint y otro de tipo Exception. Tenga en cuenta el nombre asignado a dicho parámetro, pues éste se usará en la configuración del aspecto.

  4. Teniendo en cuenta que en el método anterior se usará como 'consejo' (Advice) del aspecto, y que el mismo recibirá la excepción interceptada, haga que en éste se muestre la traza de la misma.

  5. Basado en la siguiente plantilla para la configuración de aspectos, defina un aspecto que se active cuando se arroje una excepción. Haga que como consejo (‘advice’) se imprima la traza de la excepción.

    <aop:config>
    	<aop:aspect ref="bean_aspectos">
    	
    		<!-- Pointcut -->
    		<aop:pointcut expression="expresión del poincut" id="identif.pointcut"/>
    
    		<!-- Advice & Context (after, around, after throwing, etc) -->				
    		<aop:after-throwing throwing="nombre_var_excepcion" pointcut-ref="identif.pointcut" method="metodo_advice"/>
    		
    		<!-- <aop:before pointcut-ref="xxxxx" method="yyyy"/>-->
    		<!-- <aop:after pointcut-ref="xxxxx" method="yyyy"/>-->
    			
    	</ aop:aspect>
    	
    	<aop:aspect ref="bean_aspectos2">
    		...
    	</ aop:aspect>
    </aop:config>


5. Puede encontrar mas información sobre programación orientada a aspectos y las expresiones de los pointcut la [documentación oficial de Spring](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/aop.html) (en la misma busque la sección que inicia con '*Some examples of common pointcut expressions are given below*'.


6. Pruebe el programa e intente identificar la causa del problema con los nuevos resultados obtenidos. 


7. Ahora, se quiere identificar si el método ‘execute’ de la clase MainProcessor se ejecuta un número determinado de veces a través de un aspecto, pero sin 'contaminar' el código existente. Sin embargo, para hacer más flexible el uso de este aspecto, se quiere que el mismo tenga como punto de corte (‘pointcut’) aquellos métodos que tengan una anotación en particular. Por otro lado, dicho aspecto tendrá como consejo (‘advice’) realizar el conteo del número de invocaciones e imprimir un mensaje en cuanto el límite de número de invocaciones indicado se alcance. Para hacer esto:

	1. Implemente una nueva anotación para métodos ( @Target(value=ElementType.METHOD) )
y con una retención de tipo “Runtime” (@Retention(RetentionPolicy.RUNTIME));
	2. A la anotación agregue un atributo de tipo entero, que sirva para parametrizar el número de ejecuciones que se va a validar.
	3. A la clase que maneja los aspectos, agregue un método para implementar el consejo del nuevo aspecto. En este caso, dicho método sólo debe recibir como parámetro un objeto de tipo JoinPoint. Haga que este método extraiga del objeto JoinPoint el método interceptado (objeto Method), y luego (usando el API de Reflection) extraiga la anotación, de dicha anotación extraiga el valor, y con este identifique si el número de ejecuciones límite se ha identificado.
Tenga también en cuenta que varios métodos podrían tener la misma
anotación, por lo que el método de joinPoint de alguna manera debe llevar cuentas separadas para cada método.


		Nota: para extraer el objeto Method del joinPoint:
		
		```java		
		MethodSignature signature = (MethodSignature)joinPoint.getSignature();
		Method method = signature.getMethod();
		```
		
	4. En el archivo de configuración de Spring agregue un nuevo aspecto donde:
	
		* El punto de corte será: “todos aquellos métodos que tengan la anotación creada anteriormente”. La expresión para el mismo será de la forma: @annotation(aaa.bbb.ccc.MiAnotacion)
		* El consejo será de tipo \<aop:before\>, \<aop:after\> o \<aop:around\>:
		 
			```xml			
			<aop:after pointcut-ref="identif.pointcut" method="metodo_advice"/>			
			```

	5. Agregue un nuevo método en la clase MainProcesor.
	6. Pruebe el funcionamiento del nuevo aspecto agregando las anotaciones al método creado en el punto 5 y al método execute de la clase MainProcessor con:
	
		* Límite de 10 invocaciones
		* Límite de 15 invocaciones

		
#####Parte II. Para la próxima clase.

AL ejercicio desarrollado anteriormente (procesador de palabras), se le quiere incorporar un esquema de *benchmarking* que NO QUEDE ACOPLADO al código existente, pues la idea es poder remover el mismo con facilidad -sin tener que tocar el código- una vez se tengan los datos.

1. Para poder realizar estadísticas de desempeño de las diferentes configuraciones que permite la aplicación, se quiere que los tiempos de ejecución de las operaciones de búsqueda de palabras, persistencia y carga de documentos puedan ser medidos. 

	Específicamente, se quiere que un aspecto asociado a las operaciones antes mencionadas, se le pueda inyectar el componente que decide qué hacer con los tiempos medidos (y así flexibilizar las posibilidades de uso de estos datos). Por ahora, se quiere manejar dos variantes de dicho componente:

	* Variante 1, para análisis estadístico: Concatena en un archivo de texto los tiempos calculados, usando el formato CSV (Comma Separated Values), de manera que se pueda abrir en una hoja de cálculo:
	

		| Timestamp        | Operación           | Tiempo(ms)  |
| ------------- |:-------------:| -----:|
| 1355563265      | Corrección | 1 |
| 1355563267      | Corrección | 31 |
| 1355563268      | Corrección | 12 |
| 1355563344      | Persistencia doc     |   2 |
| 1355563943 | Carga doc     |    30 |

	* Variante 2, para análisis en vivo: A partir de unos valores T y N dados, este componente alertará con una ventana emergente y un sonido cuando se hayan dado N eventos de operaciones que hayan tomado más de T milisegundos.

	Tip 1: Recuerde incluír las dependencias necesarias para habilitar el soporte a AOP.

	Tip 2: Para este ejercicio vale la pena que revise [en la documentación oficial de Spring](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/aop.html) el uso de 'consejos' de tipo *Around*.

	Tip 3: Para este caso, es útil usar anotaciones para marcar los *Pointcut* relevantes. Igualmente, en ambos casos, resulta útil definir campos dentro de la anotación en los que se puedan definir detalles que sirvan al aspecto para realizar su tarea.	
	
##Criterios de evaluación

1. Parte I.
	* Diseño:
		* Se creó un aspecto que tiene como Pointcut una anotación, que tiene como 'consejo' (de tipo antes o después) el llevar una cuenta del número de invocaciones, y que muestra un aviso cuando se supera el valor dado como propiedad de la anotación antes mencionada. Se debe tener en cuenta que la anotación puede están en diferentes métodos, por lo que se deben llevar cuentas diferentes por cada uno de éstos (si se lleva una cuenta global, se evalúa como R).
	* Funcional: 
		* Se muestra la traza completa de la excepción cuando se analizan números negativos y se lanza la alerta cuando se supera el número de invocaciones.

2. Parte II.
	* Diseño:
		* Se creó un aspecto que tiene como Pointcut una anotación. El 'consejo' asociado al aspecto es de tipo 'around' y mide los tiempos de ejecución de aquellos métodos que tengan la anotación.
		* El Bean que tiene asociado el 'consejo' del aspecto antes mencionado cumple con el principio de inversión de dependencias al tener asociada una abstracción del manejo de los tiempos. La configuración de la aplicación debe permitir inyectar al aspecto un manejador de tiempos que registre los tiempos en un archivo CSV, o uno alternativo que muestre una alerta cada vez que los tiempos superan un intervalo determinado.
			Nota: El manejar diferentes aspectos, en lugar de uno solo al que se le inyecte el mecanismo del manejo de los tiempos, tendrá evaluación R, pues esto implica tener código duplicado.
	* Funcionalidad (se debe conservar la funcioanlidad anterior):
		* Según la configuración que se tenga, la nueva versión del procesador de palabras:
			* Registra en un archivo CSV los tiempos medidos durante su ejecución.
			* Se debe mostrar un aviso emergente y un sonido(opcional) cuando se superan los tiempos de ejecución.
			

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages