SpringAOP实现自动生成日志 【基于java.lang.annotation约定】

          项目中总要发布一下服务供系统内外调用，为了方便排查错误，入参出参都要以日志的形式记录下来。
传统做法：缺点一目了然，参数少的时候只能说还好，参数一多，烦不胜烦，浪费时间。

    private static final Logger logger = Logger.getLogger(HelloServiceImpl.class);
    public String sayHello(String name,String words) {
          logger.info("remote input:name="+name+",words="+words);
          //业务逻辑
          String result = "Hello"+name+","+words);
          logger.info("remote output:result="+result);
          return result;
    }

          于是借鉴了AOP的思想，将日志功能做成一个切面，横向切入到业务逻辑前后（方法开始前和结束后）。
        另外，解释一下什么是【基于java.lang.annotation约定】。
        由于java的反射是不能获取方法的参数名的，网上有一个第三方工具包JAVAssist提供了现成的方法，但笔者觉得挺麻烦的，决定使用约定优于配置的方式来获取方法的参数名。大家大概猜到是什么了吧？对！就是建一个自定义注解。

@Target(ElementType.METHOD)  
@Retention(RetentionPolicy.RUNTIME)  
@Documented  
public @interface AOPLog4jAnnotation {
	String paramCollection();
}

在需要日志切面的地方（方法）加上这个注解。

public class HelloServiceImpl implements HelloService{
	@Override
	@AOPLog4jAnnotation(paramCollection="name,words")
	public String sayHello(String name,String words) {
		String text = "Hello "+name+"!"+words+".";
		return text;
	}
}

           大家也看到了，笔者的这种方式的明显的缺点：需要按一定规则（把参数按顺序填进去，并用英文逗号隔开）把方法参数名配置在注解中。

@AOPLog4jAnnotation(paramCollection="name,words")

唯一的好处是...只需要复制上面这行，然后遵循规则填写参数名。
唯二的好处是...日志格式统一。
完了，伤心了，感觉实用性不强，哎。 
算了，把代码都贴上吧，留着以后改进。
Spring配置：

	<bean id="helloService" class="com.aop.log4j.service.impl.HelloServiceImpl" />
	<bean id="aspect" class="com.aop.log4j.aspect.HelloAspect"/>
	<aop:config>
		<aop:pointcut id="pointcut" expression="execution(* com.aop.log4j.service.HelloService.*(..)))" />
		<aop:aspect ref="aspect">
			<aop:around pointcut-ref="pointcut" method="arround"/>
		</aop:aspect>
	</aop:config>

切面代码：

public class HelloAspect {
	private static final Logger logger = Logger.getLogger(HelloAspect.class);
	private static final String DOT = ".";//点号
	private static final String COMMA = ",";//逗号
	
	public Object arround(ProceedingJoinPoint joinPoint) throws Throwable {
	    StringBuilder sb = new StringBuilder();
	    Object[] paramValues = joinPoint.getArgs();//获取参数值
	    String[] paramNames = new String[paramValues.length];
        Class<? extends Object> invokeClass = joinPoint.getTarget().getClass();
        String signatureName = joinPoint.getSignature().getName();
	    Method methods[] = invokeClass.getMethods();
	    for (Method method : methods) {
		if(method.getName().equals(signatureName)) {
                String paramCollection = method.getAnnotation
                      (AOPLog4jAnnotation.class).paramCollection();//获取注解值
				String[] names = paramCollection.split(COMMA);
				System.arraycopy(names, 0, paramNames, 0, names.length);
			}
		}
	    for (int i = 0; i < paramValues.length; i++) {
	    	sb.append(paramNames[i] + "=" + paramValues[i] + COMMA);
	    }
        //入参日志
	    logger.info(invokeClass  + DOT + signatureName + ",remote input:" 
                        + sb.toString().substring(0, sb.length() - 1));
	    try {
		   Object result = joinPoint.proceed();
           //出参日志
		   logger.info(invokeClass  + DOT + signatureName 
                   + ",remote output:" + result);
           return result;
	    } catch (Exception e) {
		   logger.error(invokeClass  + DOT + signatureName
                   + " invoke error");
	    }
        return null;
	}
}

