1.背景
為了便于分析和記錄系統的運作,一個系統輸出其運作的關鍵日志是非常必要的
比如輸出:請求參數、請求url、請求方式、執行的sql、重要操作的日志、響應結果等
而這些日志中，大部分不需要我們手動對每個接口去輸出，主需要統一配置就可以了
2.實際生産運用步驟
步驟一:在resources下添加logback檔案,這個問價基本上每個項目都是一樣的,拷貝過來就可以使用
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：當此屬性設定為true時，配置檔案如果發生改變，将會被重新加載，預設值為true。
scanPeriod：設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間機關，預設機關是毫秒；當scan為true時，此屬性生效。預設的時間間隔為1分鐘。
debug：當此屬性設定為true時，将列印出logback内部日志資訊，實時檢視logback運作狀态。預設值為false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<!--
property:定義變量,相當于java中定義一個 String name="張無忌";
變量名LOG_HOME,用于日志根目錄檔案夾定義,可以任意命名
變量名appName,用于日志檔案名定義,可以任意命名
變量名logLevel,用于日志輸出級别定義,可以為 debug,info,error
-->
<property name="LOG_HOME" value="logs"/>
<property name="appName" value="log"></property>
<property name="logLevel" value="info"></property>
<!-- 擷取目前日期,一般生産上按照每天一個檔案夾,檔案夾的名稱就是年月日
<timestamp key="dateTime" datePattern="yyyy-MM-dd"/>
-->
<!--
1.ch.qos.logback.core.ConsoleAppender 表示控制台輸出
2.name 可以任意取名字
3.每個appender為一個日志類型
-->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志輸出格式：
%d表示日期時間，
%thread表示線程名，
%-5level：級别從左顯示5個字元寬度
%logger{50} 表示logger名字最長50個字元，否則按照句點分割。
%msg：日志消息，
%n是換行符
一般不輸出年份
案例一:<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==> [%thread] ==> %-5level %logger{50} - %msg%n</pattern>
-->
<encoder>
<pattern>%d{MM-dd HH:mm:ss.SSS} [%thread] %level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- 滾動記錄檔案，先将日志記錄到指定檔案，當符合某個條件時，将日志記錄到其他檔案 -->
<appender name="all" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--append：如果是 true，日志被追加到檔案結尾，如果是 false，清空現存檔案，預設是true。-->
<append>true</append>
<!-- 日志輸出等級
如果需要輸出mybatis執行的sql日志,需要使用debug
-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
<!-- 指定日志檔案的名稱與輸出位置 -->
<file>${LOG_HOME}/${appName}-all.log</file>
<!--
歸檔日志處理規則
當發生滾動時，決定 RollingFileAppender 的行為，涉及檔案移動和重命名
TimeBasedRollingPolicy： 最常用的滾動政策，它根據時間來制定滾動政策，既負責滾動也負責出發滾動。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滾動時産生的檔案的存放位置及檔案名稱 %d{yyyy-MM-dd}：按天進行日志滾動
%i：當檔案大小超過maxFileSize時，按照i進行檔案滾動
.zip:表示生成的歸檔檔案進行壓縮
-->
<fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/${appName}-all.%d.%i.log.zip</fileNamePattern>
<!--
可選節點，控制保留的歸檔檔案的最大數量，超出數量就删除舊檔案。假設設定每天滾動，
且maxHistory是30，則隻儲存最近30天的檔案，删除之前的舊檔案。注意，删除舊檔案是，
那些為了歸檔而建立的目錄也會被删除。
實際生中一般日志保留30天,可以根據特殊業務設定保留時間
-->
<MaxHistory>30</MaxHistory>
<!--
當日志檔案超過maxFileSize指定的大小時，根據上面提到的%i進行日志檔案滾動
注意此處配置SizeBasedTriggeringPolicy是無法實作按檔案大小進行滾動的，必須配置timeBasedFileNamingAndTriggeringPolicy
一般10M一個檔案
這裡為了測試滾動産生日志檔案,設定為10KB
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10KB</maxFileSize>
<!--<maxFileSize>10MB</maxFileSize>-->
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!--
日志輸出格式：
%d表示日期時間，
%thread表示線程名，
%-5level：級别從左顯示5個字元寬度
%logger{50} 表示logger名字最長50個字元，否則按照句點分割。
%msg：日志消息，
%line: 行号顯示,建議删除,這個有很多的性能損耗,報錯的時候有堆棧資訊
%n是換行符
案例: <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{MM-dd HH:mm:ss.SSS} [%thread] %level - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!--輸出到error-->
<appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
<append>true</append>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>error</level>
</filter>
<file>${LOG_HOME}/${appName}-error.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}/${appName}-error.%d.%i.log.zip</fileNamePattern>
<MaxHistory>30</MaxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{MM-dd HH:mm:ss.SSS} [%thread] %level - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<!--
logger主要用于存放日志對象，也可以定義日志類型、級别
name：表示比對的logger類型字首，也就是包的前半部分
level：要記錄的日志級别，包括 TRACE < DEBUG < INFO < WARN < ERROR
additivity：作用在于children-logger是否使用 rootLogger配置的appender進行輸出，
false：表示隻用目前logger的appender-ref，true：
表示目前logger的appender-ref和rootLogger的appender-ref都有效
root與logger是父子關系，沒有特别定義則預設為root，任何一個類隻會和一個logger對應，
要麼是定義的logger，要麼是root，判斷的關鍵在于找到這個logger，然後判斷這個logger的appender和level。
-->
<root level="${logLevel}">
<appender-ref ref="stdout"/>
<appender-ref ref="all"/>
<appender-ref ref="error"/>
</root>
</configuration> View Code
步驟二:添加一個過濾器,在過濾器中統一輸出日志
package com.ldp.user.common.interceptor;
import cn.hutool.core.util.RandomUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.extra.servlet.ServletUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* @Copyright (C) XXXXX科技有限公司
* @Author: LI DONG PING
* @Date: 2019/4/22 17:47
* @Description:
*/
@Component
@Slf4j
public class HttpServletRequestWrapperFilter implements Filter {
private final String CHARSET = "UTF-8";
@Override
public void doFilter(ServletRequest request, final ServletResponse response, FilterChain chain) throws IOException, ServletException {
// 自定義線程名稱
Thread.currentThread().setName(RandomUtil.randomString(10));
MultiReadHttpServletRequest requestWrapper = new MultiReadHttpServletRequest(request);
ResponseWrapper responseWrapper = new ResponseWrapper((HttpServletResponse) response, CHARSET);
String contentType = requestWrapper.getHeader(HttpHeaders.CONTENT_TYPE);
String url = requestWrapper.getRequestURL().toString();
if (url.contains("actuator") || url.contains("swagger") || url.contains("csrf")) {
chain.doFilter(requestWrapper, responseWrapper);
byte[] bytes = responseWrapper.getBytes();
response.getOutputStream().write(bytes);
return;
}
if (!url.contains("actuator")) {
log.info("ContentType: {}", contentType);
log.info("請求位址: {}", url);
log.info("請求方法: {}", requestWrapper.getMethod().toUpperCase());
if (isTextContentType(contentType)) {
String params = requestWrapper.getQueryString();
if (!StrUtil.isEmpty(params)) {
log.info("請求參數: {}", params);
}
String body = ServletUtil.getBody(requestWrapper);
if (!StrUtil.isEmpty(body)) {
log.info("請求參數[body]: {}", body);
}
}
long start = System.currentTimeMillis();
chain.doFilter(requestWrapper, responseWrapper);
long end = System.currentTimeMillis();
byte[] bytes = responseWrapper.getBytes();
if (isTextContentType(response.getContentType())) {
try {
log.info("響應結果: {}", new String(bytes, CHARSET));
} catch (Exception ex) {
log.error("響應異常", ex);
}
}
log.info("HTTP狀态: {}", responseWrapper.getStatus());
long diff = end - start;
if (diff < 1000) {
log.info("處理時長: {}毫秒", diff);
} else {
log.error("處理時長: {}毫秒,url:{}", diff, url);
}
response.getOutputStream().write(bytes);
} else {
chain.doFilter(requestWrapper, responseWrapper);
byte[] bytes = responseWrapper.getBytes();
response.getOutputStream().write(bytes);
}
}
private boolean isTextContentType(String contentType) {
return contentType != null && (contentType.contains(MediaType.TEXT_PLAIN_VALUE) ||
contentType.contains(MediaType.TEXT_XML_VALUE) ||
contentType.contains(MediaType.TEXT_HTML_VALUE) ||
contentType.contains(MediaType.APPLICATION_FORM_URLENCODED_VALUE) ||
contentType.contains(MediaType.APPLICATION_JSON_VALUE) ||
contentType.contains(MediaType.APPLICATION_XML_VALUE));
}
} 步驟三:引入日志輸出對象
// 方式一:lombok日志輸出對象引入,變量名為log (推薦使用)
@Slf4j
// 方式二:日志輸出對象引入 變量名為logger
private final static Logger logger = LoggerFactory.getLogger(UserOrderController.class); 步驟四:使用
/**
* 測試統一日志輸出
*
* @param message
* @return
*/
@GetMapping("/log")
public BaseResponse log(String message) {
// 注意這個System.out.println的輸出,隻會輸出到控制台,不能輸出到日志檔案,
// 而且效率很低,隻用于平時開發,實際生産幾乎不可能使用
System.out.println("message=" + message);
logger.debug("debug日志輸出,message={}", message);
// 這兩種寫法一樣
logger.debug("debug日志輸出,message=" + message);
logger.info("info日志輸出,message={}", message);
logger.error("error 日志輸出,message={}", message);
// 模拟輸出錯誤堆棧資訊
try {
if ("abc".equals(message)) {
Integer value = Integer.valueOf(message);
logger.info("value=" + value);
}
} catch (Exception e) {
logger.error("數字轉換異常:", e.getMessage());
logger.error("數字轉換異常:", e);
}
// 不處理的異常
Integer value2 = Integer.valueOf(message);
logger.info("value2=" + value2);
return ResponseBuilder.success("統一參數檢查.....");
} 步驟五:模拟請求測試
/**
* 統一日志輸出測試
*/
@Test
void logTest() {
String url = urlLocal + "/userOrder/log";
System.out.println("請求位址:" + url);
HttpRequest request = HttpUtil.createRequest(Method.GET, url);
Map<String, Object> map = new TreeMap<>();
// 業務參數
map.put("message", "1000");
// 公用參數
map.put("appid", "1001");
map.put("sequenceId", "seq" + System.currentTimeMillis());
map.put("timeStamp", System.currentTimeMillis());
map.put("sign", signApi(map, "123456"));
request.form(map);
System.out.println("請求參數:" + map);
request.header("Authorization", token);
request.setConnectionTimeout(60 * 1000);
String response = request.execute().body();
System.out.println("請求結果:" + response);
} 日志輸出結果:
01-02 08:59:51.760 [rptudgh22m] INFO com.ldp.user.controller.UserOrderController - info日志輸出,message=1000
01-02 08:59:51.760 [rptudgh22m] ERROR com.ldp.user.controller.UserOrderController - error 日志輸出,message=1000
01-02 08:59:51.760 [rptudgh22m] INFO com.ldp.user.controller.UserOrderController - value2=1000
01-02 08:59:51.796 [rptudgh22m] INFO c.l.u.c.i.HttpServletRequestWrapperFilter - 響應結果: {"message":"success","code":100,"data":"統一參數檢查....."}
01-02 08:59:51.797 [rptudgh22m] INFO c.l.u.c.i.HttpServletRequestWrapperFilter - HTTP狀态: 200
01-02 08:59:51.798 [rptudgh22m] INFO c.l.u.c.i.HttpServletRequestWrapperFilter - 處理時長: 275毫秒 生成的日志檔案夾
3.mybatis中sql日志輸出
步驟一:配置
步驟二:sql輸出
/**
* 測試統一sql日志輸出
*
* @param message
* @return
*/
@GetMapping("/logSql")
public BaseResponse logSql(String message) {
logger.info("message=" + message);
List<UserOrder> list = service.list(null);
return ResponseBuilder.success(list);
} 步驟三:測試
/**
* 統一日志輸出測試
*/
@Test
void logTest() {
for (int i = 100; i < 200; i++) {
String url = urlLocal + "/userOrder/logSql";
System.out.println("請求位址:" + url);
HttpRequest request = HttpUtil.createRequest(Method.GET, url);
Map<String, Object> map = new TreeMap<>();
// 業務參數
map.put("message", i);
// 公用參數
map.put("appid", "1001");
map.put("sequenceId", "seq" + System.currentTimeMillis());
map.put("timeStamp", System.currentTimeMillis());
map.put("sign", signApi(map, "123456"));
request.form(map);
System.out.println("請求參數:" + map);
request.header("Authorization", token);
request.setConnectionTimeout(60 * 1000);
String response = request.execute().body();
System.out.println("請求結果:" + response);
}
} 測試結果
01-02 09:47:34.119 [l280fegb2i] INFO com.ldp.user.controller.UserOrderController - message=199
01-02 09:47:34.119 [l280fegb2i] DEBUG com.ldp.user.mapper.UserOrderMapper.selectList - ==> Preparing: SELECT id,`order_no`,`buy_account`,`status`,`product_name`,`price`,`pay_status`,`update_time`,`create_time`,`version`,`deleted` FROM `user_order`
01-02 09:47:34.119 [l280fegb2i] DEBUG com.ldp.user.mapper.UserOrderMapper.selectList - ==> Parameters:
01-02 09:47:34.134 [l280fegb2i] DEBUG com.ldp.user.mapper.UserOrderMapper.selectList - <== Total: 5
01-02 09:47:34.134 [l280fegb2i] INFO c.l.u.c.i.HttpServletRequestWrapperFilter - 響應結果: {"message":"success","code":100,"data":[{"id":1,"orderNo":"LDP001","buyAccount":"string","status":0,"productName":"string","price":0.0,"payStatus":0,"updateTime":"2020-12-16T10:28:25","createTime":"2020-12-16T10:28:25","version":0,"deleted":0},{"id":2,"orderNo":"LDP001","buyAccount":"string","status":0,"productName":"string","price":0.0,"payStatus":0,"updateTime":"2020-12-16T10:28:25","createTime":"2020-12-16T10:28:25","version":0,"deleted":0},{"id":3,"orderNo":"LDP001","buyAccount":"string","status":0,"productName":"string","price":0.0,"payStatus":0,"updateTime":"2020-12-16T10:28:25","createTime":"2020-12-16T10:28:25","version":0,"deleted":0},{"id":4,"orderNo":"LDP003","buyAccount":"wx001","status":null,"productName":"蘋果手機","price":6990.0,"payStatus":null,"updateTime":null,"createTime":null,"version":0,"deleted":0},{"id":5,"orderNo":"NO003","buyAccount":"lidongping","status":null,"productName":"iPhone12","price":8000.0,"payStatus":null,"updateTime":null,"createTime":null,"version":0,"deleted":0}]}
01-02 09:47:34.134 [l280fegb2i] INFO c.l.u.c.i.HttpServletRequestWrapperFilter - HTTP狀态: 200
01-02 09:47:34.134 [l280fegb2i] INFO c.l.u.c.i.HttpServletRequestWrapperFilter - 處理時長: 15毫秒 文字描述内容有限,如果還是不明白可以直接問我,或者在看視訊講解與示範