SpringAOP实现自动生成日志

时间 2019-11-06

原文原文链接

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

Java代码

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;
}

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

Java代码

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

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

Java代码

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

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

Java代码

@AOPLog4jAnnotation(paramCollection="name,words")

惟一的好处是...只须要复制上面这行，而后遵循规则填写参数名。
惟二的好处是...日志格式统一。
完了，伤心了，感受实用性不强，哎。

算了，把代码都贴上吧，留着之后改进。
Spring配置：

Java代码

<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>

切面代码：

Java代码

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服务，输出：

Java代码

[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.

oschina好像不能插入附件，请移步去个人iteye博客下载吧，谢谢。 java

http://dl.iteye.com/topics/download/0e1af44b-81d0-351c-badb-5e758093767b express