Programación orientada a aspectos con Guice
Me gusta la programación orientada a aspectos por la cantidad de ifs que te quita. Ademas son ifs que tienes que ir repitiendo a lo largo del código.
Se me ha ocurrido hacer un pequeño ejemplo con JUnit. Vamos a hacer las tipicas comprobaciones de:
- Autenticación/Autorización. Usaremos http://shiro.apache.org/
- Validación de parámetros. Usaremos http://bval.apache.org/
Las vamos a hacer de las dos formas, con aspectos y sin aspectos, demostrando que el resultado es el mismo, pero con aspectos queda mas limpio.
Antes de empezar con el Test, hay que configurar Shiro. Explicandolo por encima, tenemos un fichero que se llama shiro.ini, donde he definido los usuarios con su rol.
[users]
root = secret, admin
guest = guest, guest
[roles]
admin = *
También hay que configurar el modulo de Shiro para Guice, donde se le dice que se configure en base al contenido de shiro.ini:
package com.tododev.shiro;
import org.apache.shiro.config.Ini;
import org.apache.shiro.guice.ShiroModule;
import org.apache.shiro.realm.text.IniRealm;
import com.google.inject.Provides;
public class MyShiroModule extends ShiroModule{
protected void configureShiro() {
try {
bindRealm().toConstructor(IniRealm.class.getConstructor(Ini.class));
} catch (NoSuchMethodException e) {
addError(e);
}
}
@Provides
Ini loadShiroIni() {
return Ini.fromResourcePath("classpath:shiro.ini");
}
}
Ahora vamos ya con el test. Este test contiene 4 metodos de test, que comprueban lo siguiente sobre el método de la interfaz Interface.doSomething:
- Si no estas autenticado lanza una UnauthenticatedException.
- Si no tienes el rol de “admin” lanza una UnauthorizedException.
- Si le pasas el parámetro a nulo lanza una ConstraintViolationException.
- Si estas autenticado, con el rol de “admin” y no pasas el parámetro a nulo, no lanza excepciones.
La gracia es que el test lo vamos a hacer con dos implementaciones diferentes de Interface.class:
- Aop.class
- NoAop.class
Es decir, se van a hacer 2 x 4 = 8 tests. El resultado tiene que se el mismo.
package com.tododev.shiro;
import static org.junit.Assert.fail;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.constraints.NotNull;
import org.apache.bval.guice.Validate;
import org.apache.bval.guice.ValidationModule;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.authz.UnauthenticatedException;
import org.apache.shiro.authz.UnauthorizedException;
import org.apache.shiro.authz.annotation.RequiresRoles;
import org.apache.shiro.guice.aop.ShiroAopModule;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.subject.Subject;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
import com.google.inject.AbstractModule;
import com.google.inject.Guice;
import com.google.inject.Injector;
/**
* Vamos a hacer que el test se ejecute con la clase Parameterized. Esta clase
* nos ejecutara 2 veces todos los tests, insertando en el constructor los
* valores del metodo data().
*
* @author jorge
*
*/
@RunWith(Parameterized.class)
public class GuiceAopTest {
private final static String ADMIN_ROLE = "admin";
private final UsernamePasswordToken ADMIN = new UsernamePasswordToken(
"root", "secret");
private final UsernamePasswordToken GUEST = new UsernamePasswordToken(
"guest", "guest");
private final Injector injector;
/**
* Cuando se crea la instancia de GuiceAopTest.class, se le inserta uno de
* los valores del metodo data().
*
* @param injector
*/
public GuiceAopTest(Injector injector) {
this.injector = injector;
}
/**
* Devuelve una coleccion que contiene un inyector con AOP y otro que no. La
* idea es demostrar que los tests pasan satisfactoriamente de las dos
* formas posibles.
*
* @return
*/
@Parameters
public static Collection<Object[]> data() {
Injector withAop = Guice.createInjector(new ShiroAopModule(),
new MyShiroModule(), new ValidationModule(),
new AbstractModule() {
@Override
protected void configure() {
bind(Interface.class).to(Aop.class);
}
});
Injector noAop = Guice.createInjector(new MyShiroModule(),
new AbstractModule() {
@Override
protected void configure() {
bind(Interface.class).to(NoAop.class);
}
});
Object[][] data = { { noAop }, { withAop } };
return Arrays.asList(data);
}
public static interface Interface {
void doSomething(String value);
}
/**
* Implementacion preparada para tener aspectos.
*
* @author jorge
*
*/
public static class Aop implements Interface {
@Validate
@RequiresRoles(ADMIN_ROLE)
@Override
public void doSomething(@NotNull String value) {
System.out.println(getClass() + ": " + value);
}
}
/**
* Hace lo mismo que hace Aop, pero esta no usara aspectos.
*
* @author jorge
*
*/
public static class NoAop implements Interface {
@Override
public void doSomething(String value) {
if (value != null) {
Subject currentUser = SecurityUtils.getSubject();
if (currentUser.isAuthenticated()) {
if (currentUser.isPermitted(ADMIN_ROLE)) {
System.out.println(getClass() + ": " + value);
} else {
throw new UnauthorizedException();
}
} else {
throw new UnauthenticatedException();
}
} else {
throw new ConstraintViolationException(
new HashSet<ConstraintViolation<?>>());
}
}
}
/**
* Preparamos Shiro para ser usado.
*/
@Before
public void before() {
SecurityManager securityManager = injector
.getInstance(SecurityManager.class);
SecurityUtils.setSecurityManager(securityManager);
}
/**
* Deslogueamos al usuario si estuviera logueado.
*/
@After
public void after() {
Subject currentUser = SecurityUtils.getSubject();
currentUser.logout();
}
/**
* Vefirica que si no estas logueado salta una UnauthenticatedException
*/
@Test(expected = UnauthenticatedException.class)
public void unauthenticated() {
Interface classToTest = injector.getInstance(Interface.class);
classToTest.doSomething("any value");
fail("Unreachable code");
}
/**
* Verifica que si no tienes los permisos adecuados salta una
* UnauthorizedException
*/
@Test(expected = UnauthorizedException.class)
public void unauthorized() {
Subject currentUser = SecurityUtils.getSubject();
currentUser.login(GUEST);
Interface classToTest = injector.getInstance(Interface.class);
classToTest.doSomething("any value");
fail("Unreachable code");
}
/**
* Verifica que si llamas al metodo con el String nulo, salta una
* ConstraintViolationException
*/
@Test(expected = ConstraintViolationException.class)
public void constraintViolation() {
Subject currentUser = SecurityUtils.getSubject();
currentUser.login(ADMIN);
Interface classToTest = injector.getInstance(Interface.class);
classToTest.doSomething(null);
fail("Unreachable code");
}
/**
* Verifica el caso de que todo es correcto y no hay excepciones
*/
@Test
public void allowed() {
Subject currentUser = SecurityUtils.getSubject();
currentUser.login(ADMIN);
Interface classToTest = injector.getInstance(Interface.class);
classToTest.doSomething("any value");
}
}
El resultado de los test es este:
Los 8 tests han pasado bien.
Este es el resultado que se muestra en la consola:
class com.tododev.shiro.GuiceAopTest$NoAop: any value
class com.tododev.shiro.GuiceAopTest$Aop$$EnhancerByGuice$$4ee6b586: any value
Os podeis fijar que la clase Aop “ha sido mejorada” por Guice, añadiendole los aspectos de Shiro y BVal. Lo curioso es que en las clases compiladas vemos lo siguiente:
La clase que aparece señalada debería llamarse GuiceAopTest$Aop$$EnhancerByGuice$$4ee6b586, pero se llama GuiceAopTest$Aop. Esto es porque Guice no hace los aspectos en tiempo de compilación, sino en ejecución. Esto tiene algunas limitaciones, pero en muchos casos resulta ser suficiente.
En conclusión:
Se puede comprobar lo limpio que queda el código usando aspectos. Así es mas fácil ver qué es lo que hace el método doSomething(). Además, esas anotaciones las podemos aprovechar y llevar a otros métodos que requieran esas comprobaciones.
TODOdev 