Springboot接口访问日志记录

如今大部分的产品后台都会对接口的访问做相关的日志记录。目前我只掌握的日志记录方式有如下三种：

• Nginx访问日志记录
• Interceptor拦截器中分析HttpServletRequest请求
• AOP切面+自定义注解来抓取指定相关接口的请求信息

本文章将为大家主要介绍一下如何使用切面做接口访问记录，另外稍微描述下其他两种记录方式

Nginx日志记录接口访问

通过Nginx日志记录接口访问信息我就不详细介绍了。只要对Nginx的日志稍加配置，然后通过脚本对日志文件进行分析即可，部分Nginx配置代码如下所示：

    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent $request_time $upstream_response_time "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';
    error_log /var/log/nginx/error.log;
    access_log  /var/log/nginx/access.log  main;

Nginx日志格式：

$remote_addr 客户端的ip地址(代理服务器，显示代理服务ip)
$remote_user 用于记录远程客户端的用户名称（一般为“-”）
$time_local 用于记录访问时间和时区
$request 用于记录请求的url以及请求方法
$status 响应状态码，例如：200成功、404页面找不到等。
$body_bytes_sent 给客户端发送的文件主体内容字节数
$http_user_agent 用户所使用的代理（一般为浏览器）
$http_x_forwarded_for 可以记录客户端IP，通过代理服务器来记录客户端的ip地址
$http_referer 可以记录用户是从哪个链接访问过来的
$request_time 从接受用户请求的第一个字节到发送完响应数据的时间，即包括接收请求数据时间、程序响应时间、输出响应数据时间

$upstream_response_time 指从Nginx向后端（php-cgi)建立连接开始到接受完数据然后关闭连接为止的时间

拦截器记录接口访问

通过拦截器记录接口访问日志主要是利用了拦截器的工作原理---拦截器的执行在请求进入控制层之前。

在实现了HandleInterceptor接口的拦截器 的 preHandle方法中，HttpServletRequest中保存着本次请求的基本信息，如

HostAddr, HostPort, RequestUri, RemoteAddr等等。

AOP切面记录接口访问

首先，我们定义一个存放基本访问信息的对象MethodInvokeInfo：

import java.lang.reflect.Method;
import java.util.Map;

/**
 * 记录调用的方法信息
 *
 * @author: htc
 * @date: Created in 16:35 2018/3/1.
 */
public class MethodInvokeInfo {
    /**
     * 调用的方法名
     */
    private final Method method;
    /**
     * 传递的参数信息
     */
    private final Map<String, Object> paramMap;
    /**
     * 调用的层次
     */
    private int level;

    public MethodInvokeInfo(Method method, Map<String, Object> paramMap) {
        this.method = method;
        this.paramMap = paramMap;
    }

    public int getLevel() {
        return level;
    }

    public void setLevel(int level) {
        this.level = level;
    }

    public Method getMethod() {
        return method;
    }

    public Map<String, Object> getParamMap() {
        return paramMap;
    }

    public String toDetailMessage() {
        StringBuilder builder = new StringBuilder();
        builder.append("Level ").append(level).append(";");
        builder.append("此次调用方法：").append(method.getDeclaringClass().getSimpleName()).append(".").append(method.getName());
        builder.append("\n");
        builder.append("参数信息:\n");
        for (Map.Entry<String, Object> e : paramMap.entrySet()) {
            builder.append("\t");
            builder.append(e.getKey());
            builder.append(":");
            builder.append(e.getValue());
            builder.append("\n");
        }
        return builder.toString();
    }
}