LogWebRequestFilter (myoss-starter-web 2.0.8.RELEASE API)

java.lang.Object
- org.springframework.web.filter.GenericFilterBean
- - org.springframework.web.filter.OncePerRequestFilter
  - - app.myoss.cloud.web.spring.web.servlet.filter.LogWebRequestFilter

All Implemented Interfaces:: javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public class LogWebRequestFilter
extends org.springframework.web.filter.OncePerRequestFilter

记录web请求的日志信息，设置请求的信息到 Mapped Diagnostic Context(映射调试上下文) 中，用于输出到日志文件中。

请求信息
%X{method}	请求类型：GET、POST
%X{requestURL}	完整的URL
%X{requestURLWithQueryString}	完整的URL，含querydata
%X{requestURI}	不包括host信息的URL
%X{requestURIWithQueryString}	不包括host信息的URL，含querydata
%X{queryString}	Querydata
%X{cookies}	所有cookie的名称，以逗号分隔
%X{cookie.*}	指定cookie的值，例如：cookie.JSESSIONID
客户端信息
%X{remoteAddr}	用户IP地址
%X{remoteRealIp}	客户端的真实ip地址
%X{remoteHost}	用户域名（也可能是IP地址）
%X{userAgent}	用户浏览器
%X{referrer}	上一个链接

Since:: 2018年4月11日下午12:39:20
Author:: Jerry.Chen

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MDC_COOKIE_PREFIX` cookies key prefix
`static String`	`MDC_COOKIES` cookies
`static String`	`MDC_COST_TIME` HTTP cost time
`static String`	`MDC_METHOD` HTTP request method
`static String`	`MDC_QUERY_STRING` query string
`static String`	`MDC_REFERRER` referrer
`static String`	`MDC_REMOTE_ADDR` 客户端的ip地址（如果服务前面是 NGINX 转发过来的，那么就是它的 ip 地址）
`static String`	`MDC_REMOTE_HOST` 客户端的主机名
`static String`	`MDC_REMOTE_REAL_IP` 客户端的真实ip地址
`static String`	`MDC_REQUEST_SERVER_INFO` 请求服务器域名+接口地址信息
`static String`	`MDC_REQUEST_URI` 不包括host信息的URL
`static String`	`MDC_REQUEST_URI_WITH_QUERY_STRING` 不包括host信息的URL，包括query string
`static String`	`MDC_REQUEST_URL` 取得当前的request URL，不包括query string
`static String`	`MDC_REQUEST_URL_WITH_QUERY_STRING` 取得当前的request URL，包括query string
`static String`	`MDC_START_TIME` HTTP request start time
`static String`	`MDC_STATUS` HTTP response status
`static String`	`MDC_USER_AGENT` user agent

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter
ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean
logger

Constructor Summary

Constructors
Constructor and Description
`LogWebRequestFilter(boolean logOnFilter, boolean putRequestInfoToMDC)` 记录web请求的日志信息
`LogWebRequestFilter(boolean logOnFilter, boolean putRequestInfoToMDC, String traceIdName, String spanIdName)` 记录web请求的日志信息

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearMDC()` 清除MDC下文中设置的信息，只有当前对象自己设置的MDC才能被清除。
`protected void`	`doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)`
`protected Map<String,String>`	`getMDCCopy()` 取得当前MDC map的复本。
`protected void`	`putMDC(javax.servlet.http.HttpServletRequest request, String startTime)` 设置内容到MDC中

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter
doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MDC_START_TIME
```
public static final String MDC_START_TIME
```
    HTTP request start time
    
    See Also:
    
    Constant Field Values
  - MDC_COST_TIME
```
public static final String MDC_COST_TIME
```
    HTTP cost time
    
    See Also:
    
    Constant Field Values
  - MDC_STATUS
```
public static final String MDC_STATUS
```
    HTTP response status
    
    See Also:
    
    Constant Field Values
  - MDC_METHOD
```
public static final String MDC_METHOD
```
    HTTP request method
    
    See Also:
    
    Constant Field Values
  - MDC_REQUEST_SERVER_INFO
```
public static final String MDC_REQUEST_SERVER_INFO
```
    请求服务器域名+接口地址信息
    
    See Also:
    
    Constant Field Values
  - MDC_REQUEST_URL
```
public static final String MDC_REQUEST_URL
```
    取得当前的request URL，不包括query string
    
    See Also:
    
    Constant Field Values
  - MDC_REQUEST_URL_WITH_QUERY_STRING
```
public static final String MDC_REQUEST_URL_WITH_QUERY_STRING
```
    取得当前的request URL，包括query string
    
    See Also:
    
    Constant Field Values
  - MDC_REQUEST_URI
