SpringBoot記錄HTTP請求日誌
SpringBoot記錄HTTP請求日誌
一、需求解讀
需求：java
框架須要記錄每個HTTP請求的信息，包括請求路徑、請求參數、響應狀態、返回參數、請求耗時等信息。git
需求解讀：github
Springboot框架提供了多種方式來攔截HTTP請求和響應，只要可以獲取到對應的request和response，就能夠經過相應的API來獲取所須要的信息。web
須要注意的是，請求參數能夠分爲兩部分，一部分是GET請求時，請求參數經過URL拼接的方式傳到後端，還有一部分是經過POST請求提交Json格式的參數，這種參數會放在request body中傳到後端，經過request.getParameterMap是沒法獲取到的。spring
二、Spring Boot Actuator
2.一、介紹和使用
Spring Boot Actuator 的關鍵特性是在應用程序裏提供衆多 Web 接口，經過它們瞭解應用程序運行時的內部情況，且能監控和度量Spring Boot 應用程序。後端
要使用Spring Boot Actuator，首先須要引入依賴包api
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
複製代碼
其次須要開啓端口訪問權限數組
management.endpoints.web.exposure.include=httptrace
複製代碼
Spring Boot 應用啓動時能夠看到控制檯的信息以下，表明開啓了該端口的訪問瀏覽器
瀏覽器訪問/acutator/httptrace就能看到HTTP的請求狀況bash
2.二、默認的HttpTraceRepository
Spring Boot Actuator 默認會把最近100次的HTTP請求記錄到內存中，對應的實現類是InMemoryHttpTraceRepository
public class InMemoryHttpTraceRepository implements HttpTraceRepository {
private int capacity = 100;
private boolean reverse = true;
private final List<HttpTrace> traces = new LinkedList<>();
/** * Flag to say that the repository lists traces in reverse order. * @param reverse flag value (default true) */
public void setReverse(boolean reverse) {
synchronized (this.traces) {
this.reverse = reverse;
}
}
/** * Set the capacity of the in-memory repository. * @param capacity the capacity */
public void setCapacity(int capacity) {
synchronized (this.traces) {
this.capacity = capacity;
}
}
@Override
public List<HttpTrace> findAll() {
synchronized (this.traces) {
return Collections.unmodifiableList(new ArrayList<>(this.traces));
}
}
@Override
public void add(HttpTrace trace) {
synchronized (this.traces) {
while (this.traces.size() >= this.capacity) {
this.traces.remove(this.reverse ? this.capacity - 1 : 0);
}
if (this.reverse) {
this.traces.add(0, trace);
}
else {
this.traces.add(trace);
}
}
}
}
複製代碼
這裏add方法使用了synchronized，默認只存儲最近到100條，若是併發量大的話，性能會有所影響
2.三、自定義HttpTraceRepository
咱們能夠本身實現HttpTraceRepository這個接口，重寫add方法並記錄trace日誌
@Slf4j
public class RemoteHttpTraceRepository implements HttpTraceRepository {
@Override
public List<HttpTrace> findAll() {
return Collections.emptyList();
}
@Override
public void add(HttpTrace trace) {
String path = trace.getRequest().getUri().getPath();
String queryPara = trace.getRequest().getUri().getQuery();
String queryParaRaw = trace.getRequest().getUri().getRawQuery();
String method = trace.getRequest().getMethod();
long timeTaken = trace.getTimeTaken();
String time = trace.getTimestamp().toString();
log.info("path: {}, queryPara: {}, queryParaRaw: {}, timeTaken: {}, time: {}, method: {}", path, queryPara, queryParaRaw,
timeTaken, time, method);
}
}
複製代碼
將該實現類註冊到Spring的容器中
@Configuration
@ConditionalOnWebApplication
@ConditionalOnProperty(prefix = "management.trace.http", name = "enabled", matchIfMissing = true)
@EnableConfigurationProperties(HttpTraceProperties.class)
@AutoConfigureBefore(HttpTraceAutoConfiguration.class)
public class TraceConfig {
@Bean
@ConditionalOnMissingBean(HttpTraceRepository.class)
public RemoteHttpTraceRepository traceRepository() {
return new RemoteHttpTraceRepository();
}
}
複製代碼
2.四、缺點
目前這種實現能夠記錄到請求路徑、請求耗時、響應狀態、請求Header、響應Header等信息，**沒有辦法記錄請求參數和響應參數。**有人在github上提了個issue，做者回復說這樣的設計是爲了兼容Spring MVC和WebFlux兩種模式，具體能夠參考：github.com/spring-proj…
三、Spring Boot Filter
3.一、HttpTraceFilter
既然httptrace沒法知足現有的需求，咱們能夠順着InMemoryHttpTraceRepository這個默認實現往上找，看看誰調用了這個實現類。結果能夠發現是被HttpTraceFilter這個攔截器（servlet模式下）進行了調用。
public class HttpTraceFilter extends OncePerRequestFilter implements Ordered {
// Not LOWEST_PRECEDENCE, but near the end, so it has a good chance of catching all
// enriched headers, but users can add stuff after this if they want to
private int order = Ordered.LOWEST_PRECEDENCE - 10;
private final HttpTraceRepository repository;
private final HttpExchangeTracer tracer;
/** * Create a new {@link HttpTraceFilter} instance. * @param repository the trace repository * @param tracer used to trace exchanges */
public HttpTraceFilter(HttpTraceRepository repository, HttpExchangeTracer tracer) {
this.repository = repository;
this.tracer = tracer;
}
@Override
public int getOrder() {
return this.order;
}
public void setOrder(int order) {
this.order = order;
}
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
if (!isRequestValid(request)) {
filterChain.doFilter(request, response);
return;
}
TraceableHttpServletRequest traceableRequest = new TraceableHttpServletRequest(
request);
HttpTrace trace = this.tracer.receivedRequest(traceableRequest);
int status = HttpStatus.INTERNAL_SERVER_ERROR.value();
try {
filterChain.doFilter(request, response);
status = response.getStatus();
}
finally {
TraceableHttpServletResponse traceableResponse = new TraceableHttpServletResponse(
(status != response.getStatus())
? new CustomStatusResponseWrapper(response, status)
: response);
this.tracer.sendingResponse(trace, traceableResponse,
request::getUserPrincipal, () -> getSessionId(request));
this.repository.add(trace);
}
}
...省略部分代碼
}
複製代碼
tracer中會記錄HTTP的請求耗時
3.二、自定義HttpTraceFilter獲取請求參數
在HttpTraceFilter繼承了OncePerRequestFilter，咱們能夠仿照這個過濾器，定義本身的過濾器去繼承OncePerRequestFilter，在doFilterInternal這個方法中獲取到HttpServletRequest，HttpServletResponse，這樣就能夠獲取到對應的請求參數和返回參數了。
GET請求時的參數能夠經過如下方式進行獲取：
String parameterMap = request.getParameterMap()
複製代碼
POST請求會將參數放入request body中，用如下方式進行獲取：
String requestBody = IOUtils.toString(request.getInputStream(), Charsets.UTF_8);
複製代碼
很不幸，代碼運行會拋出異常
緣由是：body裏字符的傳輸是經過HttpServletRequest中的字節流getInputStream()得到的；而這個字節流在讀取了一次以後就不復存在了。
解決方法：利用ContentCachingRequestWrapper對HttpServletRequest的請求包一層，該類會將inputstream中的copy一份到本身的字節數組中，這樣就不會報錯了。讀取完body後，須要調用
wrappedResponse.copyBodyToResponse();
複製代碼
將請求還原。
3.三、完整的自定義HttpTraceFilter
@Slf4j
public class HttpTraceLogFilter extends OncePerRequestFilter implements Ordered {
private static final String NEED_TRACE_PATH_PREFIX = "/api";
private static final String IGNORE_CONTENT_TYPE = "multipart/form-data";
private final MeterRegistry registry;
public HttpTraceLogFilter(MeterRegistry registry) {
this.registry = registry;
}
@Override
public int getOrder() {
return Ordered.LOWEST_PRECEDENCE - 10;
}
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
if (!isRequestValid(request)) {
filterChain.doFilter(request, response);
return;
}
if (!(request instanceof ContentCachingRequestWrapper)) {
request = new ContentCachingRequestWrapper(request);
}
if (!(response instanceof ContentCachingResponseWrapper)) {
response = new ContentCachingResponseWrapper(response);
}
int status = HttpStatus.INTERNAL_SERVER_ERROR.value();
long startTime = System.currentTimeMillis();
try {
filterChain.doFilter(request, response);
status = response.getStatus();
} finally {
String path = request.getRequestURI();
if (path.startsWith(NEED_TRACE_PATH_PREFIX) && !Objects.equals(IGNORE_CONTENT_TYPE, request.getContentType())) {
String requestBody = IOUtils.toString(request.getInputStream(), Charsets.UTF_8);
log.info(requestBody);
//1. 記錄日誌
HttpTraceLog traceLog = new HttpTraceLog();
traceLog.setPath(path);
traceLog.setMethod(request.getMethod());
long latency = System.currentTimeMillis() - startTime;
traceLog.setTimeTaken(latency);
traceLog.setTime(LocalDateTime.now().toString());
traceLog.setParameterMap(JsonMapper.INSTANCE.toJson(request.getParameterMap()));
traceLog.setStatus(status);
traceLog.setRequestBody(getRequestBody(request));
traceLog.setResponseBody(getResponseBody(response));
log.info("Http trace log: {}", JsonMapper.INSTANCE.toJson(traceLog));
}
updateResponse(response);
}
}
private boolean isRequestValid(HttpServletRequest request) {
try {
new URI(request.getRequestURL().toString());
return true;
} catch (URISyntaxException ex) {
return false;
}
}
private String getRequestBody(HttpServletRequest request) {
String requestBody = "";
ContentCachingRequestWrapper wrapper = WebUtils.getNativeRequest(request, ContentCachingRequestWrapper.class);
if (wrapper != null) {
try {
requestBody = IOUtils.toString(wrapper.getContentAsByteArray(), wrapper.getCharacterEncoding());
} catch (IOException e) {
// NOOP
}
}
return requestBody;
}
private String getResponseBody(HttpServletResponse response) {
String responseBody = "";
ContentCachingResponseWrapper wrapper = WebUtils.getNativeResponse(response, ContentCachingResponseWrapper.class);
if (wrapper != null) {
try {
responseBody = IOUtils.toString(wrapper.getContentAsByteArray(), wrapper.getCharacterEncoding());
} catch (IOException e) {
// NOOP
}
}
return responseBody;
}
private void updateResponse(HttpServletResponse response) throws IOException {
ContentCachingResponseWrapper responseWrapper = WebUtils.getNativeResponse(response, ContentCachingResponseWrapper.class);
Objects.requireNonNull(responseWrapper).copyBodyToResponse();
}
@Data
private static class HttpTraceLog {
private String path;
private String parameterMap;
private String method;
private Long timeTaken;
private String time;
private Integer status;
private String requestBody;
private String responseBody;
}
}
複製代碼
@Configuration
@ConditionalOnWebApplication
public class HttpTraceConfiguration {
@ConditionalOnWebApplication(type = Type.SERVLET)
static class ServletTraceFilterConfiguration {
@Bean
public HttpTraceLogFilter httpTraceLogFilter(MeterRegistry registry) {
return new HttpTraceLogFilter(registry);
}
}
}
複製代碼
四、Spring AOP
使用Spring AOP的方式須要自定義註解，而且每一個controller的方法上都須要加上這個註解才能進行攔截，對業務代碼對編寫有強制性的要求，因此沒有采用這種方式。
相關文章
- 1. Spring Boot 記錄 Http 請求日誌
- 2. SpringBoot使用Logbook記錄HTTP請求響應日誌
- 3. SpringBoot使用AOP記錄請求日誌和異常日誌
- 4. spring aop web請求日誌記錄
- 5. Nginx 記錄請求分發日誌
- 6. 在.NET Core中以日誌的方式記錄http請求
- 7. 如何使得 HTTP 請求記錄在 Domino 的日誌中
- 8. Spring Boot 記錄 Http 日誌
- 9. springboot 日誌問題記錄
- 10. springboot日誌配置，自動化記錄異常信息和用AOP記錄請求信息到日誌
- 更多相關文章...
- • HTTP 請求方法 - HTTP 教程
- • ADO 添加記錄 - ADO 教程
- • Tomcat學習筆記（史上最全tomcat學習筆記）
- • SpringBoot中properties文件不能自動提示解決方法
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. js中 charCodeAt
- 2. Android中通過ViewHelper.setTranslationY實現View移動控制（NineOldAndroids開源項目）
- 3. 【Android】日常記錄：BottomNavigationView自定義樣式，修改點擊後圖片
- 4. maya 文件檢查 ui和數據分離 （一）
- 5. eclipse 修改項目的jdk版本
- 6. Android InputMethod設置
- 7. Simulink中Bus Selector出現很多? ? ?
- 8. 【Openfire筆記】啓動Mac版Openfire時提示「系統偏好設置錯誤」
- 9. AutoPLP在偏好標籤中的生產與應用
- 10. 數據庫關閉的四種方式
歡迎關注本站公眾號,獲取更多信息
相關文章