Servlet、Tomcat访问(access)日志配置、记录Post请求参数

一、运行环境：

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>

二、配置与说明

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

参数说明：

下面着重讲下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

三、配置打印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