服务端接口日志打印的几种方法

服务端接口日志打印的几种方法

一个服务上线对外提供服务时，接口日志打印是现网运维一个必不可缺的部分。今天这篇文章，主要讲解一个SpringWeb服务，统一处理接口日志打印的方法。

接口日志主要包含的字段包括如下几点：接口路径，接口请求时间，接口入参，接口出参。且需要针对性的对接口出入参进行数据脱敏处理。

---

使用AOP打印接口日志

接口日志切面选择

对于比较简单可，可以直接拦截所有的http请求，并打印所有的request.parameters。但这样不够灵活，容易将文件数据或敏感数据打印。这里，通过自定义接口日志注解的方式作为切点。

注解定义

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

}

编写aop切面

@Aspect
@Component
public class InterfaceLogAspect {

    private static final Logger INTERFACE_LOG = LogUtil.getInterfaceLogger();


    @Pointcut("@annotation(xxx.xxx.xxx.annotation.InterfaceLog) ")
    public void log() {
    }

    @Before("log()")
    public void init(JoinPoint joinPoint) throws CException {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // ......
    }

    @AfterReturning(returning = "rsp", pointcut = "log()")
    public void doAfterReturning(JoinPoint jp, Object rsp) throws CException {
        printNormalInterfaceLog(rsp);
    }

    @AfterThrowing(throwing = "ex", pointcut = "log()")
    public void ajaxThrow(JoinPoint jp, Exception ex) throws CException {
        printErrorInterfaceLog(ex);
    }
}

网络接口请求中的数据共享传递方案

1、ThreadLocal方案
构造定义ThreadLocal对象

public final class SystemContext {
    private static final ThreadLocal LOG_CONTEXT = new ThreadLocal();

    private SystemContext() {}

    public static LogInfo getLogInfo() {
        return LOG_CONTEXT.get();
    }

    public static void setLogInfo(LogInfo logInfo) {
        LOG_CONTEXT.set(logInfo);
    }
}

ThreadLocal对象使用场景
在before时将startTime设定，在afterReturn里打印日志时可以取出startTime以计算

    @Before("log()")
    public void init(JoinPoint joinPoint) throws CException {
        // LogInfo logInfo = new LogInfo (System.currentTimeMillis(),"other paramter");
        SystemContext.setLogInfo(logInfo);
    }
    private void printNormalInterfaceLog(Object rsp) {
        LogInfo logInfo =  SystemContext.getLogInfo();
        logInfo.setCostTime(System.currentTimeMillis() - logInfo.getStartTime());
        logInfo.setRsp(LogUtil.toLogString(rsp));
        INTERFACE_LOG.info(logInfo.toLogString());
    }

2、切片方法参数匹配

切片方法中，匹配一个context对象，(其作用和ThreadLocal对象类似，都可以在切片和方法中传递数据)，对该对象进行数据的读写操作。

    @Before("log()  && args(context,..)")
    public void init(JoinPoint joinPoint, Context context) throws CException {
       context.setStartTime(System.currentTimeMillis());
    }

    @AfterReturning(returning = "rsp", pointcut = "log() && args(context,..)")
    public void doAfterReturning(JoinPoint jp, Object rsp, Context context) throws CException {
        printNormalInterfaceLog(context, rsp);
    }

    @AfterThrowing(throwing = "ex", pointcut = "log()&& args(context,..)")
    public void ajaxThrowss(JoinPoint jp, Exception ex, Context context) throws CException {
        printErrorInterfaceLog(context, ex);

    }

对应的接口也需要传入该参数, 也可是使用context对象里的其他加工好的数据。

    @RequestMapping(value = "/getUserInfo", method = RequestMethod.POST)
    @InterfaceLog
    @ResponseBody
    public GetUserInfoRsp getUserInfo(Context context) throws CException {
        LOG.debug("come into getUserInfo");
        GetUserInfoRsp rsp = loginService.getUserInfo(context);
        return rsp;
    }

在切面中获取接口信息

接口路径：可以通过HttpServletRequest对象获取到；
接口请求时间：可以通过上诉的数据传递方案，从threadLocal或切片参数中获取时间差；
接口出参：可以通过AfterReturn方法内的返回值直接获取到；
接口入参：可以通过上诉的数据传递方案，从threadLocal或切片参数中获取，也可以从JoinPoint参数中提取。

private Optional