SpringBoot利用自定义注解记录请求或方法执行日志

首先&＃xff0c;定义日志注解&＃xff0c;注解字段可自行扩展

&＃64;Documented
&＃64;Retention(RetentionPolicy.RUNTIME)
&＃64;Target({ElementType.METHOD})
public &＃64;interface Log {/**操作名称*/String value() default "";/**模块名*/String moduleName() default "";}


主要思路是&＃xff1a;

利用AOP拦截被注解标注的方法&＃xff0c;进行相关参数获取。为了防止日志保存影响正常的业务执行&＃xff0c;因此利用Spring的事件机制&＃xff0c;发送事件给监听器&＃xff0c;监听器收到事件后&＃xff0c;异步保存日志。

注&＃xff1a;在本示例中&＃xff0c;使用Lombok注解&＃xff0c;请自行了解Lombok注解作用。

下面是Aop的实现类&＃xff0c;拿到拦截参数后&＃xff0c;关键的一步是通过spring 的事件机制&＃xff0c;将事件广播出去。

LogAop.java

&＃64;Slf4j
&＃64;Aspect
&＃64;Component
public class LogAop {&＃64;Pointcut(value &＃61; "&＃64;annotation(com.chillax.boot.core.common.annotation.Log)")public void cutService() {}&＃64;Around("cutService()")public Object recordSysLog(ProceedingJoinPoint point) throws Throwable {long startTime &＃61; System.currentTimeMillis();//先执行业务Object result &＃61; point.proceed();long endTime &＃61; System.currentTimeMillis();try {handle(point, endTime - startTime, null);} catch (Exception e) {log.error("日志记录出错!", e);}return result;}&＃64;AfterThrowing(pointcut &＃61; "cutService()", throwing &＃61; "e")public void doAfterThrowing(JoinPoint point, Throwable e) {try {handle(point, null, e);} catch (Exception ex) {log.error("日志记录出错!", ex);}}private void handle(JoinPoint point, Long methodProcessTime, Throwable e) throws Exception {//获取拦截的方法名Signature sig &＃61; point.getSignature();MethodSignature msig &＃61; null;if (!(sig instanceof MethodSignature)) {throw new IllegalArgumentException("该注解只能用于方法");}msig &＃61; (MethodSignature) sig;Object target &＃61; point.getTarget();Method currentMethod &＃61; target.getClass().getMethod(msig.getName(), msig.getParameterTypes());String methodName &＃61; currentMethod.getName();//获取拦截方法的参数Object[] params &＃61; point.getArgs();//获取操作名称Log annotation &＃61; currentMethod.getAnnotation(Log.class);String moduleName &＃61; annotation.moduleName();String operationName &＃61; annotation.value();//这里根据自己的业务需求&＃xff0c;封装自己的业务类SysLog sysLog &＃61; new SysLog();SpringContextUtil.publishEvent(new SysLogEvent(sysLog));}}

日志事件类&＃xff0c;用于事件间的传递。可以扩展此类用做其他用途。

SysLogEvent.java

public class SysLogEvent extends ApplicationEvent {public SysLogEvent(Object source) {super(source);}}


Spring容器工具类&＃xff0c;在项目启动时&＃xff0c;注入Spring上下文&＃xff0c;然后封装一下事件发送方法及其他常用方法。

SpringContextUtil.java

&＃64;Slf4j
&＃64;Service
&＃64;Lazy(false)
public class SpringContextUtil implements ApplicationContextAware, DisposableBean {private static ApplicationContext applicationContext;public static Object getBean(String name) {return applicationContext.getBean(name);}public static T getBean(String name, Class requiredType) {return applicationContext.getBean(name, requiredType);}public static boolean containsBean(String name) {return applicationContext.containsBean(name);}public static boolean isSingleton(String name) {return applicationContext.isSingleton(name);}public static Class getType(String name) {return applicationContext.getType(name);}public static void publishEvent(ApplicationEvent event) {if (applicationContext !&＃61; null) {applicationContext.publishEvent(event);}}public static void clearHolder() {if (log.isDebugEnabled()) {log.debug("清除SpringContextHolder中的ApplicationContext:" &＃43; applicationContext);}applicationContext &＃61; null;}&＃64;Overridepublic void setApplicationContext(ApplicationContext applicationContext)throws BeansException {SpringContextUtil.applicationContext &＃61; applicationContext;}&＃64;Overridepublic void destroy() throws Exception {SpringContextUtil.clearHolder();}
}


最后&＃xff0c;编写事件监听器。

&＃64;Async 标注此方法执行为异步&＃xff0c;需要使用**&＃64;EnableAsync**注解开启此功能

&＃64;Order标记此监听器为最低级别加载

&＃64;EventListener(SysLogEvent.class) 标注监听的事件

比较重要的是&＃xff0c;监听器需要将它加入到Spring容器中。通过event.getSource() 获取到发送事件时&＃xff0c;传递的对象。

SysLogListener.java

&＃64;AllArgsConstructor
&＃64;Slf4j
&＃64;Component
public class SysLogListener {private final ISysLogService sysLogService;&＃64;Async&＃64;Order&＃64;EventListener(SysLogEvent.class)public void saveSysLog(SysLogEvent event) {SysLog sysLog &＃61; (SysLog) event.getSource();sysLogService.save(sysLog);}
}