springboot 使用日志切面（aspect） 监控请求 和 返回

gitee demo地址

1.核心切面

import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.mvc.method.annotation.ExtendedServletRequestDataBinder;

import javax.servlet.http.HttpServletResponseWrapper;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

/**
 * @author lfg
 * @version 1.0
 */
@Component
@Aspect
@Slf4j
public class LogAspect {

    @Around("@annotation(com.lfg.log.demo.config.Log)&&@annotation(ann)")
    public Object around(ProceedingJoinPoint pjp, Log ann) throws Throwable {
        String tranceId = UUID.randomUUID().toString().replace("-", "");
        //打印请求日志
        log.info(String.format("traceId:%s,请求接口:[%s],请求参数：%s", tranceId, ann.value(), getRequestArgs(pjp, tranceId)));

        //执行方法
        Object proceed = pjp.proceed();

        //打印返回日志
        log.info(String.format("traceId:%s,请求接口:[%s],返回结果：%s", tranceId, ann.value(), JSONObject.toJSONString(proceed)));
        return proceed;
    }

    public String getRequestArgs(JoinPoint joinPoint, String traceId) {
        try {
            // 参数名
            String[] argNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();
            // 参数值
            Object[] objs = joinPoint.getArgs();
            Map<String, Object> paramMap = new HashMap<>(16);
            for (int i = 0; i < objs.length; i++) {
                if (!(objs[i] instanceof ExtendedServletRequestDataBinder) && !(objs[i] instanceof HttpServletResponseWrapper)) {
                    paramMap.put(argNames[i], objs[i]);
                }
            }
            if (paramMap.size() > 0) {
                return JSONObject.toJSONString(paramMap);
            }
        } catch (Exception e) {
            log.error("traceId:{},LOG AOP getRequestArgs:", traceId, e);
        }
        return "";
    }

}

2.日志注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author lfg
 * @version 1.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Log {

    /**
     * 方法名
     */
    String value();
}

3.使用方式

import com.lfg.log.demo.config.Log;
import com.lfg.log.demo.domain.Result;
import com.lfg.log.demo.domain.Test2Req;
import com.lfg.log.demo.util.ResultUtils;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

/**
 * @author lfg
 * @version 1.0
 */
@RestController
public class Test {

    @Log("这里填写接口名称")
    @RequestMapping("/test1")
    public Result<Object> test1(String a, String b) {
        Map<String, Object> map = new HashMap<>(16);
        map.put("a", a);
        map.put("b", b);
        return ResultUtils.success(map);
    }

    @Log("这里填写接口名称")
    @RequestMapping("/test2")
    public Result<Object> test2(@RequestBody Test2Req req) {
        Map<String, Object> map = new HashMap<>(16);
        map.put("arg1", req.getArg1());
        map.put("arg2", req.getArg2());
        return ResultUtils.success(map);
    }
}