【Spring-boot】使用aop记录访问日志

• 引入依赖

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

• 加入记录日志功能

@Slf4j
@Aspect
@Component
public class WebLogAspect {

    @Pointcut("execution(public * com.test.controller..*.*(..))")
    public void webLog() {
    }

    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) {
        long beginTime = System.currentTimeMillis();

        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();

        String servletPath = null;
        if (attributes != null) {
            HttpServletRequest request = attributes.getRequest();
            servletPath = request.getServletPath();
            log.info("ip:{},path:{},param:{}", request.getRemoteAddr(), request.getServletPath(), getParams(proceedingJoinPoint.getArgs()));
        }

        Object result = null;
        try {
            // 一切正常的情况下，继续执行被拦截的方法
            result = proceedingJoinPoint.proceed();
            log.info("{} end，cost：{}ms", servletPath, System.currentTimeMillis() - beginTime);
        } catch (Throwable e) {
            log.error("exception: ", e);
        }

        return result;
    }

    private Object getParams(Object[] args) {
        JSONArray params = new JSONArray();

        for (Object arg : args) {
            if (arg instanceof Map<?, ?>) {
                //提取方法中的MAP参数，用于记录进日志中
                @SuppressWarnings("unchecked")
                Map<String, Object> map = (Map<String, Object>) arg;

                params.add(map);
            } else if (arg instanceof HttpServletRequest) {
                HttpServletRequest request = (HttpServletRequest) arg;

                //获取query string 或 posted form data参数
                Map<String, String[]> paramMap = request.getParameterMap();
                if (paramMap != null && paramMap.size() > 0) {
                    params.add(paramMap);
                }
            } else if (arg instanceof HttpServletResponse) {
                //do nothing...
            } else {
                params.add(BeanUtil.beanToMap(arg));
            }
        }

        return params;
    }
}