概述
在spring boot项目中利用切面思想监控API接入实现日志打印
背景
日志在项目中是必不可少的组成部分,通过日志记录可以知道系统运行情况,快速定位问题,追溯异常等等,本篇介绍了简单利用aop切面思想做一个日志打印功能,通过监控调入的API打印API请求情况。
环境
JDK 1.8
设计
1. 自定义一个注解
import java.lang.annotation.*;
/**
* @Target说明了Annotation所修饰的对象范围
* @Retention定义了该Annotation被保留的时间长短:
* @Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API
* @Date 2022/1/7 15:25
* @Created by LSH
*/
@Documented
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
boolean argsWhith() default true;
}
说明:
-
@Target: 说明了Annotation所修饰的对象范围
-
@Retention: 定义了该Annotation被保留的时间长短
-
@Documented: 用于描述其它类型的annotation应该被作为被标注的程序成员的公共API
2.编写切面类,定义拦截时要执行的逻辑
import com.geohey.annotation.Log;
import com.geohey.common.utils.UUIDGenerator;
import com.geohey.utils.LogUtils;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.util.Arrays;
/**
* @Description 切面日志打印
* @Date 2022/1/7 15:26
* @Created by LSH
*/
@Aspect
@Component
@Slf4j
public class LogAspect {
/**
* 定义切点
*/
@Pointcut("@annotation(com.geohey.annotation.Log)")
public void doAspect() {
}
@Around("doAspect()")
public Object doAround(ProceedingJoinPoint pjd) throws Throwable {
long startTime = System.currentTimeMillis();
Object result = null;
//执行标识
String handleUUID= UUIDGenerator.get16UUID();
try {
//拦截的类
Class clazz = pjd.getTarget().getClass();
//拦截的方法
Method method = ((MethodSignature) pjd.getSignature()).getMethod();
Log methodLog = method.getAnnotation(Log.class);
String params = "";
if (method != null && methodLog.argsWhith()){
params = Arrays.toString(pjd.getArgs());
}
//方法开始前打印日志
LogUtils.startInfo(log,method.getName(), clazz.getName(),handleUUID,params);
//执行拦截的方法
result = pjd.proceed();
//方法结束后打印日志
LogUtils.endtInfo(log,method.getName(),clazz.getName(),handleUUID,System.currentTimeMillis() - startTime);
} catch (Throwable e) {
throw e;
}
return result;
}
}
3.编写日志打印工具类
import org.slf4j.Logger;
/**
* @Description 日志打印工具类
* @Date 2022/1/7 10:52
* @Created by LSH
*/
public class LogUtils{
private static String logStart="\n[ 接口名称:[ {}() ], class:[ {} ] start ··· ]" +
"\n[ 执行标识:[ {} ], 接口入参:{} ]";
private static String logEnd="\n[ 接口名称:[ {}() ], class:[ {} ] end ··· ]" +
"\n[ 执行标识:[ {} ], COST:[ {}ms ]";
public static void startInfo(Logger log,String methodName ,String className,String handleUUID,String params){
log.info(logStart,methodName,className,handleUUID,params);
}
public static void endtInfo(Logger log,String method,String className,String handleUUID,Long cost){
log.info(logEnd,method,className,handleUUID,cost);
}
}
说明:日志打印的内容按需自行编辑设计
4.将自定义的注解加到需要监控的方法上
一旦方法被调用,就会执行切面类里的逻辑。下面以controller中的某个API为例,看看方法被调起以及执行结束后的效果。
API:
使用API管理工具ApiPost调用接口
调用成功后查看后台日志打印情况
总结
只需要4步就可以实现自动监控API 调用情况然后输出日志了
1.自定义一个注解,指定要拦截的对象范围,如类级别:ElementType.TYPE,方法级别:ElementType.METHOD等等,按需添加即可;
2.编写切面类,设计好切到目标后要执行的逻辑;
3.编写日志打印工具类,指定要打印的日志内容;
4.将自定义的注解加到要切得方法上,等到方法被调用时就会自动执行设计好的切面逻辑。
该功能可以结合定义全局异常监控向前端返回统一异常信息使用。