AOP实现接口请求日志，耗时记录

很多时候后端排查问题，我们要确认用户到底请求了哪些接口，接口的入参和返回是怎么样的。又或者是接口耗时有多高。这些东西都可以通过日志去排查，我们只需要将每次的请求记录日志。要如何优雅的实现接口日志呢？

有的人喜欢用拦截器，有的人喜欢用aop。后面我们会讨论下这两种方案的优劣。

AOP切面

通过springaop对controller包下的所有接口进行拦截

@Around("execution(* com..controller..*.*(..))")

@Around("execution(* com..controller..*.*(..))")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        HttpServletRequest request = ((ServletRequestAttributes) Objects.requireNonNull(RequestContextHolder.getRequestAttributes())).getRequest();
        String method = request.getMethod();
        String uri = request.getRequestURI();
        //如果参数有HttpRequest,ServletResponse，直接移除，不打印这些
        List<Object> paramList = Stream.of(joinPoint.getArgs())
                .filter(args -> !(args instanceof ServletRequest))
                .filter(args -> !(args instanceof ServletResponse))
                .collect(Collectors.toList());
        String printParamStr = paramList.size() == 1 ? JSONUtil.toJsonStr(paramList.get(0)) : JSONUtil.toJsonStr(paramList);
        RequestInfo requestInfo = RequestHolder.get();
        String userHeaderStr = JSONUtil.toJsonStr(requestInfo);
        if (log.isInfoEnabled()) {
            log.info("[{}][{}]【base:{}】【request:{}】", method, uri, userHeaderStr, printParamStr);
        }
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        Object result = joinPoint.proceed();
        stopWatch.stop();
        long cost = stopWatch.getTotalTimeMillis();
        String printResultStr = JSONUtil.toJsonStr(result);
        if (log.isInfoEnabled()) {
            log.info("[{}]【response:{}】[cost:{}ms]", uri, printResultStr, cost);
        }
        return result;
    }

用StopWatch来记录耗时。

最终日志的效果如下。

|INFO|2023-05-14 13:29:55.632|http-nio-8080-exec-9|127fba4e-3591-428a-8745-8bba10caa83d|uid=10026|[GET][/capi/chat/public/member/page]【base:{"uid":10026,"ip":"103.116.122.01"}】【request:{"pageSize":20}】|
|INFO|2023-05-14 13:29:55.659|http-nio-8080-exec-9|127fba4e-3591-428a-8745-8bba10caa83d|uid=10026|[/capi/chat/public/member/page]【response:{"success":true,"data":{"cursor":"2_1.684038421087E12","isLast":true,"list":[{"uid":10026,"name":"阿斌","avatar":"https://thirdwx.qlogo.cn/mmopen/vi_32/DYAIOgq83erXzA6OE2JYibo6vEdX9Orsp5dOsgqWBibcTvFDiam4bsMVufVEp23AIDKUnY2wZCicKQgneWibLyoRFpw/132","activeStatus":1,"lastOptTime":1684042195332},{"uid":10029,"name":"白洁","avatar":"https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTJUlbw1Mf1vptL3soSJINyKbHvR9dJaTgbN8Y1BeHzIMEWQ2qPyLCHJYicUgjKTjfDhn21HBKGJYBg/132","activeStatus":2,"lastOptTime":1684038421087}]}}】[cost:25ms]|

只要日志打印的信息足够，后续我们还可以提取日志，用它来实现流量重放，接口压测哦。

过滤器，拦截器，aop

SpringAOP拦截器：只能拦截Spring管理Bean的访问（业务层Service）。

Interceptor拦截器：拦截以.action结尾的url，拦截Action的访问。

Filter过滤器：拦截web访问url地址。

Filter与Interceptor联系与区别

• 拦截器是基于java的反射机制，使用代理模式，而拦截器是基于函数回调。
• 拦截器不依赖servlet容器，过滤器依赖于serlet容器。
• 拦截器只能对action起作用，而过滤器可以对几乎所有请求起作用（可以保护资源）。
• 拦截器可以访问action上下文，堆栈里面的对象，而过滤器不可以。
• 执行顺序：过滤器前-拦截前-action处理-拦截后-过滤后。

拦截器更关注controller ，url的请求。aop更关注方法的访问，出入参。

拦截器想拿到方法，可以用反射。aop想拿到url，可以用RequestContextHolder。所以两个能实现一样的功能可以说是都有取巧的办法。

我们更关注的一点是，aop是更内层的，统计的业务耗时更精确。同时它更关注请求的出入参。而拦截器需要反射获取出入参，会更耗时一些。

因此，我选择用aop来实现请求日志。