AspectJ en Acción
En este artículo, les mostraremos como funciona AspectJ a traves de un ejemplo básico, y para agilizar el proceso, solo nos hemos enfocado en las partes más importantes del proyecto.
El objetivo del este artículo es mostrar un breve tutorial de como utilizar AspectJ creando un aspecto que intercepte un método para imprimir un mensaje antes y después de la ejecución de dicho método.
Teniendo como base un proyecto maven vacío, procedemos con las siguientes adiciones.
Dependencias Maven
Agregamos las siguientes dependencias en nuestro archivo pom.xml.
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>1.9.7</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.7</version>
</dependency>
Y el plugin aspecjt-maven-plugin que nos permitirá entrelazar el aspecto con nuestra clase, haciendo uso del compilador de AspectJ (ajc).
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>1.14.0</version>
<configuration>
<complianceLevel>16</complianceLevel>
<source>16</source>
<target>16</target>
<showWeaveInfo>true</showWeaveInfo>
<verbose>true</verbose>
<Xlint>ignore</Xlint>
<encoding>UTF-8 </encoding>
</configuration>
<executions>
<execution>
<goals>
<goal>compile</goal>
<goal>test-compile</goal>
</goals>
</execution>
</executions>
</plugin>
La clase
Para la implementación, creamos la siguiente clase llamada Console con un método que imprime un mensaje en la consola.
public class Console {
public void printMessage() {
System.out.println("message");
}
}
El aspecto
Creamos un aspecto de prueba usando el advice «around» que imprime un mensaje antes y después de la ejecución del método printMessage.
public aspect ConsoleAspect {
void around(): call(void Console.printMessage()) {
System.out.println("Log before...");
proceed();
System.out.println("After log...");
}
}
La prueba
Creamos la siguiente prueba para validar si los mensajes son pintados en la consola.
public class ConsoleTest {
@Test
public void testPrintMessage() {
Console console = new Console();
console.printMessage();
}
}
Ejecutamos la prueba unitaria con mvn test y obtenemos un resultado similar al siguiente:
Se observan los siguientes mensajes generados por el compilado ajc (que fue configurado para ejecutarse en la fase de compilación) se muestran antes de la ejecución del test.
[INFO] --- aspectj-maven-plugin:1.14.0:compile (default) @ aop ---
[INFO] Showing AJC message detail for messages of types: [error, warning, fail]
[INFO] Join point 'method-execution(void com.indev.aop.Console.printMessage())' in Type 'com.indev.aop.Console' (Console.java:5) advised by around advice from 'com.indev.aop.ConsoleAspect' (ConsoleAspect.aj:4)
En la siguiente parte de la consola se observan 3 mensajes, dos correspondientes al aspecto y el del medio al método en sí.
[INFO]
[INFO] -------------------------------------------------------
[INFO] T E S T S
[INFO] -------------------------------------------------------
[INFO] Running com.indev.aop.ConsoleTest
Log before...
message
After log...
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.008 s - in com.indev.aop.ConsoleTest
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.031 s
[INFO] Finished at: 2022-09-10T02:45:55-05:00
[INFO] ------------------------------------------------------------------------
Como se observa, la utilización de AspectJ no debería ser algo complicado en nuestro proyecto, ya que como vimos en la parte superior es muy simple de implementar. Y si estamos usando spring en nuestro proyecto, te contamos que podemos usar AspectJ con las anotaciones de Spring, ya que son compatibles.
Como siempre puedes encontrar el código del ejemplo aquí.
Con esto nos despedimos y esperamos que hayamos podido contribuir en algo compartiendo nuestro conocimiento.