com.relaxed.common.log.access.handler

类 AbstractAccessLogHandler<T>

java.lang.Object

com.relaxed.common.log.access.handler.AbstractAccessLogHandler<T>

类型参数:

T - 请求实体类型

所有已实现的接口:

AccessLogHandler<T>

直接已知子类:

DefaultAccessLogHandler

public abstract class AbstractAccessLogHandler<T>
extends Object
implements AccessLogHandler<T>

访问日志处理器抽象类。 提供了访问日志处理的基础实现。 主要功能包括： 1. 获取请求头信息 2. 获取请求参数 3. 获取请求体 4. 获取响应体 5. 支持字段过滤和替换

从以下版本开始:

1.0

作者:

Yakir

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static interface	AbstractAccessLogHandler.ReqHeaderFilter 请求头过滤器接口

构造器概要

构造器

构造器和说明
AbstractAccessLogHandler()

方法概要

限定符和类型	方法和说明
protected String	getHeader(javax.servlet.http.HttpServletRequest request) 获取所有请求头信息
protected String	getHeader(javax.servlet.http.HttpServletRequest request, AbstractAccessLogHandler.ReqHeaderFilter reqHeaderFilter) 根据过滤器提取请求头信息
protected String	getHeader(javax.servlet.http.HttpServletRequest request, String... headerNames) 获取指定请求头信息
protected String	getMessagePayload(byte[] buf, int maxLength, String characterEncoding) 获取消息负载
protected String	getParams(javax.servlet.http.HttpServletRequest request, String matchKey) 获取请求参数
protected String	getParams(javax.servlet.http.HttpServletRequest request, String matchFieldKey, String replaceText) 获取请求参数
protected String	getRequestBody(javax.servlet.http.HttpServletRequest request, String matchingPattern) 获取请求体
protected String	getRequestBody(javax.servlet.http.HttpServletRequest request, String matchingFieldKey, String replaceText) 获取请求体
protected String	getRequestBodyText(RepeatBodyRequestWrapper wrapperRequest) 获取请求体文本
protected String	getResponseBody(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String matchResponseKey) 获取响应体信息
protected String	getResponseBody(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String matchResponseKey, String replaceText) 获取响应体信息 防止在 RequestContextHolder 设置内容之前或清空内容之后使用，从而导致获取不到响应体的问题

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

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

从接口继承的方法 com.relaxed.common.log.access.handler.AccessLogHandler

afterRequest, beforeRequest, shouldLog

构造器详细资料

AbstractAccessLogHandler

public AbstractAccessLogHandler()

方法详细资料

getHeader

protected String getHeader(javax.servlet.http.HttpServletRequest request)

获取所有请求头信息

参数:

request - HTTP请求

返回:

请求头信息JSON字符串

getHeader

protected String getHeader(javax.servlet.http.HttpServletRequest request,
                           AbstractAccessLogHandler.ReqHeaderFilter reqHeaderFilter)

根据过滤器提取请求头信息

参数:

request - HTTP请求

reqHeaderFilter - 请求头过滤器

返回:

过滤后的请求头信息JSON字符串

getHeader

protected String getHeader(javax.servlet.http.HttpServletRequest request,
                           String... headerNames)

获取指定请求头信息

参数:

request - HTTP请求

headerNames - 需要获取的请求头名称数组

返回:

指定请求头信息JSON字符串

getResponseBody

protected String getResponseBody(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 String matchResponseKey)

获取响应体信息

参数:

request - HTTP请求

response - HTTP响应

matchResponseKey - 需要过滤的响应字段

返回:

响应体信息

getResponseBody

protected String getResponseBody(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 String matchResponseKey,
                                 String replaceText)

获取响应体信息 防止在 RequestContextHolder 设置内容之前或清空内容之后使用，从而导致获取不到响应体的问题

参数:

request - HTTP请求

response - HTTP响应

matchResponseKey - 需要过滤的响应字段

replaceText - 替换文本

返回:

响应体信息

getParams

protected String getParams(javax.servlet.http.HttpServletRequest request,
                           String matchKey)

获取请求参数

参数:

request - HTTP请求

matchKey - 需要过滤的参数字段

返回:

请求参数JSON字符串

getParams

protected String getParams(javax.servlet.http.HttpServletRequest request,
                           String matchFieldKey,
                           String replaceText)

获取请求参数

参数:

request - HTTP请求

matchFieldKey - 需要过滤的参数字段

replaceText - 替换文本

返回:

请求参数JSON字符串

getRequestBody

protected String getRequestBody(javax.servlet.http.HttpServletRequest request,
                                String matchingPattern)

获取请求体

参数:

request - HTTP请求

matchingPattern - 需要过滤的字段

返回:

请求体内容

getRequestBody

protected String getRequestBody(javax.servlet.http.HttpServletRequest request,
                                String matchingFieldKey,
                                String replaceText)

获取请求体

参数:

request - HTTP请求

matchingFieldKey - 需要过滤的字段

replaceText - 替换文本

返回:

请求体内容

getRequestBodyText

protected String getRequestBodyText(RepeatBodyRequestWrapper wrapperRequest)

获取请求体文本

参数:

wrapperRequest - 包装后的请求

返回:

请求体文本

getMessagePayload

protected String getMessagePayload(byte[] buf,
                                   int maxLength,
                                   String characterEncoding)

获取消息负载

参数:

buf - 字节数组

maxLength - 最大长度

characterEncoding - 字符编码

返回:

消息文本