SpringAOP实现基于方法的日志收集

效果

下图分别为演示方法和该方法执行完成后控制台打印的日志结果

Log Object

@Data
public class LogBO {
/**
 * 请求URI
 */
private String requestURI;
/**
 * 方法名
 */
private String method;

/**
 * 方法的输入
 */
private Object input;

/**
 * 方法的输出
 */
private Object output;

/**
 * 方法耗时 (ms)
 */
private Long timeConsuming;

/**
 * 方法调用的时间
 */
private Date date;


public LogBO() {
    this.date = new Date();
    if (Objects.nonNull(RequestContext.getRequest())) {
        this.requestURI = RequestContext.getRequest().getRequestURI();
    }
}
}

Annotation

@Target({ElementType.METHOD}) 
@Retention(RetentionPolicy.RUNTIME) 
@Documented 
public @interface Log {

} 

Aspect

@Slf4j
@Aspect 
@Component 
public class LogAspect {

@Pointcut("@annotation(com.xxx.demo.log.Log)")
public void logPointCut() {
    //definition
}

@Around(value = "logPointCut()")
public void logAround(ProceedingJoinPoint joinPoint) throws Throwable {
    LogBO logBO = new LogBO();
    // get current method
    Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
    logBO.setMethod(method.getDeclaringClass().getName() + "." + method.getName());
    Map<String, Object> input = this.getInput(joinPoint, method);
    logBO.setInput(input);
    long startTime = System.currentTimeMillis();
    // get method return
    Object output = joinPoint.proceed();
    logBO.setOutput(output);
    logBO.setTimeConsuming(System.currentTimeMillis() - startTime);
    log.info(JSONObject.toJSONString(logBO));
}

private Map<String, Object> getInput(ProceedingJoinPoint joinPoint, Method method) {
    // get parameter names
    String[] parameterNames = new DefaultParameterNameDiscoverer().getParameterNames(method);
    Object[] args = joinPoint.getArgs();
    Map<String, Object> params = new HashMap<>(8);
    if (parameterNames != null && parameterNames.length != 0) {
        for (int i = 0; i < parameterNames.length; i++) {
            params.put(parameterNames[i], args[i]);
        }
    }
    return params;
}
}

Util

public class RequestContext {
    public static HttpServletRequest getRequest() {
        ServletRequestAttributes requestAttributes = (ServletRequestAttributes)        RequestContextHolder.getRequestAttributes();
        return Objects.isNull(requestAttributes) ? null : requestAttributes.getRequest();
    }
}