一、需求

我們本節要實現的需求

• 針對當前系統的每一次接口訪問，要記錄是什么人訪問的（用戶名）、什么時間訪問的、訪問耗時多長時間、使用什么HTTP method方法訪問的、訪問結果如何等。可以稱為審計日志。
• 將訪問記錄審計日志，輸出到一個單獨的日志文件access.log

二、定義訪問日志內容記錄實體類

@Data
public class AccessLog {
    //訪問者用戶名
    private String username;
    //請求路徑
    private String url;
    //請求消耗時長
    private Integer duration;
    //http 方法：GET、POST等
    private String httpMethod;
    //http 請求響應狀態碼
    private Integer httpStatus;
    //訪問者ip
    private String ip;
    //此條記錄的創建時間
    private Date createTime;
}

三、自定義日志攔截器

通過自定義攔截器的方式，記錄審計日志。

• 攔截器的preHandle方法，可以用于攔截請求處理開始。用于記錄請求開始時間等信息保存到Http Request，用于后續計算請求時長。
• 攔截器的postHandle方法，可以用于攔截請求處理完成。可以從Request對象獲取開始時間，計算本次請求總的處理時長等信息。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;


public class AccessLogInterceptor implements HandlerInterceptor {
    //請求開始時間標識
    private static final String LOGGER_SEND_TIME = "SEND_TIME";
    //請求日志實體標識
    private static final String LOGGER_ACCESSLOG = "ACCESSLOG_ENTITY";


    private static final Logger logger = LoggerFactory.getLogger("ACCESS-LOG");

    /**
     * 進入SpringMVC的Controller之前開始記錄日志實體
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object o) throws Exception {

        //創建日志實體
        AccessLog accessLog = new AccessLog();

        // 設置IP地址
        accessLog.setIp(AdrressIpUtils.getIpAdrress(request));

        //設置請求方法,GET,POST...
        accessLog.setHttpMethod(request.getMethod());

        //設置請求路徑
        accessLog.setUrl(request.getRequestURI());

        //設置請求開始時間
        request.setAttribute(LOGGER_SEND_TIME,System.currentTimeMillis());

        //設置請求實體到request內，方便afterCompletion方法調用
        request.setAttribute(LOGGER_ACCESSLOG,accessLog);
        return true;
    }


    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object o, Exception e) throws Exception {

        //獲取本次請求日志實體
        AccessLog accessLog = (AccessLog) request.getAttribute(LOGGER_ACCESSLOG);

        //獲取請求錯誤碼，根據需求存入數據庫，這里不保存
        int status = response.getStatus();
        accessLog.setHttpStatus(status);

        //設置訪問者(這里暫時寫死）
        // 因為不同的應用可能將訪問者信息放在session里面，有的通過request傳遞，
        // 總之可以獲取到，但獲取的方法不同
        accessLog.setUsername("admin");

        //當前時間
        long currentTime = System.currentTimeMillis();

        //請求開始時間
        long snedTime = Long.valueOf(request.getAttribute(LOGGER_SEND_TIME).toString());


        //設置請求時間差
        accessLog.setDuration(Integer.valueOf((currentTime - snedTime)+""));

        accessLog.setCreateTime(new Date());
        //將sysLog對象持久化保存
        logger.info(accessLog.toString());
    }
}

上文中LoggerFactory.getLogger("ACCESS-LOG")獲取一個日志配置中的Logger的名字，用于打印日志輸出，持久化到日志文件里面。"ACCESS-LOG"的日志Logger定義我們下文中介紹。

四、攔截器注冊

攔截器注冊就不細講了，前面的章節已經介紹過，回看。

@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {

    //設置排除路徑，spring boot 2.*，注意排除掉靜態資源的路徑，不然靜態資源無法訪問
    private final String[] excludePath = {"/static"};

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AccessLogInterceptor()).addPathPatterns("/**").excludePathPatterns(excludePath);
    }
}

五、獲取ip訪問地址的工具類

上面的代碼中涉及到一個工具類，用于獲取請求客戶端的ip。代碼如下：

public class AdrressIpUtils {
    /**
     * 獲取Ip地址
     * @param request HttpServletRequest
     * @return ip
     */
    public static String getIpAdrress(HttpServletRequest request) {
        String Xip = request.getHeader("X-Real-IP");
        String XFor = request.getHeader("X-Forwarded-For");
        if(StringUtils.isNotEmpty(XFor) && !"unKnown".equalsIgnoreCase(XFor)){
            //多次反向代理后會有多個ip值，第一個ip才是真實ip
            int index = XFor.indexOf(",");
            if(index != -1){
                return XFor.substring(0,index);
            }else{
                return XFor;
            }
        }
        XFor = Xip;
        if(StringUtils.isNotEmpty(XFor) && !"unKnown".equalsIgnoreCase(XFor)){
            return XFor;
        }
        if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor)) {
            XFor = request.getHeader("Proxy-Client-IP");
        }
        if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor)) {
            XFor = request.getHeader("WL-Proxy-Client-IP");
        }
        if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor)) {
            XFor = request.getHeader("HTTP_CLIENT_IP");
        }
        if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor)) {
            XFor = request.getHeader("HTTP_X_FORWARDED_FOR");
        }
        if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor)) {
            XFor = request.getRemoteAddr();
        }
        return XFor;
    }
}

六、"ACCESS-LOG"的日志Logger定義

下文中的配置參考以Log4J2配置為例（參考上一節的內容進行學習）
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-y0r1Nn7P-1644633419822)(images/screenshot_1598061650386.png)]

• LoggerFactory.getLogger("ACCESS-LOG") 代碼去配置文件里面找一個name為ACCESS-LOG的Logger配置。
• 該Logger是一個AsyncLogger，指向的輸出目標是ACCESS-APPENDER
• ACCESS-APPENDER是一個日志文件輸出配置，日志文件是access-log.log

<configuration>
    <properties>
        
        <property name="LOG_HOME">D:/logsproperty>
    properties>
    <Appenders>
        
        <RollingFile name="ACCESS-APPENDER"
                     fileName="${LOG_HOME}/access.log"
                     filePattern="${LOG_HOME}/access-%d{yyyy-MM-dd}-%i.log">
            
            <PatternLayout>
                <pattern>[%d][%p][%t][%C] %m%npattern>
            PatternLayout>
            <Policies>
                
                <SizeBasedTriggeringPolicy size="100MB"/>
                <TimeBasedTriggeringPolicy/>
            Policies>
            
            <DefaultRolloverStrategy max="20"/>
        RollingFile>
    Appenders>

    <Loggers>
        <AsyncLogger name="ACCESS-LOG" level="debug" additivity="false">
            <AppenderRef ref="ACCESS-APPENDER" level="info"/>
        AsyncLogger>
    Loggers>
configuration>