自定义注释作为方法记录的拦截器

Question

Java专家

我很新annotations，还没有搜索很多，所以请忍受…

我想实现一个Custom Annotation将intercept调用方法的方法；从最基础的东西开始，它可以只打印方法名称和参数，这样我就可以避免使用该logger语句。

像这样的示例调用：

public MyAppObject findMyAppObjectById(Long id) throws MyCustomException {
    log.debug("in findMyAppObjectById(" + id + ")");
    //....
}

可以转换为：

@LogMethodCall(Logger.DEBUG)
public MyAppObject findMyAppObjectById(Long id) throws MyCustomException {
    //....
}

我可以得到一些提示吗？

Answer 1

根据您对我的评论的回答，您将无法仅凭注释来执行此操作。当然，您可以创建批注并创建一些反射代码，然后将其检测出来并执行一些代码，但这不会对代码造成太大的改变，因为您需要在调用parser方法之前先调用方法，我认为不会对您有太大帮助，因为您将需要在每次调用之前调用解析器方法。

如果您需要提到的行为（自动调用），则需要将注释与某些AOP框架（例如Spring（普通Java）或AspectJ（AspectJ代码））结合起来。然后，您可以设置切入点，并且每次到达该切入点时，都可以执行一些代码。然后，您可以配置为在方法执行之前和/或之后执行一些代码。

如果第一种情况足够，则可以执行以下操作：

记录器：枚举

public enum Logger {
    INFO,
    DEBUG;
}

LogMethodCall：批注

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention( RetentionPolicy.RUNTIME ) // the annotation will be available during runtime
@Target( ElementType.METHOD )         // this can just used in methods
public @interface LogMethodCall {

    Logger logLevel() default Logger.INFO;

}

人员：带注释的类

public class Person {

    // will use the default log level (INFO)
    @LogMethodCall
    public void foo( int a ) {
        System.out.println( "foo! " + a );
    }

    @LogMethodCall( logLevel = Logger.DEBUG )
    public void bar( int b ) {
        System.out.println( "bar! " + b );
    }

}

实用程序：具有日志静态方法的类（将执行“解析”）

public class Utils {

    public static void log( Object o, String methodName ) {

        // gets the object class
        Class klass = o.getClass();

        // iterate over its methods
        for ( Method m : klass.getMethods() ) {

            // verify if the method is the wanted one
            if ( m.getName().equals( methodName ) ) {

                // yes, it is
                // so, iterate over its annotations
                for ( Annotation a : m.getAnnotations() ) {

                    // verify if it is a LogMethodCall annotation
                    if ( a instanceof LogMethodCall ) {

                        // yes, it is
                        // so, cast it
                        LogMethodCall lmc = ( LogMethodCall ) a;

                        // verify the log level
                        switch ( lmc.logLevel() ) {
                            case INFO:
                                System.out.println( "performing info log for \"" + m.getName() + "\" method" );
                                break;
                            case DEBUG:
                                System.out.println( "performing debug log for \"" + m.getName() + "\" method" );
                                break;
                        }

                    }
                }

                // method encountered, so the loop can be break
                break;

            }

        }

    }

}

AnnotationProcessing：带有代码的类，以测试注释处理

public class AnnotationProcessing {

    public static void main(String[] args) {

        Person p = new Person();
        Utils.log( p, "foo" );
        p.foo( 2 );
        Utils.log( p, "bar" );
        p.bar( 3 );

    }
}

当然，您将需要改进我的代码以适合您的需求。这只是一个起点。

有关注释的更多信息：

• http://docs.oracle.com/javase/1.5.0/docs/guide/language/annotations.html
• http://docs.oracle.com/javase/tutorial/java/javaOO/annotations.html
• http://tutorials.jenkov.com/java-reflection/annotations.html

有关AOP的更多信息：

• http://zh.wikipedia.org/wiki/面向方面的编程
• http://static.springsource.org/spring/docs/3.0.x/reference/aop.html
• http://www.eclipse.org/aspectj/