```
public static final String MDC_REQUEST_URI
```
    不包括host信息的URL
    
    See Also:
    
    Constant Field Values
  - MDC_REQUEST_URI_WITH_QUERY_STRING
```
public static final String MDC_REQUEST_URI_WITH_QUERY_STRING
```
    不包括host信息的URL，包括query string
    
    See Also:
    
    Constant Field Values
  - MDC_QUERY_STRING
```
public static final String MDC_QUERY_STRING
```
    query string
    
    See Also:
    
    Constant Field Values
  - MDC_REMOTE_ADDR
```
public static final String MDC_REMOTE_ADDR
```
    客户端的ip地址（如果服务前面是 NGINX 转发过来的，那么就是它的 ip 地址）
    
    See Also:
    
    Constant Field Values
  - MDC_REMOTE_REAL_IP
```
public static final String MDC_REMOTE_REAL_IP
```
    客户端的真实ip地址
    
    See Also:
    
    Constant Field Values
  - MDC_REMOTE_HOST
```
public static final String MDC_REMOTE_HOST
```
    客户端的主机名
    
    See Also:
    
    Constant Field Values
  - MDC_USER_AGENT
```
public static final String MDC_USER_AGENT
```
    user agent
    
    See Also:
    
    Constant Field Values
  - MDC_REFERRER
```
public static final String MDC_REFERRER
```
    referrer
    
    See Also:
    
    Constant Field Values
  - MDC_COOKIES
```
public static final String MDC_COOKIES
```
    cookies
    
    See Also:
    
    Constant Field Values
  - MDC_COOKIE_PREFIX
```
public static final String MDC_COOKIE_PREFIX
```
    cookies key prefix
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogWebRequestFilter
```
public LogWebRequestFilter(boolean logOnFilter,
                           boolean putRequestInfoToMDC)
```
    记录web请求的日志信息
    
    Parameters:
    
    logOnFilter - 是否在 doFilterInternal(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.FilterChain) 输出 log 日志，用于当前过滤器（默认值：false）
    
    putRequestInfoToMDC - 是否将请求的信息放入MDC中，默认只放 MDC_START_TIME、 MDC_COST_TIME、MDC_STATUS 这个key（默认值：false）
  - LogWebRequestFilter
```
public LogWebRequestFilter(boolean logOnFilter,
                           boolean putRequestInfoToMDC,
                           String traceIdName,
                           String spanIdName)
```
    记录web请求的日志信息
    
    Parameters:
    
    logOnFilter - 是否在 doFilterInternal(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.FilterChain) 输出 log 日志，用于当前过滤器（默认值：false）
    
    putRequestInfoToMDC - 是否将请求的信息放入MDC中，默认只放 MDC_START_TIME、 MDC_COST_TIME、MDC_STATUS 这个key（默认值：false）
    
    traceIdName - ApmConstants.LEGACY_TRACE_ID_NAME 输出调用链的TraceId到response header中
    
    spanIdName - ApmConstants.LEGACY_SPAN_ID_NAME 输出调用链的SpanId到response header中
- Method Detail
  - doFilterInternal
```
protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                IOException
```
    Specified by:
    
    doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - putMDC
```
protected void putMDC(javax.servlet.http.HttpServletRequest request,
                      String startTime)
```
    设置内容到MDC中
    
    Parameters:
    
    request - 客户端请求信息
    
    startTime - 请求开始时间
  - getMDCCopy
```
protected Map<String,String> getMDCCopy()
```
    取得当前MDC map的复本。
    
    Returns:
    
    MDC上下文中的信息
  - clearMDC
```
public void clearMDC()
```
    清除MDC下文中设置的信息，只有当前对象自己设置的MDC才能被清除。

Class LogWebRequestFilter

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

Fields inherited from class org.springframework.web.filter.GenericFilterBean

Constructor Summary

Method Summary

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

Methods inherited from class org.springframework.web.filter.GenericFilterBean

Methods inherited from class java.lang.Object

Field Detail

MDC_START_TIME

MDC_COST_TIME

MDC_STATUS

MDC_METHOD

MDC_REQUEST_SERVER_INFO

MDC_REQUEST_URL

MDC_REQUEST_URL_WITH_QUERY_STRING

MDC_REQUEST_URI

MDC_REQUEST_URI_WITH_QUERY_STRING

MDC_QUERY_STRING

MDC_REMOTE_ADDR

MDC_REMOTE_REAL_IP

MDC_REMOTE_HOST

MDC_USER_AGENT

MDC_REFERRER

MDC_COOKIES

MDC_COOKIE_PREFIX

Constructor Detail

LogWebRequestFilter

LogWebRequestFilter

Method Detail

doFilterInternal

putMDC

getMDCCopy

clearMDC