@Aspect切面和自定义log注解实现了下切面日志打印.
AOP
AOP (Aspect Orient Programming),直译过来就是 面向切面编程。AOP 是一种编程思想,是面向对象编程(OOP)的一种补充,在程序开发中主要用来解决一些系统层面上的问题,比如日志,事务,权限等等,这里主要是做一下方法的日志打印。
aop相关注解:
@Aspect:作用是把当前类标识为一个切面供容器读取
@Pointcut:Pointcut是植入Advice的触发条件。每个Pointcut的定义包括2部分,一是表达式,二是方法签名。方法签名必须是 public及void型。可以将Pointcut中的方法看作是一个被Advice引用的助记符,因为表达式不直观,因此我们可以通过方法签名的方式为 此表达式命名。因此Pointcut中的方法只需要方法签名,而不需要在方法体内编写实际代码。
@Around:环绕增强,相当于MethodInterceptor
@AfterReturning:后置增强,相当于AfterReturningAdvice,方法正常退出时执行
@Before:标识一个前置增强方法,相当于BeforeAdvice的功能,相似功能的还有
@AfterThrowing:异常抛出增强,相当于ThrowsAdvice
@After: final增强,不管是抛出异常或者正常退出都会执行
自定义注解
声明一个注解要用到的东西
修饰符:访问修饰符必须为public,不写默认为pubic;
关键字:关键字为@interface;
注解名称:注解名称为自定义注解的名称,使用时还会用到;
注解类型元素:注解类型元素是注解中内容,可以理解成自定义接口的实现部分;
代码:
自定义log注解代码
/**
* 日志注解
*
* Target:用于明确注解用于目标类的哪个位置
* Retention:用于标识自定义注解的生命周期
* RUNTIME:生命周期持续到运行时,能够通过反射获取到
* Documented:用于标识自定义注解能够使用javadoc命令生成关于注解的文档
*
* @author xxx
* @date 2020/xx/xx
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogMessage {
/**
* 使用value值,在使用注解的时候,不需要写@LogMessage(value=xxx),直接写@LogMessage(xxx)即可
*/
String value() default "";
/**
* 别名使用value,所以在使用注解时,既可以写@LogMessage(xxx),也可以写@LogMessage(description=xxx)
*/
@AliasFor("value")
String description() default "";
/**
* 是否打印参数
*/
boolean parameterPrint() default true;
}
apsect切面类注解
/**
* 日志切面类
* Aspect :作用是把当前类标识为一个切面供容器读取
*
* @author xxx
* @date 2020/xx/xx
*/
@Slf4j
@Aspect
@Component
public class LogAspect {
/**
* 前置增强,目标方法执行之前执行
* within:用于匹配所以持有指定注解类型内的方法
* annotation:用于匹配当前执行方法持有指定注解的方法
* within(com.xxx.xxx..*) com.xxx.xxx包及子包下的任何方法执行
*
* @param joinPoint
* @param logManage
* @return void
* @author xxx
* @date 2020/xx/xx
*/
@Before("within(com.xxx.xxx..*) && @annotation(logManage)")
public void addBeforeLogger(JoinPoint joinPoint, LogMessage logManage) {
log.info("[{}] Start", logManage.value());
// 处理参数
try {
if (logManage.parameterPrint()) {
Object[] args = joinPoint.getArgs(); // 参数值
String[] argNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();
Map<String, Object> paramsMap = new HashMap<>();
StringBuilder sb = new StringBuilder();
if (args != null && args.length > 0) {
for (int i = 0; i < args.length; i++) {
paramsMap.put(argNames[i], args[i] != null ? args[i].toString() : "");
}
for (Map.Entry<String, Object> entry : paramsMap.entrySet()) {
sb.append(entry.getKey()).append(":").append(entry.getValue()).append(";");
}
}
log.info("[方法名称:{},方法参数:{}", ((MethodSignature) joinPoint.getSignature()).getMethod().getName(), sb.toString());
}
} catch (Exception e) {
log.info("切面日志打印异常!");
}
}
/**
* 返回增强,目标方法正常执行完毕时执行
*
* within:用于匹配所以持有指定注解类型内的方法
* annotation:于匹配当前执行方法持有指定注解的方法
* within(com.xxx.xxx..*) com.xxx.xxx 包及子包下的任何方法执行
*
* @param joinPoint
* @param logManage
* @return void
* @author xxx
* @date 2020/xx/xx
*/
@AfterReturning("within(com.xxx.xxx..*) && @annotation(logManage)")
public void addAfterReturningLogger(JoinPoint joinPoint, LogMessage logManage) {
log.info("[{}] End", logManage.value());
}
}
controller中使用
@LogMessage("测试日志打印")
@GetMapping(value = "/test", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public void xxx() {
log.info("test");
}
这样在方法执行前和返回后都会打印日志,只需要在想要打印日志的方法上添加@LogMessage("")注解就可以了。