AOP日志切片输出

import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.support.spring.PropertyPreFilters;
import com.course.server.util.UuidUtil;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Field;

@Aspect
@Component
public class LogAspect {

private final static Logger LOG = LoggerFactory.getLogger(LogAspect.class);

/** 定义一个切点 */
@Pointcut("execution(public * com.course.*.controller..*Controller.*(..))")
public void controllerPointcut() {}

@Before("controllerPointcut()")
public void doBefore(JoinPoint joinPoint) throws Throwable {
    // 日志编号
    MDC.put("UUID", UuidUtil.getShortUuid());

    // 开始打印请求日志
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = attributes.getRequest();
    Signature signature = joinPoint.getSignature();
    String name = signature.getName();

    // 打印业务操作
    String nameCn = "";
    if (name.contains("list") || name.contains("query")) {
        nameCn = "查询";
    } else if (name.contains("save")) {
        nameCn = "保存";
    } else if (name.contains("delete")) {
        nameCn = "删除";
    } else {
        nameCn = "操作";
    }

    // 使用反射，获取业务名称
    Class clazz = signature.getDeclaringType();
    Field field;
    String businessName = "";
    try {
        field = clazz.getField("BUSINESS_NAME");
        if (!StringUtils.isEmpty(field)) {
            businessName = (String) field.get(clazz);
        }
    } catch (NoSuchFieldException e) {
        LOG.error("未获取到业务名称");
    } catch (SecurityException e) {
        LOG.error("获取业务名称失败", e);
    }

    // 打印请求信息
    LOG.info("------------- 【{}】{}开始 -------------", businessName, nameCn);
    LOG.info("请求地址: {} {}", request.getRequestURL().toString(), request.getMethod());
    LOG.info("类名方法: {}.{}", signature.getDeclaringTypeName(), name);
    LOG.info("远程地址: {}", request.getRemoteAddr());

    // 打印请求参数
    Object[] args = joinPoint.getArgs();
    Object[] arguments  = new Object[args.length];
    for (int i = 0; i < args.length; i++) {
        if (args[i] instanceof ServletRequest
                || args[i] instanceof ServletResponse
                || args[i] instanceof MultipartFile) {
            continue;
        }
        arguments[i] = args[i];
    }
    // 排除字段，敏感字段或太长的字段不显示
    String[] excludeProperties = {"shard"};
    PropertyPreFilters filters = new PropertyPreFilters();
    PropertyPreFilters.MySimplePropertyPreFilter excludefilter = filters.addFilter();
    excludefilter.addExcludes(excludeProperties);
    LOG.info("请求参数: {}", JSONObject.toJSONString(arguments, excludefilter)); // 为空的会不打印，但是像图片等长字段也会打印
}

@Around("controllerPointcut()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
    long startTime = System.currentTimeMillis();
    Object result = proceedingJoinPoint.proceed();
    // 排除字段，敏感字段或太长的字段不显示
    String[] excludeProperties = {"password", "shard"};
    PropertyPreFilters filters = new PropertyPreFilters();
    PropertyPreFilters.MySimplePropertyPreFilter excludefilter = filters.addFilter();
    excludefilter.addExcludes(excludeProperties);
    LOG.info("返回结果: {}", JSONObject.toJSONString(result, excludefilter));
    LOG.info("------------- 结束 耗时：{} ms -------------", System.currentTimeMillis() - startTime);
    return result;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

}