Servlet、Tomcat訪問(access)日誌配置、記錄Post請求參數

1、運行環境：

Maven：3.5.2(點擊下載) ，下載頁

Tomcat：8.5.29(點擊下載) ，下載頁

JDK：jdk1.7.0_80(點擊下載) ，下載頁

MavenDependency:

<dependency>
    <dependency>
    <groupId>javax.servlet.jsp</groupId>
    <artifactId>javax.servlet.jsp-api</artifactId>
    <version>3.1.0</version>
    <!--該jar不打包，會和tomcat的lib目錄下的jar衝突-->
    <scope>provided</scope>
</dependency>

 

2、配置與說明

tomcat訪問日誌格式配置，在config/server.xml裏Host標籤下加上：

<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
               prefix="access_log" suffix=".txt"
               pattern="%a %S [%{yyyy-MM-dd HH:mm:ssSSS}t] &quot;%r&quot; [%{postData}r] %s %{Referer}i [%{User-Agent}i] %T %b" />

 

咱們在日誌文件中將看到以下文本：

 

來訪ip  |  session ID  |  請求時間  |  請求的方法和URL  |  POST參數  |  http的響應狀態碼  |  來源網頁  |  瀏覽器類型  |  請求消耗的秒數  |  發送信息的字節數

182.92.182.165 5ABD1AC3DF321E752B0DE133A81FFECA [2018-04-09 00:01:23587] "GET /api/notify.do?code=6219&LinkID=42447 HTTP/1.1" [mobile=26219&LinkID=42447] 200 - [Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.0)] 1.83 6

 

參數說明：

className	官方文檔上說了：This MUST be set to org.apache.catalina.valves.AccessLogValve to use the default access log valve。
directory	日誌文件存放的目錄。一般設置爲tomcat下已有的那個logs文件。
prefix	日誌文件的名稱前綴。
suffix	日誌文件的名稱後綴。
pattern	最主要的參數。下面會細講。
resolveHosts	若是是true，tomcat會將這個服務器IP地址經過DNS轉換爲主機名；若是是false，就直接寫服務器IP地址啦。默認false。
rotatable	默認爲true，tomcat生成的文件名爲prefix（前綴）+.+時間（通常是按天算）+.+suffix（後綴），如：localhost_access_log.2007-09-22.txt。設置爲false的話，tomcat會忽略時間，不會生成新文件，文件名就是：localhost_access_log.txt。久而久之，這個日誌文件會超級大
condition	這個參數不太實用，可設置任何值，好比設置成condition="tkq"，那麼只有當ServletRequest.getAttribute("tkq")爲空的時候，該條日誌纔會被記錄下來。
fileDateFormat	顧名思義，就是時間格式嘛。但這個時間格式是針對日誌文件名起做用的。我們生成的日誌文件全名：localhost_access_log.2016-09-22.txt，這裏面的2016-09-22就是這麼來的。若是想讓tomcat每小時生成一個日誌文件，也很簡單，將這個值設置爲：fileDateFormat="yyyy-MM-dd.HH"，固然也能夠按分鐘生成什麼的，本身改改吧^_^

 

下面着重講下pattern。它的參數比較多。能夠設置成common,combined兩種格式。

common的值：%h %l %u %t %r %s %b
combined的值：%h %l %u %t %r %s %b %{Referer}i %{User-Agent}i

 

%a 這是記錄訪問者的IP，在日誌裏是127.0.0.1 
%A 這是記錄本地服務器的IP，在日誌裏是192.168.254.108 
%b 發送信息的字節數，不包括http頭，若是字節數爲0的話，顯示爲- 
%B 發送信息的字節數，不包括http頭。 
%h 服務器的名稱。若是resolveHosts爲false的話，這裏就是IP地址了，例如個人日誌裏是10.217.14.16 
%H 訪問者的協議，這裏是HTTP/1.0 
%l 官方解釋：Remote logical username from identd (可能這樣翻譯：記錄瀏覽者進行身份驗證時提供的名字)(always returns '-') 
%m 訪問的方式，是GET仍是POST 
%p 本地接收訪問的端口 
%q 好比你訪問的是aaa.jsp?bbb=ccc，那麼這裏就顯示?bbb=ccc，就是querystring的意思 
%r First line of the request (method and request URI) 請求的方法和URL 
%s http的響應狀態碼 
%S 用戶的session ID,這個session ID你們能夠另外查一下詳細的解釋，反正每次都會生成不一樣的session ID 
%t 請求時間 
%u 獲得了驗證的訪問者，不然就是"-" 
%U 訪問的URL地址，我這裏是/rightmainima/leftbott4.swf 
%v 服務器名稱，可能就是你url裏面寫的那個吧，我這裏是localhost 
%D Time taken to process the request,in millis，請求消耗的時間，以毫秒記 
%T Time taken to process the request,in seconds，請求消耗的時間，以秒記

 

附：參考官方文檔： https://tomcat.apache.org/tomcat-8.5-doc/config/valve.html#Access_Logging

 

3、配置打印POST參數

另外%r參數能打印出請求的url和get參數。若是url指定訪問方式是post,post的參數是打印不出來的。當須要打印post參數，該怎麼辦？

你們注意到開篇舉例Valve配置裏的%{postData}r。沒錯，這個combined格式的patterrn能夠實現。

可是隻在valve裏配置是還不夠的。由於postData是自定義的參數名。須要在request中設置這個值。

下面附上設置postData到request中的代碼：

import javax.servlet.*;
import java.io.IOException;
import java.util.Enumeration;

/**
 * 該過濾器是爲了給tomcat打印access_log日誌時，打印POST參數用
 */
public class PostDataDumperFilter implements Filter {

    private FilterConfig filterConfig = null;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        this.filterConfig = filterConfig;
    }

    @Override
    public void destroy() {
        this.filterConfig = null;
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        if (filterConfig == null)
            return;

        Enumeration<String> names = request.getParameterNames();
        StringBuilder output = new StringBuilder();
        while (names.hasMoreElements()) {
            String name = names.nextElement();
            output.append(name).append("=");
            String values[] = request.getParameterValues(name);
            for (int i = 0; i < values.length; i++) {
                if (i > 0) {
                    output.append("' ");
                }

                output.append(values[i]);
            }
            if (names.hasMoreElements())
                output.append("&");
        }

        request.setAttribute("postData", output);
        chain.doFilter(request, response);
    }
}

 

在 項目路徑/src/main/webapp/WEB-INF/web.xml 中添加配置該 filter :

<!--給tomcat打印access_log時，能打印post參數提供-->
<filter>
    <filter-name>post-data-dumper-filter</filter-name>
    <filter-class>com.xxxx.jstl.filter.PostDataDumperFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>post-data-dumper-filter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

 

至此，配置完畢！

 

 

PS：

http://blog.csdn.net/qq_30121245/article/details/52861935