com.relaxed.common.log.access.filter

类 AccessLogFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

com.relaxed.common.log.access.filter.AccessLogFilter

所有已实现的接口:

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 AccessLogFilter
extends org.springframework.web.filter.OncePerRequestFilter

访问日志过滤器类。 用于拦截HTTP请求并记录访问日志。 主要功能包括： 1. 根据URL规则匹配决定是否记录日志 2. 包装请求和响应以支持重复读取 3. 记录请求处理时间和异常信息 4. 支持自定义日志处理器

从以下版本开始:

1.0

作者:

Yakir

字段概要

从类继承的字段 org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

从类继承的字段 org.springframework.web.filter.GenericFilterBean

logger

构造器概要

构造器

构造器和说明
AccessLogFilter(LogAccessProperties logAccessProperties, AccessLogHandler accessLogHandler, LogAccessRule defaultLogAccessRule) 创建访问日志过滤器实例

方法概要

限定符和类型	方法和说明
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain) 处理HTTP请求并记录访问日志
protected AccessLogHandler	getAccessLogHandler() 获取访问日志处理器
protected org.springframework.util.AntPathMatcher	getAntPathMatcher() 获取Ant风格路径匹配器
protected LogAccessRule	getDefaultLogAccessRule() 获取默认的访问日志规则
protected LogAccessProperties	getLogAccessProperties() 获取访问日志配置属性
protected org.springframework.web.util.UrlPathHelper	getUrlPathHelper() 获取URL路径匹配帮助类
protected LogAccessRule	searchRequestRule(javax.servlet.http.HttpServletRequest request) 根据请求查找匹配的日志规则
protected javax.servlet.http.HttpServletRequest	wrapperRequest(javax.servlet.http.HttpServletRequest request) 包装HTTP请求 用于支持重复读取请求内容
protected javax.servlet.http.HttpServletResponse	wrapperResponse(javax.servlet.http.HttpServletResponse response) 包装HTTP响应 用于支持重复读取响应内容

从类继承的方法 org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

从类继承的方法 org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AccessLogFilter

public AccessLogFilter(LogAccessProperties logAccessProperties,
                       AccessLogHandler accessLogHandler,
                       LogAccessRule defaultLogAccessRule)

创建访问日志过滤器实例

参数:

logAccessProperties - 访问日志配置属性

accessLogHandler - 访问日志处理器

defaultLogAccessRule - 默认的访问日志规则

方法详细资料

doFilterInternal

protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                IOException

处理HTTP请求并记录访问日志

指定者:

doFilterInternal 在类中 org.springframework.web.filter.OncePerRequestFilter

参数:

request - HTTP请求

response - HTTP响应

filterChain - 过滤器链

抛出:

javax.servlet.ServletException - 如果发生Servlet异常

IOException - 如果发生IO异常

wrapperResponse

protected javax.servlet.http.HttpServletResponse wrapperResponse(javax.servlet.http.HttpServletResponse response)

包装HTTP响应 用于支持重复读取响应内容

参数:

response - 原始HTTP响应

返回:

包装后的HTTP响应

wrapperRequest

protected javax.servlet.http.HttpServletRequest wrapperRequest(javax.servlet.http.HttpServletRequest request)

包装HTTP请求 用于支持重复读取请求内容

参数:

request - 原始HTTP请求

返回:

包装后的HTTP请求

searchRequestRule

protected LogAccessRule searchRequestRule(javax.servlet.http.HttpServletRequest request)

根据请求查找匹配的日志规则

参数:

request - HTTP请求

返回:

匹配的日志规则，如果没有匹配则返回默认规则

getAccessLogHandler

protected AccessLogHandler getAccessLogHandler()

获取访问日志处理器

返回:

访问日志处理器

getLogAccessProperties

protected LogAccessProperties getLogAccessProperties()

获取访问日志配置属性

返回:

访问日志配置属性

getDefaultLogAccessRule

protected LogAccessRule getDefaultLogAccessRule()

获取默认的访问日志规则

返回:

默认的访问日志规则

getAntPathMatcher

protected org.springframework.util.AntPathMatcher getAntPathMatcher()

获取Ant风格路径匹配器

返回:

Ant风格路径匹配器

getUrlPathHelper

protected org.springframework.web.util.UrlPathHelper getUrlPathHelper()

获取URL路径匹配帮助类

返回:

URL路径匹配帮助类