调用HelloService服务，输出：

[INFO] 2012-10-03 11:54:29,807 [com.aop.log4j.aspect.HelloAspect.arround] - class com.aop.log4j.service.impl.HelloServiceImpl.sayHello,remote input:name=Java,words=I love you.
[INFO] 2012-10-03 11:54:29,808 [com.aop.log4j.aspect.HelloAspect.arround] - class com.aop.log4j.service.impl.HelloServiceImpl.sayHello,remote output:Hello Java!I love you.

评论

9 楼 kjj 2012-11-18  

和我的实现思路差不多，我是直接用aspectj这个插件记录的，sprign的aop总觉得没有原声的方便

8 楼 JianFengLiang 2012-11-18  

hitmit1314 写道

拜托，没有必要引入第三方包你用Spring干什么？ 而且跟你说,Javassist叫做字节码读写框架,你要用到hibernate, 它本来就是required的包。即使你不用hibernate, spring 也用了字节码框架的，asm。 就是说，你已经有了这个资源，就是米有去用。而且字节码框架是直接读.class文件的，在有些时候，比起反射，classloader效果要好很多。

    是在搜自己遇到的问题搜到博主的文章的，想法很到位，十分感激。只是用了个贱贱的方法给你一些提示，呵呵，还请博主见谅，不与小辈计较，希望能帮助你改进你所说的缺点。另外， asm是访问者(Vister)模式的，比较难转过弯儿来

受教了！哈哈，谢谢哥们的指点，尽快改正~

7 楼 hitmit1314 2012-11-18  

拜托，没有必要引入第三方包你用Spring干什么？ 而且跟你说,Javassist叫做字节码读写框架,你要用到hibernate, 它本来就是required的包。即使你不用hibernate, spring 也用了字节码框架的，asm。 就是说，你已经有了这个资源，就是米有去用。而且字节码框架是直接读.class文件的，在有些时候，比起反射，classloader效果要好很多。

    是在搜自己遇到的问题搜到博主的文章的，想法很到位，十分感激。只是用了个贱贱的方法给你一些提示，呵呵，还请博主见谅，不与小辈计较，希望能帮助你改进你所说的缺点。另外， asm是访问者(Vister)模式的，比较难转过弯儿来

6 楼 JianFengLiang 2012-10-06  

小树鹿鸣 写道

这个东东没啥实用，特别是形参的多变性， 公司项目还采用模板语言freemarker去解析参数，性能也经不起考验，还花了成员好多时间磨在上面，伤不起！还是自已去封装一套API，格式可以自定义在properties文件中，使用占位符， 这样来得简单。

多谢您的建议，确实不实用，权当一个想法，抛砖引玉啦。
PS:哈哈 WEB-INF\lib 你都去看了~太仔细了，示例里面是没用到freemarker的，忘记删了。不过公司的项目用的都是freemarker。可能为了省事吧，不甚理解。

5 楼 小树鹿鸣 2012-10-06  

这个东东没啥实用，特别是形参的多变性， 公司项目还采用模板语言freemarker去解析参数，性能也经不起考验，还花了成员好多时间磨在上面，伤不起！还是自已去封装一套API，格式可以自定义在properties文件中，使用占位符， 这样来得简单。

4 楼 tywo45 2012-10-04  

不用测试，目测一把就知道性能很差，博主赶紧给个高性能版本的。哈哈

3 楼 JianFengLiang 2012-10-03  

cue2008 写道

你有压测过性能吗

没有 目测性能会很差 反射、循环等 公司项目有现成的一套 想自己先写一个再去研究公司的 呵呵

2 楼 cue2008 2012-10-03  

你有压测过性能吗

1 楼 kjj 2012-10-03  

由于java的反射是不能获取方法的参数名的 :roll:  :roll:  :roll:  :roll:  :roll:  :roll: