Tengo una pregunta general del diseño y la arquitectura. Después de mirar los patrones de diseño (decoradores, la cadena de comandos, etc.) todavía no está claro para mí.
Requisito: Me gustaría tener que entrar tanto en la entrada y salida de mis métodos.
A partir de ahora, todos mis métodos se parece a:
public SomeReturnType someMethod1( SomeParameter someParameter ) {
LOGGER.info( "{someMethod1}[START someMethod1 compute]" );
doSomeComputationFor(someParameter);
SomeReturnType result = getSomeResult();
LOGGER.info( "{someMethod1}[END someMethod1 compute]" );
return result;
}
public SomeOtherReturnType someMethod2( SomeOtherParameter someOtherParameter ) {
LOGGER.info( "{someMethod2}[START someMethod2 compute]" );
maybeDoSomeDBOperation(someOtherParameter);
SomeOtherReturnType result = getSomeOtherResult();
LOGGER.info( "{someMethod2}[END someMethod2 compute]" );
return result;
}
(Por debajo de la tala, También estoy usando alguna biblioteca KPI para enviar alguna marca de tiempo, como StatsD)
Todas las estructuras son realmente de la forma:
public Foo method( Bar bar ) {
//1 do some logging as the method starts, and also send some KPI
LOGGER.info( "{method}[START method compute]" );
//2 do some computation and actual business logic
//3 do some logging the confirm the mothods has reached the end + send some other KPI like time elapsed
LOGGER.info( "{method}[END method compute]" );
return result;
}
Ahora, mirando a mi proyecto, tengo unos 290 métodos que están siguiendo la misma estructura exacta.
¿Hay una forma inteligente de resolver esto? Tal vez con un modelo agradable? Algunas anotaciones? Aspectos? Estoy abierto a la sugerencia ya que creo que definitivamente hay una solución mejor que mi actual.
Una posible solución está usando su dependencia del inyector + anotaciones.
Aquí tienes un ejemplo de cómo poner en práctica lo que desee con autógena en una aplicación JavaSE.
Es necesario añadir esta dependencia:
<dependency>
<groupId>org.jboss.weld.se</groupId>
<artifactId>weld-se-core</artifactId>
<version>3.1.0.Final</version>
</dependency>
A continuación, crear una anotación que será útil para señalar los métodos que desea registrar.
package org.loggable;
import javax.interceptor.InterceptorBinding;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.TYPE, ElementType.METHOD})
@Inherited
@InterceptorBinding
@Retention(RetentionPolicy.RUNTIME)
public @interface Loggable {
}
Crear el interceptor
package org.loggable;
import javax.interceptor.AroundInvoke;
import javax.interceptor.Interceptor;
import javax.interceptor.InvocationContext;
import java.util.logging.Logger;
@Loggable
@Interceptor
public class LoggableInterceptor {
@AroundInvoke
public Object logMethod(InvocationContext context) throws Exception {
Logger logger = Logger.getLogger(context.getTarget().getClass().getSimpleName());
logger.info("Starting method: " + context.getMethod().getName());
Object response = context.proceed();
logger.info("Finished method: " + context.getMethod().getName());
return response;
}
}
Como se puede ver @AroundInvoke
, nos permite el control al entrar y salir de un método.
Tenemos que informar de soldadura que hay un nuevo interceptor, lo hacemos mediante la adición beans.xml
en la carpeta META-INF.
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd"
bean-discovery-mode="all">
<interceptors>
<class>org.loggable.LoggableInterceptor</class>
</interceptors>
</beans>
Por último tenemos que llamar a nuestra entidad a través de soldadura, ya que es el encargado de crear y ejecutar los interceptores.
package org.loggable;
import javax.enterprise.inject.se.SeContainer;
import javax.enterprise.inject.se.SeContainerInitializer;
import java.io.IOException;
import java.util.logging.Logger;
public class Main {
public static void main(String... args) throws IOException {
SeContainer seContainer = SeContainerInitializer.newInstance()
.initialize();
Main main = seContainer.select(Main.class).get();
main.loggableMethod();
seContainer.close();
}
@Loggable
public void loggableMethod() {
Logger.getLogger(Main.class.getSimpleName()).info("Inside method.");
}
}
Y obtendrá una salida como:
[2019-04-06 11:07:20] [INFO ] Starting method: loggableMethod
[2019-04-06 11:07:20] [INFO ] Inside method.
[2019-04-06 11:07:20] [INFO ] Finished method: loggableMethod
Esta es la estructura del proyecto en caso de necesidad.
Nota: En caso de estar en un proyecto JavaEE, todos ellos relacionados con la creación de soldadura es gestionado por el contenedor.